咨询热线:0755-33548988
云话机回调接口
1.云话机回调接口介绍

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

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

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

接入流程

 流程图

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

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

(3).开始使用

请求地址配置

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

地址配置图

3.云话机呼叫发起通知接口

此接口用于呼叫发起时,平台通知用户AS服务器。平台呼叫A路及B路时会分别发出通知。

回调请求地址

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

回调请求包头

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

回调请求包体

属性 类型 约束 描述 取值
action String 必选 请求类型 CallInvite
type int 必选 呼叫类型 7:SipPhone回拨
appId String 必选 应用ID 应用ID
caller String 必选 主叫号码 type取值为7时,主叫号码为Sipphone号码
called String 必选 被叫号码 type取值为7时,被叫号码为Sipphone、固话、手机号码
userFlag String 必选 A,B路标识 0标识A路(主叫),1标识B路(被叫)
subType String 必选 外呼显号标示 0:不显号 1:显号
callId String 必选 呼叫的唯一标示 32位字符串
dateCreated String 必选 请求时间 回调用户的时间
userData String 可选 用户数据 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户,否则为空

参数说明:

1)action:请求类型
2)type:呼叫类型
3)appId:应用ID
4)caller:主叫号码
5)called:被叫号码
6)userFlag: A,B路标识
7)subType:外呼显号标示
8)callId:呼叫的唯一标示
9)dateCreated:请求时间
10)userData:用户回调REST接口中传入的数据

回调请求示例

XML请求示例
      POST
      <?xml version='1.0'?>
      <req>
          <action>CallInvite</action>
          <type>7</type>
          <appId>7290fa01293c483fb2709c690f213272</appId>
          <caller>075577123456</caller>
          <called>18612345678</called>
          <userFlag>0</userFlag&g
          <subType>1</subType>
          <callId>9f1ffdf1273511e7a80d000c29779dd9</callId&g
          <dateCreated>20161106190844</dateCreated>
          <userData>AA,BB,CC</userData>
      </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>
                            
4.云话机呼叫建立通知接口

此接口用于B路(被叫)接听后,通话建立成功时。平台通知用户AS服务器呼叫已经建立。

回调请求地址

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

回调请求包头

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

回调请求包体

属性 类型 约束 描述 取值
action String 必选 请求类型 CallEstablish
type int 必选 呼叫类型 13:云呼小号业务
appId String 必选 应用ID 应用ID
caller String 必选 主叫号码 type取值为7时,主叫号码为Sipphone号码
called String 必选 被叫号码 type取值为7时,被叫号码为Sipphone、固话、手机号码
userFlag String 必选 A,B路标识 0标识A路(主叫),1标识B路(被叫)
subType String 必选 外呼显号标示 0:不显号 1:显号
callId String 必选 呼叫的唯一标示 32位字符串
dateCreated String 必选 请求时间 回调用户的时间
userData String 可选 用户数据 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户,否则为空

参数说明:

1)action:请求类型
2)type:呼叫类型
3)appId:应用ID
4)caller:主叫号码
5)called:被叫号码
6)subType:外呼显号标示
7)callId:呼叫的唯一标示
8)dateCreated:请求时间
9)userData:用户回调REST接口中传入的数据

回调请求示例

XML请求示例
      POST
      <?xml version='1.0'?>
      <req>
          <action>CallInvite</action>
          <type>7</type>
          <appId>7290fa01293c483fb2709c690f213272</appId>
          <caller>075577123456</caller>
          <called>18612345678</called>
          <subType>1</subType>
          <callId>9f1ffdf1273511e7a80d000c29779dd9</callId>
          <dateCreated>20161106190844</dateCreated>
          <userData>AA,BB,CC</userData>
      </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>
                            
5.云话机挂机通知接口

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

回调请求地址

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

回调请求包头

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

回调请求包体

属性 类型 约束 描述 取值
action String 必选 请求类型 Hangup
type int 必选 呼叫类型 7:回拨
8:直拨
9:回呼
appId String 必选 应用ID
callId String 必选 呼叫的唯一标示 32位字符串
caller String 可选 主叫号码
called String 可选 被叫号码
userFlag int 必选 主被叫标示 0标示主叫,1标示被叫
startTimeA String 可选 主叫接听时间,适用于回拨 YYYYMMDDHH24MISS 20130212000256
startTimeB String 可选 被叫接听时间,适用于回拨 YYYYMMDDHH24MISS 20130212000256
startTime String 可选 被叫接听时间,适用于直拨和回呼 YYYYMMDDHH24MISS 20130212000256
endTime String 必选 通话结束时间 YYYYMMDDHH24MISS
duration String 必选 通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0 单位:秒
subType String 可选 外呼显号标示,适用于回拨 0:不显号 1:一方显号 2:双方均显号(取值为2仅双向回拨时存在)
byeType String 必选 通话挂机类型 0:正常挂断
1:A无法接通
2:B无法接通
3:A目标忙
4:B目标忙
5: 通话达到最大时长
6:服务器错误
7:网络错误
255:其他错误
dateCreated String 必选 请求时间 回调用户的时间
userData String 可选 用户数据,适用于回拨 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户
recordUrl String 必选 录音回调地址 URL格式,未开启录音,则为空,录音下载有延时

参数说明:

1)action:请求类型
2)type:呼叫类型
3)appId:应用ID
4)callId:呼叫的唯一标示
5)caller:主叫号码
6)called:被叫号码
7)userFlag:主被叫标示
8)startTimeA:主叫接听时间,适用于回拨
9)startTimeB:被叫接听时间,适用于回拨
10)startTime:被叫接听时间,适用于直拨和回呼
11)endTime:通话结束时间
12)duration:通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0
13)subType:外呼显号标示,适用于回拨。0:不显号 1:一方显号 2:双方均显号(取值为2仅双向回拨时存在)
14)byeType:通话挂机类型
15)dateCreated:请求时间
16)userData:用户回调REST接口中传入的数据。适用于回拨
17)recordUrl:录音回调地址

回调请求示例

XML请求示例
      POST
      <?xml version='1.0'?>
      <req>
          <action>Hangup</action>
          <type>7</type>
          <appId>7290fa01293c483fb2709c690f213272</appId>
          <callId>9f1ffdf1273511e7a80d000c29779dd9</callId>
          <caller>075577123456</caller>
          <called>075577654321</called>
          <startTimeA>20170911145109</startTimeA>
          <startTimeB>20170911145113</startTimeB>
          <endTime>20170422163810</endTime>
          <duration>0</duration>
          <byeType>2</byeType>
          <subType>2</subType>
          <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

回到顶部