概述
向指定手机号码发送指定内容的语音通知,通知内容包括事先录制好的语音内容(录音文件),以及日期时间、货币金额、数字、数字串等限定类型的文本内容。
发送通知接口(REST API)
请求
请求URL
/Accounts/{AccountSid}/VoiceNotices
请求包头
HTTP标准包头字段
Accept: application/json
Content-Type: application/json;charset=utf-8
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
请求消息示例
POST /Accounts/abcdefghijklmnopqrstuvwxyz012345/VoiceNotices HTTP/1.1
Host: xxx.xxx.xxx.xxx:xxxx
Content-Length: 100
Accept: application/json
Content-Type: application/json;charset=utf-8
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"appid": "11111111111111111111111111111111","from":"01080001001","to":"13800100001","contents":[{"type":"voice","content":"prompt1.wav"},{"type":"digits","content":"123"},{"type":"voice","content":"prompt1.wav"}],"finishkey":"1","repeatkey":"2","finishvoice":"prompt3.wav"}
易读版
{
"appid": "11111111111111111111111111111111",
"from":"01080001001",
"to":"13800100001",
"contents":[
{
"type":"voice",
"content":"prompt1.wav"
},
{
"type":"digits",
"content":"123"
},
{
"type":"voice",
"content":"prompt2.wav"
}
],
"finishkey":"1",
"repeatkey":"2",
"finishvoice":"prompt3.wav"
}
鉴权采用Basic Authorization。在请求包头携带Authorization信息。计算方法:
"Basic " + Base64({AccountSid}+":"+{AccountToken})
参数需要 URLENCODE,编码方式采用UTF-8
名称 | 约束 | 描述 |
appid | 必须 | 用户登录云通信平台后,所创建的应用的编号appid, |
to | 必须 | 目的电话号码。可以是手机或直线固话,固话前要加区号 |
from | 可选 | 被叫收到的来显号码 |
contents | 必须 | JSON格式,由type,content属性值对构成的数组。 若传递了finishkey或repeatkey参数,在最后一个content时会接收一个按键。 详见type属性值说明。 |
userdata | 可选 | 用户自定义数据,在话单中返回。 |
times | 可选 | 播放次数,默认2次,最多3次 |
finishkey | 可选 | 确认键,"any" 任意键。优先于repeatkey。 |
repeatkey | 可选 | 重播键,"any" 任意键。 |
finishvoice | 可选 | 用户按确认键之后播放的语音文件名 |
contents:type属性取值说明
type取值 | 对应内容 | 举例 |
"voice" | 语音文件名 | "hello.wav" |
"time" | 日期时间,格式YYYY-MM-DD | "2013-07-30" |
"money" | 货币金额 | "2.14" |
"number" | 数 | "112" |
"digits" | 字串 | "112" |
响应
正常
HTTP/1.1 200 OK
Content-Length: 100
{ "statuscode":"0","statusmsg":"succ","requestid":"RQ10000201901010101010100000000001","callid":"CA10000201901010101010100000000001"}
异常
HTTP/1.1 200 OK
Content-Length: 100
{"statuscode":"-4","statusmsg":"missing contents","requestid":"RQ10000201901010101010100000000002"}
响应参数说明
名称 | 示例值 | 描述 |
requestid | RQ10000201901010101010100000000001 | 请求唯一标识 |
statuscode | 0 | 发送结果错误码 |
statusmsg | succ | 发送结果状态描述 |
callid | CA10000201901010101010100000000001 | 呼叫唯一标识(发起呼叫后返回)可选 |
statuscode说明
statuscode取值 | 说明 |
0 | 请求成功 |
-1 | 鉴权失败 |
-2 | JSON解析失败 |
-3 | appid错误 |
-4 | 参数错误 |
-5 | 发起呼叫失败 |
-6 | 发起呼叫失败 |