全部产品
Search
文档中心

语音服务:BackendCallSignal - 向指定号码发起语音验证码

更新时间:Mar 26, 2024

向指定号码发送语音验证码和带参数变量的语音通知。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
CalledNumberstring

接收语音通知的手机号码。

号码格式:国际码+号码: 示例:85200****00。

852****0000
CallerIdNumberstring

主叫号码。

若您不填该参数,系统将会使用当地随机号码作为外显号码。 若您专属号码外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录国际语音服务控制台,选择"号码管理"查看已购买的号码。

852****0000
CountryIdstring

国家二字码,ISO2

HK
PlayTimeslong

一通电话内语音通知内容的播放次数。取值范围:1~3,默认取值 3。

2
Speedlong

语速控制。取值范围为:-500~500。

0
TtsCodestring

已通过审核的语音验证码模板 ID。

您可以登录国际语音服务控制台,选择"国际语音-语音模板管理-文本转语音模板"查看模板 ID。

1001
TtsParamstring

模板中的变量参数,JSON 格式。

{"code":"1234"}
Volumelong

语音通知的播放音量。取值范围:0~100,默认取值 100。

100
OutIdstring

预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。

字符串类型,长度为 1~15 个字节。

22522****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

D9CB****-****-****-****-********9D23
Codestring

请求状态码。

返回 OK 代表请求成功。 其他错误码,请参见 API 错误码。

OK
Messagestring

状态码的描述。

OK
CallIdstring

此次通话的唯一回执 ID。可以通过此 ID 查询单个通话的详情。

550E****-****-****-****-********0CA0

示例

正常返回示例

JSON格式

{
  "RequestId": "D9CB****-****-****-****-********9D23",
  "Code": "OK",
  "Message": "OK",
  "CallId": "550E****-****-****-****-********0CA0"
}

错误码

HTTP status code错误码错误信息
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-05-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:OutId