文档

SingleCallByTts - 向指定号码发送语音验证码或文本转语音类型的语音通知

更新时间:

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

接口说明

  • 因业务调整,自 2022 年 03 月起,中国站国际/港澳台语音通知、国际/港澳台语音验证码不再更新,并即将停止服务。目前仅支持已有资质的客户继续使用。

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

被叫显号。

  • 若您使用的语音通知文本转语音模板或语音验证码模板为公共模式外呼,则该参数值不填。更多信息,请参见公共模式 FAQ
  • 若您使用的语音通知文本转语音模板或语音验证码模板为专属模式外呼,则必须传入已购买的号码,仅支持一个号码。您可以登录语音服务控制台,选择语音号码>真实号管理查看已购买的号码。
0571****5678
CalledNumberstring

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

  • 号码格式:中国内地语音:
    • 手机号码。示例:159****0000。
    • 固话号码。示例:0571****5678。
  • 国际语音或港澳台语音:国际区号+号码。示例:85200****00。
说明
  • 一次请求仅支持一个被叫号,使用流程,请参见国内语音通知使用流程国际/港澳台语音验证码使用流程
  • 对同一个“资质+用途”下的主叫进行流控限制:1 次/分钟、5 次/小时、20 次/24 小时(流控规则计时从第一次正常外呼开始)。
  • 1590****000
    TtsCodestring

    已通过审核的语音通知文本转语音模板或语音验证码模板的模板 ID。

    您可以登录语音服务控制台,选择语音消息>语音验证码语音消息>语音通知,查看模板 ID

    说明 TTS 模板归属账号和调用接口的账号需保持一致。
    TTS_100****
    TtsParamstring

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

    说明 模板变量实际内容:模板变量整体长度必须小于 250 个字符以内,对单个模板变量无限制,不支持传入链接;验证码模板变量实际内容仅支持数字和英文字母格式。
    {"AckNum":"123456"}
    PlayTimesinteger

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

    3
    Volumeinteger

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

    100
    Speedinteger

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

    5
    OutIdstring

    发起请求时预留给调用方的自定义 ID,最终会通过在回执消息中将此 ID 带回给调用方。

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

    225869*****

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
    CallIdstring

    此次通话的唯一回执 ID。

    CallId 可以通过 QueryCallDetailByCallId 接口查询呼叫详情。

    116012354148^10281378****

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
      "CallId": "116012354148^10281378****"
    }

    错误码

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

    变更历史

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