傳送阿里雲簡訊通知

更新時間：2023-04-04 09:31:23

介面描述

1、根据用户配置的模板发送短信通知
2、（timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/sms/send

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

2、介面呼叫頻率限制，單一使用者、IP每日簡訊傳送上限2000，單一手機號碼每日傳送上限10則

3、使用前帳號需設定阿里雲簡訊範本

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】

請求體參數說明

參數名	必填	類型	說明
phoneNumbers	true	Array	手機號碼，長度11位，最大200個
templateParamNames	true	Array	簡訊範本的參數名稱
templateParamValues	true	Array	簡訊範本參數名稱對應的參數值，與參數名稱一一對應

範例

http://api.polyv.net/live/v4/user/sms/send?appId=frlr1zazn3&timestamp=1656903040000&sign=9E0DCCEAB6A9D255717C9BEAB66CFDCA

請求體json參數：

{
    "phoneNumbers": [1768909,17680476163],
    "templateParamNames": ["code"],
    "templateParamValues": [9802]
}

回應參數說明

參數名	類型	說明
code	Integer	狀態碼，與http狀態碼相同，用於確定基本的回應狀態
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	是否成功回應
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應與業務掛鉤
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
data	Array	【詳見data欄位說明】

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與error.code對應

data參數說明

參數名	類型	說明
phoneNumber	String	手機號碼
status	Integer	簡訊狀態 -1：傳送失敗，手機號碼超過每日傳送頻次限制 -2：傳送失敗，手機號碼不合法（非數字、長度錯誤） 11：傳送失敗（呼叫阿里雲簡訊介面失敗） 12：傳送成功（呼叫阿里雲簡訊介面成功，進入簡訊傳送佇列等待傳送，並非成功傳送到手機）
serialNo	String	傳送成功時回傳阿里雲回執ID流水號

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 发送阿里云短信通知
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void sendSmsTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/sms/send";
    List<String> phoneNumbers = Arrays.asList("17677777777");
    List<String> templateParamNames = Arrays.asList("code");
    List<String> templateParamValues = Arrays.asList("9876");
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("phoneNumbers", phoneNumbers);
    jsonMap.put("templateParamNames", templateParamNames);
    jsonMap.put("templateParamValues", templateParamValues);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试发送短信通知成功：{}", response);
    //do somethings
    
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "f2a4a564-4dd6-4a9f-b58e-05580cd69939",
    "data": [
        {
            "serialNo": "605320356903663783^0",
            "phoneNumber": "17680476163",
            "status": 12
        },
        {
            "serialNo": null,
            "phoneNumber": "1768909",
            "status": -2
        }
    ],
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}