语音通知
xunzhong.templateNoticeCall向指定手机号码发送固定模板的语音通知,模板内可设置部分变量或者一段事先录制好的wav录音文件。
优先必读
1 | 用户账户Id(accountSID)和用户账户授权令牌(authToken)在哪获取? |
提示 |
用户登录平台,在导航菜单管理-控制台-开发者主账号下面 或用户登录平台,在导航菜单管理-体验-功能体验-账号信息下面。(两种获取到账户信息是一样的) |
2 | 应用ID在哪获取? |
提示 |
1.如果使用沙箱环境 http://sandbox.ytx.net ,用户登录平台,在导航菜单管理-体验-功能体验-测试应用下面。 2.如果使用正式环境 http://api.ytx.net ,用户登录平台,在导航菜单管理-应用管理-应用列表下,若没有应用,需要创建应用。(注:应用上线后,应用ID才有效) |
3 | 状态回推的相关设置? |
提示 |
(注:沙箱环境 http://sandbox.ytx.net ,没有相关设置) 在使用正式环境 http://api.ytx.net 下,用户登录平台,在导航菜单管理-应用管理-创建应用-设置相应的回调地址。 |
4 | IP鉴权地址的相关配置? |
提示 |
(注:沙箱环境 http://sandbox.ytx.net ,没有相关设置) 在使用正式环境 http://api.ytx.net 下,用户登录平台,在导航菜单管理-应用管理-创建应用-设置相应的IP白名单。 (注:如测试使用ip白名单,切记将测试主机ip加入到白名单中) 有需要对用户接口发送的服务器进行ip限制,就可以使用ip鉴权进行配置。多个ip使用英文,号分隔。配置空表示不鉴权。 |
5 | 签名sign的加密格式是什么? |
提示 | MD5加密(账户Id + 账户授权令牌 +时间戳),例如:Sign=AAABBBCCCDDDEEEFFFGGG *时间戳需与Authorization中时间戳相同(时间戳格式:yyyyMMddHHmmss) 注:MD5加密32位,无论大小写 |
6 | 应用验证失败原因(-205)与解决办法? |
提示 |
1.应用ID与环境不匹配: ①体验里应用ID与沙箱环境 http://sandbox.ytx.net 使用 ②自己创建的应用的应用ID与正式环境 http://api.ytx.net 使用 2.设置ip白名单: ①去掉白名单在测试 ②将测试主机ip加入到白名单中 3.应用未开通相应的功能或应用没有上线。 |
公共参数
请求地址:
环境 | HTTP请求地址 |
正式环境 | http://api.ytx.net |
沙箱环境 | http://sandbox.ytx.net |
公共请求参数:
名称 | 类型 | 是否必须 | 描述 |
accountSID | string | 是 | 云通信平台用户账户Id:对应管理控制台中的 ACCOUNT SID |
authToken | string | 是 | 云通信平台用户账户授权令牌:对应管理控制台中的 AUTH TOKEN |
version | string | 是 | 云通信API接口版本 目前可选版本:201512 |
func | string | 是 | 功能所属分类call【语音类】/sms【消息类】/traffic【流量类】/account【账户类】 当前功能属:call |
funcURL | string | 是 | 业务功能的各类具体操作分支 当前功能属:NoticeCall.wx |
Authorization | string | 是 | 云通信平台API接口,包头验证信息:base64加密(账户Id + "|" + 时间戳) 说明:时间戳有效时间为24小时 格式"yyyyMMddHHmmss",如:20140416142030 |
Sign | string | 是 | 云通信平台API接口,API 验证参数 :MD5加密(账户Id + 账户授权令牌 +时间戳) *URL后必须带有Sign参数,例如:Sign=AAABBBCCCDDDEEEFFFGGG *时间戳需与Authorization中时间戳相同 注:MD5加密32位,无论大小写 |
请求参数:
名称 | 类型 | 是否必须 | 描述 |
action | string | 是 | API接口名称,默认值:templateNoticeCall(区分大小写) |
appid | string | 是 | 用户登录云通信平台后,所创建的应用的编号appid,若想调用当前模板短信接口,则此应用必须包含有模板短信功能,否则调用失败。 |
dst | string | 是 | 接收语音通知的手机号,只能是单个直线固话或手机,固话前要加区号(例:153****2082或者01085485069) |
dstclid | string | 是 | 被叫收到的来显号码。号码定制联系客服。该参数值因为线路资源变化较大,需要做成可配置形式。 |
templateId | long | 是 | 所采用的模板编号templateId,使用事先编辑好、已通过平台审核的模板,可以加快你接入的速度 |
datas | string[] | 是 | 若所采用的模板中有{1}等占位符,该字符串数组的元素分别填充模板占位符 详细说明请看下面报文示例关于模板templateId为9的例子 |
time | string | 否 | 播放次数,默认2次,最多3次 |
playSpeed | string | 否 | 播放速度1-9,默认为5 |
letterlink | string | 否 | 字母是否连读 0:字母连读,数字读中文,1:字母连读,数字读英文,2:字母分开读,数字读中文 |
digitallink | string | 否 | 数字是否连读 0:数字分开读 1:数字连读 |
iscallstatuscheck | string | 否 | 是否启用通话识别 0:否 ,1:是 |
isdtmfcallback | string | 否 | 是否启用按键回调 0:否 ,1:是 |
响应参数:
名称 | 类型 | 示例值 | 描述 |
statusCode | string | 0 | 发送结果错误码 |
statusMsg | string | 提交成功 | 发送结果状态描述 |
requestId | string | 2016010000000219 | 为验证码发送成功后返回的requestId唯一标识 |
请求包头:
1 | URL |
2 | /{version}/sid/{accountSID}/{func}/{funcURL}?Sign={Sign} |
3 | HTTP标准包头字段 |
4 | Accept:application/json; |
5 | Content-Type:application/json;charset=utf-8; |
6 | Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
报文示例:
JSON提示:
1 | POST /201512/sid/abcdefghijklmnopqrstuvwxyz012345/call/NoticeCall.wx?Sign=C1F20E7A9733CE94F680 C70A1DBABCDE HTTP/1.1 |
2 | Host:127.0.0.1:46376 |
3 | content-length: 142 |
4 | Accept:application/json; |
5 | Content-Type:application/json;charset=utf-8; |
6 | Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3M jAwN2M6MjAxMzAyMDExNTABCDE= |
7 | {"action":"templateNoticeCall","dst":"13911281234","appid": "ff8080813fc70a7b013fc72312324213","templateId":"9","datas":["当前时间","流量大小"]} |
请求示例:
.Net
1 | string jsonData= "{\"action\":\"templateNoticeCall\",\"dst\":\"13911281234\", |
2 | \"appid\":\"3215ad6a7d0247ae8b39728b854fa59c\",\"templateId\":\"9\",\"datas\":[\"替换内容\", \"替换内容\"]}"; |
3 | string url = "/call/NoticeCall.wx"; |
4 | string result = CommenHelper.SendRequest(url, jsonData); |
5 | 备注: SendRequest方法在CommenHelper.cs文件里做了封装,详细介绍请点击这里完整demo示例,下载。 |
响应示例
JSON示例
1 | HTTP/1.1 200 OK |
2 | Content-Length: 85 |
3 | { "statusCode":"0","statusMsg":"提交成功","requestId":"2016010000000205"} |
异常示例
JSON示例
1 | HTTP/1.1 200 OK |
2 | Content-Length: 61 |
3 | {"statusCode":"-2","statusMsg":"缺少必要参数","requestId":""} |