本产品(
短信服务/2017-05-25
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
签名管理
API | 标题 | API概述 |
---|---|---|
AddSmsSign | 申请短信签名 | 一条完整的短信由短信签名和短信内容组成,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,与短信内容一起发送给接收方。 |
QuerySmsSign | 查询签名审核状态 | 申请签名后,通过此接口查询签名审核详情。 |
QuerySmsSignList | 查询签名列表详情 | 可以通过此接口可以查询您账号下的所有签名,方便您查看签名详情,包括签名审核状态、签名类型、签名名称等。 |
ModifySmsSign | 修改短信签名 | 修改未通过审核的签名,修改后请重新提交审核。 |
DeleteSmsSign | 删除短信签名 | 如果您不再使用某个短信签名,需要删除签名时,调用此接口或在短信服务控制台删除短信签名。 |
CreateSmsSign | 申请短信签名(新接口) | 短信签名作为短信发送方的一种标识,发送短信前,您需要先申请签名和模板,系统会将已审核通过的短信签名添加到短信内容的开头,并与短信内容一起发送给接收方。 |
UpdateSmsSign | 修改短信签名(新接口) | 修改未通过审核的签名,修改后请重新提交审核。 |
GetSmsSign | 查询签名详情(新接口) | 申请签名后,通过此接口查询签名审核详情。 |
模板管理
API | 标题 | API概述 |
---|---|---|
AddSmsTemplate | 申请短信模板 | 短信模板即接收方收到短信的详细内容,包括变量和模板内容。您可以根据业务需要,申请验证码、通知短信或推广短信,模板审核通过后才可以发送短信。 |
QuerySmsTemplate | 查询模板审核状态 | 查询短信模板。 |
QuerySmsTemplateList | 查询模板列表详情 | 可以通过此接口可以查询您账号下的所有模板,方便您查看模板详情,包括模板审核状态、模板类型、模板内容等。 |
ModifySmsTemplate | 修改短信模板 | 修改短信模板。 |
DeleteSmsTemplate | 删除短信模板 | 如果您不再使用某个短信模板,需要删除模板时,调用此接口或在短信服务控制台删除短信模板。 |
CreateSmsTemplate | 申请短信模板(新接口) | 短信模板即接收方收到短信的详细内容,包括变量和模板内容。您可以根据业务需要,申请验证码、通知短信或推广短信,模板审核通过后才可以发送短信。 |
UpdateSmsTemplate | 修改短信模板(新接口) | 修改未通过审核的模板,修改后请重新提交审核。 |
GetSmsTemplate | 查询模板审核详情(新接口) | 申请模板后,通过此接口查询模板审核详情,可查看模板审核状态。 |
短信发送
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 | 批量发送卡片短信 | 批量发送卡片短信。 |
获取OSS上传信息
API | 标题 | API概述 |
---|---|---|
GetOSSInfoForUploadFile | 文本短信获取OSS上传信息 | 获取OSS资源配置信息,此配置信息将用于后续OSS文件上传操作。 |
国内发国际短信转化率
API | 标题 | API概述 |
---|---|---|
SmsConversionIntl | 国内发国际短信转化反馈 | 将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。 |
ConversionDataIntl | 国内发国际转化率数据接入API | 将短信转化率统计数据反馈给阿里云短信平台。 |
标签管理
API | 标题 | API概述 |
---|---|---|
ListTagResources | 查询模板标签 | 查询模板标签。 |
TagResources | 添加模板标签 | 给模板添加标签。 |
UntagResources | 删除模板标签 | 删除模板标签。 |