向指定的一批号码发起语音群呼。群呼内容为已经通过审核的模板。可以通过登录国际语音控制台,进入“模板管理”查看模板ID。此功能会将号码送入发送队列进行排队。实际呼出时间不确定。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledNumber | array | 否 | 被叫号码。上限为 5 万个。 | |
string | 否 | 号码格式:国际码+号码。 例如: 852****0000 | 852****0000 | |
CallerIdNumber | string | 否 | 主叫号码。 若您不填该参数,系统将会使用当地随机号码作为外显号码。 若您专属号码外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录国际语音服务控制台,选择"号码管理"查看已购买的号码。 | 852****1111 |
CountryId | string | 否 | 国家码。ISO2。 | HK |
PlayTimes | long | 否 | 语音文件的播放次数。取值范围:1~3。 | 1 |
SendType | long | 否 | 发送类型:取值[1,2]。 1: 立即开始发送任务,不等待。 2: 定时开始发送任务。如果传该类型,TimingStart 为必选字段。 | 2 |
Speed | long | 否 | 语速控制,取值范围:-500~500。 音频类型为 TTS 时必传。录音文件可不传。 | 0 |
TaskName | string | 否 | 任务名称。 | 测试群呼 |
TimingStart | string | 否 | 定时发送的时间。 | 2022-05-01T08:00:00+08:00 |
TtsCode | string | 否 | 语音文件的语音 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"文本转语音模板",查看模板 ID。 此参数与 VoiceCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。 | 100001 |
VoiceCode | string | 否 | 文本转语音的模板 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"语音文件",查看模板 ID。 此参数与 TtsCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。 | 200001 |
Volume | long | 否 | 语音文件播放的音量。取值范围:0~100,默认取值 100。 | 100 |
OutId | string | 否 | 预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型,长度为 1~15 个字节。 | 22596**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E50F****-****-****-****-********966F",
"Code": "OK",
"Message": "OK",
"TaskId": "550E****-****-****-****-********00A0"
}
错误码
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-03-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 看变更集 | ||||||||
|