调用SingleCallByVoice接口向指定号码发送语音通知文件类型的语音通知。
注意因业务调整,自2022年3月起,中国站国际/港澳台语音通知、国际/港澳台语音验证码不再更新,并即将停止服务。目前仅支持已有资质的客户继续使用。
使用说明
带参数变量的语音通知请使用SingleCallByTts接口。
QPS限制
- 单用户调用频率:1200次/秒。
- API频率:3600次/秒。
说明如果多个用户的总调用超过API频率也会触发流控。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledShowNumber | string | 否 | 0571****5678 | |
CalledNumber | string | 是 | 接收语音通知的手机号码。 号码格式:
说明 | 1590****000 |
VoiceCode | string | 是 | 语音通知文件的语音ID。 您可以登录语音服务控制台,选择国内语音单呼叫>语音通知或语音文件管理,在语音通知文件页签下查看语音ID。 | 2d4c-4e78-8d2a-afbb06cf****.wav |
PlayTimes | integer | 否 | 语音文件的播放次数。取值范围:1~3。 | 3 |
Volume | integer | 否 | 语音文件播放的音量。取值范围:0~100,默认取值100。 | 100 |
Speed | integer | 否 | 语速控制,取值范围:-500~500。 | 100 |
OutId | string | 否 | 预留给调用方使用的ID,最终会通过在回执消息中将此ID带回给调用方。 字符串类型,长度为1~15个字节。 | 22596**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "E50FFA85-0B79-4421-A7BD-00B0A271966F",
"CallId": "116004767703^102806****"
}
XML
格式
<SingleCallByVoiceResponse>
<Message>OK</Message>
<RequestId>E50FFA85-0B79-4421-A7BD-00B0A271966F</RequestId>
<Code>OK</Code>
<CallId>116004767703^102806****</CallId>
</SingleCallByVoiceResponse>