调用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 |
返回参数
示例
正常返回示例
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": false,
"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 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. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。
