调用GetAgent根据坐席账号名称查询悉犀客服工作台坐席信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetAgent

系统规定参数。取值:GetAgent

ClientToken String 46c1341e-2648-447a-9b11-70b6a298d94d

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

InstanceId String ccc_xp_pre-cn-***

AICCS实例ID。可在智能联络中心控制台>实例管理中获取。

AccountName String 123@123.com

坐席账号名称。实例内唯一(登录名)。

返回数据

名称 类型 示例值 描述
RequestId String EE338D98-9BD3-4413-B165

请求ID。

Data Object

坐席数据。

Status Integer 0

坐席状态。取值:

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

坐席对外显示名称。

AgentId Long 222222

坐席ID。

GroupList Array of GroupList

坐席所属技能组信息。

DisplayName String 自动化技能组

技能组对外显示名称。

Description String 自动化技能组

技能组描述

ChannelType Integer 1

技能组渠道类型

SkillGroupId Long 123456

技能组ID。

Name String 自动化技能组

技能组名称。

AccountName String 123@123.com

坐席账号名称(登录名)。

TenantId Long 0

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

Code String Success

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

Success Boolean true

接口调用是否成功。

HttpStatusCode Long 200

HTTP状态码。

示例

请求示例

http(s)://aiccs.aliyuncs.com/?Action=GetAgent
&ClientToken=46c1341e-2648-447a-9b11-70b6a298d94d
&InstanceId=ccc_xp_pre-cn-***
&AccountName=123@123.com
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAgentResponse>
    <RequestId>EE338D98-9BD3-4413-B165</RequestId>
    <Data>
        <Status>0</Status>
        <DisplayName>刘测试</DisplayName>
        <AgentId>222222</AgentId>
        <GroupList>
            <DisplayName>自动化技能组</DisplayName>
            <Description>自动化技能组</Description>
            <ChannelType>1</ChannelType>
            <SkillGroupId>123456</SkillGroupId>
            <Name>自动化技能组</Name>
        </GroupList>
        <AccountName>123@123.com</AccountName>
        <TenantId>0</TenantId>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
    <HttpStatusCode>200</HttpStatusCode>
</GetAgentResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
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. 系统错误,请联系管理员!

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