调用GetHotlineAgentDetail根据实例ID和坐席账号获取热线坐席详情-智能联络中心-阿里云-智能联络中心(AICCS)-阿里云帮助中心

根据实例ID、坐席账号名称获取热线坐席当前服务详情。

接口说明

热线坐席详情包含坐姿状态、坐席 ID、心跳签名等信息，具体参见返回参数。

QPS 限制

单用户调用频率：不限流。
API 频率：100 次/秒。

说明

如果多个用户的总调用超过 API 频率也会触发流控。

调试

您可以在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

返回参数

名称	类型	描述	示例值
	object	返回数据。
Message	string	状态码描述。	OK
RequestId	string	请求 ID。	EE338D98-9BD3-4413-B165
HttpStatusCode	integer	HTTP 状态码。	200
Data	object	坐席服务数据。
Assigned	boolean	是否被分配。取值： false：未分配（无通话）。 true：已分配（有通话）。	false
TenantId	integer	坐席所属的租户 ID，与入参中的实例 ID 相对应。	ccc_xp_pre-cn-***
RestType	integer	小休类型。取值： 1：小休。 2：就餐。 3：会议。 4：辅导。 5：培训。	1
AgentStatus	integer	坐席状态。取值范围：1~6。	1
AgentStatusCode	string	坐席状态编码。取值： AgentCheckout：坐席下班。 AgentReady：坐席空闲。 AgentBreak：坐席小休。 AgentAcw：话后处理。 AgentBusyForCall：通话中。	AgentCheckout
Token	string	心跳签名。	dnthF_oinHg7JMJDmKqex3Ux****
AgentId	integer	坐席 ID。	2235****
Code	string	状态码。	Success
Success	boolean	调用接口是否成功。取值： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "Message": "OK",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "HttpStatusCode": 200,
  "Data": {
    "Assigned": false,
    "TenantId": 0,
    "RestType": 1,
    "AgentStatus": 1,
    "AgentStatusCode": "AgentCheckout",
    "Token": "dnthF_oinHg7JMJDmKqex3Ux****",
    "AgentId": 0
  },
  "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.	系统错误，请联系管理员！

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

变更历史

更多信息，参考变更详情。