外呼号码组
服务描述
本接口,可用于获取商家可用的外呼号码组。
开发须知
调用本接口前,请先获取appId
服务地址
GET/POST https://{您的专属域名}/outbound/openapi/v1/speech
请求参数
| 参数 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| appId | header | String | Y | 应用ID |
| timestamp | header | String | Y | 时间戳,毫秒 |
| sign | header | String | Y | 签名 |
| encrypted | header | String | N | 是否需要加密,需要加密传值(加密方式):AES/REQBODY/RESP,不需要加密不用传该字段 |
| Content-Type | header | String | Y | application/json |
post请求
无入参需要加密
POST https://{您的专属域名}/outbound/openapi/v1/speech
数据示例:
GET https://{您的专属域名}/outbound/openapi/v1/speech
返回结果加密
加密方式
header中的encrypted传值,表示需要对返回结果进行加密,拿到加密后的返回结果, 使用私钥加解密工具进行解密
返回结果
- 需要加密,以下是返回结果加密前的json
- 不需要加密则直接直接返回不加密的结果
| 参数 | 类型 | 说明 |
|---|---|---|
| code | String | 结果码 |
| message | String | 结果描述 |
| data | JSONArray | 外呼号码组 |
JSONObject
| 参数 | 类型 | 说明 |
|---|---|---|
| label | String | 线路名称 |
| value | String | 线路id |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": [
{
"label": "重庆电信zn_hf",
"value": "11"
},
{
"label": "CQ03",
"value": "203"
},
{
"label": "test2",
"value": "249"
}
]
}
结果码说明
| 结果码 | 说明 |
|---|---|
| 10000 | 请求成功 |
| 20001 | 请求失败 |
| 21002 | 认证失败,请重新登录 |
FAQ:
*