通过实例ID和坐席账号名称调用GetAgent查询坐席信息-智能联络中心-阿里云-智能联络中心(AICCS)-阿里云帮助中心

根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息，如坐席ID等。

接口说明

调用此接口前，请您确认 AICCS 的实例信息及坐席账号名称，请参考请求参数描述中的指引获取。
已删除的坐席也支持查询，请您查看返回参数中的 Status 参数值，若取值为 2，则表示该坐席已删除。

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	result
RequestId	string	请求 ID。	EE338D98-9BD3-4413-B165
HttpStatusCode	integer	HTTP 状态码。	200
Data	object	坐席数据。
Status	integer	坐席状态。取值： 0：正常 1：冻结 2：删除说明只有正常的状态，才可进行业务活动。	0
TenantId	integer	坐席所属的租户 ID，与请求参数中的实例 ID 相对应。	0
GroupList	array<object>	坐席所属技能组信息。
	object	技能组信息。
Description	string	技能组描述	自动化技能组
DisplayName	string	技能组对外显示名称。	自动化技能组
SkillGroupId	integer	技能组 ID。	123456
ChannelType	integer	技能组渠道类型	1
Name	string	技能组名称。	自动化技能组
DisplayName	string	坐席对外显示名称。	XX测试
AgentId	integer	坐席 ID。	222222
AccountName	string	坐席账号名称，即账号注册时填写的手机或邮箱。实例内唯一。	username@example.com
Code	string	状态码。返回 Success 表示请求成功。	Success
Success	boolean	调用接口是否成功。取值： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "EE338D98-9BD3-4413-B165",
  "HttpStatusCode": 200,
  "Data": {
    "Status": 0,
    "TenantId": 0,
    "GroupList": [
      {
        "Description": "自动化技能组",
        "DisplayName": "自动化技能组",
        "SkillGroupId": 123456,
        "ChannelType": 1,
        "Name": "自动化技能组"
      }
    ],
    "DisplayName": "XX测试",
    "AgentId": 222222,
    "AccountName": "username@example.com"
  },
  "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.	系统错误，请联系管理员！

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

变更历史

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