SendSmsVerifyCode - 发送验证码短信--短信服务-火山引擎

文档中心

立即注册

导航

SendSmsVerifyCode - 发送验证码短信

最近更新时间：2024.09.20 17:05:13首次发布时间：2023.01.17 16:23:54

短信服务使用方可调用SendSmsVerifyCode接口，由短信服务生成验证码并下发验证码短信。

注意事项

发送验证码场景并非必须使用此API，也可使用SendSms和SendBatchSms，此接口的特点为验证码由短信服务生成

请求说明

请求方式: POST
请求地址: https://sms.volcengineapi.com?Action=SendSmsVerifyCode&Version=2020-01-01

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	SendSmsVerifyCode	要执行的操作，取值：SendSmsVerifyCode
Version	String	是	2020-01-01	API的版本，取值：2020-01-01

Body

名称	类型	是否必填	示例值	描述
SmsAccount	String	是	049c****	消息组ID（验码主键之一）
Sign	String	是	火山测试	短信签名
TemplateID	String	是	ST_6f8c****	短信模板ID，模板变量只支持code。模板类型必须是CN_OTP 或 I18N_OTP
PhoneNumber	String	是	133********	接收手机号，不支持批量发送（验码主键之一）如果您设置的是中国大陆手机号，则国际区号为可选项。例如+86188和188都是合法的手机号码。如果您设置的是非中国大陆手机号，则国际区号为必填项，且格式需符合 E.164 标准。
Tag	String	否	tag-123456	透传字段。这个字段用于关联发送请求和短信回执，在回传回执消息的时候，会将该字段原样返回给服务使用方。例：如果你在短信发送请求的Tag中传了一个唯一的ID，在短信回执的ext参数中会把这个ID也原样返回给调用方
Scene	String	是	注册验证码	验证码使用场景（验码主键之一）
CodeType	Integer	否	4	控制验证码长度，仅支持4/6/8位验证码，默认为6位，传入不支持的长度将替换为默认值
ExpireTime	Integer	否	180	验证码有效时间，单位为秒，范围是180-1800，默认180秒，超过范围会使用默认时间
TryCount	Integer	否	1	验证码可以尝试验证次数，范围是1-10，默认3次；如果传值超过范围，将替换为默认值

响应数据

名称	类型	示例值	描述
ResponseMetadata	ResponseMetadata		响应公共参数
Result	SendResult		响应的消息 ID。每一条消息 ID 对应一个手机号的请求。多条消息 ID 的展示顺序即为传入电话号码的顺序。

示例

成功请求示例

请求

{
    "SmsAccount": "A123****",
    "TemplateId": "ST_6f8c****",
    "PhoneNumber": "152********",
    "CodeType": 6,
    "TryCount":3,
    "ExpireTime": 1800,
    "Scene": "注册验证码"
}

响应

{
    "ResponseMetadata": {
        "RequestId": "a8e0788d-334e-49fc-92e8-61b7878c****",
        "Action": "SendSmsVerifyCode",
        "Version": "2020-01-01",
        "Service": "volcSMS",
        "Region": "cn-north-1"
    },
    "Result": {
        "MessageID": [
            "c0603139-2613-4f17-a9e3-e6faa384****"
        ]
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
200	RE:0000	账号鉴权失败	请检查参数是否使用正确或参考SDK内的鉴权处理
200	RE:0001	账号短信服务未开通	请检查当前AccessKey是否已经开通短信服务。如已开通短信服务，则参照短信服务文档调用接口。
200	RE:0002	账号被关停	请联系火山引擎客服确认
200	RE:0003	子账号不存在	请填写正确的SmsAccount，即消息组ID
200	RE:0004	签名错误	请确认对应SmsAccount下是否存在该签名，或登录短信服务控制台，在短信签名页面查询此签名是否审核通过。
200	RE:0005	模板错误	请检查对应SmsAccount下是否存在该模板，或登录短信服务控制台，在短信模板页面查询此模板是否审核通过。
200	RE:0006	手机号格式错误	参数PhoneNumbers请传入正确的格式。国内消息：+86或无任何前缀的11位手机号码，例如1580799**** 国际/港澳台消息：国际区号为必填项，且格式需符合 E.164 标准。
200	RE:0007	IP校验错误	已开启IP白名单，请联系火山引擎客服确认当前IP是否已加白。
200	RE:0009	请求参数错误	请根据接口文档检查参数是否正确
200	RE:0010	账号欠费	请登录控制台费用中心查询余额是否充足
200	RE:0011	不支持对应地区下发	请在允许的地区内进行下发或者申请对应地区的短信下发
200	RE:0012	不支持的发送类型	请登录控制台，在消息组列表点击编辑，检查允许发送的短信类型是否勾选
200	RE:0013	发送量超阈值	发送量超阈值，请检查控制台发送上限设置
200	RE:0500	未知交互类错误	请尝试重新调用接口