查询满意度调查结果(satisfaction/query)
接口方法
POST
接口URI
https://域名/apiaccess/rest/cc-management/v1/satisfaction/query,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
X-APP-Key |
string |
False |
appKey字段,用户标识,请联系运营人员获取appKey |
2 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
requestBody |
object |
True |
请求入参 |
1.1 |
callId |
string |
True |
通话标识callId |
1.2 |
beginTime |
number |
True |
评价开始时间,毫秒级别Timestamp时间戳类型 |
1.3 |
endTime |
number |
True |
评价结束时间,毫秒级别Timestamp时间戳类型 |
响应说明
- 响应状态码: 200
表3 响应体参数 序号
名称
参数类型
是否必选
说明
1
schema
object
True
-
1.1
returnCode
string
True
结果返回码,0表示查询成功,-1表示查询失败,description表示失败具体原因
1.2
description
string
True
结果返回描述
1.3
satisfactionEvaluations
object
True
满意度评价
1.3.1
evaluationValue
string
False
满意度评价,为满意度等级配置的字典key值。
“1”表示“很不满意”,
“2”表示“不满意”,
“3”表示“一般”,
“4”表示“满意”,
“5”表示“很满意”
“-1”表示“超时未回复”,指用户收到满意度评价后,评价超时,
“-2”表示“评价错误”指用户回复的满意度,不在满意度配置的按键值中。
1.3.2
channel
string
False
渠道:
audio表示音频渠道,MSG表示短信,WEB表示网页文字交谈渠道
1.3.3
evaluationTime
number
False
评价时间,毫秒级别Timestamp时间戳类型
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
请求头:
Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX
请求参数:
{ "callId": "1647265024-xxxx", "beginTime": 1647265028000, "endTime": 1647265029000 }
响应参数:
{ "returnCode": "0", "satisfactionEvaluations": { "channel": "audio", "evaluationValue": "5", "evaluationTime": 1647265028000 }, "description": " query Success" }