一、 API接口介紹
alibaba.aliqin.fc.sms.num.send (短信發送)
向指定手機號碼發送模板短信,模板內可設置部分變量。使用前需要在阿里大於管理中心添加短信簽名與短信模板。測試時請直接使用正式環境HTTP請求地址。 【重要】批量發送(一次傳遞多個號碼eg:1381111111,1382222222)會產生相應的延遲,觸達時間要求高的建議單條發送
公共參數
請求地址:
公共請求參數:
環境 | HTTP請求地址 | HTTPS請求地址 |
---|---|---|
正式環境 | http://gw.api.taobao.com/router/rest | https://eco.taobao.com/router/rest |
沙箱環境 | http://gw.api.tbsandbox.com/router/rest | https://gw.api.tbsandbox.com/router/rest |
名稱 | 類型 | 是否必須 | 描述 |
---|---|---|---|
method | String | 是 | API接口名稱。 |
app_key | String | 是 | TOP分配給應用的AppKey。 |
target_app_key | String | 否 | 被調用的目標AppKey,僅當被調用的API為第三方ISV提供時有效。 |
sign_method | String | 是 | 簽名的摘要算法,可選值為:hmac,md5。 |
sign | String | 是 | API輸入參數簽名結果,簽名算法介紹請點擊這里。 |
session | String | 否 | 用戶登錄授權成功后,TOP頒發給應用的授權信息,詳細介紹請點擊這里。當此API的標簽上注明:“需要授權”,則此參數必傳;“不需要授權”,則此參數不需要傳;“可選授權”,則此參數為可選。 |
timestamp | String | 是 | 時間戳,格式為yyyy-MM-dd HH:mm:ss,時區為GMT+8,例如:2015-01-01 12:00:00。淘寶API服務端允許客戶端請求最大時間誤差為10分鍾。 |
format | String | 否 | 響應格式。默認為xml格式,可選值:xml,json。 |
v | String | 是 | API協議版本,可選值:2.0。 |
partner_id | String | 否 | 合作伙伴身份標識。 |
simplify | Boolean | 否 | 是否采用精簡JSON返回格式,僅當format=json時有效,默認值為:false。 |
請求參數
名稱 | 類型 | 是否必須 | 示例值 | 更多限制 | 描述 |
---|---|---|---|---|---|
extend | String | 可選 | 123456 | 公共回傳參數,在“消息返回”中會透傳回該參數;舉例:用戶可以傳入自己下級的會員ID,在消息返回時,該會員ID會包含在內,用戶可以根據該會員ID識別是哪位會員使用了你的應用 | |
sms_type | String | 必須 | normal | 短信類型,傳入值請填寫normal | |
sms_free_sign_name | String | 必須 | 阿里大於 | 短信簽名,傳入的短信簽名必須是在阿里大於“管理中心-驗證碼/短信通知/推廣短信-配置短信簽名”中的可用簽名。如“阿里大於”已在短信簽名管理中通過審核,則可傳入”阿里大於“(傳參時去掉引號)作為短信簽名。短信效果示例:【阿里大於】歡迎使用阿里大於服務。 | |
sms_param | Json | 可選 | {"code":"1234","product":"alidayu"} | 短信模板變量,傳參規則{"key":"value"},key的名字須和申請模板中的變量名一致,多個變量之間以逗號隔開。示例:針對模板“驗證碼${code},您正在進行${product}身份驗證,打死不要告訴別人哦!”,傳參時需傳入{"code":"1234","product":"alidayu"} | |
rec_num | String | 必須 | 13000000000 | 短信接收號碼。支持單個或多個手機號碼,傳入號碼為11位手機號碼,不能加0或+86。群發短信需傳入多個號碼,以英文逗號分隔,一次調用最多傳入200個號碼。示例:18600000000,13911111111,13322222222 | |
sms_template_code | String | 必須 | SMS_585014 | 短信模板ID,傳入的模板必須是在阿里大於“管理中心-短信模板管理”中的可用模板。示例:SMS_585014 |
響應參數
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
BizResult | 0 | 返回值 | |
|
二、SDK實現
三、調用方法
header('Content-Type: text/html; charset=UTF-8'); $sms = new Alidayu; $sms->appkey = "24535123"; $sms->secretKey = '1d7ed250f68e3c096f9b18a434760000'; $code = strval(rand(100000,999999)); $requestMethod = "alibaba.aliqin.fc.sms.num.send"; $apiParams = array(); $apiParams["extend"] = "123456"; $apiParams["sms_type"] = "normal"; $apiParams["sms_free_sign_name"] = "方倍工作室"; $apiParams["sms_param"] = json_encode(array("code"=>$code)); $apiParams["rec_num"] = "15889386666"; $apiParams["sms_template_code"] = "SMS_75835210"; $resp = $sms->execute($requestMethod, $apiParams); var_dump($resp);
四、代碼下載
掃描關注下文二維碼,回復 “1245” 獲取