AXB业务主要处理的请求和响应类型如下：
l 绑定
l 解绑
1.1.1.1 code返回码定义
第三方业务系统应该检查响应消息中的“返回码”。如果结果不是成功，则第三方业务系统需要针对不同返回码进行处理。
平台返回码
返回码 | 描述 | 定义 |
0 | 成功 | 请求报文成功被处理 |
400 | 格式异常 | 请求报文格式不正确 |
401 | 认证未通过 | 请求的来源或者请求的签名未通过校验。 |
402 | 号码已有相关绑定关系 | 请求中要求绑定的小号已经被分配给其他用户。 |
402 | 号码池资源不足 | 无可用小号分配 |
402 | 未找到对应号码 | 请求绑定小号在号码池中未找到 |
403 | 绑定关系不存在 | 第三方业务系统提交的请求中提供的“绑定关系标识”，在小号业务系统中不存在。 |
404 | 绑定数据不一致 | 请求中提供的“绑定关系标识”在小号业务系统中查询获得的“真实号码”和“小号”绑定关系，与请求中提供的“真实号码”与“小号”不一致。 |
429 | 请求过多 | 第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时，可能会出现该错误。 |
501 | 业务处理超时 | 小号业务系统内部处理引起的超时。第三方业务系统可以尝试重新提交请求。 |
502 | 服务暂时不可用 | 小号业务系统当前不可用，可能是因为系统负载过重，或者暂时停机。 |
503 | 服务接口被禁止 | 小号业务系统已经关闭相关服务。后续对于该服务的请求是被禁止的。 |
其他 | 待定义 |
|
接口
POST {url}/api/v1/axb/{mode}
mode取值:
bind:APP自带x号码
assign:平台分配x号码
请求头
access-key:asdlasdlajskdJOJHHPOMLK
ts: 20180309142730001
sign:BA9854BED1A2986B061E2713F403C752
company-id: 7XXXXX
Accept:application/json;charset=utf-8
Content-Type:application/json;charset=utf-8
请求体
{
"request_id": "f3xgsxa23fdg",
"tal_a": "1761083XXXX",
"tal_b": "1880100XXXX",
"tal_x":"1319445XXXX",
"sub_ts": "20180604111430",
"anu_code": "1,2,3",
"duration": "60",
"is_record": "0",
"call_display": "0,0",
"call_controller": "1"
}
参数 | 类型 | 意义 | 是否必传 | 备注 |
request_id | string | 业务id | M | 消息请求标识,每次请求,请保持唯一性。 最大不超过16位 |
tel_a | string | 真实号码 | M |
|
tel_x | string | 小号号码 | O | X号码；平台分配号码模式下，该参数可不带，系统忽略该参数 APP自带x号码模式下，该参数必传 |
tel_b | string | 对端号码 | M |
|
sub_ts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。 |
anu_code |
| 放音编码 | M | AXB业务时必须设置。 放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。 场景编号取值B->X放音编号0-255A->X放音编号0-255其它号码->X放音编号0-255 |
area_code | string | 主城市区号 | O | 例如：北京（010）；在平台分配X号码模式中，该参数必传,平台从号码池中分配该地区的X号码，避免产生呼叫长途费。 |
duration | string | 过期时间 | M | 单位：秒， 自绑定时间开始后duration秒自动解绑；0表示不限制时间，不会自动解绑,需客户自己解绑 注意： 1）必须携带； 2）必须为数字； |
is_record | string | 录音控制 | O | 可选。 仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：接通后录音 2：被叫响铃后录音 |
call_display | string | 来显控制 | O | 可选。 针对AXB中的A或者B作为主叫时，是否在被叫上显示来话的真实号码。默认为0（不显示真实号码）。 0：不显示真实号码 1：显示真实号码 来显控制按照“A->B时B上的显示,B(N)->A时在A上的显示”的顺序填写编码，编码之间以逗号分隔。“其他号码”的来显控制，同B(N)设置。 场景A -> BB(N)-> Acall_display(1)A 显示为XB(N)显示为X“0,0”(2)A 显示为XB(N)显示为B(N)“0,1”(3)A 显示为AB(N)显示为X“1,0”(4)A 显示为AB(N)显示为B(N)“1,1” |
call_controller | string | 呼叫控制 | O | 可选。 仅下列值有效。默认是1。 0 AXB不做呼叫控制，A和B（N）均有权限，即为现有的AXN模式 1 AXB做呼叫控制，A和B有权限，其他号码无权限，即为现有的AXB 2 AXB的单通控制，A无权限，B有权限，其他号码无权限 3 AXB的单通控制，A有权限，B以及其他号码无权限 4 AXN的单通控制，A无权限，B以及其他号码有权限 5 AXN的单通控制，A有权限，B以及其他号码无权限 6 均无权限 |
smsmtchannel | string | 短信下行控制 | 0 | 可选。 仅下列值有效。默认是1。 1 现有流程 2 推送下发 1 现有流程下发并推送短信内容 2 拦截不发送 |
响应体
{
"code": 0,
"message": "SUCCESS",
"data": {
"tal_x": "1319445XXXX",
"sub_id": "A2129X591X0373480707-11-0-XZGF-GXI"
}
}
参数 | 类型 | 意义 | 是否必传 | 备注 |
sub_id | string | 绑定id | M |
|
tal_x | string | 小号 | M |
|
请求响应实例bind：
请求地址：
POST {url}/api/v1/axb/bind
请求头：
Accept: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
access-key:asdlasdlajskdJOJHHPOMLK
ts:20180605171030125
company-id:7000XX
sign:FB68ECE1E65A21B02108C766C5F127C1
请求体:
{
"request_id": "f3xgsxa23fdg",
"tal_a": "1761083XXXX",
"tal_b": "1880100XXXX",
"tal_x":"1319445XXXX",
"sub_ts": "20180604111430",
"anu_code": "1,2,3",
"duration": "60",
"is_record": "0",
"call_display": "0,0",
"call_controller": "1"
}
响应体：
{
"code":0,
"message":"SUCCESS",
"data":{
"tal_x":"1319445XXXX",
"sub_id":"A2129X591X0373480707-11-0-XZGF-GXI"
}
}
请求响应实例assign：
请求地址：
POST {url}/api/v1/axb/assign
请求头：
Accept: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
access-key:asdlasdlajskdJOJHHPOMLK
ts:20180605171030125
company-id:7000XX
sign:FB68ECE1E65A21B02108C766C5F127C1
请求体:
{
"request_id": "f23sasca23fdg",
"tal_a": "1761083XXXX",
"tal_b": "1880100XXXX",
"sub_ts": "20180604111430",
"anu_code": "1,2,3",
"duration": "60",
"area_code": "591",
"is_record": "0",
"call_display": "0,0",
"call_controller": "1"
}
响应体：
{
"code":0,
"message":"SUCCESS",
"data":{
"tal_x":"1319445XXXX",
"sub_id":"A2129X591X0373480707-11-0-XZGF-GXI"
}
}