axyb 类型

概述

主要页面提供 AXYB 类型相关业务接口。

所有接口均使用 POST 方式进行交互，通讯格式为 application/json，服务器返回格式均为 JSON。

一、AXYB 绑定

接口

POST https://axb.icsoc.net/api/axyb/v2/binding

参数

参数名称	类型	说明	是否必须	备注
a	string	A 号码	是
x	string	X 号码	否	如果不传入此参数，将从 AXYB-X 号码池中随机一个可用号码
y	string	Y 号码	否	如果不传入此参数，将从 AXYB-Y 号码池中随机一个可用号码
b	string	B 号码	是
area_code	string	x 号码区号	否	如果有此参数，则将从该地区随机 X 号码
expiration	int	过期时间，单位秒。默认0 即永不过期	否
call_recording	bool	是否录音。默认0 不录音	否
area_code_y	string	y 号码区号	否	如果有此参数，则将从该地区随机 Y 号码
xyb	object	xyb 支持	否
xyb.expiration	int	xyb 过期时间。默认0 即永不过期	否

结果

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是
data	object		是
data.binding_id_ax	string	AX 绑定 id	否
data.x	string	x号码	否
data.binding_id_xyb	string	XYB 绑定 id	否
data.y	string	y 号码	否

二、AXYB 解绑

接口

POST https://axb.icsoc.net/api/axyb/v2/unbinding

参数

参数名称	说明	是否必须
binding_id_ax	AX绑定 ID	特殊可选，任选其一
binding_id_xyb	XYB 绑定ID	特殊可选，任选其一

结果

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是

三、AXYB 更新

接口

POST https://axb.icsoc.net/api/axyb/v2/update

参数

参数名称	说明	是否必须
binding_id	绑定 ID	是
a	A 号码	否
expiration	过期时间。默认0 即永不过期	否
call_recording	是否录音。默认0 不录音	否

结果

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是

四、AXYB 查询

接口

POST https://axb.icsoc.net/api/axyb/v2/detail

参数

参数名称	说明	是否必须
bingding_id	绑定 ID	特殊可选。此参数和 x 选其一
x	x 号码	特殊可选。此参数和 binding_id 选其一

结果

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是
data.ax.binding_id	string	绑定 ID	是
data.ax.a	string	主叫号码	是
data.ax.x	string	中间号码	是
data.ax.area_code	string	区号	是
data.ax.binding_time	string	绑定时间	是
data.ax.extra.expiration	string	过期时间	是
data.ax.extra.call_recording	string	录音控制	否

举例

{
    "code": 0,
    "message": "success",
    "request_id": "38d0434b6730e79b7038689f0bd1c3b0",
    "data": {
        "ax": {
            "binding_id": "DX020X202009110032042289157-7-0-CSAC-GX",
            "a": "18566722456",
            "binding_time": "20200911000904",
            "extra": {
                "callunsub": "1",
                "sms_mt_channel": "1",
                "ringpickup": "1",
                "call_display": "0",
                "callpickup": "1",
                "called_audio_code": "0",
                "call_control": "0",
                "caller_audio_code": "0",
                "call_recording": "0",
                "expiration": "600",
                "call_restrict": "0"
            },
            "area_code": "",
            "x": "18664871508",
            "auto_xyb": "0"
        }
    }
}

五、AXYB 话单结束推送

该接口为 AXYB 话单推送业务接口，需客户提供推送地址。

推送格式为 JSON

推送参数支持加密，签名算法，加密算法，解密算法，详见附录

接口

POST 客户提供的推送地址

推送参数

参数名称	类型	说明	是否必须
mode	string	固定值：axyb-x	是
type	int	固定值：9	是
sign	string	推送签名	是
data	object/string	数据，加密时返回类型为 string	是
data.binding_id	string	绑定 ID	是
data.a	string	主叫号码	是
data.b	string	被叫号码	是
data.x	string	中间号码	是
data.y	string	Y 号码	是
data.call_id	string	呼叫 ID	是
data.call_type	string	呼叫类型；1: 语音主叫 2: 语音被叫 3: 短信发送 4: 短信接收	是
data.call_time	string	呼叫时间	是
data.call_recording	string	录音控制	是

返回响应

参数名称	类型	说明	是否必须
code	int	0 视为推送成功	是

返回的 json 中必须包含 code 字段，且值必须为 0 ，否则系统将视为推送失败，失败后，将以 15/15/30/180/1800/1800/1800/1800/3600（单位：秒）的频率重试通知客户端，如果所有的重试完成后仍然失败，则自动放弃通知。

概述​

一、AXYB 绑定​

接口​

参数​

结果​

二、AXYB 解绑​

接口​

参数​

结果​

三、AXYB 更新​

接口​

参数​

结果​

四、AXYB 查询​

接口​

参数​

结果​

举例​

五、AXYB 话单结束推送​

接口​

推送参数​

返回响应​

概述