AXB话单通知
该接口用于AXB通知话单,回调接口地址有两两种设置方式
- 在后台系统的 系统管理-->租户配置-->AXB话单推送地址 里设置。
- 配置AXB时设置话单回调地址。
注意方式2的优先级高于方式1
返回的HTTP状态码200或2XX表示推送成功,否则表示推送失败。
接口请求地址
请求方法 | POST |
---|---|
访问URI | 回调接口 |
通信协议 | HTTPS |
请求参数
请求Headers参数说明
参数名称 | 是否必选 | 参数类型 | 说明 |
---|---|---|---|
Content-Type | 是 | String | application/json;charset=UTF-8 |
timeStamp | 是 | String | 时间戳格式为yyyy-MM-dd HH:mm:ss |
randomStr | 是 | String(32-64) | 随机字符串 |
sign | 是 | String(1-256) | 签名,签名方式为 SHA-256(用户名+时间戳+随机字符串+secret),格式为小写 |
请求Body参数说明
参数名称 | 是否必选 | 参数类型 | 说明 |
---|---|---|---|
[0]id | 是 | String(1-64) | 话单id |
[0]customerId | 是 | String(1-32) | 客户id |
[0]customerName | 是 | String(1-64) | 客户名称 |
[0]firstCallerNumber | 是 | String(1-32) | A路主叫号码 |
[0]firstCallerName | 否 | String(1-64) | A路主叫名称 |
[0]firstType | 是 | 枚举 | A路类型,PHONE:话机,GATEWAY_TO:落地网关,GATEWAY_FROM:对接网关 |
[0]firstCalleeNumber | 是 | String(1-32) | A路被叫 |
[0]firstRateId | 否 | String(1-32) | A路费率id |
[0]firstRateVersion | 否 | int | 费率版本 |
[0]firstPhoneId | 否 | String(1-32) | A路话机id,firstType为PHONE不为空 |
[0]firstGatewayId | 否 | String(1-32) | A路网关id,firstType为GATEWAY_FROM或GATEWAY_TO不允许为空 |
[0]firstGatewayName | 否 | String(1-64) | A路网关名称,firstType为GATEWAY_FROM或GATEWAY_TO不允许为空 |
[0]secondCallerNumber | 是 | String(1-32) | B路主叫号码 |
[0]secondCallerName | 否 | String(1-64) | B路主叫名称 |
[0]secondType | 是 | 枚举 | B路类型,PHONE:话机,GATEWAY_TO:落地网关,GATEWAY_FROM:对接网关 |
[0]secondCalleeNumber | 是 | String(1-32) | B路被叫 |
[0]secondRateId | 否 | String(1-32) | B路费率id |
[0]secondRateVersion | 否 | int | B路费率版本 |
[0]secondPhoneId | 否 | String(1-32) | B路话机id,secondType为PHONE不为空 |
[0]secondGatewayId | 否 | String(1-32) | B路网关id,secondType为GATEWAY_FROM或GATEWAY_TO不允许为空 |
[0]secondGatewayName | 否 | String(1-64) | B路网关名称,secondType为GATEWAY_FROM或GATEWAY_TO不允许为空 |
[0]remark | 否 | String(1-256) | 备注 |
[0]tranType | 是 | 枚举 | 通话类型,1:语音,2:视频 |
[0]firstStartTime | 否 | String | A路开始时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]firstAlertingTime | 否 | String | A路响铃时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]firstAnswerTime | 否 | String | A路接听时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]endTime | 是 | String | 结束时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]secondStartTime | 否 | String | B路开始时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]secondAlertingTime | 否 | String | B路响铃时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]secondAnswerTime | 否 | String | B路接听时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]firstTalkTime | 否 | long | A路通话时长,单位为毫秒 |
[0]firstChargingTime | 否 | long | A路计费时长,单位为毫秒 |
[0]firstSpend | 否 | float(24,6) | A路通话费用 |
[0]firstEndCode | 否 | String(1-32) | A路终止原因编码 |
[0]firstEndDesc | 否 | String(1-64) | A路终止原因 |
[0]secondTalkTime | 否 | long | B路通话时长,单位为毫秒 |
[0]secondChargingTime | 否 | long | B路计费时长,单位为毫秒 |
[0]secondSpend | 否 | float(24,6) | B路通话费用 |
[0]secondEndCode | 否 | String(1-32) | B路终止原因编码 |
[0]secondEndDesc | 否 | String(1-64) | B路终止原因 |
[0]hangUpDirection | 否 | 枚举 | 挂断方,FIRST:A路,SECOND:B路,SERVE:服务端 |
[0]firstDeviceName | 否 | String(1-64) | A路设备名称 |
[0]secondDeviceName | 否 | String(1-64) | B路设备名称 |
[0]firstCallId | 否 | String(1-128) | A路callId |
[0]secondCallId | 否 | String(1-128) | B路callId |
[0]firstTranCode | 否 | String(1-32) | A路通话编码 |
[0]firstTranRate | 否 | int | A路通话编码频率 |
[0]secondTranCode | 否 | String(1-32) | B路通话编码 |
[0]secondTranRate | 否 | int | B路通话编码频率 |
[0]callmode | 是 | 枚举 | 通话模式,COMMON:普通,CALLBACK:回拨,AX:AX,AXB:AXB |
[0]callbackReqId | 否 | String(1-32) | 回拨请求id,callmodew为CALLBACK时不为空 |
[0]axBindId | 否 | String(1-32) | ax绑定id,callmode为AX时不为空 |
[0]axBindTempId | 否 | String(1-32) | ax临时绑定id,callmode为AX且callDirectionw为SECOND_TO_SERVER不为空 |
[0]axbBindId | 否 | String(1-32) | axb绑定id,callmode为AX时不为空 |
[0]callDirection | 是 | 枚举 | 呼叫方向,FIRST_TO_SERVER:A路呼出,SECOND_TO_SERVER:B路呼出,SERVER_TO_FIRST:服务器呼出A路,SERVER_TO_SECOND:服务器呼出B路 |
[0]firstHangUpTime | 否 | String | A路挂断时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]secondHangUpTime | 否 | String | B路挂断时间,格式为yyyy-MM-dd HH:mm:ss.SSS |
[0]firstIp | 否 | String(1-64) | A路ip |
[0]secondIp | 否 | String(1-64) | B路ip |
响应参数
参数名称 | 是否必选 | 参数类型 | 说明 |
---|
响应结果码
响应码 | 结果码 | 描述 | 处理方法 |
---|---|---|---|
2XX | 成功 |