根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户请求唯一 ID。用于幂等校验,可以用 UUID 生成。 | 46c1341e-2648-447a-9b11-70b6a298d94d |
InstanceId | string | 是 | AICCS 实例 ID。 您可以在智能联络中心控制台左侧导航栏的实例管理中获取。 | ccc_xp_pre-cn-*** |
AccountName | string | 是 | 坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 | username@example.com |
Token | string | 是 | 心跳签名。 可调用 StartHotlineService 接口获取 Token。 | 0079e7a845e373**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Message": "xxxx",
"RequestId": "EE338D98-9BD3-4413-B165",
"Code": "Success",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | NoAgentFound | The specified agent does not exist. | 没有找到指定坐席 |
500 | NoTenantFound | The specified tenant does not exist. | 没有发现租户实例 |
500 | SystemError | A system error occurred. Please contact the administrator. | 系统错误,请联系管理员! |
访问错误中心查看更多错误码。