1 接口简介
第三方系统通过此接口可以获取账户内的所有外显号,可实现坐席指定外显号外呼等场景。
2 接口请求
-
HTTP请求方式:POST
-
请求url:{HOST}/v20180426/account/getAccountDialoutNumber/{ACCOUNTID}?sig=SIG
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
请求频次:20次/分钟
3 接口参数
字段 | 是否必填 | 类型 | 是否必填 | 描述 |
number | 外显号 | string | 否 | |
status | 号码状态 | string | 否 | 在用/停用/试用/赠送, inUse/outUse/trial/gift |
lineType | 线路类型 | string | 否 | 主要/备用, primary/standby 可能为空 |
请求示例
{
"number": "0",
"status":"inUse",
"lineType":"primary"
}
4 系统返回
字段说明:
参数 | 类型 | 说明 |
---|---|---|
_id | string | id |
number | string | 外显号 |
account | string | 账户编号 |
status | string | 号码状态,在用/停用/试用/赠送, inUse/outUse/trial/gift |
area | string | 归属地 |
lineType | string | 线路类型,主要/备用, primary/standby 可能为空 |
lineStatus | string | 线路状态,正常/故障, normal/fault 可能为空 |
ability | string | 号码能力,例如:外呼 |
createTime | string | 创建时间 |
updateTime | string | 更新时间 |
bindAgent | array | 绑定座席 |
bindAgent._id | string | 座席id |
bindAgent.displayName | string | 座席昵称 |
bindAgent.exten | string | 座席工号 |
返回示例:
{
"success": true,
"data": [
{
"_id": "33de8e90-ae9f-11ed-ab2c-1d116a04762c",
"number": "02166609122",
"account": "N00000002715",
"status": "inUse",
"area": "北京市 北京市",
"lineType": "primary",
"lineStatus": "normal",
"ability": "dialout",
"createTime": "2023-02-17 16:43:51",
"updateTime": "2023-03-30 18:30:13",
"bindAgent": [
{
"_id": "d916bbf0-5a51-11ed-8443-c15b93b7d208",
"displayName": "xxxs",
"exten": "3000"
},
{
"_id": "bb8b2aa0-bbe8-11ed-bbb0-b5f6a27e170f",
"displayName": "测试外呼选号",
"exten": "30003"
}
]
},
{
"_id": "17f13990-1a1e-11ee-a4d1-9bb0b6274ee8",
"number": "01053154538",
"account": "N00000002715",
"status": "inUse",
"area": "北京市 北京市",
"lineType": "primary",
"lineStatus": "normal",
"ability": "dialout",
"bindAgent": [
{
"_id": "bb8b2aa0-bbe8-11ed-bbb0-b5f6a27e170f",
"displayName": "测试外呼选号",
"exten": "30003"
}
],
"createTime": "2023-07-04 11:51:44",
"updateTime": "2023-07-04 11:51:44"
}
]
}