文档

GetAgent - 获取坐席信息

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

接口说明

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

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

返回参数

名称类型描述示例值
object

result

RequestIdstring

请求 ID。

EE338D98-9BD3-4413-B165
Dataobject

坐席数据。

Statusinteger

坐席状态。取值:

  • 0:正常
  • 1:冻结
  • 2:删除
说明 只有正常的状态,才可进行业务活动。
0
DisplayNamestring

坐席对外显示名称。

XX测试
AgentIdlong

坐席 ID。

222222
GroupListobject []

坐席所属技能组信息。

DisplayNamestring

技能组对外显示名称。

自动化技能组
Descriptionstring

技能组描述

自动化技能组
ChannelTypeinteger

技能组渠道类型

1
SkillGroupIdlong

技能组 ID。

123456
Namestring

技能组名称。

自动化技能组
AccountNamestring

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

username@example.com
TenantIdlong

坐席所属的租户 ID,与请求参数中的实例 ID 相对应。

0
Codestring

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

Success
Successboolean

调用接口是否成功。取值:

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

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "EE338D98-9BD3-4413-B165",
  "Data": {
    "Status": 0,
    "DisplayName": "XX测试",
    "AgentId": 222222,
    "GroupList": [
      {
        "DisplayName": "自动化技能组",
        "Description": "自动化技能组",
        "ChannelType": 1,
        "SkillGroupId": 123456,
        "Name": "自动化技能组"
      }
    ],
    "AccountName": "username@example.com",
    "TenantId": 0
  },
  "Code": "Success",
  "Success": true,
  "HttpStatusCode": 200
}

错误码

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

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

  • 本页导读 (1)