domainConsult

接入准备工作

开户

操作
说明
常见问题

联合产品团队,按规范在生产环境、测试环境分别完成开户流程落地,同步配置符合业务要求的逻辑规则

完成企业配置和用户授权后,才能登录运营平台; 若 flow 未配置,会导致对话请求报错

环境确定

环境
说明
常见问题

生产:api.xxx.com

生产环境使用生产环境的vendorId,appId,ak,sk 测试环境要使用测试环境的数据,不能混用,会导致鉴权问题

连接正式环境使用测试环境的ak、sk等导致连接失败

获取令牌

操作
说明
常见问题

设备注册和websocket连接都需要getToken

1、签名计算请严格参考示例,要保证计算签名的数据和发送的数据要一致 2、accessTimestamp时区必须是GMT+8 3、accessTimestamp必须在当前时间前15分钟内 4、accessTimestamp必须是13位毫秒级时间戳

1、计算签名使用的数据和发送的数据不一致,导致签名验证失败 2、时间戳时区设置错误 3、时间戳超过15分钟 4、时间戳仅为10位,会导致签名验证失败

刷新令牌的有效期是7天,有效期内可以刷新token,失效后需要重新获取

如果获取token时使用的参数是vendorId,那么刷新令牌也需要使用vendorId,刷新令牌需要和获取token时保持一致

获取令牌错误码

状态码
错误类型
描述
触发条件

1001

参数非法

参数非法

1、必需参数为空 2、vendorId和botId同时为空

1002

版本号错误

版本号错误

accessVersion不等于"V2"

1003

时间戳错误

时间戳格式错误或时间戳错误

1、时间戳格式不正确 2、时间戳超出允许范围【15分钟内】

1004

身份验证错误

企业不存在或设备不存在

1、vendorId对应的企业不存在 2、botId对应的设备不存在

1005

签名错误

签名不合法

客户端签名与服务端生成签名不匹配

1006

系统异常

系统异常

生成签名时出现加密算法异常

设备注册

操作
说明
常见问题

通过设备注册获取botId

1、获取token(文档) 2、设备注册(文档) 3、deviceId请使用产品序列号SN 4、deviceId相同会返回已存在botId

1、设备注册的唯一判定依据为厂商标识(vendorId)、SN 编码(deviceId)、设备型号(deviceModel)的组合参数;系统将同时匹配这三个参数,若完全命中已注册设备记录,则返回该设备首次注册对应的 botId 2、传入vendorId和ak和签名sk不对应会导致鉴权失败

文本对话参考

Last updated