1. 接口介绍

接口功能:当用户发起呼叫或收到来电时, 小号业务会将呼叫事件推送到第三方应用。

请求方向:小号平台(服务端)→ 第三方应用平台。

请求方法:POST

请求 URI:商户应用提供的用来接收通知的服务地址,示例:http://{AppServerAddr}{ AppServerAddr }是第三方应用接收呼叫通知的服务地址。





2 事件说明

应答事件(默认不推送)

格式:

{
  "eventType": "answer",
  "timestamp": "2018-12-05 02:35:15",
  "caller": "1719173xxxx",
  "called": "1852131xxxx",
  "subscriptionId": "c9f09eb2-22a9-46c4-86c7-fd1db5dexxxx"
}

// eventType answer:表示应答事件
// caller: 主叫号码应答中的主叫号码是虚拟小号
// called: 被叫号码
// subscriptionId: 绑定关系id
// timestamp: 事件的事件

话单事件

格式:

{
  "eventType": "fee",
  "bindNum": "1715677xxxx",
  "icid": "ba171f34e6953fcd751edc77127748f4.3753069029.2314xxxx",
  "subscriptionId": "16b22333-5056-4eff-a761-83d312e6xxxx",
  "callerNum": "1362543xxxx",
  "calleeNum": "1715677xxxx",
  "fwdDisplayNum": "1715677xxxx",
  "fwdDstNum": "1321071xxxx",
  "callInTime": "2018-12-06 15:10:29",
  "fwdStartTime": "2018-12-06 15:10:29",
  "fwdAlertingTime": "2018-12-06 15:10:32",
  "fwdAnswerTime": "",
  "callEndTime": "2018-12-06 15:10:52",
  "duration": 0,
  "reason": "8001",
  "recordFlag": 0,
  "userData": ""
}

// eventType fee: 表示话单事件
// bindNum:  虚拟小号
// icid:  唯一的通话标志
// subscriptionId:  绑定关系id
// callerNum:  主叫号码
// calleeNum:  被叫号码
// fwdDisplayNum:  转接呼叫时的显示的号码
// fwdDstNum:  转接呼叫的被叫号码
// callInTime:  呼入开始的时间
// fwdStartTime:  呼叫转接开始时间
// fwdAlertingTime:  转接呼叫后振铃时间
// fwdAnswerTime:  转接呼叫后应答时间
// callEndTime:  挂断时间
// Duration:  通话时长
// userData: 用户自定义的数据





3. 通话结束原因列表

错误码 错误原因
7001 呼叫频次管控
7002 应用呼叫频次管控
7003 主显号码呼叫频次管控
7004 被叫黑名单呼叫管控
7008 用户状态已冻结
8000 内部错误
8001 用户未接续成功
8002 接续用户时对端返回失败放音
8003 用户振铃超时
8004 用户振铃时挂机
8005 TTS 转换失败
8006 放音文件不存在
8007 给用户放音失败
8008 给用户放音收号失败
8009 主叫用户主动挂机
8010 超过通话最大时长挂机
8011 其他错误
8012 无效的 AX 模式呼叫
8013 无效的 AXB 模式呼叫
8014 给用户录音失败
8015 AXB 模式呼叫方向不允许
8016 X 模式客户指示挂机
8017 业务无权限
8018 绑定关系不存在
8019 业务异常
8020 无效的分机号码
8022 被叫号码不存在
8101 被叫无应答
8102 被叫用户正忙
8103 被叫用户暂时无法接通
8104 被叫已关机
8105 被叫已停机
8201 主叫正常挂断(已接通)
8202 被叫正常挂断(已接通)
8203 主叫用户主动挂断(已振铃)
8204 主叫用户主动挂断(未振铃)





4. 推送说明

接收端响应 200 后不会再进行推送, 404 等状态不会进行重新推送, 500 会进行重新推送, 重推次数为 5 次, 间隔时间为 1 分钟, 5 分钟, 10 分钟, 1 小时, 1 小时

文档更新时间: 2020-11-28 04:04   作者:admin