语音消息发送语音验证码-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： vms.tencentcloudapi.com 。

给用户发语音验证码（仅支持数字）。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SendCodeVoice。
Version	是	String	公共参数，本接口取值：2020-09-02。
Region	是	String	公共参数，详见产品支持的地域列表。
CodeMessage	是	String	验证码，仅支持填写数字，实际播报语音时，会自动在数字前补充语音文本"您的验证码是"。示例值：1234
CalledNumber	是	String	被叫手机号码，采用 e.164 标准，格式为+[国家或地区码][用户号码]。例如：+8613711112222，其中前面有一个+号，86为国家码，13711112222为手机号。示例值：+8613788888888
VoiceSdkAppid	是	String	在语音控制台添加应用后生成的实际SdkAppid，示例如1400006666。示例值：1400006666
PlayTimes	否	Integer	播放次数，可选，最多3次，默认2次。示例值：2
SessionContext	否	String	用户的 session 内容，腾讯 server 回包中会原样返回。示例值：test

3. 输出参数

参数名称	类型	描述
SendStatus	SendStatus	语音验证码发送状态。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发送语音验证码

输入示例

POST / HTTP/1.1
Host: vms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SendCodeVoice
<公共请求参数>

{
    "CodeMessage": "1234",
    "PlayTimes": 2,
    "CalledNumber": "+8613788888888",
    "SessionContext": "test",
    "VoiceSdkAppid": "1400006666"
}

输出示例

{
    "Response": {
        "SendStatus": {
            "CallId": "12582bce-403c-11eb-96b8-525400476c37",
            "SessionContext": "test"
        },
        "RequestId": "91260bb8-cf91-4f3e-a81f-9198114a2279"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.AccessUpstreamTimeout	访问上下游模块超时。
FailedOperation.ContainSensitiveWord	语音内容中含有敏感词，请联系我们沟通解决。
FailedOperation.FailResolvePacket	后端请求包解析失败，通常由于没有遵守 API 接口说明规范导致的，请参见1004错误详解。
FailedOperation.InsufficientBalanceInVoicePackage	套餐包余量不足，请及时购买语音套餐包。
FailedOperation.InvalidJsonParameters	无效 JSON，请核查发送的请求是否为标准的 JSON 格式。
FailedOperation.InvalidParameters	无效参数，请核查发送的请求参数是否为对应 API 所需参数。
FailedOperation.JsonParseFail	解析请求包体时候失败。
FailedOperation.ParametersOtherError	语音未知错误，请联系我们沟通解决。
FailedOperation.PhonenumberUnappliedOrExpired	未申请号码或申请的号码资源已过期，请及时支付月功能费用和信息服务费用，具体操作请参见购买指南。
FailedOperation.TemplateIncorrectOrUnapproved	模板未审核或请求的内容与审核通过的模板内容不匹配，请参见1014错误详解
InternalError.AccessUpstreamTimeout	访问上游超时网络，请稍后重试。
InternalError.RequestTimeException	请求发起时间不正常，通常由您的服务器与腾讯云服务器之间的时间差超过10分钟引起。
InternalError.RestApiInterfaceNotExist	后端不存在该 REST API 接口，请核查 REST API 接口说明。
InternalError.SigVerificationFail	后端 Sig 校验失败。
InternalError.SsoSendRecvFail	内部sso通道超时。
InternalError.UpstreamError	语音上游错误，请联系我们沟通解决。
InvalidParameterValue.CalledNumberVerifyFail	被叫手机号码格式校验失败。
InvalidParameterValue.ContentLengthLimit	语音模板中单个变量长度超过限制，如需调整限制，请联系我们。
InvalidParameterValue.SdkAppidNotExist	SDK AppID 不存在。
LimitExceeded.DeliveryFrequencyLimit	下发语音消息时命中频率限制策略，如需申请不受频率限制的测试号码或更改限制策略，请联系我们。
UnauthorizedOperation.SdkAppidIsDisabled	SDK AppID 禁用发送语音消息，如有需要请联系我们。
UnauthorizedOperation.ServiceSuspendDueToArrears	因腾讯云账号欠费被停止服务，请及时为您的腾讯云账号充值缴清欠款。
UnauthorizedOperation.VoiceSdkAppidVerifyFail	VoiceSdkAppid 校验失败。
UnsupportedOperation	操作不支持。

发送语音验证码

本页目录：