code返回码定义
第三方业务系统应该检查响应消息中的“返回码”。如果结果不是成功，则第三方业务系统需要针对不同返回码进行处理。
平台返回码
返回码 | 描述 | 定义 |
0 | 成功 | 请求报文成功被处理 |
400 | 格式异常 | 请求报文格式不正确 |
401 | 认证未通过 | 请求的来源或者请求的签名未通过校验。 |
402 | 号码已有相关绑定关系 | 请求中要求绑定的小号已经被分配给其他用户。 |
402 | 号码池资源不足 | 无可用小号分配 |
402 | 未找到对应号码 | 请求绑定小号在号码池中未找到 |
403 | 绑定关系不存在 | 第三方业务系统提交的请求中提供的“绑定关系标识”，在小号业务系统中不存在。 |
404 | 绑定数据不一致 | 请求中提供的“绑定关系标识”在小号业务系统中查询获得的“真实号码”和“小号”绑定关系，与请求中提供的“真实号码”与“小号”不一致。 |
429 | 请求过多 | 第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时，可能会出现该错误。 |
501 | 业务处理超时 | 小号业务系统内部处理引起的超时。第三方业务系统可以尝试重新提交请求。 |
502 | 服务暂时不可用 | 小号业务系统当前不可用，可能是因为系统负载过重，或者暂时停机。 |
503 | 服务接口被禁止 | 小号业务系统已经关闭相关服务。后续对于该服务的请求是被禁止的。 |
505 | 其他类型错误 | 请联系运营协助查找原因 |
其他 | 待定义 |
|
接口
POST {url}/api/v1/ax/{xmode}
xmode取值:
bind:APP自带x号码
assign:平台分配x号码
请求头
Accept:application/json;charset=utf-8
Content-Type:application/json;charset=utf-8
access-key:QfKP7JuO52Ep6WdR
ts:20210727095330120
company-id:7000XX
sign:BF7C450829D0E283B802C8D72AA05EEF
请求体
{
"request_id": "2dgsf3jd2g92",
"tel_a": "1880100XXXX",
"sub_ts": "20180605092630",
"name": "张三",
"card_type": 0,
"card_no": "35030119891010XXXX",
"duration": 120,
"area_code": "28",
"is_record": 1,
"call_display": 1
}
参数 | 类型 | 意义 | 是否必传 | 备注 |
request_id | string | 业务id | M | 消息请求标识 |
tel_a | string | 真实号码 | M |
|
tel_x | string | 隐私号码 | O | X号码；平台分配号码模式下，该参数可不带，系统忽略该参数 |
sub_ts | string | 当前绑定时间 | M | 格式为 yyyyMMddHHmmss。 时间
采用北京时间， 24 小时制 |
area_code | string | 区号 | M | 例如：北京（010）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费。 |
duration | string | 过期时间 | M | 单位：秒， 自绑定时间开始后duration秒自动解绑；0表示不限制时间，不会自动解绑 |
is_record | string | 录音控制 | O | 可选。M 仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：接通后录音 2：被叫响铃后录音 |
call_display | string | 来显控制 | O | 可选。M 仅下列值有效。默认是0（显示真实号码）。 0：显示真实号码 1：显示X号码 2: 显示Z号码池中的号码 在绑定时可自由选择是否分配Z号码池的开关。 |
name | string | 姓名 | O | 真实姓名 |
card_type | string | 证件类型 | O | 默认传0 |
card_no | string | 证件号码 | O | 真实姓名对应的真实身份证号 |
响应体
{
"code": 0,
"message": "AX绑定成功",
"data": {
"tel_x": "1319445XXXX",
"sub_id": "A2129X591X0373480707-11-0-YYGF-GXI"
}
}
参数 | 类型 | 意义 | 是否必传 | 备注 |
sub_id | string | 绑定id | M |
|
tel_x | string | 小号 | M |
|
请求响应实例bind：
请求地址：
POST {url}/api/v1/ax/bind
请求头：
Accept: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
ts:20180605171030125
company-id:7000XX
access-key:QfKP7JuO52Ep6WdR
sign:FB68ECE1E65A21B02108C766C5F127C1
请求体：
{
"request_id": "2d58lk3jd2g92",
"tel_a": "1880100XXXX",
"tel_x":"18684046451",
"sub_ts": "20180605093830",
"name": "张三",
"card_type": 0,
"card_no": "350301198910109087",
"duration": 120,
"is_record": 1,
"call_display": 1
}
响应体：
{
"code": 0,
"message":"AX绑定成功",
"data":{
"tel_x":"1319445XXXX",
"sub_id":"A2129X591X0373480707-11-0-YYGF-GXI"
}
}
请求响应实例assign：
请求地址：
POST {url}/api/v1/ax/assign
请求头：
Accept: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
ts:20180605171030125
company-id:7000XX
access-key:QfKP7JuO52Ep6WdR
sign:FB68ECE1E65A21B02108C766C5F127C1
请求体:
{
"request_id": "2dgsf3jd2892",
"tel_a": "1880100XXXX",
"sub_ts": "20180605092630",
"name": "张三",
"card_type": 0,
"card_no": "350301198910109087",
"duration": 120,
"area_code": "28",
"is_record": 1,
"call_display": 1
}
响应体：
{
"code":0,
"message":"AX绑定成功",
"data":{
"tel_x":"1319445XXXX",
"sub_id":"A2129X591X0373480707-11-0-YYGF-GXI"
}
}