七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线机器人会话评价

查询机器人会话评价设置

查询机器人会话评价设置。

接口级参数规则:fromType 必填且必须是系统支持的来源渠道。

请求字段限制:

  • robotId:选填,机器人 ID,不传时使用默认机器人
  • fromType:必填,访客来源渠道,必须是系统支持的 FromType

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey1c088a89de51d0af457616605f28390f
timeint64是请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败1511832531
checksumstring是请求签名校验和f570a5eb049eb803b086e45829b07e48
checksumAlgorithmint32否签名算法:0-SHA-1,1-SHA-256;不传默认为 0(SHA-1)0

请求体

名称类型必填描述示例值
robotIdint64否机器人 ID,不传时使用默认机器人123456
fromTypestring是访客来源渠道,必须是系统支持的 FromTypeweb

返回参数

名称类型描述示例值
codeint32业务状态码,200 表示成功200
messagestring响应消息success
dataobject
└patternint32评价样式:0-浮层,1-气泡,2-新页面
└patternUrlstringpattern=2 时的自定义地址
└typeint32当前评价模式:2-二级,3-三级,4-四级,5-五级
└titlestring当前评价模式标题
└notestring当前评价模式描述
└listobject[]当前评价模式评分项列表
└namestring得分项名称,如满意、一般、不满意
└valueint32得分项分值
└tagListstring[]标签列表
└tagRequiredint32标签是否必填
└commentRequiredint32备注是否必填
└resolvedEnabledint32是否向访客收集“您的问题是否解决”:0-关闭,1-打开
└resolvedRequiredint32resolvedEnabled 开启后是否必填:0-非必填,1-必填
└messageThanksstring评价感谢文案,富文本
└enableEvaluationMuttimesboolean是否允许多次评价:false-不允许,true-允许
└evaluationRoundsint32展示评价按钮的回合数限制
└evaluationValuesint32会话状态中已评价的得分值
└showEvaluationDirectint32会话状态中是否直接展示评价按钮
└forceEvaluationRoundsint32强制评价回合数限制
└forceEvaluationint32会话状态中是否强制评价
└unevaluatedIconUrlstring未评价图标地址
└evaluatedIconUrlstring已评价图标地址
totalint32分页总数,分页接口返回100
requestIdstring链路请求 ID0a1b2c3d4e5f
resultobject部分历史接口使用 result 字段承载业务数据

错误码

状态码描述
14001AppKey 缺失或不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象,或参数缺失、格式非法
14009频控限制:接口调用超过限流阈值
14500服务内部错误
14501数据查询范围超出限制
14515当前 AppKey 无接口或资源访问权限
postEndpoint
/openapi/robot/evaluation/setting
POST
/openapi/robot/evaluation/setting
curl -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": "未开通机器人服务"
}

这篇文档有帮助吗?