调用ListUsers获取坐席列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用ListUsers获取指定实例下的坐席列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
SearchPattern	string	否	根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。	agent
PageNumber	integer	是	分页序号，范围 1-100。	1
PageSize	integer	是	分页大小，范围 1-100。	10
SkillGroupId	string	否	技能组 ID。	ankedayaopin@zcwlwhkf

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	数据。
PageNumber	integer	分页序号，范围 1-100。	1
PageSize	integer	分页大小，范围 1-100。	10
TotalCount	integer	总数。	1
List	array<object>	坐席列表。
UserDetail	object	坐席信息。
DisplayName	string	坐席展示名。	坐席小王
LoginName	string	坐席登录名。	agent
Email	string	邮箱。	username@example.com
WorkMode	string	工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	ON_SITE
Mobile	string	坐席的个人电话号码。	1382114****
UserId	string	坐席 ID。	agent@ccc-test
DisplayId	string	坐席的工号。	1001
RoleName	string	角色名称。枚举值： Mannager：技能组组长。 Agent：坐席。 Admin：管理员。	Admin
RoleId	string	角色 ID，格式为：角色@实例 ID。	Admin@ccc-test
PrimaryAccount	boolean	坐席映射的 RAM 账户是否为 RAM 主账号。	已弃用，请使用Primary代替此参数。
PersonalOutboundNumberList	array<object>	坐席个人外呼号码列表。
PhoneNumber	object	号码信息。
Number	string	号码。	0830011****
Active	boolean	是否可用。	true
City	string	号码归属地市。	乐山
Usage	string	号码用途。枚举值： Outbound：呼出。 Inbound：呼入。 Bidirection：呼入及呼出。	Bidirection
Province	string	号码归属地省。	四川
SkillLevelList	array<object>	坐席关联的技能组等级列表。
UserSkillLevel	object	技能组等级信息。
SkillLevel	integer	技能等级。	5
SkillGroupId	string	技能组 ID。	skillgroup@ccc-test
SkillGroupName	string	技能组名称。	skillgroup
RamId	long	坐席关联的 RAM 账号的 UID。	21234502254620****
Extension	string	座机分机号。	8031****
DeviceId	string	设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。	ACC-YUNBS-1.0.10-****
DeviceExt	string	SIP 话机分机号，如果座席注册了 SIP 话机，则此参数为 SIP 话机设备的分机号。	8033****
DeviceState	string	SIP 话机设备的状态，如果未注册 SIP 话机，则状态为 UNREGISTERED（未注册），如过 SIP 话机注册过但是不在线，则状态为 OFFLINE（离线），如果 SIP 话机注册过并且在线则为 ONLINE（在线）。	OFFLINE
Primary	boolean	坐席映射的 RAM 账户是否为 RAM 主账号。
Params	array	响应参数。
Param	string	响应参数。	无

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "DisplayName": "坐席小王",
        "LoginName": "agent",
        "Email": "username@example.com",
        "WorkMode": "ON_SITE",
        "Mobile": "1382114****",
        "UserId": "agent@ccc-test",
        "DisplayId": "1001",
        "RoleName": "Admin",
        "RoleId": "Admin@ccc-test",
        "PrimaryAccount": true,
        "PersonalOutboundNumberList": [
          {
            "Number": "0830011****",
            "Active": true,
            "City": "乐山",
            "Usage": "Bidirection",
            "Province": "四川"
          }
        ],
        "SkillLevelList": [
          {
            "SkillLevel": 5,
            "SkillGroupId": "skillgroup@ccc-test",
            "SkillGroupName": "skillgroup"
          }
        ],
        "RamId": 0,
        "Extension": "8031****",
        "DeviceId": "ACC-YUNBS-1.0.10-****",
        "DeviceExt": "8033****",
        "DeviceState": "OFFLINE",
        "Primary": true
      }
    ]
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.	参数必须小于或等于系统规定的最大值。
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.	参数必须大于或等于系统规定的最小值。
400	Parameter.Null	The parameter %s may not be null.	该参数不能为null值.
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-11-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情