tencent cloud

Query User Satisfaction Survey Setting
Last updated: 2025-04-07 10:55:01
Query User Satisfaction Survey Setting
Last updated: 2025-04-07 10:55:01

API Call Description

Through this API, query the configuration of user satisfaction, toggle, survey invitation methods, and multilingual reminders for invitation, etc.

Sample Request URL

https://console.tim.qq.com/v4/desk_http_svc/get_satisfaction_settings?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please refer to REST API Introduction.
Parameter
Description
v4/desk_http_svc/get_satisfaction_settings
Request API.
sdkappid
Assigned SDKAppID in the Chat console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Generated signature of the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype
The request format has a fixed value of json.

Sample Request Packet

{
}

Sample Response Packet

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Data": {
        "SatisfactionEnabled": 1,
        "InvitationMethod": 3,
        "SatisfactionContent": {
            "RatingInvitationMessage": "Thank you for using our service. Please rate this service."
            "SubmissionMessage": "Thank you for rating this service. Wish you a pleasant life. Goodbye."
            "OneStarContent": "Dissatisfied."
            "TwoStarContent": "Not satisfied."
            "ThreeStarContent": "Average."
            "FourStarContent": "Satisfied."
            "FiveStarContent": "Super satisfied."
            "SubmissionValidityPeriod": 12
        },
        "SatisfactionContentMultilingual": {
            "en": {
                "RatingInvitationMessage": "Please rate our service.",
                "SubmissionMessage": "Thank you for your feedback.",
                "OneStarContent": "Very dissatisfied",
                "TwoStarContent": "Dissatisfied",
                "ThreeStarContent": "Neutral",
                "FourStarContent": "Satisfied",
                "FiveStarContent": "Very satisfied",
                "SubmissionValidityPeriod": 12
            },
            "zh": {
                "RatingInvitationMessage": "Please rate our service!"
                "SubmissionMessage": "Thank you for your evaluation!"
                "OneStarContent": "Dissatisfied"
                "TwoStarContent": "Not satisfied."
                "ThreeStarContent": "Average"
                "FourStarContent": "Satisfied."
                "FiveStarContent": "Super satisfied"
                "SubmissionValidityPeriod": 12
            }
        }
    }
}

Response Packet Parameter Description

Field
Type
Description
ErrorCode
Integer
Error Code:
0: success.
Non-zero: failure.
ErrorInfo
String
Error message.
ActionStatus
String
Result of request processing.
SatisfactionEnabled
Integer
Whether to enable satisfaction survey:
1: Enable.
0: Disable.
InvitationMethod
Integer
Invitation for Evaluation Method
1: Automatically send after the session ends.
2: Agent invites the user to provide feedback on satisfaction.
3: Both methods are available. If not proactively invited for evaluation, it will be automatically sent after the session ends.
SatisfactionContent
Object
Satisfaction survey content.
SatisfactionContent.RatingInvitationMessage
String
Prompt inviting evaluation.
SatisfactionContent.SubmissionMessage
String
Thank-you message after submitting the evaluation.
SatisfactionContent.OneStarContent
String
The content of one-star evaluation, for example: Dissatisfied.
SatisfactionContent.TwoStarContent
String
The content of two-star evaluation, for example: Not satisfied.
SatisfactionContent.ThreeStarContent
String
The content of three-star evaluation, for example: Average.
SatisfactionContent.FourStarContent
String
The content of four-star evaluation, for example: Satisfied.
SatisfactionContent.FiveStarContent
String
The content of five-star evaluation, for example: Super satisfied.
SatisfactionContent.SubmissionValidityPeriod
Integer
The valid period for submitting evaluations, measured in hours.
SatisfactionContentMultilingual
Map<String, Object>
Multilingual configuration of user satisfaction survey content
The key is a language tag (for example: Chinese: "zh", English: "en").
The value is the user satisfaction survey configuration content in the corresponding language.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 200. The actual error code and error information are represented by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
141000
The application is not a desk application.
141002
Internal error, retry.
141004
Invalid parameter.

API Debugging Tool

Debug this interface using the REST API online debugging tool.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback