最近更新时间：2023.03.13 11:47:03
首次发布时间：2021.03.23 15:19:39
短信服务的接口请求首先经过“火山引擎TOP网关”，请求细节需要按照火山引擎TOP网关要求的格式进行构建，详见火山引擎API调用指南。我们已经为开发者封装了以下SDK，开发者可通过下载SDK直接调用短信服务。如果现有SDK不能满足使用需求，可参考签名方法进行对接。
| 模块 | API | 概述 |
|---|---|---|
| 短信发送 | 发送短信SendSms | 发送短信。支持向一个或多个手机号（最多支持200个）发送相同内容的短信。 |
| 批量发送短信SendBatchSms | 批量发送短信。支持向多个手机号（最多支持200个）发送不同内容的短信。 | |
| 消息组 | 获取消息组列表GetSubAccountList | 获取消息组列表。支持查询消息组列表，内容包括消息组名称、消息组ID和创建时间。 |
| 获取消息组详情GetSubAccountDetail | 获取消息组详情。支持查询消息组详情，内容包括名称、ID、简介、允许发送的短信类型等。 | |
| 短信签名 | 申请短信签名ApplySmsSignature | 申请短信签名。 |
| 删除短信签名DeleteSignature | 删除短信签名。支持删除已审核通过的短信签名或者撤销申请中的短信签名。 | |
| 获取短信签名和签名工单列表GetSignatureAndOrderList | 获取短信签名列表。支持查询单个消息组下签名列表及详情，内容包括签名ID、内容、用途等。 | |
| 短信模板 | 申请短信模板ApplySmsTemplate | 申请短信模板。 |
| 删除短信模板DeleteSmsTemplate | 删除短信模板。支持删除已审核通过的短信模板或者撤销申请中的短信模板。 | |
| 获取短信模板列表GetSmsTemplateAndOrderList | 获取短信模板列表。支持查询单个消息组下模板列表及详情，内容包括ID、内容、审核状态等。 | |
| 短信验码 | 发送验证码短信SendSmsVerifyCode | 验证码短信发送接口。支持自动生成验证码并填充至模板中。 |
| 验证验证码CheckSmsVerifyCode | 验证码验证接口。和SendSmsVerifyCode配合使用，验证填入的验证码是否有效。 | |
| Conversion | 回填验码率Conversion | 回填验码接口。支持将验码数据回传至火山引擎，火山引擎将根据传入的验码数据计算验码率。 |
| 回调类型 | 概述 |
|---|---|
| 短信上行结果回调 | 用户回复短信后，将通过该接口将短信上行推送至短信服务使用方指定的接口。 |
| 短信状态报告回调 | 短信服务使用方可提供接口，接收火山引擎短信平台异步返回的短信回执，可用于识别短信是否成功送达 |
| 短链接点击结果回调 | 如果使用了火山引擎的短链接功能，在用户点击短链接后，火山引擎短信平台将通过该接口将短链接的点击事件推送至短信服务使用方指定的接口。 |
签名完成审核后，火山引擎短信平台将通过该接口将签名审核结果推送至短信服务使用方指定的接口。 | |
| 模板审核结果回调 | 模板完成审核后，火山引擎短信平台将通过该接口将模板审核结果推送至短信服务使用方指定的接口。 |
| 模块 | API | 概述 |
|---|---|---|
| 短信发送 | 发送短信SendSms | 发送短信。支持向一个或多个手机号（最多支持200个）发送相同内容的短信。 |
| 批量发送短信SendBatchSms | 批量发送短信。支持向多个手机号（最多支持200个）发送不同内容的短信。 | |
| 消息组 | 获取消息组列表GetSubAccountList | 获取消息组列表。支持查询消息组列表，内容包括消息组名称、消息组ID和创建时间。 |
| 获取消息组详情GetSubAccountDetail | 获取消息组详情。支持查询消息组详情，内容包括名称、ID、简介、允许发送的短信类型等。 | |
| 短信签名 | 申请短信签名ApplySmsSignature | 申请短信签名。 |
| 删除短信签名DeleteSignature | 删除短信签名。支持删除已审核通过的短信签名或者撤销申请中的短信签名。 | |
| 获取短信签名和签名工单列表GetSignatureAndOrderList | 获取短信签名列表。支持查询单个消息组下签名列表及详情，内容包括签名ID、内容、用途等。 | |
| 短信模板 | 申请视频短信模板ApplyVmsTemplate | 申请视频短信模板。 |
| 查询视频短信模版审核结果GetVmsTemplateStatus | 查询视频短信模板审核结果。 |
| 回调类型 | 概述 |
|---|---|
| 短信上行结果回调 | 用户回复短信后，将通过该接口将短信上行推送至短信服务使用方指定的接口。 |
| 短信状态报告回调 | 短信服务使用方可提供接口，接收火山引擎短信平台异步返回的短信回执，可用于识别短信是否成功送达 |
签名完成审核后，火山引擎短信平台将通过该接口将签名审核结果推送至短信服务使用方指定的接口。 | |
| 模板审核结果回调 | 模板完成审核后，火山引擎短信平台将通过该接口将模板审核结果推送至短信服务使用方指定的接口。 |