咨询热线:0755-33548988
虚拟小号回调接口
1.虚拟小号回调接口介绍

玖云平台针对虚拟小号回拨接口提供了回调通知接口,虚拟小号发起呼叫请求后会回到用户服务器,将通话的状态信息返回给用户。

回调通知接口示例代码(即Demo)下载

2.回调通知AS接口接入及使用流程

接入流程

 流程图

(1).创建应用并配置用户的AS服务器地址即回调地址

(2).用户AS服务器端开发相应接口

(3).开始使用

请求地址配置

请求地址为开发者服务器地址,具体配置方式如下:

地址配置图

3.虚拟小号呼叫挂机通知接口

此接口用于呼叫断开的时候,平台通知用户应用服务器。包括正常断开以及异常断开情况。

回调请求地址

用户自行配置URL地址。通过POST方式请求通知用户,提供XML和JSON格式。

回调请求包头

属性 类型 约束 说明
Content-Type String 必选 类型application/xml
Content-Length String 必选 消息体的长度

回调请求包体

属性 类型 约束 描述 取值
action String 必选 请求类型 Hangup
type int 必选 呼叫类型 12:虚拟小号
appId String 必选 应用ID
subid String 必选 虚拟小号绑定时生成的唯一ID
callId String 必选 呼叫的唯一标示 32位字符串
telA String 必选 A号码
telB String 必选 B号码
telX String 必选 X号码
startTimeCaller String 必选 主叫发起时间,主叫接通X的时间 YYYYMMDDHH24MISS 20130212000256
startTimeCallee String 可选 被叫接听时间,未接通话单可能为空 YYYYMMDDHH24MISS 20130212000256
endTime String 必选 通话结束时间 YYYYMMDDHH24MISS
duration String 必选 通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0 单位:秒
callFrom String 必选 本次通话发起的方向 0:A主叫,1:B主叫,2:平台回拨
releasedir String 必选 本次通话挂机的方向 0:平台释放,1:主叫释放,2:被叫释放
byeType String 必选 通话挂机类型 包含正常挂机以及异常挂机类型。 1:无匹配规则, 2:拦截, 3:小号逻辑关机, 4:业务响应超时, 5:未接通超时, 6:Channel 异常(被叫呼转拦截), 7:Session 异常, 8:系统处理异常, 9:呼入信令异常, 10:保留, 11:主叫正常挂机, 12:主叫挂机, 13:被叫正常挂机, 14:被叫挂机, 15:超长通话平台拆机, 16:业务设置通话时长平台拆机, 17:媒体中断平台拆机, 18:系统拆机, 19:被叫停机, 20:被叫关机, 21:主叫呼叫中止, 22:主叫中止, 23:号码不存在, 24:转接遇忙, 25:被叫忙, 26:被叫拒接, 27:被叫漏接, 28:被叫无应答, 29:被叫不可及, 30:不可达,未指定, 31:正常挂机, 32:无绑定关系, 34:禁呼时段内呼叫 41:DTMF 无响应, 42:DTMF 号码异常
dateCreated String 必选 请求时间 回调用户的时间
userData String 可选 用户数据 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户
recordUrl String 可选 录音回调地址 URL格式,未开启录音,则为空,录音下载有延时
abline String 可选 回拨话单标识 A:A路话单,B:B路话单

参数说明:

(1).action:请求类型
(2).type:呼叫类型
(3).appId:应用ID
(4).subid:AX绑定时生成的唯一ID
(5).callId:呼叫的唯一标示
(6).telA:A号码
(7).telB:B号码
(8).telX: X号码
(9).startTimeCaller:主叫发起时间,主叫接通X的时间
(10).startTimeCallee:被叫接听时间
(11).endTime:通话结束时间
(12).duration:通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0
(13).callFrom:本次通话发起的方向
(14).releasedir: 本次通话挂机的方向
(15).byeType:通话挂机类型
(16).dateCreated:请求时间
(17).userData:用户回调REST接口中传入的数据
(18).recordUrl:录音回调地址
(19).abline:回拨话单标识

回调请求示例

XML请求示例
      POST
      <?xml version='1.0'?>
      <req>
          <action>Hangup</action>
          <type>12</type>
          <appId>7290fa01293c483fb2709c690f213272</appId>
          <subid>A1102X755X0048018792-00-0-XCPT-GXI</subid>
          <callId>9f1ffdf1273511e7a80d000c29779dd9</callId>
          <telA>18612345678</telA>
          <telB>0</telB>
          <telX>18612345678</telX>
          <startTimeCaller>20170911145109</startTimeCaller>
          <startTimeCallee>20170911145113</startTimeCallee>
          <endTime>20170422163810</endTime>
          <duration>0</duration>
          <callFrom>0</callFrom>
          <releasedir>1</releasedir>
          <byeType>16</byeType>
          <dateCreated>20161106190844</dateCreated>
          <userData>AA,BB,CC</userData>
          <recordUrl>http://xxx.xx/download/record1</recordUrl>
      </req>
                            

用户AS响应包头

属性 类型 约束 说明 举例
Status-Code String 必选 应答状态码,全部为200 HTTP/1.1 200 OK
Date String 可选 服务器时间 Wed Nov 9 16:08:57 2011
Content-Length String 必选 消息体的长度 140

用户AS响应包体

属性 类型 约束 描述 取值
statusCode String 必选 响应结果 用户返回错误码 0000表示成功,目前平台不对此字段进行解析
statusMsg String 可选 响应结果描述 用户自定义描述,目前平台不对此字段进行解析

用户AS响应示例

XML响应示例
      POST
      <?xml version='1.0' encoding='utf-8'?>
      <Response>
          <statusCode>0000</statusCode>
          <statusMsg>Success</statusMsg>
      </Response>
                            

虚拟小号回调接口...

回调通知AS接口入...

虚拟小号呼叫挂机...


在线客服

在线语音

点击呼叫

音频设备正常
点击"呼叫"立即接通客服
麦克风设备未准备好
请检查设备后再点击"呼叫"
音频设备未准备好
请检查设备后再点击"呼叫"
呼叫中……
请耐心等待
00:00
通话中
通话已结束
时长: 00:00
通话未接通
非常抱歉!客服未能接通。请再次呼叫或在官网下方留下您的联系方式,我们将尽快与您沟通。

电话咨询
0755-33548988

回到顶部