Help Center/ Customer Engagement Center/ API Reference/ Adapter Class Interface Reference/ Interface Description/ Data Access Interfaces/ Web Channel/ Querying Satisfaction Survey Levels
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Satisfaction Survey Levels

Function

This interface is invoked to query satisfaction survey levels.

Usage Description

  • Prerequisites

    The web channel configuration has been correctly created.

Interface Prototype

Table 1 Interface prototype description

Method

POST

URL

https://ip:port/service-cloud/rest/webadapter/v1/webadapterfacade/querySatisfyMode

{IP address}:{Port number} indicates the IP address and port number of the NSLB exposed externally.
Table 2 Request header parameters

Parameter

Mandatory or Not

Type

Default Value

Description

Content-Type

Yes

String

None

The value is fixed at application/json; charset=UTF-8.

Cookie

Yes

String

None

During page integration, the CC-Messaging writes the value of ccmessaging-token to browser cookies through the request response. When invoking this interface independently, ensure that the cookie in the request header contains ccmessaging-token=xxx, where xxx indicates the value of ccmessaging-token.

Request Parameters

None

Response Parameters

Table 3 Response parameters

Parameter

Mandatory or Not

Type

Description

resultCode

Yes

String

Interface response code. The value 0 indicates success.

resultDesc

Yes

String

Interface description.

surveyType

No

String

Channel type to which the satisfaction survey applies.

satisfactionLevel

No

List

Satisfaction level. For details, see Table 4.
Table 4 satisfactionLevel

Parameter

Mandatory or Not

Type

Description

satisfactionLevelDesc

Yes

String

Description of a satisfaction level.

satisfactionLevelKey

Yes

String

No. of a satisfaction level.

Example

  • Request 
    POST /service-cloud/rest/webadapter/v1/webadapterfacade/querySatisfyMode

host: 10.10.10.2:18446
connection: Keep-Alive
x-forwarded-for: 10.10.10.3, 10.10.10.4
x-real-ip: 10.10.10.5
content-length: 401
remote-host: 10.10.10.6
user-agent: java/socket
content-type: application/json; charset=utf-8
cookie: JSESSION*****#*#*****3
ccmessaging-token: ********
accept: */*
  • Response 
    {
    "resultCode":"0",
    "resultDesc":"query satisfaction success!",
    "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"
        }
    ]
}
Parent topic: Web Channel