1 简介
本文档适用于双向回呼接口调用， 主要包含了发起呼叫 、结束呼叫 、 呼叫状态通知 、以及获取录音的API。
本接口所用的APPID APPSECRET可自行创建。
文档中所有未标明请求方式的接口皆为 POST 方式调用， 请求体 JSON 格式
接口访问需要添加IP白名单，请联系业务员
呼叫状态回调地址， 请自己在平台设置， 配置错误情况下不会重新发送
2 公共请求头 Authorization
Authorization 为“APPID:timestamp:sign ”字符串的Base64编码值，其中冒号为半角。
请求头示例如下：
POST /api/qmc-call/openapi/api/v1/call HTTP/1.1 Content-Type: application/json;charset=utf-8
Authorization : MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi
Authorization的生成构成
| 参数名称 | 必选 | 类型 | 描述 |
|---|
| appId | 是 | Long | 调用接口的APPID |
| timestamp | 是 | Long | 当前时间戳，毫秒数。不能和当前时间偏差5分钟 |
| sign | 是 | String | 签名方式: 拼接字符 APPID:APPSECRET:tim estamp 的MD5值 |
示例代码
sign = DigestUtil.md5Hex(APPID+":"+APPSECRET+":"+timestamp)
3 接口说明
3.0 接口域名(BaseUrl)
http://open.v2.quanmayun.com:8089/
3.1.1 同步主显号码
请求地址 http://open.v2.quanmayun.com:8089/
{BaseURL}/openapi/v1/caller 请求方式: POST
参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|
| phone | 是 | String | 主显号码 |
| merchantName | 是 | String | 商户名称 ，用于区分代理商下的商户 |
返回参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|
| code | 是 | Integer | 200正常 ，其他异常 |
| msg | 是 | String | 错误信息 |
3.2.2 查询主显号码状态
请求地址
{BaseURL}/openapi/v1/caller 请求方式: GET
参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|
| phone | 是 | String | 主显号码 |
返回参数
| 参数名称 | 必选 | 类型 | 描述 |
|---|
| code | 是 | Intege | 200正常 ，其他异常 |
| msg | 是 | String | 错误信息 |
| data | 否 | CallerStatus | 成功必带 ，CallerStatus详细参数要求如下所示。 |
| 参数名称 | 类型 | 长度 | 是否必选 | 说明 |
|---|
| status | String |
| 是 | 主显状态
InWhiteList： 已加白
NotInWhiteList：未加白 Disabled：已禁用 |
| description | String |
| 是 | 主显状态描述 |
请求消息示例如下：
GET /openapi/v1/caller?phone= 13987654321 HTTP/ 1.1 Content-Type: application/json;charset=utf-8
Authorization : MTY5NjA1NDMwOTk2OTEwNDg5ODoxNjkzMjcwMjI2NjQyOmFhNzI2MzlhODY4NDljM2MyZTJiZjljMmVjYzExOTdi
响应消息示例如下：
HTTP/ 1.1 200 OK
Content-Type: application/json;charset=utf-8 Connection: close
{
"code": 200,
"success": true, "data": {
"status": "InWhiteList", "description": " 已加白"
},
"msg": "操作成功" }