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

Querying Satisfaction Survey Results (satisfaction /query)

Scenario

Query the satisfaction survey result based on the call ID and evaluation time.

Before using this interface, understand how to configure a satisfaction survey flow. For details, see Configuring a Satisfaction Survey.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/satisfaction/query. 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.)
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

requestBody

Object

Yes

Input parameters.

1.1

callId

String

Yes

Call ID.

1.2

beginTime

Number

Yes

Evaluation start time, in milliseconds. The value is a timestamp.

1.3

endTime

Number

Yes

Evaluation end time, in milliseconds. The value is a timestamp.

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

    Result code. The value 0 indicates that the query is successful, -1 indicates that the query fails, and description indicates the failure cause.

    1.2

    description

    String

    Yes

    Result description.

    1.3

    satisfactionEvaluations

    Object

    Yes

    Satisfaction evaluation.

    1.3.1

    evaluationValue

    String

    No

    Satisfaction degree, which is the dictionary key value configured for the satisfaction level.

    1: very dissatisfied

    2: dissatisfied

    3: minor

    4: satisfied

    5: very satisfied

    The value -1 indicates that the user does not reply within the specified period after receiving the satisfaction evaluation.

    The value -2 indicates that the satisfaction degree replied by the user is not included in the configured key values.

    1.3.2

    channel

    String

    No

    Channel.

    audio indicates the audio channel, MSG indicates the SMS channel, and WEB indicates the web page text chat channel.

    1.3.3

    evaluationTime

    Number

    No

    Evaluation time, in milliseconds. The value is a timestamp.
  • 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: 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
Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX
X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX

Request parameters:

{
     "callId": "1647265024-xxxx",
     "beginTime": 1647265028000,
  "endTime": 1647265029000
 }

Response parameters:

{
  "returnCode": "0",
  "satisfactionEvaluations": {
   "channel": "audio",
   "evaluationValue": "5",
   "evaluationTime": 1647265028000
  },
  "description": " query Success"
 }
Parent topic: IVR Flow Management