消息由接口、请求头、请求体三部分组成,包含在HTTP载荷中。 接口: method+URL 如:POST {url}/v2/axb 请求头:key:value 请求体: json串 对象的取值为数字的,一律以字符串表示 消息都是以UTF-8编码 接口风格 公共请求头 "Accept", "application/json;charset=utf-8", "Content-Type", "application/json;charset=utf-8" 公共响应体 所有的响应Json都应符合下面的格式,其中code是返回码,state是故障码 { "code": 0, "message": "success", "data": { } }
第三方业务系统接入平台时,需在消息头传入appkey参数,用来区分不同的APP接入。 appkey示例如下,由下划线分割的两部分组成,其中下划线以前部分(四位定长字母)由平台分配用来标识不同的接入商,下划线后面部分XXXX(四位定长数字)由第三方业务系统自行定义,用来标识同一个接入商的不同APP。 例:"appkey":"ALPT_0001"
msgdgt是消息交换双方进行数据校验的摘要信息,用来保证数据在网络传输过程中的数据一致性,剔除假冒和非法的请求数据。 系统采用共享秘钥方式,秘钥由业务平台分配。 msgdgt生成规则如下: 1)把消息头(appkey和ts)、消息体按key的字母顺序排序 2)排序后将密钥、消息头(appkey和ts)和消息体的所有key、value串起来以UTF-8编码进行MD5加密,如: MD5(secretkey1value1key2value2..) 3)生成32位大写的摘要字符串,如:BA9854BED1A2986B061E2713F403C752
返回码 | 描述 | 定义 |
---|---|---|
0 | 成功 | 请求报文成功被处理 |
400 | 格式异常 | 请求报文格式不正确 |
401 | 认证未通过 | 请求的来源或者请求的签名未通过校验。 |
402 | 号码已有相关绑定关系 | 请求中要求绑定的小号已经被分配给其他用户。 |
402 | 号码池资源不足 | 无可用小号分配 |
402 | 未找到对应号码 | 请求绑定小号在号码池中未找到 |
403 | 绑定关系不存在 | 第三方业务系统提交的请求中提供的“绑定关系标识”,在小号业务系统中不存在。 |
404 | 绑定数据不一致 | 请求中提供的“绑定关系标识”在小号业务系统中查询获得的“真实号码”和“小号”绑定关系,与请求中提供的“真实号码”与“小号”不一致。 |
429 | 请求过多 | 第三方业务系统在一定时间内提交了过多的请求。第三方业务系统在访问某些特定服务接口时,可能会出现该错误。 |
501 | 小号使用异常 | 小号被下线或者与appkey不匹配时会出现该错误 |
502 | 请求报文有误 | 请求报文有误,检查请求头和请求体、请求方法是否按照文档规范填写 |
503 | 服务接口被禁止 | 小号业务系统已经关闭相关服务。后续对于该服务的请求是被禁止的。 |
其他 | 待定义 |
作用范围为AXB类型的X号码; 接口 PUT {url}/v2/axb/outtransfer 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telX": "13720056198", "transferms": "13720056197", "transfervoicecode": "1", "transfercalldisplay": "0", "transfercallrecording": "0", "calldisplayshow": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telX | string | 隐私号码 | M | X号码 |
transferms | string | 转接号码 | M | 转接号码 |
transfervoicecode | string | 转接号码设置放音编码 | M | 设置转接号码的放音编码 |
transfercalldisplay | string | 来显控制 | M |
转接号码的来显控制,默认0 0:显示X号码 1:显示真实号码 |
transfercallrecording | string | 录音控制 | M |
默认是0(不开通录音功能)。 0:不开通录音功能 1:开通录音功能 |
calldisplayshow | string | 推送被叫来显号码控制 | 0 |
可选。仅下列值有效。默认是0。 0 推送中不携带被叫来显号码 1 推送中携带被叫来显号码 |
callcontrol | string | 被叫接通控制 | 0 |
可选。其他号码呼叫X时,对来显进行鉴权,仅下列值有效。默认是0。 0 不对来话号码鉴权 1 对来话号码鉴权 |
selfvoivecode | string | 放音编码 | 0 | 当绑定的被转接号码拨打X号码时听到此放音 |
remark | string | 客户标签 | 0 |
响应体 { "code": "0", "message": "success" }
接口 DELETE {url}/v2/axb/outtransfer/{telX} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axb/{xmode} xmode取值: mode101:APP自带x号码 mode102:平台分配x号码 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13900000000", "telX": "13720056199", "telB": "13005711234", "subts": "20150920190126", "anucode": "1,2,3", "areacode": "10", "expiration": "7200", "remark": "derc", "extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0","callunsub": "0","callpickup": "0" } }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | 0 | 101模式填该字段,102模式不填 |
telB | string | 对端号码 | M | |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
anucode | 放音编码 | M |
AXB业务时必须设置。
放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码,编码之间以逗号分隔。
比如:“1,2,3”表示 B->X 放音编号为 1,A->X 放音编号为 2,其他号码->X 放音编号为 3。
场景
编号取值
B->X 放音编号
0-255
A->X 放音编号
0-255
其它号码->X 放音编号
0-255
|
|
areacode | string | 区号 | 0 | 例如:北京(10);在平台分配X号码模式中,平台从号码池中分配该地区的X号码,避免产生呼叫长途费。101模式不填该字段,102模式需要填 |
expiration | string | 过期时间 | M | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,不能超过30个字节 |
extra | json | 扩展参数 | 0 | |
-callrecording | string | 录音控制 | 0 |
可选。 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 2:被叫响铃后录音 |
-calldisplay | string | 来显控制 | 0 |
可选。 针对AXB中的A或者B作为主叫时,是否在被叫上显示来话的真实号码。默认为0(不显示真实号码)。
0:不显示真实号码
1:显示真实号码 来显控制按照“A->B时B上的显示,B(N)->A时在A上的显示”的顺序填写编码,编码之间以逗号分隔。“其他号码”的来显控制,同B(N)设置。
场景
A -> B
B(N)-> A
calldisplay
(1)
A 显示为X
B(N)显示为X
“0,0”
(2)
A 显示为X
B(N)显示为B(N)
“0,1”
(3)
A 显示为A
B(N)显示为X
“1,0”
(4)
A 显示为A
B(N)显示为B(N)
“1,1”
|
-callrestrict | string | 呼叫控制 | 0 |
可选。 仅下列值有效。默认是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 均无权限 |
-calldisplayshow | string | 推送被叫来显号码控制 | 0 |
可选。 仅下列值有效。默认是0。 0 推送中不携带被叫来显号码 1 推送中携带被叫来显号码 |
-callunsub | string | 解绑推送消息控制 | 0 |
可选。 仅下列值有效。默认是0。 0 解绑不推送消息 1 解绑推送消息 |
-ringpickup | string | 被叫振铃推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫振铃事件 1 推送被叫振铃事件 |
-callpickup | string | 被叫接通推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫接通事件 1 推送被叫接通事件 |
-callcontrol | string | 被叫接通控制 | 0 |
可选。其他号码呼叫X时,对来显进行鉴权,仅下列值有效。默认是0。 0 不对来话号码鉴权 1 对来话号码鉴权 |
-callduration | string | 通话持续时间 | 0 | 可选,单位秒,如果出现则通话有效时长为此值,如果没有出现按现在默认处理。 |
响应体 { "code": "0", "message": "success", "data": { "subid": "100X571X0000000001", "telX": "13720056199"} }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
subid | string | 绑定id | M | |
telX | string | 小号 | M |
请求响应实例mode101: /v2/axb/mode101 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 182 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: JD_0001 ts: 20161213110012564 msgdgt: 29050BBCCDBE07AB281DEDDEA32C6426 Content-Type: application/json;charset=utf-8 {"telX":"15601000100","expiration":"30000","requestId":"1234420","extra":{"callrecording":"1"},"subts":"20161213110012","telA":"13601000100","anucode":"1,2,3","telB":"15588760015"} HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 03:00:12 GMT Server: BSS/1.1 Content-Length: 90 Connection: close {"code":0,"message":"SUCCESS","data":{"telX":"15601000100","subid":"A100X558X0000400025"}} 请求响应实例mode102: POST /v2/axb/mode102 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 177 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: JD_0001 ts: 20161213105929124 msgdgt: 6908C8682BE4FF3996792A6142C0F16F Content-Type: application/json;charset=utf-8 {"expiration":"30000","requestId":"1223537","extra":{"callrecording":"1"},"areacode":"556","subts":"20161213105929","telA":"1370000125","anucode":"1,2,3","telB":"15688760025"} HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 02:59:29 GMT Server: BSS/1.1 Content-Length: 90 Connection: close {"code":0,"message":"SUCCESS","data":{"telX":"15601000101","subid":"A100X556X0000400024"}}
接口 DELETE {url}/v2/axb/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success" } 请求响应实例: DELETE /v2/axb/A100X558X0000400023 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 0 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: JD_0001 ts: 20161213105808354 msgdgt: FB18E497C39505A84127D8C2B7A2DDAB HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 02:58:08 GMT Server: BSS/1.1 Content-Length: 30 Connection: close {"code":0,"message":"SUCCESS"}
接口 PUT {url}/v2/axb/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13900000000", "telB": "13005711234", "subts": "20150920190126", "anucode": "1,2,3", "expiration": "7200", "extra": { "callrecording": "0","calldisplay": "0,0" } }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | 请求和绑定时的appkey必须一致; |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | 0 | telA,telB不允许同时更新 |
telB | string | 对端号码 | 0 | telA,telB不允许同时更新 |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
anucode | 放音编码 | 0 |
AXB业务时必须设置。
放音编码必须包含3个场景的编码。按照“A->X,B->X,其他号码->X”的顺序填写编码,编码之间以逗号分隔。
比如:“1,2,3”表示A->X放音编号为1, B->X放音编号为2, 其他号码->X放音编号为3。
场景
编号取值
A->X 放音编号
0-255
B->X 放音编号
0-255
其它号码->X 放音编号
0-255
|
|
expiration | string | 过期时间 | 0 | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
extra | json | 扩展参数 | 0 | |
-callrecording | string | 录音控制 | 0 |
可选。 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 2:被叫响铃后录音 |
-calldisplay | string | 来显控制 | 0 |
可选。 针对AXB中的A或者B作为主叫时,是否在被叫上显示来话的真实号码。默认为0(不显示真实号码)。
0:不显示真实号码
1:显示真实号码 来显控制按照“A->B时B上的显示,B(N)->A时在A上的显示”的顺序填写编码,编码之间以逗号分隔。“其他号码”的来显控制,同B(N)设置。
场景
A -> B
B(N)-> A
calldisplay
(1)
A 显示为X
B(N)显示为X
“0,0”
(2)
A 显示为X
B(N)显示为B(N)
“0,1”
(3)
A 显示为A
B(N)显示为X
“1,0”
(4)
A 显示为A
B(N)显示为B(N)
“1,1”
|
响应体 { "code": "0", "message": "success" }
接口 GET {url}/v2/axb/subid/{subid} GET {url}/v2/axb/xa/{telX}/{telA} GET {url}/v2/axb/xb/{telX}/{telB} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success", "data": { "telA": "13900000000", "telX": "13720056199", "telB": "13005711234", "subts": "20150920190126", "subid": "100X571X0000000001", "anucode": "1,2,3", "areacode": "10", "expiration": "7200", "extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0"} } }
返回码 | 描述 | 定义 |
---|---|---|
0 | 成功 | 推送报文成功被处理 |
400 | 格式异常 | 推送报文格式不正确 |
401 | 认证未通过 | 推送的来源或者推送的签名未通过校验。 |
其他 | 待定义 |
接口 POST {url}/v2/axb/callin 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "calltime": "2016-11-03 20:22:20", "callid":"14c821340104058b", "callrecording": "0", "calldisplay": "13720056197", "smscnt": "1" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,在绑定请求携带过来,不能超过30个字节 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 31:转接短信 真实号码为A 小号为X 对端号码为B或者其它 |
calltime | string | 发起呼叫时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 唯一关联标识 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
calldisplay | string | 被叫来显号码 | 0 | |
smscnt | string | 短信条数 | 0 | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: POST /v2/axb/callin HTTP/1.1 Connection: close Contet-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 appkey: PRD-6-1-1472023876 msgdgt: 94872E3BA9A418E045911A7446201A6F ts: 20161213151618497 Content-Length: 214 Host: 192.168.110.196:10010 User-Agent: Apache-HttpClient/4.3.2 (java 1.5) Accept-Encoding: gzip,deflate {"telX":"1560100106","callid":"0102030000000000","calltype":"10","requestId":"1119897972","calltime":"2016-12-13 15:16:17","callrecording":"1","telA":"1560000106","subid":"A102X0571X0000000002","telB":"1560200106"} HTTP/1.0 200 OK Content-Type: text/html; charset=utf-8 Content-Length: 35 Server: Werkzeug/0.11.11 Python/2.7.11 Date: Tue, 13 Dec 2016 07:15:25 GMT {"message": "success", "code": 200}
接口 POST {url}/v2/axb/finish 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "calltime": "2016-11-03 20:22:20", "ringingtime": "2016-11-03 20:22:20", "starttime": "2016-11-03 20:22:20", "releasetime": "2016-11-03 20:22:20", "callid": "14c821340104058b", "releasedir": "1", "releasecause": "1", "callrecording": "0", "recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3", "recordMode": "2", "telredir": "13720056197", "redirreason": "1", "calldisplay": "13720056195" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分)
10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
calltime | string | 发起呼叫时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
ringingtime | string | 振铃开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
starttime | string | 通话开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
releasetime | string | 通话结束时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 业务参考号 |
releasedir | string | 释放方向 | M |
1表示主叫, 2表示被叫, 0表示平台释放 |
releasecause | string | 释放原因 | M |
000 0001(1) 未分配的号码 000 0010(2) 无路由到指定的转接网 000 0011(3) 无路由到目的地 000 0100(4) 发送专用信息音 001 0000(16) 正常的呼叫拆线 001 0001(17) 用户忙 001 0010(18) 用户未响应 001 0011(19) 用户未应答 001 0100(20) 用户缺席 001 0101(21) 呼叫拒收 001 0110(22) 号码改变 001 1011(27) 目的地不可达 001 1100(28) 无效的号码格式(地址不全) 001 1101(29) 性能拒绝 001 1111(31) 正常—未指定 类别010,资源不可用类: 010 0010(34) 无电路/通路可用 010 1010(42) 交换设备拥塞 类别011,业务或任选不可用类: 011 0010(50) 所请求的性能未预定 011 0101(53) CUG中限制去呼叫 011 0111(55) CUG中限制来呼叫 011 1001(57) 承载能力无权 011 1010(58) 承载能力目前不可用 类别100,业务或任选未实现类: 100 0001(65) 承载能力未实现 100 0101(69) 所请求的性能未实现 类别101,无效的消息(例如参数超出范围)类: 101 0111(87) 被叫用户不是CUG的成员 101 1000(88) 不兼容的目的地 101 1010(90) 不存在的CUG 101 1011(91) 无效的转接网选择 101 1111(95) 无效的消息,未指定 类别110,协议错误(例如未知的消息)类: 110 0001(97) 消息类型不存在或未实现 110 0011(99) 参数不存在或未实现 110 0110(102)定时器终了时恢复 110 0101(103)参数不存在或未实现—传递 110 1110(110)消息带有未被识别的参数—舍弃 110 1111(111)协议错误,未指定 类别111,互通类: 111 1111(127)互通,未指定 类别1100、1101,平台拒绝类: 1100 1010(202)用户忙,MSRN获取失败,平台挂机 1100 1011(203)用户去活,平台挂机 1100 1100(204)用户在平台侧关机,平台挂机 1100 1101(205)用户未开户,平台挂机 1100 1110(206)小号不允许呼叫,平台挂机 1100 1111(207)主号拨打小号,平台挂机 1101 0001(209)主叫打小号带原始被叫,平台挂机 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
recordUrl | string | 录音地址 | 0 | |
recordMode | string | 录音模式 | 0 |
1:主叫在左声道 2:主叫在右声道 3:混音 |
telredir | string | 呼转号码 | 0 | |
redirreason | string | 呼转原因 | 0 |
0000(0) 未知 0001(1) 用户忙 0010(2) 无应答 0011(3) 无条件 0110(6) 移动用户不可及 |
calldisplay | string | 被叫来显号码 | 0 | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: POST /v2/axb/finish HTTP/1.1 Connection: close Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 appkey: PRD-6-1-1472023876 msgdgt: D6433F8A7677D38FC47AAA522743BE92 ts: 20161213151618499 Content-Length: 484 Host: 192.168.110.196:10010 User-Agent: Apache-HttpClient/4.3.2 (java 1.5) Accept-Encoding: gzip,deflate {"releasetime":"2016-12-13 15:16:22","ringingtime":"2016-12-13 15:16:17","releasedir":"1","starttime":"2016-12-13 15:16:17","requestId":"1225472050","calltype":"10","telA":"1560000106","telB":"1560200106","telX":"1560100106","releasecause":"16","callid":"0405060000000000","recordMode":"1","calltime":"2016-12-13 15:16:17","callrecording":"1","recordUrl":"http://192.168.110.196:10010/record/14c8000700189afa_15920210324_18029169766_20160818101010.mp3","subid":"A102X0571X0000000002"} HTTP/1.0 200 OK Content-Type: text/html; charset=utf-8 Content-Length: 35 Server: Werkzeug/0.11.11 Python/2.7.11 Date: Tue, 13 Dec 2016 07:15:25 GMT {"message": "success", "code": 200}
接口 POST {url}/v2/axb/unsub 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "subid": "100X571X0000000001" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
subid | string | 绑定id | M | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axb/pickup 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axb/ring 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/ax/{xmode} xmode取值: mode101:APP自带x号码 mode102:平台分配x号码 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13900000000", "telX": "13720056199", "subts": "20150920190126", "name": "张三", "cardtype": "0", "cardno": "363333199912221022", "areacode": "10", "expiration": "7200", "remark": "derc", "extra": {"callrecording": "0","calldisplay": "0","anucodecalled": "123","anucodecaller": "124","callunsub": "0","callpickup": "0"} }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | 0 | X号码;平台分配号码模式下,该参数可不带,系统忽略该参数 |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
name | 姓名 | M | ||
cardtype | 证件类型 | M | ||
cardno | 身份证号码 | M | ||
areacode | string | 区号 | 0 | 例如:北京(10);在平台分配X号码模式中,平台从号码池中分配该地区的X号码,避免产生呼叫长途费。 |
expiration | string | 过期时间 | M | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,不能超过30个字节 |
extra | json | 扩展参数 | 0 | |
-callrecording | string | 录音控制 | 0 |
可选。M 仅下列值有效。默认是0(不开通录音功能)。 0、好, :不录音 1:接通后录音 2:被叫响铃后录音 |
-calldisplay | string | 来显控制 | 0 |
可选。M 仅下列值有效。默认是0(显示真实号码)。 0:显示真实号码 1:显示X号码 2: 显示Z号码池中的号码 在绑定时可自由选择是否分配Z号码池的开关。 |
-anucodecalled | string | 放音编码 | 0 |
可选。 其他号码拨打X时,给其他号码的放音 不带,不放音。 |
-anucodecaller | string | 放音编码 | 0 |
可选。 其他号码拨打X时,给A的放音 不带,不放音。 |
-callunsub | string | 解绑推送消息控制 | 0 |
可选。 仅下列值有效。默认是0。 0 解绑不推送消息 1 解绑推送消息 |
-callpickup | string | 被叫接通推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫接通事件 1 推送被叫接通事件 |
-ringpickup | string | 被叫振铃推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫振铃事件 1 推送被叫振铃事件 |
-callcontrol | string | 被叫接通控制 | 0 |
可选。其他号码呼叫X时,对来显进行鉴权,仅下列值有效。默认是0。 0 不对来话号码鉴权 1 对来话号码鉴权 |
-callduration | string | 通话持续时间 | 0 | 可选,单位秒,如果出现则通话有效时长为此值,如果没有出现按现在默认处理 |
响应体 { "code": "0", "message": "success", "data": { "subid": "100X571X0000000001", "telX": "13720056199"} }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
subid | string | 绑定id | M | |
telX | string | 小号 | M |
请求响应实例mode101: POST /v2/ax/mode101 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 213 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: RR_0001 ts: 20161213133955424 msgdgt: 25F024C797A7791501D79E4196D6F6AF Content-Type: application/json;charset=utf-8 {"cardtype":"0","telX":"15601000116","expiration":"30000","requestId":"1212331","extra":{},"name":"landy............","areacode":"671","cardno":"341281198909237626","subts":"20161213133955","telA":"13500000023"} HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 05:39:55 GMT Server: BSS/1.1 Content-Length: 90 Connection: close {"code":0,"message":"SUCCESS","data":{"telX":"15601000116","subid":"A202X671X0000400028"}} 请求响应实例mode102: POST /v2/ax/mode102 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 202 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: RT_0001 ts: 20161213134329178 msgdgt: 1D2EC9FAC88FE07A276A1F92BF8F83F3 Content-Type: application/json;charset=utf-8 {"cardtype":"0","telX":"1234678900898","expiration":"30000","requestId":"1212324","extra":{},"name":"mary","areacode":"672","cardno":"341281199809234625","subts":"20161213134329","telA":"13500000017"} HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 05:43:29 GMT Server: BSS/1.1 Content-Length: 90 Connection: close {"code":0,"message":"SUCCESS","data":{"telX":"15601000118","subid":"A204X672X0000400029"}}
接口 DELETE {url}/v2/ax/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success" } 请求响应实例: DELETE /v2/ax/A204X672X0000400029 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 0 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: RT_0001 ts: 20161213134921749 msgdgt: B7E6D788450DB145016BD9ED67A5A7EA HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 05:49:21 GMT Server: BSS/1.1 Content-Length: 30 Connection: close {"code":0,"message":"SUCCESS"}
接口 PUT {url}/v2/ax/onlinecall/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telB": "13720056198" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telB | string | 被叫号码 | M |
响应体 { "code": "0", "message": "success" } 请求响应实例: PUT /v2/ax/onlinecall/15601000116 HTTP/1.0 X-Real-IP: 192.168.150.160 Host: localhost X-Forwarded-For: 192.168.150.160 Connection: close Content-Length: 46 Accept-Language: zh-cn Accept: application/json;charset=utf-8 appkey: RR_0001 ts: 20161213135904517 msgdgt: 9C3C2D47B095EBEEFC41664ACAA10E72 Content-Type: application/json;charset=utf-8 {"requestId":"1234504","telB":"15600000005"} HTTP/1.1 200 OK Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 Date: Tue, 13 Dec 2016 05:59:04 GMT Server: BSS/1.1 Content-Length: 30 Connection: close {"code":0,"message":"SUCCESS"}
接口 PUT {url}/v2/ax/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13900000000", "subts": "20150920190126", "name": "张三", "cardtype": "0", "cardno": "363333199912221022", "expiration": "7200", "extra": {"callrecording": "0","calldisplay": "0","anucodecalled": "123"} }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | 0 | 不带此参数,表示只更新其他属性 |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
name | 姓名 | 0 | ||
cardtype | 证件类型 | 0 | ||
cardno | 身份证号码 | 0 | ||
expiration | string | 过期时间 | 0 | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
extra | json | 扩展参数 | 0 | |
callrecording | string | 录音控制 | 0 |
可选。M 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 2:被叫响铃后录音 |
calldisplay | string | 来显控制 | 0 |
可选。M 仅下列值有效。默认是0(显示真实号码)。 0:显示真实号码 1:显示X号码 2: 显示Z号码池中的号码 在绑定时可自由选择是否分配Z号码池的开关。 |
anucodecalled | string | 放音编码 | 0 |
可选。 其他号码拨打X时给其他号码的放音 不带,不放音。 |
响应体 { "code": "0", "message": "success" }
接口 GET {url}/v2/ax/subid/{subid} GET {url}/v2/ax/telX/{telX} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success", "data": { "telA": "13900000000", "telX": "13720056199", "subts": "20150920190126", "subid": "100X571X0000000001", "name": "张三", "cardtype": "0", "cardno": "363333199912221022", "expiration": "7200", "extra": {"callrecording": "0","calldisplay": "0" ,"anucodecalled": "123"} } }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
telA | string | 真实号码 | M | |
telX | string | 隐私号码 | 0 | X号码;平台分配号码模式下,该参数可不带,系统忽略该参数 |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
subid | string | 绑定id | M | |
name | 姓名 | M | ||
cardtype | 证件类型 | M | ||
cardno | 身份证号码 | M | ||
areacode | string | 区号 | 0 | 例如:北京(10);在平台分配X号码模式中,平台从号码池中分配该地区的X号码,避免产生呼叫长途费。 |
expiration | string | 过期时间 | M | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
extra | json | 扩展参数 | 0 | |
callrecording | string | 录音控制 | 0 |
可选。M 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 |
calldisplay | string | 来显控制 | 0 |
可选。M 仅下列值有效。默认是0(显示真实号码)。 0:显示真实号码 1:显示X号码 2: 显示Z号码池中的号码 在绑定时可自由选择是否分配Z号码池的开关。 |
anucodecalled | string | 放音编码 | 0 |
可选。 其他号码拨打X时给其他号码的放音 不带,不放音。 |
返回码 | 描述 | 定义 |
---|---|---|
0 | 成功 | 推送报文成功被处理 |
400 | 格式异常 | 推送报文格式不正确 |
401 | 认证未通过 | 推送的来源或者推送的签名未通过校验。 |
其他 | 待定义 |
接口 POST {url}/v2/ax/callin 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "subid": "100X571X0000000001", "calltype": "10", "calltime": "2016-11-03 20:22:20", "callid":"14c821340104058b", "calrecording": "0", "telZ": "13720056196", "smscnt": "1" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AX业务:(Bit7=0时为传统CS方式,Bit7=1时为PS方式) 0:DTMF方式通话主叫 1:通话被叫 2:短信发送 3:短信接收 128:PS方式通话主叫 127: 双呼 真实号码为A 小号为X |
calltime | string | 通话开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 唯一关联标识 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
telZ | string | Z号码 | M | 默认为空。在绑定请求中设置了来显为Z号码时,该值为显示的Z号码。 |
smscnt | string | 短信条数 | 0 | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: 参考AXB业务呼叫起始推送。
接口 POST {url}/v2/ax/finish 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "subid": "100X571X0000000001", "calltype": "1", "calltime": "2016-11-03 20:22:20", "ringingtime": "2016-11-03 20:22:20", "starttime": "2016-11-03 20:22:20", "releasetime": "2016-11-03 20:22:20", "callid": "14c821340104058b", "releasedir": "1", "releasecause": "1", "callrecording": "0", "recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3", "recordMode": "2", "telZ": "13720056196", "userkey": "1234" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AX业务:(Bit7=0时为传统CS方式,Bit7=1时为PS方式) 0:DTMF方式通话主叫 1:通话被叫 2:短信发送 3:短信接收 128:PS方式通话主叫 127: 双呼 真实号码为A 小号为X |
calltime | string | 通话开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
ringingtime | string | 振铃开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
starttime | string | 通话开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
releasetime | string | 通话结束时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 业务参考号 |
releasedir | string | 释放方向 | M |
1 表示主叫, 2 表示被叫, 0 表示平台释放 |
releasecause | string | 释放原因 | M |
000 0001(1) 未分配的号码 000 0010(2) 无路由到指定的转接网 000 0011(3) 无路由到目的地 000 0100(4) 发送专用信息音 001 0000(16) 正常的呼叫拆线 001 0001(17) 用户忙 001 0010(18) 用户未响应 001 0011(19) 用户未应答 001 0100(20) 用户缺席 001 0101(21) 呼叫拒收 001 0110(22) 号码改变 001 1011(27) 目的地不可达 001 1100(28) 无效的号码格式(地址不全) 001 1101(29) 性能拒绝 001 1111(31) 正常—未指定 类别010,资源不可用类: 010 0010(34) 无电路/通路可用 010 1010(42) 交换设备拥塞 类别011,业务或任选不可用类: 011 0010(50) 所请求的性能未预定 011 0101(53) CUG中限制去呼叫 011 0111(55) CUG中限制来呼叫 011 1001(57) 承载能力无权 011 1010(58) 承载能力目前不可用 类别100,业务或任选未实现类: 100 0001(65) 承载能力未实现 100 0101(69) 所请求的性能未实现 类别101,无效的消息(例如参数超出范围)类: 101 0111(87) 被叫用户不是CUG的成员 101 1000(88) 不兼容的目的地 101 1010(90) 不存在的CUG 101 1011(91) 无效的转接网选择 101 1111(95) 无效的消息,未指定 类别110,协议错误(例如未知的消息)类: 110 0001(97) 消息类型不存在或未实现 110 0011(99) 参数不存在或未实现 110 0110(102)定时器终了时恢复 110 0101(103)参数不存在或未实现—传递 110 1110(110)消息带有未被识别的参数—舍弃 110 1111(111)协议错误,未指定 类别111,互通类: 111 1111(127)互通,未指定 类别1100、1101,平台拒绝类: 1100 1010(202)用户忙,MSRN获取失败,平台挂机 1100 1011(203)用户去活,平台挂机 1100 1100(204)用户在平台侧关机,平台挂机 1100 1101(205)用户未开户,平台挂机 1100 1110(206)小号不允许呼叫,平台挂机 1100 1111(207)主号拨打小号,平台挂机 1101 0001(209)主叫打小号带原始被叫,平台挂机 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
recordUrl | string | 录音地址 | 0 | |
recordMode | string | 录音模式 | 0 |
1:主叫在左声道 2:主叫在右声道 3:混音 |
telZ | string | Z号码 | 0 | 在绑定请求中设置了来显为Z号码时,该值为显示的Z号码。 |
userkey | string | 分机号 | 0 | 分机号 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: 参考AXB业务呼叫结束推送。
接口 POST {url}/v2/ax/unsub 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "subid": "100X571X0000000001" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
subid | string | 绑定id | M | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/ax/pickup 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "subid": "100X571X0000000001", "calltype": "1", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AX业务:(Bit7=0时为传统CS方式,Bit7=1时为PS方式) 0:DTMF方式通话主叫 1:通话被叫 2:短信发送 3:短信接收 128:PS方式通话主叫 127: 双呼 真实号码为A 小号为X |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/ax/ring 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "subid": "100X571X0000000001", "calltype": "1", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AX业务:(Bit7=0时为传统CS方式,Bit7=1时为PS方式) 0:DTMF方式通话主叫 1:通话被叫 2:短信发送 3:短信接收 128:PS方式通话主叫 127: 双呼 真实号码为A 小号为X |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axn/{xmode} xmode取值: mode101:APP自带x号码 mode102:平台分配x号码 请求体 { "requestId": "1234567890", "telA": "13900000000", "telX": "13720056199", "telB": "13005711234", "subts": "20150920190126", "anucode": "1,2,3", "areacode": "10", "expiration": "7200", "remark": "derc", "extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1","calldisplayshow": "0","callunsub": "0","callpickup": "0" } }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | 0 | 101模式填该字段,102模式不填 |
telB | string | 对端号码 | M | |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
anucode | 放音编码 | M |
AXB业务时必须设置。
放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码,编码之间以逗号分隔。
比如:“1,2,3”表示 B->X 放音编号为 1,A->X 放音编号为 2,其他号码->X 放音编号为 3。
场景
编号取值
B->X 放音编号
0-255
A->X 放音编号
0-255
其它号码->X 放音编号
0-255
|
|
areacode | string | 区号 | 0 | 例如:北京(10);在平台分配X号码模式中,平台从号码池中分配该地区的X号码,避免产生呼叫长途费。101模式不填该字段,102模式需要填 |
expiration | string | 过期时间 | M | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,不能超过30个字节 |
extra | json | 扩展参数 | 0 | |
-callrecording | string | 录音控制 | 0 |
可选。 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 2:被叫响铃后录音 |
-calldisplay | string | 来显控制 | 0 |
可选。 针对AXB中的A或者B作为主叫时,是否在被叫上显示来话的真实号码。默认为0(不显示真实号码)。
0:不显示真实号码
1:显示真实号码 |
-callrestrict | string | 呼叫控制 | 0 |
可选。 仅下列值有效。默认是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 均无权限 |
-calldisplayshow | string | 推送被叫来显号码控制 | 0 |
可选。 仅下列值有效。默认是0。 0 推送中不携带被叫来显号码 1 推送中携带被叫来显号码 |
-callunsub | string | 解绑推送消息控制 | 0 |
可选。 仅下列值有效。默认是0。 0 解绑不推送消息 1 解绑推送消息 |
-ringpickup | string | 被叫振铃推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫振铃事件 1 推送被叫振铃事件 |
-callpickup | string | 被叫接通推送事件控制 | 0 |
可选。 仅下列值有效。默认是0。 0 不推送被叫接通事件 1 推送被叫接通事件 |
-callcontrol | string | 被叫接通控制 | 0 |
可选。其他号码呼叫X时,对来显进行鉴权,仅下列值有效。默认是0。 0 不对来话号码鉴权 1 对来话号码鉴权 |
-callduration | string | 通话持续时间 | 0 | 可选,单位秒,如果出现则通话有效时长为此值,如果没有出现按现在默认处理。 |
响应体 { "code": "0", "message": "success", "data": { "subid": "100X571X0000000001", "telX": "13720056199"} }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
subid | string | 绑定id | M | |
telX | string | 小号 | M |
接口 DELETE {url}/v2/axn/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
响应体 { "code": "0", "message": "success" }
接口 PUT {url}/v2/axn/{subid} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13900000000", "telB": "13005711234", "subts": "20150920190126", "anucode": "1,2,3", "expiration": "7200", "extra": { "callrecording": "0","calldisplay": "0,0" } }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string/header | 应用id | M | 请求和绑定时的appkey必须一致; |
ts | string/header | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string/header | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | 0 | telA,telB不允许同时更新 |
telB | string | 对端号码 | 0 | telA,telB不允许同时更新 |
subts | string | 绑定时间 | M | 格式为yyyyMMddHHmmss。时间采用北京时间,24小时制。 |
anucode | 放音编码 | 0 |
AXB业务时必须设置。
放音编码必须包含3个场景的编码。按照“A->X,B->X,其他号码->X”的顺序填写编码,编码之间以逗号分隔。
比如:“1,2,3”表示A->X放音编号为1, B->X放音编号为2, 其他号码->X放音编号为3。
场景
编号取值
A->X 放音编号
0-255
B->X 放音编号
0-255
其它号码->X 放音编号
0-255
|
|
expiration | string | 过期时间 | 0 | 单位:秒, 自绑定时间开始后expiration秒自动解绑;0表示不限制时间,不会自动解绑 |
extra | json | 扩展参数 | 0 | |
-callrecording | string | 录音控制 | 0 |
可选。 仅下列值有效。默认是0(不开通录音功能)。 0:不录音 1:接通后录音 2:被叫响铃后录音 |
-calldisplay | string | 来显控制 | 0 |
可选。 针对AXB中的A或者B作为主叫时,是否在被叫上显示来话的真实号码。默认为0(不显示真实号码)。
0:不显示真实号码
1:显示真实号码 来显控制按照“A->B时B上的显示,B(N)->A时在A上的显示”的顺序填写编码,编码之间以逗号分隔。“其他号码”的来显控制,同B(N)设置。
场景
A -> B
B(N)-> A
calldisplay
(1)
A 显示为X
B(N)显示为X
“0,0”
(2)
A 显示为X
B(N)显示为B(N)
“0,1”
(3)
A 显示为A
B(N)显示为X
“1,0”
(4)
A 显示为A
B(N)显示为B(N)
“1,1”
|
响应体 { "code": "0", "message": "success" }
接口 GET {url}/v2/axn/subid/{subid} GET {url}/v2/axn/telx/{telX} GET {url}/v2/axn/tela/{telA} 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752"
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
响应体
如果有多个AXN的绑定关系,则出现多个object结构(array格式)
参数说明请参考绑定请求和响应。
{
"code": "0",
"message": "success",
"data": {
"telA": "13900000000",
"telX": "13720056199",
"telB": "13005711234",
"subts": "20150920190126",
"subid": "100X571X0000000001",
"anucode": "1,2,3",
"areacode": "10",
"expiration": "7200",
"extra": { "callrecording": "0","calldisplay": "0,0","callrestrict": "1" ,"calldisplayshow": "0"}
}
}
接口 POST {url}/v2/axn/callin 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056197", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "calltime": "2016-11-03 20:22:20", "callid":"14c821340104058b", "callrecording": "0", "calldisplay": "13720056197", "smscnt": "1" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,在绑定请求携带过来,不能超过30个字节 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 31:转接短信 真实号码为A 小号为X 对端号码为B或者其它 |
calltime | string | 发起呼叫时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 唯一关联标识 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
calldisplay | string | 被叫来显号码 | 0 | |
smscnt | string | 短信条数 | 0 | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: POST /v2/axn/callin HTTP/1.1 Connection: close Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 appkey: PRD-6-1-1472023876 msgdgt: 94872E3BA9A418E045911A7446201A6F ts: 20161213151618497 Content-Length: 214 Host: 192.168.110.196:10010 User-Agent: Apache-HttpClient/4.3.2 (java 1.5) Accept-Encoding: gzip,deflate {"telX":"1560100106","callid":"0102030000000000","calltype":"10","requestId":"1119897972","calltime":"2016-12-13 15:16:17","callrecording":"1","telA":"1560000106","subid":"A102X0571X0000000002","telB":"1560200106"} HTTP/1.0 200 OK Content-Type: text/html; charset=utf-8 Content-Length: 35 Server: Werkzeug/0.11.11 Python/2.7.11 Date: Tue, 13 Dec 2016 07:15:25 GMT {"message": "success", "code": 200}
接口 POST {url}/v2/axn/finish 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "calltime": "2016-11-03 20:22:20", "ringingtime": "2016-11-03 20:22:20", "starttime": "2016-11-03 20:22:20", "releasetime": "2016-11-03 20:22:20", "callid": "14c821340104058b", "releasedir": "1", "releasecause": "1", "callrecording": "0", "recordUrl": "http://101.12.12.123:12000/record/ALPT_1234_14c8546501234567_18600000000_13800000000_20161204070000.mp3", "recordMode": "2", "telredir": "13720056197", "redirreason": "1", "calldisplay": "13720056195" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 对端号码 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
calltime | string | 发起呼叫时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
ringingtime | string | 振铃开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
starttime | string | 通话开始时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
releasetime | string | 通话结束时间 | M | 格式: yyyy-MM-dd HH:mm:ss |
callid | string | 通话标识 | M | 业务参考号 |
releasedir | string | 释放方向 | M |
1 表示主叫, 2 表示被叫, 0 表示平台释放 |
releasecause | string | 释放原因 | M |
000 0001(1) 未分配的号码 000 0010(2) 无路由到指定的转接网 000 0011(3) 无路由到目的地 000 0100(4) 发送专用信息音 001 0000(16) 正常的呼叫拆线 001 0001(17) 用户忙 001 0010(18) 用户未响应 001 0011(19) 用户未应答 001 0100(20) 用户缺席 001 0101(21) 呼叫拒收 001 0110(22) 号码改变 001 1011(27) 目的地不可达 001 1100(28) 无效的号码格式(地址不全) 001 1101(29) 性能拒绝 001 1111(31) 正常—未指定 类别010,资源不可用类: 010 0010(34) 无电路/通路可用 010 1010(42) 交换设备拥塞 类别011,业务或任选不可用类: 011 0010(50) 所请求的性能未预定 011 0101(53) CUG中限制去呼叫 011 0111(55) CUG中限制来呼叫 011 1001(57) 承载能力无权 011 1010(58) 承载能力目前不可用 类别100,业务或任选未实现类: 100 0001(65) 承载能力未实现 100 0101(69) 所请求的性能未实现 类别101,无效的消息(例如参数超出范围)类: 101 0111(87) 被叫用户不是CUG的成员 101 1000(88) 不兼容的目的地 101 1010(90) 不存在的CUG 101 1011(91) 无效的转接网选择 101 1111(95) 无效的消息,未指定 类别110,协议错误(例如未知的消息)类: 110 0001(97) 消息类型不存在或未实现 110 0011(99) 参数不存在或未实现 110 0110(102)定时器终了时恢复 110 0101(103)参数不存在或未实现—传递 110 1110(110)消息带有未被识别的参数—舍弃 110 1111(111)协议错误,未指定 类别111,互通类: 111 1111(127)互通,未指定 类别1100、1101,平台拒绝类: 1100 1010(202)用户忙,MSRN获取失败,平台挂机 1100 1011(203)用户去活,平台挂机 1100 1100(204)用户在平台侧关机,平台挂机 1100 1101(205)用户未开户,平台挂机 1100 1110(206)小号不允许呼叫,平台挂机 1100 1111(207)主号拨打小号,平台挂机 1101 0001(209)主叫打小号带原始被叫,平台挂机 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
recordUrl | string | 录音地址 | 0 | |
recordMode | string | 录音模式 | 0 |
1:主叫在左声道 2:主叫在右声道 3:混音 |
telredir | string | 呼转号码 | 0 | |
redirreason | string | 呼转原因 | 0 |
0000(0) 未知 0001(1) 用户忙 0010(2) 无应答 0011(3) 无条件 0110(6) 移动用户不可及 |
calldisplay | string | 被叫来显号码 | 0 | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" } 请求响应实例: POST /v2/axn/finish HTTP/1.1 Connection: close Content-Type: application/json;charset=utf-8 Accept: application/json;charset=utf-8 appkey: PRD-6-1-1472023876 msgdgt: D6433F8A7677D38FC47AAA522743BE92 ts: 20161213151618499 Content-Length: 484 Host: 192.168.110.196:10010 User-Agent: Apache-HttpClient/4.3.2 (java 1.5) Accept-Encoding: gzip,deflate {"releasetime":"2016-12-13 15:16:22","ringingtime":"2016-12-13 15:16:17","releasedir":"1","starttime":"2016-12-13 15:16:17","requestId":"1225472050","calltype":"10","telA":"1560000106","telB":"1560200106","telX":"1560100106","releasecause":"16","callid":"0405060000000000","recordMode":"1","calltime":"2016-12-13 15:16:17","callrecording":"1","recordUrl":"http://192.168.110.196:10010/record/14c8000700189afa_15920210324_18029169766_20160818101010.mp3","subid":"A102X0571X0000000002"} HTTP/1.0 200 OK Content-Type: text/html; charset=utf-8 Content-Length: 35 Server: Werkzeug/0.11.11 Python/2.7.11 Date: Tue, 13 Dec 2016 07:15:25 GMT {"message": "success", "code": 200}
接口 POST {url}/v2/axn/unsub 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "subid": "100X571X0000000001" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
subid | string | 绑定id | M | |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axn/pickup 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }
接口 POST {url}/v2/axn/ring 请求头 "appkey": "ALPT_1234" "ts": "20161114143116001" "msgdgt": "BA9854BED1A2986B061E2713F403C752" 请求体 { "requestId": "1234567890", "telA": "13720056198", "telX": "13720056199", "telB": "13720056195", "telC": "13720056196", "subid": "100X571X0000000001", "calltype": "10", "callid": "14c821340104058b", "callrecording": "0" }
参数 | 类型 | 意义 | 是否必传 | 备注 |
---|---|---|---|---|
appkey | string | 应用id | M | |
ts | string | 业务时间戳 | M | 格式yyyyMMddHHmmssSSS,时间采用北京时间,24小时制,精确至毫秒,不能与当前标准时间相差超过5分钟 |
msgdgt | string | 签名摘要 | M | 消息体的MD5摘要 |
requestId | string | 业务id | M | 消息请求标识 |
telA | string | 真实号码 | M | |
telX | string | 小号号码 | M | |
telB | string | 对端号码 | M | |
telC | string | 原始被叫 | 0 | |
subid | string | 绑定id | M | |
calltype | string | 呼叫类型 | M |
AXB业务:(针对被保护号码A来分) 10:通话主叫 11:通话被叫 12:短信发送 13:短信接收 20:呼叫不允许 30:短信不允许 21: 未开户不允许 126: 双呼 真实号码为A 小号为X 对端号码为B或者其它 |
callid | string | 通话标识 | M | 业务参考号 |
callrecording | string | 录音控制 | M | 同绑定接口定义 |
remark | string | 接入商自有字段 | 0 | 接入商自有字段,如果请求中携带,则响应中返回 |
响应体 { "code": "0", "message": "success" }