通信猫产品文档通信猫产品文档
通信猫系统
通信猫官网
通信猫系统
通信猫官网
  • 产品介绍
  • 快速开始
  • 常用业务场景
  • API参考

    • 概述
    • 获取token
    • 客户

      • 创建客户
      • 修改客户
      • 客户单个查询
      • 客户分页查询
      • 客户充值
      • 客户充值单个查询
      • 客户充值分页查询
    • 话机

      • 创建话机
      • 修改话机
      • 话机单个查询
      • 话机分页查询
    • 落地网关

      • 创建落地网关
      • 修改落地网关
      • 落地网关单个查询
      • 落地网关分页查询
    • 费率

      • 创建费率
      • 修改费率
      • 费率单个查询
      • 费率分页查询
      • 费率版本单个查询
    • 回拨请求

      • 创建回拨请求
      • 回拨请求单个查询
    • AX绑定

      • 创建AX绑定
      • 修改AX绑定
      • AX绑定单个查询
      • AX绑定分页查询
      • 创建AX临时绑定
      • 修改AX临时绑定
      • AX临时绑定单个查询
      • AX临时绑定分页查询
    • AXB绑定

      • 创建AXB绑定
      • 修改AXB绑定
      • AXB绑定单个查询
      • AXB绑定分页查询
    • 话单

      • 话单通知
      • 回拨话单通知
      • AX话单通知
      • AXB话单通知
    • 录音

      • 录音事件通知
      • 录音下载
  • 知识库

    • webrtc快速开始

AX话单通知

该接口用于AX通知话单,回调接口地址有两两种设置方式

  1. 在后台系统的 系统管理-->租户配置-->AX话单推送地址 里设置。
  2. 配置AX时设置话单回调地址。

注意方式2的优先级高于方式1

返回的HTTP状态码200或2XX表示推送成功,否则表示推送失败。

接口请求地址

请求方法POST
访问URI回调接口
通信协议HTTPS

请求参数

请求Headers参数说明

参数名称是否必选参数类型说明
Content-Type是Stringapplication/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否intB路费率版本
[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否StringA路开始时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]firstAlertingTime否StringA路响铃时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]firstAnswerTime否StringA路接听时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]endTime是String结束时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]secondStartTime否StringB路开始时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]secondAlertingTime否StringB路响铃时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]secondAnswerTime否StringB路接听时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]firstTalkTime否longA路通话时长,单位为毫秒
[0]firstChargingTime否longA路计费时长,单位为毫秒
[0]firstSpend否float(24,6)A路通话费用
[0]firstEndCode否String(1-32)A路终止原因编码
[0]firstEndDesc否String(1-64)A路终止原因
[0]secondTalkTime否longB路通话时长,单位为毫秒
[0]secondChargingTime否longB路计费时长,单位为毫秒
[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否intA路通话编码频率
[0]secondTranCode否String(1-32)B路通话编码
[0]secondTranRate否intB路通话编码频率
[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否StringA路挂断时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]secondHangUpTime否StringB路挂断时间,格式为yyyy-MM-dd HH:mm:ss.SSS
[0]firstIp否String(1-64)A路ip
[0]secondIp否String(1-64)B路ip

响应参数

参数名称是否必选参数类型说明

响应结果码

响应码结果码描述处理方法
2XX成功
Last Updated:
Contributors: YuDongying
Prev
回拨话单通知
Next
AXB话单通知