文档

API概览

更新时间:
本产品(短信服务/2017-05-25)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

短信发送

API标题API概述
SendSms发送短信发送前请申请短信签名和短信模板,并确保签名和模板已审核通过。
SendBatchSms批量发送短信批量发送短信,支持多个号码,多个签名,注意模板只能用一个。

发送查询

API标题API概述
QuerySendStatistics查询短信发送统计信息查询短信发送量详情。
QuerySendDetails查询短信发送详情查询短信发送记录和发送状态等信息。

签名管理

API标题API概述
AddSmsSign申请短信签名申请短信签名。
DeleteSmsSign删除短信签名删除签名,删除后您将不能使用它继续发短信。
ModifySmsSign修改短信签名修改短信签名后需要重新提交审核,审核中的签名不支持修改。
QuerySmsSignList查询短信签名列表查询短信签名列表详情,分页获取短信签名列表。
QuerySmsSign查询短信签名申请状态查询短信签名申请状态。

模板管理

API标题API概述
AddSmsTemplate申请短信模板创建短信模板。
DeleteSmsTemplate删除短信模板删除短信模板。
ModifySmsTemplate修改审核未通过的短信模板修改未审核通过的短信模板信息,并重新提交审核。
QuerySmsTemplateList查询短信模板列表查询短信模板列表详情。
QuerySmsTemplate查询短信模板的审核状态查询短信模板审核状态。

标签管理

API标题API概述
ListTagResources查询模板标签查询模板标签。
TagResources添加模板标签给模板添加标签。
UntagResources删除模板标签删除模板标签。

卡片短信

API标题API概述
GetOSSInfoForCardTemplate获取OSS上传信息获取卡片短信所属OSS资源配置信息,此配置信息将用于后续OSS文件上传操作。
GetMediaResourceId获取媒体资源ID将用户上传到卡片短信OSS存储的图片、视频转换成(生成)资源数据统一管理,并返回资源ID,用户可以对返回的资源ID自行管理。
CreateCardSmsTemplate创建卡片短信模板创建卡片短信模板。
QueryCardSmsTemplate查询卡片短信模板状态查询模板审核状态。
CheckMobilesCardSupport检查手机号是否支持卡片短信(旧接口)检查手机号码是否支持卡片短信。
QueryMobilesCardSupport查询手机号是否支持卡片短信(新接口)查询手机号是否支持卡片短信。
GetCardSmsLink获取卡片短信短链获取卡片短信短链。
QueryCardSmsTemplateReport查询卡片短信发送详情查询卡片短信发送详情。
SendCardSms发送卡片短信发送卡片短信。
SendBatchCardSms批量发送卡片短信批量发送卡片短信。

国际短信

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