预约使用
即接即用,玖云平台为您提供稳定的通信能力
开发者账户使用使用指南
开放接口使用指南
平台审核标准
平台服务标准
Rest API接口介绍
取消通话接口
通话记录查询接口
录音及下载接口
专线语音接口
专号通接口
专号通号码申请接口
专号通号码查询接口
专号通号码释放接口
应用映射号码查询接口
语音通知下发接口
取消预约语音通知接口
语音通知记录查询接口
语音验证码接口
智能语音验证接口
订单小号绑定接口
订单小号解绑接口
订单小号查询接口
订单小号话单查询接口
虚拟小号绑定接口
虚拟小号解绑接口
虚拟小号查询接口
虚拟小号在线呼叫接口
虚拟小号话单查询接口
工作号被叫绑定接口
云呼小号在线呼叫接口
批量上传号码接口
手机专号通绑定接口
手机专号通解绑接口
手机专号通更新接口
手机专号通查询接口
手机专号通双呼接口
云话机回拨接口
SDK产品简介
SDK集成指南
来电推送配置指南
Web
Android
Ios
更多
常见问题
专线语音回调通知接口
专号通回调通知接口
语音通知状态回调接口
语音验证码回调接口
智能语音验证回调接口
订单小号状态回调接口
虚拟小号状态回调接口
云呼小号状态回调
AI智能语音回调接口
语音回呼回调接口
手机专号通回调接口
云双呼回调接口
云呼AXB回调接口
云话机回调通知接口
全局错误码表
接入流程
(1).创建应用并配置用户的AS服务器地址即回调地址
(2).用户AS服务器端开发相应接口
(3).开始使用
请求地址配置
请求地址为开发者服务器地址,具体配置方式如下:
此接口用于呼叫发起时,平台通知用户AS服务器。平台呼叫A路及B路时会分别发出通知。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供XML格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/xml |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| action | String | 必选 | 请求类型 | CallInvite |
| type | int | 必选 | 呼叫类型 | 13:云呼小号业务 |
| appId | String | 必选 | 应用ID | 应用ID |
| iSeatNo | String | 必选 | 业务员坐席号 | 业务员坐席号,8位数字。每个业务员有一个唯一坐席标识号,是系统内部唯一的号 |
| caller | String | 必选 | 主叫号码 | type取值为1时,主叫号码为电话号码 |
| called | String | 必选 | 被叫号码 | type取值为1时,被叫号码为电话号码 |
| 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)iSeatNo:业务员坐席号
5)caller:主叫号码
6)called:被叫号码
7)userFlag: A,B路标识
8)subType:外呼显号标示
9)callId:呼叫的唯一标示
10)dateCreated:请求时间
11)userData:用户回调REST接口中传入的数据
回调请求示例
XML请求示例
POST
<?xml version='1.0'?>
<req>
<action>CallInvite</action>
<type>13</type>
<appId>7290fa01293c483fb2709c690f213272</appId>
<iSeatNo>10010002</iSeatNo>
<caller>18676543210</caller>
<called>18612345678</called>
<userFlag>0</userFlag>
<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>
此接口用于B路(被叫)接听后,通话建立成功时。平台通知用户AS服务器呼叫已经建立。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供XML格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/xml |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| action | String | 必选 | 请求类型 | CallEstablish |
| type | int | 必选 | 呼叫类型 | 13:云呼小号业务 |
| appId | String | 必选 | 应用ID | 应用ID |
| iSeatNo | String | 必选 | 业务员坐席号 | 业务员坐席号,8位数字。每个业务员有一个唯一坐席标识号,是系统内部唯一的号 |
| caller | String | 必选 | 主叫号码 | type取值为1时,主叫号码为电话号码 |
| called | String | 必选 | 被叫号码 | type取值为1时,被叫号码为电话号码 |
| 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)iSeatNo:业务员坐席号
5)caller:主叫号码
6)called:被叫号码
7)subType:外呼显号标示
8)callId:呼叫的唯一标示
9)dateCreated:请求时间
10)userData:用户回调REST接口中传入的数据
回调请求示例
XML请求示例
POST
<?xml version='1.0'?>
<req>
<action>CallInvite</action>
<type>13</type>
<appId>7290fa01293c483fb2709c690f213272</appId>
<iSeatNo>10010002</iSeatNo>
<caller>18676543210</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>
此接口用于呼叫断开的时候,平台通知第三方应用服务器。包括正常断开以及异常断开情况。
回调请求地址
用户自行配置URL地址。通过POST方式请求通知用户,只提供XML格式。
回调请求包头
| 属性 | 类型 | 约束 | 说明 |
| Content-Type | String | 必选 | 类型application/xml |
| Content-Length | String | 必选 | 消息体的长度 |
回调请求包体
| 属性 | 类型 | 约束 | 描述 | 取值 |
| action | String | 必选 | 请求类型 | Hangup |
| type | int | 必选 | 呼叫类型 | 14:回拨 15:直拨 16:回呼 |
| appId | String | 必选 | 应用ID | |
| iSeatNo | String | 必选 | 业务员坐席号 | 业务员坐席号,8位数字。每个业务员有一个唯一坐席标识号,是系统内部唯一的号 |
| callId | String | 必选 | 呼叫的唯一标示 | 32位字符串 |
| telA | String | 可选 | 对回拨类型有效,主叫号码 | |
| telB | String | 可选 | 对回拨类型有效,被叫号码 | |
| telX | String | 必选 | 主被叫绑定的小号 | |
| caller | String | 可选 | 对直拨、回呼类型有效,主叫号码 | |
| called | String | 可选 | 对直拨、回呼类型有效,被叫号码 | |
| startTimeCaller | String | 可选 | 对回拨类型有效,主叫发起时间,主叫接通X的时间 | YYYYMMDDHH24MISS 20130212000256 |
| startTimeCallee | String | 可选 | 对回拨类型有效,被叫接听时间 | YYYYMMDDHH24MISS 20130212000256 |
| startTime | String | 可选 | 对直拨、回呼有效,通话开始时间 | YYYYMMDDHH24MISS 20130212000256 |
| endTime | String | 必选 | 通话结束时间 | YYYYMMDDHH24MISS |
| duration | String | 必选 | 通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0 | 单位:秒 |
| callFrom | String | 必选 | 本次通话发起的方向 | 0:A主叫,1:B主叫 |
| telY | String | 必选 | 业务员的包月中继固话号码 | 业务员的包月中继固话号码 |
| byeType | String | 必选 | 通话挂机类型 |
包含正常挂机以及异常挂机类型。 000 0001(1) 未分配的号码 000 0010(2) 无路由到指定的转接网 000 0011(3) 无路由到目的地 000 0100(4) 发送专用信息 音 000 0110(6) 服务器错误 001 0000(16) 正常的呼叫拆 线 001 0001(17) 用户忙 001 0010(18) 用户未响应 001 0011(19) 用户未应答 001 0100(20) 用户缺席 001 0101(21) 呼叫拒收 001 0110(22) 号码改变 001 1011(27) 目的地不可达 001 1100(28) 无效的号码格 式(地址不全) 001 1101(29) 性能拒绝 001 1111(31) 正常—未指定 类别010,资源不可用类: 010 0010(34) 无电路/通路可 用 010 1010(42) 交换设备拥塞 类别011 , 业务或任选不可用 类: 011 0010(50) 所请求的性能 未预定 011 0101(53) CUG 中限制去 编号: 接口说明书 Page 23 of 74 呼叫 011 0111(55) CUG 中限制来 呼叫 011 1001(57) 承载能力无权 011 1010(58) 承载能力目前 不可用 类别100 , 业务或任选未实现 类: 100 0001(65) 承载能力未实 现 100 0101(69) 所请求的性能 未实现 类别101,无效的消息(例如参 数超出范围)类: 101 0111(87) 被叫用户不是 CUG 的成员 101 1000(88) 不兼容的目的 地 101 1010(90) 不存在的CUG 101 1011(91) 无效的转接网 选择 101 1111(95) 无效的消息, 未指定 类别110,协议错误(例如未知 的消息)类: 110 0001(97) 消息类型不存 在或未实现 110 0011(99) 参数不存在或 未实现 110 0110(102)定时器终了时 恢复 110 0101(103)参数不存在或 未实现—传递 110 1110(110)消息带有未被 识别的参数—舍弃 110 1111(111)协议错误,未 指定 类别111,互通类: 111 1111(127)互通,未指定 类别1100 、1101 , 平台拒绝 类: 1100 1010(202)用户忙,MSRN 获取失败,平台挂机 1100 1011(203)用户去活,平 台挂机 1100 1100(204)用户在平台侧 关机,平台挂机 |
| dateCreated | String | 必选 | 请求时间 | 回调用户的时间 |
| userData | String | 可选 | 用户数据 | 用户自定义数据,最长可支持128字节。如用户在回拨REST请求接口中传入,则回调会将数据原样回调给客户 |
| recordUrl | String | 必选 | 录音回调地址 | URL格式,未开启录音,则为空,录音下载有延时 |
参数说明:
1)action:请求类型
2)type:呼叫类型
3)appId:应用ID
4)iSeatNo:业务员坐席号
5)telY:业务员的包月中继固话号码
6)callId:呼叫的唯一标示
7)telA: 对回拨类型有效,主叫号码
8)telB:对回拨类型有效,被叫号码
9)telX:业务员发起呼叫时绑定的小号X
10)caller:对直拨、回呼类型有效,主叫号码
11)called:对直拨、回呼类型有效,被叫号码
12)startTimeCaller:主叫发起时间,主叫接通X的时间
13)startTimeCallee:被叫接听时间
14)startTime:对直拨、回呼有效,通话开始时间
15)endTime:通话结束时间
16)duration:通话时长。回拨时,如被叫接听,通话建立,则为B路接听到结束的时间。如被叫未接听,则为0
17)callFrom:呼叫的唯一标示
18)byeType:通话挂机类型
19)dateCreated:请求时间
20)userData:用户回调REST接口中传入的数据
21)recordUrl:录音回调地址
回调请求示例
XML请求示例
POST
<?xml version='1.0'?>
<req>
<action>Hangup</action>
<type>14</type>
<appId>7290fa01293c483fb2709c690f213272</appId>
<iSeatNo>10010002</iSeatNo>
<callId>9f1ffdf1273511e7a80d000c29779dd9</callId>
<telA>18687654321</telA>
<telB>1860001234</telB>
<telX>18643210001</telX>
<telY>18612345678</telY>
<startTimeCaller>20170911145109</startTimeCaller>
<startTimeCallee>20170911145113</startTimeCallee>
<endTime>20170422163810</endTime>
<duration>0</duration>
<callFrom>0</callFrom>
<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>
1
2
3
4
5