咨询热线:0755-33548988
语音通知下发接口
1.语音通知下发接口介绍

标准语音通知为通过语音外呼的方式,将通知信息下发到终端手机。

2.请求地址

  /{softVersion}/Accounts/{accountSid}/VoiceNotify/request

REST API是通过HTTPS POST方式请求。

4.请求包体
属性 类型 约束 说明
appId String 必选 应用ID
voiceRecId String 必选 语音通知模板ID
dtmfFlag int 可选 0为关闭,不接受反馈;1为开启,接受反馈码。缺省0
orderFlag int 可选 0为关闭,1为启用,缺省为0关闭
orderTime String 可选 定时下发开关开启有效。传入格式yyyy/MM/dd HH:mm:ss,精确到秒即可
moduleParams String 可选 模板中包含参数,即按顺序传入,可传入多个参数,参数间用逗号隔开。单个参数不超过20个字符,下发内容总长度不超过300个字符
toList String 必选 被叫电话号码列表,列表上限1000,目前支持手机及固定电话(固话需带区号)
displayNum String 可选 不传入则强显,传入号码必须审核通过,若未通过则不可使用
playTimes String 可选 试呼次数,不传默认3次,可传1、2、或3
audioRepeat String 可选 播放次数,不传默认2次,可传1、2、或3

参数说明:

(1).appId:应用ID
(2).voiceRecId:语音通知模板ID
(3).dtmfFlag:0为关闭,不接受反馈;1为开启,接受反馈码。缺省0
(4).orderFlag:0为关闭,1为启用,缺省为0关闭
(5).orderTime:定时下发开关开启有效。传入格式yyyy/MM/ddHH:mm:ss,精确到秒即可
(6).moduleParams:模板中包含参数,即按顺序传入,可传入多个参数,参数间用逗号隔开。单个参数不超过20个字符,下发内容总长度不超过300个字符
(7).toList:被叫电话号码列表,列表上线1000,目前支持手机及固定电话(固话需带区号)
(8).displayNum:不传入则强显,传入号码必须审核通过,若未通过则不可使用

请求示例

JSON请求示例
      POST
      /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/VoiceNotify/request?sig=
      6949C5F977B304EC5BB969FD8838D345HTTP/1.1
      Host:127.0.0.1:9080
      content-length: 272
      Accept: application/json;
      Content-Type: application/json;charset=utf-8;
      Authorization: Nzk4YjllYzBlYWE5NDE0Mjg1MjYwMmM0AAI1NzAxNDY6MjAxNjAzMjQxNTE3MDE=
      {
         "req": {
           "appId":"7290fa01293c483fb2709c690f213272",
           "voiceRecId":"100003",
           "dtmfFlag":"1",
           "orderFlag":"0",
           "orderTime":"2016/10/11 17:40:00",
           "moduleParams":"dukai,2022年1月1日",
           "toList":["13410240093","18617069177","18617069177","4008006013"],
           "displayNum":"4008006013",
           "audioRepeat":"3",
           "playTimes":"1"
         }
      }
                            
XML请求示例
      POST
      /2016-01-01/Accounts/798b9ec0eaa94142852aa2c402570146/VoiceNotify/request?sig=
      230AB7B77C951C9DB5FECD55B3AFB3CFHTTP/1.1
      Host:127.0.0.1:9080
      content-length: 357
      Accept: application/xml;
      Content-Type: application/xml;charset=utf-8;
      Authorization: Nzk4YjllYzBlYWE5NDE0Mjg1MjYwMmMAADI1NzAxNDY6MjAxNjAzMjQxNjA2MjI=
      <?xml version='1.0' encoding='utf-8'?>
      <req>
          <appId>7290fa01293c483fb2709c690f213272</appId>
          <voiceRecId>100003</voiceRecId>
          <dtmfFlag>1</dtmfFlag>
          <orderFlag>0</orderFlag>
          <orderTime>2016/10/09 10:25:00</orderTime>
          <moduleParams>dukai</moduleParams>
          <toList>[13410240093,18617069177,18617069177,18617069177]</toList>
          <displayNum>18312345678</displayNum>
          <audioRepeat>3</audioRepeat>
          <playTimes>1</playTimes>
      </req>
                            
5.响应包体
属性 类型 约束 说明
statusCode String 必选 请求状态码,取值000000(成功),可参考 Rest 错误代码
dateCreated String 必选 响应时间:格式"yyyy/MM/dd HH:mm:ss"。如:2016/01/01 12:00:00
requestId String 可选 一个由32个字符组成的电话唯一标识符,请求成功返回,请求失败不返回
represent String 可选 错误描述,报错时返回,正常时不返回

响应示例

JSON响应示例
      HTTP/1.1 200 OK 
      Content-Length: 126
      {
        "resp": {
          "statusCode": "000000",
          "dateCreated": "2016/03/24 15:36:52",
          "requestId": "0a680be886ae48a5b5fc84dad00cba9e"
      }
      }
                            
XML响应示例
      HTTP/1.1 200 OK 
      Content-Length: 197
      <?xml version='1.0'?>
      <resp>
          <statusCode>000000</statusCode>
          <dateCreated>2016/03/24 16:12:44</dateCreated>
          <requestId>0a680be886ae48a5b5fc84dad00cba9e</requestId>
      </resp>
                            

1 语音通知下发...

2 请求地址

3 请求包头

4 请求包体

5 响应包体


在线客服

在线语音

点击呼叫

音频设备正常
点击"呼叫"立即接通客服
麦克风设备未准备好
请检查设备后再点击"呼叫"
音频设备未准备好
请检查设备后再点击"呼叫"
呼叫中……
请耐心等待
00:00
通话中
通话已结束
时长: 00:00
通话未接通
非常抱歉!客服未能接通。请再次呼叫或在官网下方留下您的联系方式,我们将尽快与您沟通。

电话咨询
0755-33548988

回到顶部