根据实例ID、坐席账号名称进行热线坐席签入,开始热线服务。
接口说明
此接口返回的 Data 参数为发起心跳所需的 Token。
若坐席小休,需暂停热线服务,可调用 SuspendHotlineService 接口。
QPS 限制
单用户调用频率:不限流。
API 频率:100 次/秒。
如果多个用户的总调用超过 API 频率也会触发流控。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ClientToken |
string |
否 |
客户请求唯一 ID。用于幂等校验,可以用 UUID 生成。 |
46c1341e-2648-447a-9b11-70b6a298d94d |
| InstanceId |
string |
是 |
AICCS 实例 ID。 您可以在智能联络中心控制台左侧导航栏的实例管理中获取。 |
ccc_xp_pre-cn-*** |
| AccountName |
string |
是 |
坐席账号名称,即账号注册时填写的手机或邮箱。实例内唯一。 |
username@example.com |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
状态码。返回 Success 表示请求成功。 |
Success |
| Data |
string |
请求调用成功后返回,发起心跳所需的 Token。 |
0079e7a845e373**** |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
状态码描述。 |
OK |
| RequestId |
string |
请求 ID。 |
EE338D98-9BD3-4413-B165 |
| Success |
boolean |
接口调用是否成功。
|
true |
示例
正常返回示例
JSON格式
{
"Code": "Success",
"Data": "0079e7a845e373****",
"HttpStatusCode": 200,
"Message": "OK",
"RequestId": "EE338D98-9BD3-4413-B165",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | NoAgentFound | The specified agent does not exist. | 没有找到指定坐席 |
| 500 | SystemError | A system error occurred. Please contact the administrator. | 系统错误,请联系管理员! |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。