調用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 |
返回參數
示例
正常返回示例
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 返回結構發生變更 | 查看變更詳情 |