短信服务API概览及参考_短信服务(SMS)-阿里云帮助中心

本产品（Dysmsapi/2017-05-25）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

资质管理

API	标题	API概述
SubmitSmsQualification	申请短信资质	根据工信部及运营商实名制发送短信的要求，国内短信需提供签名归属方的资质证件信息。请先申请短信资质，然后再申请签名和模板。
QuerySmsQualificationRecord	查询资质列表	当您在申请短信资质后，可以通过此接口查询资质列表及其审核详情，支持条件筛选查询。
QuerySingleSmsQualification	查询单个资质详情	当您在申请短信资质后，可以通过此接口查询单个资质详情。
UpdateSmsQualification	修改短信资质	如果您需要更新短信资质信息，可通过本接口提交修改请求，提交后将重新进入审核流程。
DeleteSmsQualification	删除短信资质	若您不再使用某个短信资质或因其他原因需要删除时，调用此接口或在短信服务控制台删除短信资质。
RequiredPhoneCode	获取手机验证码	申请短信资质时，需要验证管理员手机号，请通过本接口获取短信验证码。
ValidPhoneCode	验证手机验证码	申请短信资质时，需要验证管理员手机号，本接口可对手机号及收到的验证码进行验证。

授权委托书

API	标题	API概述
CreateSmsAuthorizationLetter	创建授权委托书	若申请的资质用途为他用或申请的签名涉及第三方权益，则必须获取第三方授权，并在申请前提前创建授权委托书。
QuerySmsAuthorizationLetter	查询授权委托书	查询已创建的授权委托书，可查看授权书审核状态、授权签名范围。

签名管理

API	标题	API概述
CreateSmsSign	申请短信签名（新接口）	短信签名作为短信发送方的一种标识，发送短信前，您需要先申请签名和模板，系统会将已审核通过的短信签名添加到短信内容的开头，并与短信内容一起发送给接收方。
GetSmsSign	查询签名详情（新接口）	申请签名后，通过此接口查询签名审核详情。
QuerySmsSignList	查询签名列表详情	可以通过此接口可以查询您账号下的所有签名，方便您查看签名详情，包括签名审核状态、签名类型、签名名称等。
UpdateSmsSign	修改短信签名（新接口）	修改未通过审核和已经审核通过的签名，修改完成后自动提交审核，签名进入待审核状态。
DeleteSmsSign	删除短信签名	如果您不再使用某个短信签名，需要删除签名时，调用此接口或在短信服务控制台删除短信签名。
ChangeSignatureQualification	更换签名的资质和授权书（待下线）	更换签名的资质和授权书。
AddSmsSign	申请短信签名（已下线）	该接口已下线。
ModifySmsSign	修改短信签名（已下线）	该接口已下线。
QuerySmsSign	查询签名审核状态（待下线）	查询签名审核状态。

模板管理

API	标题	API概述
CreateSmsTemplate	申请短信模板（新接口）	短信模板即接收方收到短信的详细内容，包括变量和模板内容。您可以根据业务需要，申请验证码、通知短信或推广短信，模板审核通过后才可以发送短信。
GetSmsTemplate	查询模板审核详情（新接口）	申请模板后，通过此接口查询模板审核详情，可查看模板审核状态。
QuerySmsTemplateList	查询模板列表详情	可以通过此接口查询您账号下的所有模板，方便您查看模板详情，包括模板审核状态、模板类型、模板内容等。
UpdateSmsTemplate	修改短信模板（新接口）	修改未通过审核的模板，调用本接口修改后将自动提交审核。
DeleteSmsTemplate	删除短信模板	如果您不再使用某个短信模板，需要删除模板时，调用此接口或在短信服务控制台删除短信模板。
AddSmsTemplate	申请短信模板（已下线）	该接口已下线。
ModifySmsTemplate	修改短信模板（已下线）	该接口已下线。
QuerySmsTemplate	查询模板审核状态（已下线）	该接口已下线。

短信发送

API	标题	API概述
SendSms	发送短信	向指定的手机号码发送短信。
SendBatchSms	批量发送短信	调用此接口可以给不同的手机号码，发送不同签名、同一个模板（可以是不同模板变量）的短信。

发送查询

API	标题	API概述
QuerySendDetails	查询短信发送详情	查询单个号码的短信发送记录和发送状态等信息。
QuerySendStatistics	查询短信发送量统计	查询短信发送统计详情，包括短信发送时间、短信发送成功条数、接收回执条数等。

卡片短信

API	标题	API概述
GetOSSInfoForCardTemplate	获取OSS上传信息	获取卡片短信所属OSS资源配置信息，此配置信息将用于后续OSS文件上传操作。
GetMediaResourceId	获取媒体资源ID	将用户上传到卡片短信OSS存储的图片、视频转换成（生成）资源数据统一管理，并返回资源ID，用户可以对返回的资源ID自行管理。
CreateCardSmsTemplate	创建卡片短信模板	创建卡片短信模板。
QueryCardSmsTemplate	查询卡片短信模板状态	查询卡片短信模板审核状态，返回手机厂商审核相关信息。
CheckMobilesCardSupport	检查手机号是否支持卡片短信（旧接口）	检查手机号码是否支持卡片短信。
QueryMobilesCardSupport	查询手机号是否支持卡片短信（新接口）	查询手机号是否支持卡片短信。
GetCardSmsLink	获取卡片短信短链	获取卡片短信短链。
GetCardSmsDetails	查询单个号码的卡片短信发送记录和发送状态等信息	查询单个号码的卡片短信发送记录和发送状态等信息。
QueryCardSmsTemplateReport	查询卡片短信指定模板的解析数据	查询卡片短信指定模板的解析数据，解析数据包括短信解析回执成功数、消息曝光次数和消息点击数等。
SendCardSms	发送卡片短信	发送卡片短信。
SendBatchCardSms	批量发送卡片短信	批量发送卡片短信。

获取OSS上传信息

API	标题	API概述
GetQualificationOssInfo	获取资质材料/授权书OSS配置信息	获取资质材料OSS资源配置信息，此配置信息将用于后续授权委托书、企业证件等资质文件的上传操作。
GetOSSInfoForUploadFile	获取签名/模板材料OSS配置信息	获取OSS资源配置信息，此配置信息将用于后续OSS文件上传操作。

国内发国际短信转化率

API	标题	API概述
SmsConversionIntl	国内发国际短信转化反馈	将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。
ConversionDataIntl	国内发国际转化率数据接入API	将短信转化率统计数据反馈给阿里云短信平台。

短链管理

API	标题	API概述
AddShortUrl	创建短链	创建短链。
DeleteShortUrl	删除短链	删除短链，删除后短链将无法使用，无法还原为原链。
QueryShortUrl	短链状态查询	查询短链状态，可判断短链是否可用。

标签管理

API	标题	API概述
ListTagResources	查询模板标签	标签是您为模板添加的标记，每个标签都由一对键值对（Key-Value）组成。您可以查询标签键值对绑定的模板Code，也可以查询某个模板已绑定的所有标签。
TagResources	添加模板标签	标签可以标记资源，允许企业或个人将同类型的模板进行资源归类，便于搜索和资源聚合。调用本接口对短信模板进行标签绑定。
UntagResources	删除模板标签	标签可以标记资源，允许企业或个人将同类型的模板进行资源归类，便于搜索和资源聚合。如果模板不再适用于当前已绑定的标签，可以从模板中解绑标签。您可以删除单个标签，也可以批量删除标签。