首页 云呼叫中心 API参考 API目录 坐席 ListUsers - 获取坐席列表

ListUsers - 获取坐席列表

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

ccc-test
SearchPatternstring

根据坐席登录名或坐席展示名进行模糊匹配,非必填,默认为空,为空表示不过滤。

agent
PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10
TotalCountinteger

总数。

1
Listarray

坐席列表。

object

坐席信息。

DisplayNamestring

坐席展示名。

坐席小王
LoginNamestring

坐席登录名。

agent
Emailstring

邮箱。

username@example.com
WorkModestring

工作模式。

ON_SITE
枚举值:
- ON_SITE: 场内模式
- OFF_SITE: 场外模式
- OFFICE_PHONE: 办公电话模式
Mobilestring

坐席的个人电话号码。

1382114****
UserIdstring

坐席ID。

agent@ccc-test
DisplayIdstring

坐席的工号。

1001
RoleNamestring

角色名称。

Admin
枚举值:
- Mannager: 技能组组长
- Agent: 坐席
- Admin: 管理员
RoleIdstring

角色ID,格式为:角色@实例ID。

Admin@ccc-test
PrimaryAccountboolean

坐席映射的RAM账户是否为RAM主账号。

false
PersonalOutboundNumberListarray

坐席个人外呼号码列表。

object

号码信息。

Numberstring

号码。

0830011****
Activeboolean

是否可用。

true
Citystring

号码归属地市。

乐山
Usagestring

号码用途。

Bidirection
枚举值:
- Outbound: 呼出
- Inbound: 呼入
- Bidirection: 呼入及呼出
Provincestring

号码归属地省。

四川
SkillLevelListarray

坐席关联的技能组等级列表。

object

技能组等级信息。

SkillLevelinteger

技能等级。

5
SkillGroupIdstring

技能组ID。

skillgroup@ccc-test
SkillGroupNamestring

技能组名称。

skillgroup
RamIdLong

坐席关联的RAM账号的UID。

21234502254620****
Extensionstring

座机分机号。

8031****
DeviceIdstring

设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
DeviceExtstring

SIP话机分机号,如果座席注册了SIP话机,则此参数为SIP话机设备的分机号。

8033****
DeviceStatestring

SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如过SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。

OFFLINE
枚举值:
- UNREGISTERED: 未注册
- OFFLINE: 离线
- ONLINE: 在线

示例

正常返回示例

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"
      }
    ]
  }
}

错误码

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

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

阿里云首页 云呼叫中心 相关技术圈