{
  "name": "vms",
  "display_name": "语音消息",
  "description": "介绍如何使用API对语音消息进行操作，包括管理语音消息应用、标签等。",
  "domain": "other",
  "api_version": "2020-09-02",
  "endpoint": "vms.tencentcloudapi.com",
  "actions": [
    {
      "name": "SendCodeVoice",
      "description": "给用户发语音验证码（仅支持数字）。",
      "status": "online",
      "parameters": [
        {
          "name": "CodeMessage",
          "type": "string",
          "required": true,
          "description": "验证码，仅支持填写数字，实际播报语音时，会自动在数字前补充语音文本\"您的验证码是\"。",
          "example": "8253"
        },
        {
          "name": "CalledNumber",
          "type": "string",
          "required": true,
          "description": "被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]。 例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号。",
          "example": "+8613788888888"
        },
        {
          "name": "VoiceSdkAppid",
          "type": "string",
          "required": true,
          "description": "在[语音控制台](https://console.cloud.tencent.com/vms)添加应用后生成的实际SdkAppid，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "PlayTimes",
          "type": "integer",
          "required": false,
          "description": "播放次数，可选，最多3次，默认2次。",
          "example": "2"
        },
        {
          "name": "SessionContext",
          "type": "string",
          "required": false,
          "description": "用户的 session 内容，腾讯 server 回包中会原样返回。",
          "example": "sc-t"
        }
      ],
      "required": [
        "CodeMessage",
        "CalledNumber",
        "VoiceSdkAppid"
      ]
    },
    {
      "name": "SendTtsVoice",
      "description": "给用户发送指定模板的语音通知。",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateId",
          "type": "string",
          "required": true,
          "description": "模板 ID，在控制台审核通过的模板 ID。",
          "example": "4356"
        },
        {
          "name": "CalledNumber",
          "type": "string",
          "required": true,
          "description": "被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]。 例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号。",
          "example": "+8613788888888"
        },
        {
          "name": "VoiceSdkAppid",
          "type": "string",
          "required": true,
          "description": "在[语音控制台](https://console.cloud.tencent.com/vms)添加应用后生成的实际SdkAppid，示例如1400006666。",
          "example": "1400006666"
        },
        {
          "name": "TemplateParamSet",
          "type": "array",
          "required": false,
          "description": "模板参数，若模板没有参数，请提供为空数组。 注：语音消息的内容长度不超过350字。",
          "example": "[\"7652\"]",
          "item_type": "string"
        },
        {
          "name": "PlayTimes",
          "type": "integer",
          "required": false,
          "description": "播放次数，可选，最多3次，默认2次。",
          "example": "2"
        },
        {
          "name": "SessionContext",
          "type": "string",
          "required": false,
          "description": "用户的 session 内容，腾讯 server 回包中会原样返回。",
          "example": "sc-t"
        }
      ],
      "required": [
        "TemplateId",
        "CalledNumber",
        "VoiceSdkAppid"
      ]
    }
  ]
}