调用接口给单个被叫号码发送语音通知文件类型的语音通知。
接口说明
-
请在使用该接口前,了解语音服务套餐包及功能计费,详情请参见国内语音服务定价。
-
语音文件公共模式外呼和专属模式外呼不通用,如果您使用公共模式调用本接口外呼,请在导入语音文件时外呼号码选择公共模式外呼,专属模式同理。
-
语音通知文件不支持变量参数,如您需要发送带变量的语音通知,请至语音服务控制台申请文本转语音模板后使用 SingleCallByTts 接口。
-
如果需要批量发送语音任务,请使用 CreateCallTask 接口创建语音任务(创建语音任务仅限专属模式且需要虚拟号调用)。
QPS 限制
单用户调用频率:1200 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dyvms:SingleCallByVoice | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CalledShowNumber | string | 否 | 发送语音通知的外呼号码(被叫显号)。若此参数不填,则为公共模式外呼;若传入真实/虚拟号,则为专属模式外呼。
| 0571****5678 |
CalledNumber | string | 是 | 接收语音通知的被叫号码。 号码格式:
说明
| 159****0000 |
VoiceCode | string | 是 | 语音通知文件的语音 ID。传入的语音 ID 的外呼模式类型应与 CalledShowNumber 匹配。 您可登录语音服务控制台在以下页面获取语音 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****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|