本产品(
短信服务/2017-05-25
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
签名管理
API | 标题 | API概述 |
---|---|---|
AddSmsSign | 申请短信签名 | 短信签名作为短信发送方的一种标识,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,并与短信内容一起发送给接收方。 |
DeleteSmsSign | 删除短信签名 | 删除签名后您将不能使用此签名继续发送短信。 |
ModifySmsSign | 修改短信签名 | 修改短信签名后需要重新提交审核,审核中的签名不支持修改。 |
QuerySmsSignList | 查询短信签名列表 | 查询短信签名列表详情,分页获取短信签名列表。 |
QuerySmsSign | 查询签名审核状态 | 查询短信签名审核进度。一般情况下,签名提交后,阿里云预计在2个小时内审核完成(审核工作时间:周一至周日9:00~21:00,法定节假日顺延),建议您尽量在18:00前提交申请。 |
模板管理
API | 标题 | API概述 |
---|---|---|
AddSmsTemplate | 申请短信模板 | 创建短信模板。 |
DeleteSmsTemplate | 删除短信模板 | 删除短信模板。 |
ModifySmsTemplate | 修改审核未通过的短信模板 | 修改未审核通过的短信模板信息,并重新提交审核。 |
QuerySmsTemplateList | 查询短信模板列表 | 查询短信模板列表。 |
QuerySmsTemplate | 查询短信模板的审核状态 | 查询短信模板审核状态。一般情况下,模板提交后,阿里云预计在2个小时内审核完成(审核工作时间:周一至周日9:00~21:00,法定节假日顺延),建议您尽量在18:00前提交申请。 |
短信发送
API | 标题 | API概述 |
---|---|---|
SendSms | 发送短信 | 发送前请申请短信签名和短信模板,并确保签名和模板已审核通过。 |
SendBatchSms | 批量发送短信 | 批量发送短信,支持多个号码,多个签名,模板只能用一个。 |
发送查询
API | 标题 | API概述 |
---|---|---|
QuerySendDetails | 查询短信发送详情 | 查询单个号码的短信发送记录和发送状态等信息。 |
QuerySendStatistics | 查询短信发送量统计 | 查询短信发送统计详情,包括短信发送时间、短信发送成功条数、接收回执条数等。 |
卡片短信
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 | 将短信转化率统计数据反馈给阿里云短信平台。 |
标签管理
API | 标题 | API概述 |
---|---|---|
ListTagResources | 查询模板标签 | 查询模板标签。 |
TagResources | 添加模板标签 | 给模板添加标签。 |
UntagResources | 删除模板标签 | 删除模板标签。 |