Help Center/ Cognitive Engagement Center/ API Reference/ Web Client Access Interface Reference/ Querying the Satisfaction Survey Configuration (getSatisfactionSurveyMode)
Updated on 2023-09-27 GMT+08:00
View PDF

Querying the Satisfaction Survey Configuration (getSatisfactionSurveyMode)

Scenario

This interface is invoked to query the satisfaction survey configuration.

Method

POST

URI

https://Domain name/apiaccess/ccmessaging/getsatisfactionsurveymode (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, which is the user ID

2

Authorization

String

Yes

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

3

ccmessaging-token

String

Yes

Value of ccmessaging-token generated by the applyToken interface

Response Description

  • Status code: 200
Table 2 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

resultCode

String

Yes

Response code.

  • 0: success
  • 13: failure to query the satisfaction survey configuration

2

resultDesc

String

Yes

Response description

3

satisfactionSurvey

Object

Yes

Satisfaction survey

3.1

surveyType

String

Yes

Survey type

WEB: web page

NO: no survey

3.2

satisfactionLevel

Array

No

Satisfaction level array

3.2.1

satisfactionLevelKey

String

No

Satisfaction level. The value ranges from 1 to 5. The default satisfaction levels are as follows:

  • 1: very dissatisfied
  • 2: dissatisfied
  • 3: general
  • 4: satisfied
  • 5: very satisfied

You can invoke the interface for querying the satisfaction survey configuration to query the satisfaction level set in Configuration Center > Workbench Configuration > Satisfaction Survey > Satisfaction Level or use the default value. The satisfaction level is the same as the pressed key.

3.2.2

satisfactionLevelDesc

String

No

Satisfaction description. The default values are as follows:

  • Very dissatisfied
  • Dissatisfied
  • General
  • Satisfied
  • Very satisfied
  • 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

  • Scenario: Create an outbound call task.
  • Request header 
    {
	"X-APP-Key": "b*************c7b",
	"Authorization": "Bearer 1fea*************1d6a15",
	"Content-Type": "application/json"
}
  • Request parameters

    None

  • Response header 
    connection: keep-alive  
content-encoding: gzip  
content-length: 130 
content-type: application/json;charset=UTF-8  
date: Wed, 12 May 2021 08:52:40 GMT  
server: openresty
  • Response parameters 
    {
     "satisfactionSurvey": {
        "surveyType": "WEB",
        "satisfactionLevel": [
            {
                "satisfactionLevelDesc": "Very dissatisfied",
                "satisfactionLevelKey": "1"
            },
            {
                "satisfactionLevelDesc": "Dissatisfied",
                "satisfactionLevelKey": "2"
            },
            {
                "satisfactionLevelDesc": "General",
                "satisfactionLevelKey": "3"
            },
            {
                "satisfactionLevelDesc": "Satisfied",
                "satisfactionLevelKey": "4"
            },
            {
                "satisfactionLevelDesc": "Very satisfied",
                "satisfactionLevelKey": "5"
            }
        ]
    },
    "resultCode": "0",
    "resultDesc": "Get satisfaction survey mode success!"
}