發送短信
更新時間 2024-09-12 10:24:12
最近更新時間: 2024-09-12 10:24:12
分享文章
您可以使用SendSms接口來發送短信。
SendSms接口是短信發送接口，支持在一次請求中向多個不同的手機號碼發送同樣內容的短信。
調用該接口發送短信時，請注意：發送短信會根據發送量計費，價格請參見產品定價。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| action | String | 是 | SendSms | 系統規定參數。取值：SendSms。 |
| phoneNumber | String | 是 | 1381111***** | 接收短信的手機號碼。格式：國內短信：無任何前綴的11位手機號碼，例如1381111****。多個手機號碼使用英文","隔開，最多支持一次提交200個手機號碼。 |
| signName | String | 是 | 天翼云 | 短信簽名名稱。請在控制臺的簽名管理頁簽下簽名名稱一列查看。說明：必須是已添加、并通過審核的短信簽名。 |
| templateCode | String | 是 | SMS73419576145 | 短信模板ID。請在控制臺的模板管理頁簽下模板Code一列查看。說明：必須是已添加、并通過審核的短信模板。 |
| templateParam | String | 否 | {"code":"1111"} | 短信模板變量對應的實際值，JSON字符串格式。說明：如果JSON中需要帶換行符，請參照標準的JSON協議處理。 |
| extendCode | String | 否 | 90999 | 上行短信擴展碼，長度不可超過6。上行短信，指發送給通信服務提供商的短信，用于定制某種服務、完成查詢，或是辦理某種業務等，需要收費的，按運營商普通短信資費進行扣費。說明：無特殊需要此字段的用戶請忽略此字段。 |
| sessionId | String | 否 | 123456 | 客戶自帶短信標識，在狀態報告中會原樣返回。說明：無特殊需要此字段的用戶請忽略此字段。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| code | String | OK | 請求狀態碼。 返回OK代表請求被成功接收。 實際短信發送狀態，通過配置短信狀態報告回調地址異步返回，錯誤碼詳見錯誤碼列表。 |
| message | String | success | 狀態碼描述。 |
| requestId | String | cknkbmqflsojbf48h8ng | 請求ID。多個手機號碼的請求ID使用","隔開。 |
示例
請求示例
{
????"action":?"SendSms",
????"signName":?"天翼云",
????"phoneNumber":?"13301110000",
????"templateCode":?"SMS73419576145",
????"templateParam":?"{\"code\":\"123456\",\"time\":\"1\"}",
????"extendCode":?"123"
}
正常返回示例
{
??"code":?"OK",
??"message":?"success",
??"requestId":?"cknkbmqflsojbf48h8ng"
}
