IVR外呼

REST API: IVR外呼


  • 通过HTTPS POST方式提交请求,云通讯平台收到请求后,向对象电话终端发起呼叫,接通电话后播放指定语音。

  • 接口Demo示例可在REST Server Demo中找到,开发者可根据使用的语言下载对应的Demo

1、请求

1.1 请求地址

  • /{SoftVersion}/Accounts/{accountSid}/ivr/dial
  •                                         

1.2 请求包头


  • 请参阅:Rest 介绍》统一请求包头,使用主账户进行验证

1.3 请求包体

属性类型约束说明
Appid
String必选应用Id
number
String必选待呼叫号码,为Dial节点的属性
userdataString
可选用户数据,需要base64加密,在<startservice>通知中返回,为Dial节点的属性
record
String
可选
是否录音,可填项为true和false,默认值为false不录音,为Dial节点的属性
disnumber
String
可选
用户方的显号号码,根据平台侧显号规则控制。

  • 注意:显号设置需要云平台开放相关权限,如需开通请联系云通讯商务人员或拨打400-610-1019

1.4 请求示例

  • POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/dial?sig=155EAA68C5DFB6B762A42D88F406ABCD 
  • HTTP/1.1
  • Accept:application/xml;
  • Host:192.168.0.1:8883
  • content-length: 139
  • Content-Type:application/xml;
  • charset=utf-8;
  • Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=

  • <?xml version="1.0" encoding="UTF-8"?>
  • <Request>
  •   <Appid>12345678</Appid>
  •   <Dial number="13812345678" userdata="1" record="true"></Dial>
  • </Request>

  •                                         

2、响应

2.1 响应包体

属性类型约束说明
statusCodeString必选请求状态码,000000为成功,其他错误码则为失败,错误码可参考Rest 错误代码
callSidString必选一个由32个字符组成的通话唯一标识符,需要应用侧进行保存以便提供给云通讯的技术支持进行相关问题的查询,云通讯根据这唯一标识符进行快速的问题定位,以便能更快的解决问题。

2.2 响应示例

  • HTTP/1.1 200 OK
  • Content-Length:586

  • <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  • <Response>
  •   <statusCode>000000</statusCode>
  •   <callSid>a346467ca321c71dbd5e12f627123456</callSid>  
  • </Response>
  •