插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
本接口主要用于向单个手机号发送短信，也支持向多个手机号（单次最多支持 1000 个手机号）发送相同签名、相同模板变量的短信，群发存在一定延迟。如果您需要向多个手机号发送不同签名、不同模板变量的短信，请使用 SendBatchSms 接口（单次最多支持 100 个手机号）。
注意事项
- 国内短信服务超时时间建议设置为≥1S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。超时和重试的相关设置，请参见超时机制、重试机制。
- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。
- 发送短信为计费接口，国内短信按照运营商回执状态计费，调用 SendSms 提交成功但运营商回执失败时不计费。计费详情请参见计费概述。
QPS 限制
本接口的单用户 QPS 限制为 5000/秒。超过限制，API 调用将会被限流，请合理使用。
流控信息
当前云产品API请求速率暂未透出。
授权信息
当前云产品暂无权限信息透出。
请求参数
| 字段名称 | 字段详情 |
|---|---|
PhoneNumbersstring | 接收短信的手机号码。手机号码格式：展开详情 示例值:1390000**** |
SignNamestring | 短信签名名称。展开详情 示例值:阿里云参考取值来源: CreateSmsSign UpdateSmsSign AddSmsSign QuerySmsSignList ModifySmsSign |
TemplateCodestring | 短信模板 Code。展开详情 示例值:SMS_15305****参考取值来源: UpdateSmsTemplate CreateSmsTemplate QuerySmsTemplateList |
TemplateParamstring | 短信模板变量对应的实际值。当您选择的模板内容含有变量时，此参数必填，参数个数应与模板内变量个数一致。展开详情 示例值:{"name":"张三","number":"1390000****"} |
SmsUpExtendCodestring | 上行短信扩展码。上行短信指发送给通信服务提供商的短信，用于定制某种服务、完成查询，或是办理某种业务等，需要收费，按运营商普通短信资费进行扣费。展开详情 示例值:90999 |
OutIdstring | 外部流水扩展字段。展开详情 示例值:abcdefgh |
请求说明
请求示例
- 服务地址 URL：dysmsapi.aliyuncs.com（中国站）
- 请求风格：RPC
- 请求方式：POST/GET （推荐使用 POST）
- 公共请求头： V3 版本请求体公共请求头
- 请求参数：见上方请求参数表格
SDK 示例
如果您需要了解如何使用 SDK，请参见首次调用 API。
// 构造请求对象
SendSmsRequest sendSmsRequest = new SendSmsRequest()
.setPhoneNumbers("<YOUR_VALUE>")
.setSignName("<YOUR_VALUE>")
.setTemplateCode("<YOUR_VALUE>")
.setTemplateParam("<YOUR_VALUE>");
// 发送 API 请求
SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);
您可以访问 OpenAPI 门户，查看各语言 SDK 请求完整示例。
自签名请求示例
推荐您通过 SDK 调用 API，SDK 已经封装了签名等机制。
POST /?PhoneNumbers=123****4567&SignName=阿里云短信测试&TemplateCode=SMS_154950909&TemplateParam={"code":"1234"} HTTP/1.1
Host: dysmsapi.aliyuncs.com
Authorization: ACS3-HMAC-SHA256 Credential=YourAccessKeyId,SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=06563a9e1b43f5dfe96b81********ceab24a1d853912eee15083a6f0f3283c0
x-acs-action: SendSms
x-acs-version: 2017-05-25
x-acs-signature-nonce: d410180a5abf7f********74aca91fc0
x-acs-date: 2024-12-02T06:53:09Z
x-acs-content-sha256: e3b0c44298fc1c149afb********b92427ae41e4649b934ca495991b7852b855
自定义封装 API 调用签名机制，请参见 V3 版本签名机制示例。
返回参数
返回示例
变更历史
暂无变更历史