预约使用
即接即用,玖云平台为您提供稳定的通信能力
开发者账户使用使用指南
开放接口使用指南
平台审核标准
平台服务标准
Rest API接口介绍
取消通话接口
通话记录查询接口
录音及下载接口
专线语音接口
专号通接口
专号通号码申请接口
专号通号码查询接口
专号通号码释放接口
应用映射号码查询接口
语音通知下发接口
取消预约语音通知接口
语音通知记录查询接口
语音验证码接口
智能语音验证接口
订单小号绑定接口
订单小号解绑接口
订单小号查询接口
订单小号话单查询接口
虚拟小号绑定接口
虚拟小号解绑接口
虚拟小号查询接口
虚拟小号在线呼叫接口
虚拟小号话单查询接口
工作号被叫绑定接口
云呼小号在线呼叫接口
批量上传号码接口
手机专号通绑定接口
手机专号通解绑接口
手机专号通更新接口
手机专号通查询接口
手机专号通双呼接口
云话机回拨接口
SDK产品简介
SDK集成指南
来电推送配置指南
Web
Android
Ios
更多
常见问题
专线语音回调通知接口
专号通回调通知接口
语音通知状态回调接口
语音验证码回调接口
智能语音验证回调接口
订单小号状态回调接口
虚拟小号状态回调接口
云呼小号状态回调
AI智能语音回调接口
语音回呼回调接口
手机专号通回调接口
云双呼回调接口
云呼AXB回调接口
云话机回调通知接口
全局错误码表
接入流程
(1).创建应用并配置用户的AS服务器地址即回调地址
(2).用户AS服务器端开发相应接口
(3).开始使用
请求地址配置
请求地址为开发者服务器地址,具体配置方式如下:
此接口用于呼叫断开的时候,平台通知用户应用服务器。包括正常断开以及异常断开情况。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供XML格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/xml |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| action | String | 必选 | 请求类型 | Hangup |
| type | int | 必选 | 呼叫类型 | 10:小号业务 |
| appId | String | 必选 | 应用ID | |
| caller | String | 必选 | 主叫号码 | type取值为1,2时,主叫号码为电话号码 |
| called | String | 必选 | 被叫号码 | type取值为1,2时,被叫号码为电话号码 |
| telX | String | 必选 | 主被叫绑定的小号 | |
| startTimeA | String | 必选 | 主叫发起时间 | YYYYMMDDHH24MISS 20130212000256 |
| startTimeB | String | 可选 | 被叫接听时间,未接通话单可能为空 | YYYYMMDDHH24MISS 20130212000256 |
| endTime | String | 必选 | 通话结束时间 | YYYYMMDDHH24MISS |
| duration | String | 必选 | 通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0 | 单位:秒 |
| callId | String | 必选 | 呼叫的唯一标示 | 32位字符串 |
| userFlag | int | 必选 | 本次通话挂机的方向 | 0:平台释放,1:主叫释放,2:被叫释放 |
| byeType | String | 必选 | 通话挂机类型 |
包含正常挂机以及异常挂机类型。 1 未分配的号码 2 无路由到指定的转接网 3 无路由到目的地 4 发送专用信息音 5 主叫提前挂机 6 无绑定关系 7 发送专用信息音 8 中间号状态异常 9 呼叫转移 10 平台系统异常 11 关机 12 停机 14 空号 16 正常的呼叫拆线 17 用户忙 18 用户未响应 19 用户未应答 20 用户缺席 21 呼叫拒收 22 号码改变 27 目的地不可达 28 无效的号码格式(地址不全) 29 性能拒绝 31 正常—未指定类别 34 无电路/通路可用 42 交换设备拥塞 50 所请求的性能未预定 53 CUG 中限制去编号 55 CUG 中限制来呼叫 57 承载能力无权 58 承载能力目前不可用 65 承载能力未实现 69 所请求的性能未实现 87 被叫用户不是CUG 的成员 88 不兼容的目的地 90 不存在的CUG 91 无效的转接网选择 95 无效的消息 97 消息类型不存在或未实现 99 参数不存在或未实现 102定时器终了时恢复 103参数不存在或未实现—传递 110消息带有未被识别的参数—舍弃 111协议错误 127互通,未指定 202用户忙,MSRN获取失败,平台挂机 203用户去活,平台挂机 204用户在平台侧关机,平台挂机 205平台拦截 206禁呼时段内呼叫 207超过呼叫次数限制 208实名认证拦截 |
| dateCreated | String | 必选 | 请求时间 | 回调用户的时间 |
| userData | String | 可选 | 用户数据 | 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户 |
| recordUrl | String | 可选 | 录音回调地址 | URL格式,未开启录音,则为空,录音下载有延时 |
| subid | String | 可选 | 订单小号绑定时生成的唯一ID |
参数说明:
(1).action:请求类型
(2).type:呼叫类型
(3).appId:应用ID
(4).caller:主叫号码
(5).called:被叫号码
(6).telX: 主被叫绑定的小号
(7).startTimeA:主叫发起时间
(8).startTimeB:被叫接听时间
(9).endTime:通话结束时间
(10).duration:通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0
(11).callId:呼叫的唯一标示
(12).userFlag: 本次通话挂机的方向
(13).byeType:通话挂机类型
(14).dateCreated:请求时间
(15).userData:用户回调REST接口中传入的数据
(16).recordUrl:录音回调地址
(17).subid:订单小号绑定时生成的唯一ID
回调请求示例
XML请求示例
POST
<?xml version='1.0'?>
<req>
<action>Hangup</action>
<type>10</type>
<appId>7290fa01293c483fb2709c690f213272</appId>
<caller>18612345678</caller>
<called>18676543212</called>
<telX>null</telX>
<startTimeA>20170422163700</startTimeA>
<startTimeB>20170422163710</startTimeB>
<endTime>20170422163810</endTime>
<duration>60</duration>
<callId>9f1ffdf1273511e7a80d000c29779dd9</callId>
<userFlag>0</userFlag>
<byeType>0</byeType>
<dateCreated>20161106190844</dateCreated>
<userData>AA,BB,CC</userData>
<recordUrl>http://xxx.xx/download/record1</recordUrl>
<subid>A1102X755X0048018792-00-0-XCPT-GXI</subid>
</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>
1
2
3