Help Center/ Cognitive Engagement Center/ API Reference/ Voice Notification Interface Reference/ Querying Voice Notification Recording Files (queryVoiceNotificationRecording)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Voice Notification Recording Files (queryVoiceNotificationRecording)

Scenario

This API is invoked to query voice notification recording data, and queries only approved voice notification data.

To configure recording files, a system administrator can sign in to the AICC and choose Configuration Center > Resource Management and Configuration > Audio and video Resource Management to configure them, or invoke the API for uploading IVR voice files.

Method

POST

URI

https://Domain name/apiaccess/rest/voiceNotification/v1/queryVoiceNotificationRecording. For example, the domain name is service.besclouds.com.

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

X-APP-Key

String

Yes

App key field, which is the user ID. Contact the operation personnel to obtain the app key.

2

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

For details about the generation mode, see C1 System Configuration Interface Authentication.
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

reqBody

Object

Yes

-

1.1

offset

Integer

No

Start line number for query in pagination mode.

The value 0 is transferred for the first query.

Sequence number of the first record on the page when other pages are queried. The sequence number of the first record is 0, and the sequence numbers of subsequent records increase in order. For example, if 50 records are listed on each page, 50 is transferred for the first record on the second page.

If this parameter is not transferred, the default value 0 is used, and there is no upper limit.

1.2

limit

Integer

No

Number of records on each page during pagination query. The value is a positive integer. If this parameter is not transferred, the default value 100 is used. The maximum value is 100. If a value greater than 100 is transferred, the value is converted to 100.

1.3

type

Integer

No

Recording file type. The options are 0 (audio) and 2 (text).

Response Description

  • Status code: 200
    Table 3 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    schema

    Object

    Yes

    -

    1.1

    returnCode

    String

    Yes

    Return code. 0: success; other values: failure (1: incorrect request parameter type)

    1.2

    description

    String

    No

    Return result description.

    1.3

    voiceInfo

    Object

    No

    Recording information.

    1.3.1

    tenant_id

    String

    Yes

    Tenant ID.

    1.3.2

    uploaddate

    Number

    Yes

    Upload time, in timestamp format.

    1.3.3

    voice_id

    String

    Yes

    Voice ID.

    1.3.4

    name

    String

    Yes

    Recording name.

    1.3.5

    voicecontent

    String

    No

    Voice content.

    1.3.6

    type

    Number

    Yes

    The options are 0 (audio) and 2 (text).

    1.3.7

    tenantSpaceName

    String

    No

    Tenant name.

    1.3.8

    auditaccount

    String

    No

    Reviewer account.

    1.3.9

    noReference

    boolean

    No

    Whether the prompt tone and fault tone are referenced.

    1.3.10

    auditcomments

    String

    No

    Review comment.

    1.3.11

    auditdate

    Number

    No

    Review time, in timestamp format.

    1.3.12

    scene

    Number

    No

    Application scenario.

    1.3.13

    uploadaccount

    String

    No

    Upload account.

    1.3.14

    isUpdateRec

    Number

    No

    Whether the record is updated.

    1.3.15

    status

    Number

    No

    Callback status.

    1.3.16

    callbackTimes

    Number

    No

    Number of callback times.
  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 403

    Authentication fails.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request header:

{
"Content-Type": application/json
"x-app-key": ********************
"Authorization": Bearer ************************
}

Request parameters:

{
 "offset":0,
 "limit":10,
 "type":2
}

Response parameters:

{
    "returnCode": "0",
    "description": "query success",
    "voiceInfo": [
        {
            "tenant_id": "20******234",
            "uploaddate": 163*****4000,
            "voice_id": "113379*********9999",
            "name": "welcome",
            "voicecontent": "{\"0\":{\"languageId\":\"0\",\"textcontent\":\"Welcome\"}}",
            "type": 2,
            "tenantSpaceName": "************"
        },
    ]
}