全部产品
Search
文档中心

语音服务:GroupCall - 向指定的一批号码发起语音群呼

更新时间:Apr 01, 2024

向指定号码发送多次语音呼叫,支持语音文件模板或文本转语音模板进行呼叫。

调试

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

授权信息

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

请求参数

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

认证签名。自动补全,无需写入

s****************D
Timestampstring

写入记录的时间。自动补全,无需写入

20**-**-******10Z
SignatureNoncestring

签名唯一的随机数。自动补全,无需写入。

l*********y
CalledNumberarray

被叫号码。上限为 5 万个。

string

号码格式:国际码+号码。 例如: 852****0000

852****0000
CallerIdNumberstring

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

852****1111
CountryIdstring

国家/地区二字码,ISO2。

HK
PlayTimeslong

语音文件的播放次数。取值范围:1~3。

1
SendTypelong

发送类型:取值[1,2]。 1: 立即开始发送任务,不等待。 2: 定时开始发送任务。如果传该类型,TimingStart 为必选字段。

3
Speedlong

语速控制,取值范围:-500~500。 音频类型为 TTS 时必传。录音文件可不传。

94
TaskNamestring

任务名称。

群呼任务
TimingStartstring

2022-05-01T08:00:00+08:00

定时发送的时间。
TtsCodestring

文本转语音的模板 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"文本转语音模板",查看模板 ID。 此参数与 VoiceCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。

1****01
VoiceCodestring

语音文件的模板 ID。 您可以登录国际语音服务控制台,选择"语音模板管理"-"语音文件",查看模板 ID。 此参数与 TtsCode 二选一必填。分别代表使用语音文件作为呼叫内容呼叫或者使用固定模板文字作为呼叫内容。

2*****01
Volumelong

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

11
OutIdstring

预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型,长度为 1~15 个字节。

22596****
TtsParamstring

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

{"code":"1234"}

返回参数

名称类型描述示例值
object
AccessDeniedDetailstring

访问被拒绝详细信息。

""
RequestIdstring

请求 ID

E50F****-****-****-****-********966F
Messagestring

返回信息描述

OK
Modelobject

请求结果数据。

TaskIdstring

任务 ID,可以通过此 ID 查询任务的详情。

550E****-****-****-****-********00A0
Codestring

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

OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "\"\"",
  "RequestId": "E50F****-****-****-****-********966F",
  "Message": "OK",
  "Model": {
    "TaskId": "550E****-****-****-****-********00A0"
  },
  "Code": "OK"
}

错误码

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