ax 类型
概述
主要页面提供 AX 类型相关业务接口。
所有接口均使用 POST 方式进行交互，通讯格式为 application/json，服务器返回格式均为 JSON。
一、AX 绑定
接口
POST https://axb.icsoc.net/api/ax/v2/binding
参数
| 参数名称 | 类型 | 说明 | 是否必须 | 备注 |
|---|---|---|---|---|
| a | string | A 号码 | 是 | |
| x | string | X 号码 | 否 | 若不传此项，将随机一个号码 |
| name | string | 姓名 | 是 | |
| identity | string | 身份证号码 | 是 | |
| area_code | string | x 号码区号 | 否 | |
| expiration | int | 过期时间，单位秒。默认0 即永不过期 | 否 | |
| call_recording | bool | 是否录音。默认0 不录音 | 否 | |
| ayb | object | axyb 支持 | 否 | |
| ayb.expiration | int | ayb 过期时间 | 是 | |
| ayb.area_code | string | y 号码地区，默认 x 号码地区 | 否 |
结果
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0为成功，其他均为不成功，请参考 message | 是 |
| message | string | 是 | |
| data | object | 是 | |
| data.binding_id | string | 绑定 id | 否 |
| data.x | string | x号码 | 否 |
二、AX 解绑
接口
POST https://axb.icsoc.net/api/ax/v2/unbinding
参数
| 参数名称 | 说明 | 是否必须 |
|---|---|---|
| binding_id | 绑定 ID | 是 |
结果
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0为成功，其他均为不成功，请参考 message | 是 |
| message | string | 是 |
三、AX 更新
接口
POST https://axb.icsoc.net/api/ax/v2/update
参数
| 参数名称 | 说明 | 是否必须 |
|---|---|---|
| binding_id | 绑定 ID | 是 |
| a | A 号码 | 是 |
| name | 姓名 | 是 |
| identity | 身份证号码 | 是 |
| expiration | 过期时间。默认0 即永不过期 | 否 |
| call_recording | 是否录音。默认0 不录音 | 否 |
结果
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0为成功，其他均为不成功，请参考 message | 是 |
| message | string | 是 | |
| data | object | 否 | |
| data.binding_id | string | 绑定 id | 否 |
| data.x | string | x号码 | 否 |
四、AX 查询
接口
POST https://axb.icsoc.net/api/ax/v2/detail
参数
| 参数名称 | 说明 | 是否必须 |
|---|---|---|
| binding_id | 绑定 ID | 特殊可选。此参数和 x 选其一 |
| x | x 号码 | 特殊可选。此参数和 binding_id 选其一 |
结果
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0为成功，其他均为不成功，请参考 message | 是 |
| message | string | 是 | |
| data.binding_id | string | 绑定 ID | 是 |
| data.a | string | 主叫号码 | 是 |
| data.x | string | 中间号码 | 是 |
| data.area_code | string | 区号 | 是 |
| data.binding_time | string | 绑定时间 | 是 |
| data.expiration | string | 过期时间 | 是 |
| data.call_recording | string | 录音控制 | 否 |
| data.call_restrict | string | 呼叫控制 | 否 |
| data.call_display | string | 来显控制 | 否 |
| data.name | string | 姓名 | 是 |
| data.identity | string | 身份证号码 | 是 |
五、AX 话单结束推送
该接口为 AX 话单推送业务接口，需客户提供推送地址。
推送格式为 JSON
推送参数支持加密，签名算法，加密算法，解密算法，详见 附录
接口
POST 客户提供的推送地址
推送参数
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| mode | string | 固定值：ax | 是 |
| type | int | 固定值：3 | 是 |
| sign | string | 推送签名 | 是 |
| data | object/string | 数据，加密时返回类型为 string | 是 |
| data.binding_id | string | 绑定 ID | 是 |
| data.a | string | 主叫号码 | 是 |
| data.b | string | 被叫号码 | 是 |
| data.x | string | 中间号码 | 是 |
| data.call_id | string | 呼叫 ID | 是 |
| data.call_type | string | 呼叫类型；1: 语音主叫 2: 语音被叫 3: 短信发送 4: 短信接收 | 是 |
| data.call_time | string | 呼叫时间 | 是 |
| data.ringing_time | string | 响铃时间 | 是 |
| data.start_time | string | 通话开始时间 | 是 |
| data.release_time | string | 通话结束时间 | 是 |
| data.call_recording | string | 录音控制 | 否 |
| data.recording_url | string | 录音地址 | 否 |
| data.sms_content | string | 短信内容，UCS2编码16进制字符串 | 否 |
| data.sms_count | string | 短信条数 | 否 |
| data.call_duration | int | 通话时长，单位：秒 | 是 |
| data.result | int | 通话结果；0：未接通 1：接通 | 是 |
返回响应
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0 视为推送成功 | 是 |
返回的 json 中必须包含 code 字段，且值必须为 0 ，否则系统将视为推送失败，失败后，将以 15/15/30/180/1800/1800/1800/1800/3600（单位：秒）的频率重试通知客户端，如果所有的重试完成后仍然失败，则自动放弃通知。
六、外呼上报
接口
POST https://axb.icsoc.net/api/ax/v2/call
参数
| 参数名称 | 说明 | 是否必须 |
|---|---|---|
| binding_id | ax的绑定 ID | 是 |
| b | B 号码 | 是 |
结果
| 参数名称 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| code | int | 0为成功，其他均为不成功，请参考 message | 是 |
| message | string | 是 |