向指定号码发送语音验证码和带参数变量的语音通知，支持语音文件模板或文本转语音模板。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CallerIdNumber |
string |
否 |
主叫号码。 若您不填该参数，系统将会使用当地随机号码作为外显号码。 若您专属号码外呼，则必须传入已购买的号码，仅支持一个号码。您可以登录国际语音服务控制台，选择"号码管理"查看已购买的号码。 |
852****0001 |
| CalledNumber |
string |
否 |
接收语音通知的手机号码。 号码格式：国际码+号码： 示例：85200****00。 |
852****0000 |
| TtsCode |
string |
否 |
文本转语音模板的语音 ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"文本转语音模板"，查看模板 ID。 此参数与 VoiceCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。 |
1001 |
| TtsParam |
string |
否 |
模板中的变量参数，JSON 格式。 |
{"code":"1234"} |
| VoiceCode |
string |
否 |
语音文件的模板 ID。 您可以登录国际语音服务控制台，选择"语音模板管理"-"语音文件"，查看模板 ID。 此参数与 TtsCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。 |
1002 |
| PlayTimes |
integer |
否 |
一通电话内语音通知内容的播放次数。取值范围：1~3，默认取值 3。 |
2 |
| Volume |
integer |
否 |
语音通知的播放音量。取值范围：0~100，默认取值 100。 |
100 |
| Speed |
integer |
否 |
语速控制。取值范围为：-500~500。 |
0 |
| TaskName |
string |
否 |
任务名称。 |
单呼任务名 |
| SendType |
integer |
否 |
发送类型：取值[1,2]。 1： 立即开始发送任务，不等待。 2： 定时开始发送任务。如果传该类型，TimingStart 为必选字段。 |
1 |
| TimingStart |
string |
否 |
定时发送的时间。 |
2022-05-01T08:00:00+08:00 |
| OutId |
string |
否 |
预留给调用方使用的 ID，最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型，长度为 1~15 个字节。 |
22522**** |
| CountryId |
string |
否 |
国家/地区二字码，ISO2。 |
HK |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
"" |
| Message |
string |
返回信息描述。 |
OK |
| RequestId |
string |
请求 ID。 |
D9CB****-****-****-****-********9D23 |
| Model |
object |
请求结果数据 |
|
| Code |
string |
请求状态码。 返回 SUCCESS 代表请求成功。 其他错误码，请参见 API 错误码。 |
SUCCESS |
| Success |
boolean |
请求是否成功，成功：true，失败：false。 |
true |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "\"\"",
"Message": "OK",
"RequestId": "D9CB****-****-****-****-********9D23\n",
"Model": {
"test": "test",
"test2": 1
},
"Code": "SUCCESS",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。