向指定的手機(jī)號(hào)碼發(fā)送短信。
接口說(shuō)明
本接口主要用于向單個(gè)手機(jī)號(hào)發(fā)送短信,也支持向多個(gè)手機(jī)號(hào)(單次最多支持 1000 個(gè)手機(jī)號(hào))發(fā)送相同簽名、相同模板變量的短信,群發(fā)存在一定延遲。如果您需要向多個(gè)手機(jī)號(hào)發(fā)送不同簽名、不同模板變量的短信,請(qǐng)使用 SendBatchSms 接口(單次最多支持 100 個(gè)手機(jī)號(hào))。
注意事項(xiàng)
- 國(guó)內(nèi)短信服務(wù)超時(shí)時(shí)間建議設(shè)置為≥1S;發(fā)生超時(shí)失敗的情況時(shí),建議查看回執(zhí)狀態(tài)后再判斷是否重試。超時(shí)和重試的相關(guān)設(shè)置,請(qǐng)參見(jiàn)超時(shí)機(jī)制、重試機(jī)制。
- 國(guó)內(nèi)短信、國(guó)際短信及多媒體短信目前均不支持冪等的能力,請(qǐng)您做好冪等控制,防止因多次重試而導(dǎo)致的重復(fù)操作問(wèn)題。
- 發(fā)送短信會(huì)根據(jù)發(fā)送量計(jì)費(fèi),計(jì)費(fèi)詳情請(qǐng)參見(jiàn)計(jì)費(fèi)概述。
QPS 限制
本接口的單用戶 QPS 限制為 5000/秒。超過(guò)限制,API 調(diào)用將會(huì)被限流,請(qǐng)合理使用。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dysms:SendSms | get | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PhoneNumbers | string | 是 | 接收短信的手機(jī)號(hào)碼。手機(jī)號(hào)碼格式:
說(shuō)明
支持向不同的手機(jī)號(hào)碼發(fā)送短信,手機(jī)號(hào)碼之間以半角逗號(hào)(,)分隔。上限為 1000 個(gè)手機(jī)號(hào)碼。批量發(fā)送相對(duì)于單條發(fā)送,及時(shí)性稍有延遲。驗(yàn)證碼類型的短信,建議單條發(fā)送。
| 1390000**** |
SignName | string | 是 | 短信簽名名稱。 您可以通過(guò) CreateSmsSign 接口添加簽名或在短信服務(wù)控制臺(tái)添加簽名,簽名通過(guò)審核后,才可使用簽名名稱。 說(shuō)明
如果驗(yàn)證碼簽名和通用簽名相同時(shí),默認(rèn)使用通用簽名發(fā)送短信。
| 阿里云 |
TemplateCode | string | 是 | 短信模板 Code。 您可以通過(guò) CreateSmsTemplate 接口添加模板或在短信服務(wù)控制臺(tái)添加模板,模板通過(guò)審核后,才可使用模板 Code。 | SMS_15305**** |
TemplateParam | string | 否 | 短信模板變量對(duì)應(yīng)的實(shí)際值。支持傳入多個(gè)參數(shù)。 說(shuō)明
| {"name":"張三","number":"1390000****"} |
SmsUpExtendCode | string | 否 | 上行短信擴(kuò)展碼。上行短信指發(fā)送給通信服務(wù)提供商的短信,用于定制某種服務(wù)、完成查詢,或是辦理某種業(yè)務(wù)等,需要收費(fèi),按運(yùn)營(yíng)商普通短信資費(fèi)進(jìn)行扣費(fèi)。 說(shuō)明
擴(kuò)展碼是生成簽名時(shí)系統(tǒng)自動(dòng)默認(rèn)生成的,不支持自行傳入。無(wú)特殊需要可忽略此字段。
| 90999 |
OutId | string | 否 | 外部流水?dāng)U展字段。 說(shuō)明
無(wú)特殊需要可忽略此字段。
| abcdefgh |
請(qǐng)求示例
- 服務(wù)地址 URL:dysmsapi.aliyuncs.com(中國(guó)站)
- 請(qǐng)求風(fēng)格:RPC
- 請(qǐng)求方式:POST/GET (推薦使用 POST)
- 公共請(qǐng)求頭: V3 版本請(qǐng)求體公共請(qǐng)求頭
- 請(qǐng)求參數(shù):見(jiàn)上方請(qǐng)求參數(shù)表格
SDK 示例
如果您需要了解如何使用 SDK,請(qǐng)參見(jiàn)首次調(diào)用 API。
// 構(gòu)造請(qǐng)求對(duì)象
SendSmsRequest sendSmsRequest = new SendSmsRequest()
.setPhoneNumbers("<YOUR_VALUE>")
.setSignName("<YOUR_VALUE>")
.setTemplateCode("<YOUR_VALUE>")
.setTemplateParam("<YOUR_VALUE>");
// 發(fā)送 API 請(qǐng)求
SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);
您可以訪問(wèn) OpenAPI 門戶,查看各語(yǔ)言 SDK 請(qǐng)求完整示例。
自簽名請(qǐng)求示例
推薦您通過(guò) SDK 調(diào)用 API,SDK 已經(jīng)封裝了簽名等機(jī)制。
POST /?PhoneNumbers=123****4567&SignName=阿里云短信測(cè)試&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 調(diào)用簽名機(jī)制,請(qǐng)參見(jiàn) V3 版本簽名機(jī)制示例。
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"BizId": "9006197469364984****",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990"
}
錯(cuò)誤碼
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-03 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記 | 查看變更詳情 |