Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ IVR Flow Management/ Querying Satisfaction Survey Information (querySatisfactionConfig)
Updated on 2023-09-27 GMT+08:00

Querying Satisfaction Survey Information (querySatisfactionConfig)

Scenario

Query satisfaction surveys.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/satisfactionconfig/querySatisfactionConfig. 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

No

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.)

Response Description

  • Status code: 200
    Table 2 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    schema

    Object

    Yes

    -

    1.1

    returnCode

    String

    Yes

    Return code. The value 0 indicates success. Other values indicate failure.

    1.2

    description

    String

    No

    Return result description.

    1.3

    enabled

    Boolean

    Yes

    Whether to enable the satisfaction survey. true: enabled; false: disabled. If this function is disabled, data is empty.

    1.4

    data

    Array (object)

    No

    Currently, only one value is returned.

    1.4.1

    ivrId

    String

    No

    IVR flow ID.

    1.4.2

    feedbackType

    String

    No

    IVR: IVR flow. Currently, there is only one value.

    1.4.3

    channelType

    String

    No

    audio: audio

    media: multimedia

    Currently, the value can only be audio.

    1.4.4

    accessCode

    String

    No

    Flow access code.

  • Status code: 401

    Authorization failed: 1. Whether the parameter is correct and valid. 2. Check whether you have purchased related services. 3. Contact customer service to check the status of your account.

  • Status code: 404

    The request path may be incorrect.

  • Status code: 500

    The service fails or an internal exception occurs on the server due to incorrect parameters.

Error Codes

None

Example

Request header:

X-APP-KEY: ****************************
Authorization: Bearer *******************************

Response parameters:

{
    "returnCode": "0",
    "data": [
        {
            "accessCode": "6001",
            "channelType": "audio",
            "feedbackType": "IVR",
            "ivrId": "1239554736420597767"
        }
    ],
    "description": "success",
    "enabled": true
}