向指定号码发送语音验证码和带参数变量的语音通知。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledNumber | string | 否 | 接收语音通知的手机号码。 号码格式:国际码+号码: 示例:85200****00。 | 852****0000 |
CallerIdNumber | string | 否 | 主叫号码。 若您不填该参数,系统将会使用当地随机号码作为外显号码。 若您专属号码外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录国际语音服务控制台,选择"号码管理"查看已购买的号码。 | 852****0000 |
CountryId | string | 否 | 国家二字码,ISO2 | HK |
PlayTimes | long | 否 | 一通电话内语音通知内容的播放次数。取值范围:1~3,默认取值 3。 | 2 |
Speed | long | 否 | 语速控制。取值范围为:-500~500。 | 0 |
TtsCode | string | 否 | 已通过审核的语音验证码模板 ID。 您可以登录国际语音服务控制台,选择"国际语音-语音模板管理-文本转语音模板"查看模板 ID。 | 1001 |
TtsParam | string | 否 | 模板中的变量参数,JSON 格式。 | {"code":"1234"} |
Volume | long | 否 | 语音通知的播放音量。取值范围:0~100,默认取值 100。 | 100 |
OutId | string | 否 | 预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型,长度为 1~15 个字节。 | 22522**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "D9CB****-****-****-****-********9D23",
"Code": "OK",
"Message": "OK",
"CallId": "550E****-****-****-****-********0CA0"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | Product.Unsubscript | You have not subscribed to the specified product. |
400 | Ram.PermissionDeny | You are not authorized to perform the operation. |
400 | System.LimitControl | The system is under flow control. |
400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-10-12 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-05-29 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
| ||||||||||
2023-03-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
|