SendHotlineHeartBeat - 发送热线心跳

根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。

接口说明

QPS 限制

  • 单用户调用频率:不限流。
  • API 频率:100 次/秒。
说明 如果多个用户的总调用超过 API 频率也会触发流控。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ClientTokenstring

客户请求唯一 ID。用于幂等校验,可以用 UUID 生成。

46c1341e-2648-447a-9b11-70b6a298d94d
InstanceIdstring

AICCS 实例 ID。 您可以在智能联络中心控制台左侧导航栏的实例管理中获取。

ccc_xp_pre-cn-***
AccountNamestring

坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。

username@example.com
Tokenstring

心跳签名。

可调用 StartHotlineService 接口获取 Token。

0079e7a845e373****

返回参数

名称类型描述示例值
object

返回数据。

Messagestring

状态码描述。

xxxx
RequestIdstring

请求 ID。

EE338D98-9BD3-4413-B165
Codestring

状态码。返回 Success 表示请求成功。

Success
Successboolean

接口调用是否成功。

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "xxxx",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
500NoAgentFoundThe specified agent does not exist.没有找到指定坐席
500NoTenantFoundThe specified tenant does not exist.没有发现租户实例
500SystemErrorA system error occurred. Please contact the administrator.系统错误,请联系管理员!

访问错误中心查看更多错误码。