文档

SingleCallByVoice - 发送语音通知文件类型的语音通知

更新时间:

调用接口给单个被叫号码发送语音通知文件类型的语音通知。

接口说明

  • 请在使用该接口前,已了解语音服务产品计费

  • 如果语音通知文件中带变量参数,请使用 SingleCallByTts 接口发送语音通知。

  • 如果需要批量发送语音任务,请使用 CreateCallTask 接口创建语音任务。

  • 语音套餐包或语音计费相关,请参见国内语音服务定价

QPS 限制

单用户调用频率:1200 次/秒。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dyvms:SingleCallByVoiceWrite
  • 全部资源
    *

请求参数

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

发送语音通知的外呼号码(被叫显号)。

  • 如果您使用的外呼号码是公共模式,该参数不填。公共模式详情请参见公共模式
  • 如果您使用的外呼号码是专属模式,请传入您的真实号码虚拟号码。 您可以登录语音服务控制台,在真实号管理页面查看已购买的真实号,在虚拟号管理页面查看已创建并绑定真实号的虚拟号
0571****5678
CalledNumberstring

接收语音通知的被叫号码。

号码格式:

  • 手机号码。示例:159****0000。
  • 固话号码。示例:0571****5678。
  • 国际区号+号码。示例:85200****00。
说明
  • 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码,可以多次调用。
  • 针对同一个资质信息+号码用途,主叫号码拨打每一个被叫号码的频次进行限制:1 次/分钟、5 次/小时、20 次/24 小时。 流控规则计时从第一次正常外呼开始,超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。
  • 159****0000
    VoiceCodestring

    语音通知文件的语音 ID。

    您登录语音服务控制台在以下页面获取语音 ID,该语音通知文件必须已审核通过。

    • 语音消息>语音通知>语音通知文件页面获取语音 ID

    • 语音文件管理>语音通知文件页面获取语音 ID

    2d4c-4e78-8d2a-afbb06cf****.wav
    PlayTimesinteger

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

    3
    Volumeinteger

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

    100
    Speedinteger

    语音文件播放的语速。取值范围:-500~500

    100
    OutIdstring

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

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

    22596****

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    E50FFA85-0B79-4421-A7BD-00B0A271966F
    CallIdstring

    此次通话的唯一回执 ID。

    可以使用 CallId,调用 QueryCallDetailByCallId 接口查询指定通话详情。

    116004767703^102806****

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "E50FFA85-0B79-4421-A7BD-00B0A271966F",
      "CallId": "116004767703^102806****"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)