获取Proxy_url地址接口说明
1 接口简介
第三方系统通过此接口可以获取账户内坐席所在PBX的地址,可通过该接口实现动态传参,是软电话条对接的一个必要参数。
2 接口请求
-
HTTP请求方式:POST
-
请求url:{HOST}/v20210827/user/fetchProxyUrl/{ACCOUNTID}?sig=SIG
-
请求时请将{HOST}换成对接数据查询中获取到的请求域名,{ACCOUNTID}替换为账户编号,{SIG}是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则
-
鉴权方式:接口鉴权
-
请求频次:100次/分钟
3 接口参数
| 字段 | 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|---|
| exten | 座席工号 | string | 是 | 默认传管理员坐席工号,例如:8000 |
请求示例
{
"exten": "8000"
}
4 系统返回
字段说明:
| 参数 | 类型 | 说明 |
|---|---|---|
| code | number | 响应码 |
| success | boolean | 成功与否的标识 |
| message | string | 提示信息 |
| data | object | 返回数据 |
| data.pbx | string | 座席所在PBX |
| data.proxyUrl | string | PBX地址,账户内所有坐席都是该地址 |
返回示例:
{
"success": true,
"data": {
"pbx": "wh.test.13.0",
"proxyUrl": "http://10.1.114.13:38080"
},
"code": 200
}
响应码code说明:
| 代码 | 含义 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 403 | 鉴权参数错误或接口访问频次达到上限 |
| 500 | 服务器错误 |