发送语音IVR（CallIvr）

描述

给指定手机号发送语音通知，通过按键进行选择，播放不同的语音。

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

点击查看 公共参数列表详情

名称	类型	必须	长度限制	参数格式	描述	备注
Action	String	是	确定值	[a-zA-Z]+	操作接口名，系统规定参数，取值：CallIvr
Version	String	是	确定值		版本号，系统规定参数，取值：2020-05-01
Mobile	String	是		[0-9]+	仅支持中国大陆手机号: 11位数字，例如 1xxxxxxxxxx
Caller	String	否		[0-9]+	号显号码，被叫终端上显示的主叫号码
TplId	Int	是		[0-9]+	语音通知模板ID
TplParams	Json	是		{ “模板变量key”: “模板变量值” }	例如模板如下：你的验证码{code},有效期为五分钟。其中code是模块变量，则TplParams参数值格式为：{“code”:123456},如果你的模板没有变量，则该参数值为: {}	模板变量值长度限制为100，最终拼接后的内容长度限制180; 仅支持 中英文、数字、基本符号（不支持\n \b等转义字符）; 模板变量值中不可带url
ExtId	String	否	最多50个字符	[0-9a-zA-Z]+	客户自定义流水号，在状态报告中返回

返回结果

通过指定 Accept:application/json，返回的数据格式为json。

名称	类型	描述
CallId	String	语音消息记录唯一标识
ExtId	String	客户自定义流水号
RequestId	String	请求唯一标识

示例

1. 调用成功请求示例

curl -X POST \
  'http://voice.api.ksyun.com/' \
  -H 'Authorization: AWS4-HMAC-SHA256 xxx' \
  -H 'accept: application/json' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -H 'host: voice.api.ksyun.com' \
  -d 'Mobile=1xxxx&TplId=1xxx&Code=123456&Action=CallIvr&Version=2020-05-01&Signature=xxxx&SignatureVersion=1.0&Timestamp=2020-08-13T17:18:36Z&Service=voice&Accesskey=xxx'

2. 调用成功返回示例

{
    "CallId": "fbdad845962b1586960833",
    "ExtId": "",
    "RequestId": "7de19b5e-0791-4269-872b-c3e05b53c3c8"
}

3. 调用失败返回示例

{
    "RequestId": "7e9a59c5-2e20-4aa8-bd0f-9cef8d42961f",
    "Error": {
        "Type": "server",
        "Message": "The Account do not call voice service",
        "Code": "AccountVoiceServiceUnavailable"
    }
}

访问API错误码查看更多错误码。