接口调用说明
通过该接口查询满意度评价的配置,启用开关,邀评方式,邀评的多语言提示语等。
请求 URL 示例
https://console.tim.qq.com/v4/desk_http_svc/get_satisfaction_settings?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
v4/desk_http_svc/get_satisfaction_settings | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json 。 |
请求包示例
{}
应答包示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Data": {"SatisfactionEnabled": 1,"InvitationMethod": 3,"SatisfactionContent": {"RatingInvitationMessage": "感谢您使用我们的服务,请对此次服务进行评价。","SubmissionMessage": "感谢您对此次服务作出评价,祝您生活愉快,再见。","OneStarContent": "非常不满意。","TwoStarContent": "不满意。","ThreeStarContent": "一般。","FourStarContent": "满意。","FiveStarContent": "非常满意。","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": "请您对我们的服务进行评价!","SubmissionMessage": "感谢您的评价!","OneStarContent": "非常不满意","TwoStarContent": "不满意","ThreeStarContent": "一般","FourStarContent": "满意","FiveStarContent": "非常满意","SubmissionValidityPeriod": 12}}}}
应答包参数说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
ActionStatus | String | 请求处理的结果。 |
SatisfactionEnabled | Integer | 是否启用满意度调查: 1表示启用。 0表示不启用。 |
InvitationMethod | Integer | 邀评方式: 1表示会话结束后自动发送。 2表示客服主动邀评。 3表示两种方式皆可,未主动邀评会话结束后自动发送。 |
SatisfactionContent | Object | 满意度调查内容。 |
SatisfactionContent.RatingInvitationMessage | String | 邀请评价的提示语。 |
SatisfactionContent.SubmissionMessage | String | 提交评价后的感谢语。 |
SatisfactionContent.OneStarContent | String | 一星评价的内容,例如:非常不满意。 |
SatisfactionContent.TwoStarContent | String | 二星评价的内容,例如:不满意。 |
SatisfactionContent.ThreeStarContent | String | 三星评价的内容,例如:一般。 |
SatisfactionContent.FourStarContent | String | 四星评价的内容,例如:满意。 |
SatisfactionContent.FiveStarContent | String | 五星评价的内容,例如:非常满意。 |
SatisfactionContent.SubmissionValidityPeriod | Integer | 提交评价的有效期,单位为小时。 |
SatisfactionContentMultilingual | Map<String, Object> | 满意度评价内容的多语言配置: key 是语言标签(例如:中文:"zh", 英文:"en")。 value 是对应语言的满意度评价配置内容。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
141000 | 该应用非智能客服应用。 |
141002 | 内部错误,请重试。 |
141004 | 参数非法。 |