语音通知

语音通知是云通讯平台提供的一种语音通话能力,通过此REST API可以方便的对您的客户进行外呼放音服务。并通过请求时传入的外呼通知状态通知回调地址进行呼叫状态回调。

REST API: 语音通知

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

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

1、请求

1.1 请求地址

/{SoftVersion}/Accounts/{accountSid}/Calls/LandingCalls/
					

1.2 请求包头

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

1.3 请求包体

属性
类型 约束 说明
appId
String
必选
应用id
to
String
必选
被叫号码,被叫为座机时需要添加区号,如:01052823298;被叫为分机时分机号由‘-’隔开,如:01052823298-3627
mediaName
String
可选
语音文件名称,格式 wav,播放多个文件用英文分号隔开。与mediaTxt不能同时为空。当不为空时mediaTxt属性失效。测试用默认语音:ccp_marketingcall.wav
mediaNameType

String
可选
语音文件名的类型,默认值为0,表示用户语音文件; 值为1表示平台通用文件。
此为json参数,在xml时为属性type值
mediaTxt
String
可选
文本内容,文本中汉字要求utf8编码,默认值为空。当mediaName为空才有效。
displayNum
String
可选
来电显示的号码,根据平台侧显号规则控制(有显号需求请联系云通讯商务,并且说明显号的方式),不在平台规则内或空则显示云通讯平台默认号码。默认值空。注:来电显示的号码不能和呼叫的号码相同,否则显示云通讯平台默认号码。
playTimes
String
可选
循环播放次数,1-3次,默认播放1次。
respUrl
String
可选
外呼通知状态通知回调地址(必须符合URL规范),云通讯平台将向该Url地址发送呼叫结果通知。
userData
String
可选
第三方私有数据,可在外呼通知状态通知中获取此参数。
txtSpeed
String
可选
文本转语音后的发音速度,取值范围:-500至500,当mediaTxt有效才生效,默认值为0。
txtVolume
String
可选
文本转语音后的音量大小,取值范围:-20至20,当mediaTxt有效才生效,默认值为0。
txtPitch
String
可选
文本转语音后的音调,取值范围:-500至500,当mediaTxt有效才生效,默认值为0。
txtBgsound
String
可选
文本转语音后的背景音编号,目前云通讯平台支持6种背景音,1到6的六种背景音编码,0为不需要背景音。暂时不支持第三方自定义背景音。当mediaTxt有效才生效。
playMode
String
可选
是否同时播放文本和语音文件 , 0、否 1、是,默认0。优先播放文本。

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

1.4 XML请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/LandingCalls?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
<?xml version="1.0" encoding="utf-8"?>
<LandingCall>         
  <appId>11112222333344445555666677778888</appId>
   <to>008613912345678</to>  
  <mediaName>1.wav;2.wav</mediaName>
  <displayNum>13131313131</displayNum>
</LandingCall>

					

1.5 JSON请求示例

POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/LandingCalls?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 
{"mediaName":"1.wav","to":"01052821234","appId":"111122222333333444444","displayNum":"13912345678"}

					

2、响应

2.1 响应包体

属性 类型 约束 说明
statusCode
String
必选
请求状态码,000000为成功,其他错误码则为失败,错误码可参考Rest 错误代码
callSid
String
必选
一个由32个字符组成的通话唯一标识符,需要应用侧进行保存以便提供给云通讯的技术支持进行相关问题的查询,云通讯根据这唯一标识符进行快速的问题定位,以便能更快的解决问题。
dateCreated
String
必选
电话的创建时间,时间格式为2013-02-01 15:53:06。
orderid
String
可选
话单id

2.2 XML请求示例

HTTP/1.1 200 OK 
Content-Length: 641 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
  <statusCode>000000</statusCode>
  <LandingCall>
    <callSid>a346467ca321c71dbd5e12f627123456</callSid>
    <dateCreated>2013-02-01 15:38:09</dateCreated>
  </LandingCall>
</Response>
					

2.3 JSON请求示例

HTTP/1.1 200 OK 
Content-Length: 641 

{"statusCode":"000000","LandingCall":{"dateCreated":"2013-02-01 15:53:06","callSid":" ff8080813c373cab013c94be9fe300c5"}}

				

文档更新时间:2016年10月21日