在线机器人会话评价
查询机器人会话评价设置
查询机器人会话评价设置。
接口级参数规则:fromType 必填且必须是系统支持的来源渠道。
请求字段限制:
- robotId:选填,机器人 ID,不传时使用默认机器人
- fromType:必填,访客来源渠道,必须是系统支持的 FromType
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | 1c088a89de51d0af457616605f28390f |
| time | int64 | 是 | 请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败 | 1511832531 |
| checksum | string | 是 | 请求签名校验和 | f570a5eb049eb803b086e45829b07e48 |
| checksumAlgorithm | int32 | 否 | 签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1) | 0 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| robotId | int64 | 否 | 机器人 ID,不传时使用默认机器人 | 123456 |
| fromType | string | 是 | 访客来源渠道,必须是系统支持的 FromType | web |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 业务状态码,200 表示成功 | 200 |
| message | string | 响应消息 | success |
| data | object | ||
| └pattern | int32 | 评价样式:0-浮层,1-气泡,2-新页面 | |
| └patternUrl | string | pattern=2 时的自定义地址 | |
| └type | int32 | 当前评价模式:2-二级,3-三级,4-四级,5-五级 | |
| └title | string | 当前评价模式标题 | |
| └note | string | 当前评价模式描述 | |
| └list | object[] | 当前评价模式评分项列表 | |
| └name | string | 得分项名称,如满意、一般、不满意 | |
| └value | int32 | 得分项分值 | |
| └tagList | string[] | 标签列表 | |
| └tagRequired | int32 | 标签是否必填 | |
| └commentRequired | int32 | 备注是否必填 | |
| └resolvedEnabled | int32 | 是否向访客收集“您的问题是否解决”:0-关闭,1-打开 | |
| └resolvedRequired | int32 | resolvedEnabled 开启后是否必填:0-非必填,1-必填 | |
| └messageThanks | string | 评价感谢文案,富文本 | |
| └enableEvaluationMuttimes | boolean | 是否允许多次评价:false-不允许,true-允许 | |
| └evaluationRounds | int32 | 展示评价按钮的回合数限制 | |
| └evaluationValues | int32 | 会话状态中已评价的得分值 | |
| └showEvaluationDirect | int32 | 会话状态中是否直接展示评价按钮 | |
| └forceEvaluationRounds | int32 | 强制评价回合数限制 | |
| └forceEvaluation | int32 | 会话状态中是否强制评价 | |
| └unevaluatedIconUrl | string | 未评价图标地址 | |
| └evaluatedIconUrl | string | 已评价图标地址 | |
| total | int32 | 分页总数,分页接口返回 | 100 |
| requestId | string | 链路请求 ID | 0a1b2c3d4e5f |
| result | object | 部分历史接口使用 result 字段承载业务数据 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 缺失或不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体不是合法 JSON 对象,或参数缺失、格式非法 |
| 14009 | 频控限制:接口调用超过限流阈值 |
| 14500 | 服务内部错误 |
| 14501 | 数据查询范围超出限制 |
| 14515 | 当前 AppKey 无接口或资源访问权限 |
postEndpoint
/openapi/robot/evaluation/settingcurl -X POST "https://qiyukf.com/openapi/robot/evaluation/setting?appKey=1c088a89de51d0af457616605f28390f&time=1511832531&checksum=f570a5eb049eb803b086e45829b07e48" \ -H "Content-Type: application/json" \ -d '{ "fromType": "web", "robotId": 123456 }'{
"code": 200,
"data": {},
"message": "success"
}{
"code": 14001,
"message": "AppKey not exists"
}{
"code": 14002,
"message": "Bad checksum"
}{
"code": 14003,
"message": "Bad time"
}{
"code": 14004,
"message": "body内容json解析错误"
}{
"code": 14009,
"message": "单位时间内请求过于频繁"
}{
"code": 14500,
"message": "Internal error"
}{
"code": 14501,
"message": "Data limit exceeded"
}{
"code": 14515,
"message": "未开通机器人服务"
}这篇文档有帮助吗?
提交机器人会话评价
提交机器人会话评价。 接口级参数规则:sessionId、evaluation 必填;evaluation 范围 1-100;evaluationResolved 范围 0-2;remarks 默认最长 200,tagList 默认最长 500。 请求字段限制: - sessionId:必填,会话 ID,必须属于当前 appKey 对应企业 - evaluation:必填,评价分值,范围 1-100,最小值 1,最大值 100 - evaluationResolved:选填,解决状态:0-未选择,1-已解决,2-未解决,可选值:0/1/2 - remarks:选填,评价备注,长度不能超过服务端配置,默认 200 - tagList:选填,评价标签,多个标签按现有协议传入,长度不能超过服务端配置,默认 500
查询机器人转人工统计
查询机器人转人工统计。 接口级参数规则:startTime、endTime 必填;sessionType 仅支持 0、1、2;时间跨度不能超过服务端配置。 请求字段限制: - robotId:选填,机器人 ID,不传时默认 -1 表示全部机器人,默认值:-1 - startTime:必填,开始时间,毫秒时间戳 - endTime:必填,结束时间,毫秒时间戳;与 startTime 的间隔不能超过服务端配置 - sessionType:选填,会话类型:0-全部,1-普通会话,2-访客主动转人工会话,可选值:0/1/2,默认值:0