遍历可呼设备
接口描述
分页查询当前坐席可呼叫的设备列表。
「可呼」判定：设备分机的默认呼叫号码包含本坐席的分机号，或包含本坐席所在呼叫中心的号码。设备的默认呼叫号码由管理员在臻云控制台配置（参见使用指南）。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 93 |
HTTPS |
GET |
/openapi/v1/voip/agent/devices |
PATH参数
无
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
| keyword |
string |
否 |
按 SN / 设备名称模糊匹配 |
| page |
int |
否 |
页码，默认 1 |
| size |
int |
否 |
每页条数，默认 20 |
HTTP请求头
| 名称 |
必填 |
说明 |
| X-Agent-Token |
是 |
坐席登录返回的 token |
请求示例
GET https://open.vzicloud.com/openapi/v1/voip/agent/devices?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D&keyword=R5&page=1&size=20 HTTP/1.1
X-Agent-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.***
返回说明
返回参数
| 参数 |
类型 |
说明 |
| total |
int |
总条数 |
| page |
int |
当前页码 |
| size |
int |
每页条数 |
| items |
array |
设备列表 |
| items[].id |
int |
设备分机 ID |
| items[].sn |
string |
设备 SN |
| items[].dial_id |
string |
设备分机号 |
| items[].display_name |
string |
设备显示名称 |
| items[].online |
bool |
设备是否在线 |
| items[].default_call_number |
string |
默认呼叫号码（未配置时为空串） |
返回示例
{
"total": 2,
"page": 1,
"size": 20,
"items": [
{
"id": 101,
"sn": "12345678901234",
"dial_id": "12345678901234",
"display_name": "门口机-1",
"online": true,
"default_call_number": "1001"
},
{
"id": 102,
"sn": "56789012345678",
"dial_id": "56789012345678",
"display_name": "门口机-2",
"online": false,
"default_call_number": ""
}
]
}