查询号码段资源列表
请求方法
GET
请求地址
/number-resources
请求参数
请求参数 |
参数类型 |
数据类型 |
是否必需 |
描述 |
limit |
Query |
Long |
否 |
获取的最大记录数,默认为10,最大100 |
offset |
Query |
Long |
否 |
跳过的记录数,默认为0 |
HTTP状态码
返回值 |
描述 |
200 |
操作成功,详见响应参数 |
400 |
客户端传参异常 |
401 |
鉴权失败 |
500 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
offset |
Long |
偏移量 |
limit |
Long |
返回最大数量 |
total |
Long |
总数据量 |
data |
NumberResource[] |
号码段信息数组 |
NumberResource对象定义
参数 |
数据类型 |
描述 |
id |
String |
号码段 Id |
partyId |
String |
所属企业id |
type |
Integer |
号码段类型 0 : 账号号码段,1:会议号码段 |
startValue |
String |
起始号码段 |
endValue |
String |
结束号码段 |
remark |
String |
备注 |
请求消息示例
GET /open/api/v2/number-resources?limit=3&offset=0 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"offset": 0,
"limit": 3,
"total": 2,
"data": [
{
"id": "b1a47a02a2e8462e8eaf280e48014f3f",
"partyId": "de6f9cc7d403467282df1720090edc3d",
"type": 0,
"startValue": "0000",
"endValue": "9999",
"remark": null
},
{
"id": "765df3b03ded40a08f53db5db120ba7f",
"partyId": "de6f9cc7d403467282df1720090edc3d",
"type": 1,
"startValue": "10000",
"endValue": "99999",
"remark": null
}
]
}
CURL命令示例
curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' 'https://api.yealink.com/open/api/v2/number-resources?limit=3&offset=0'