自訂驗證碼下發

如果您希望自行生成驗證碼而不透過 EngageLab 平台生成，可以呼叫本 API。

本 API 專用於發送預先生成的驗證碼，不會自行生成驗證碼。發送驗證碼後，無須呼叫驗證 API 進行驗證。

如果您希望 EngageLab 平台生成驗證碼，可以呼叫 EngageLab OTP 驗證碼下發 API。

呼叫網址

POST https://otp.api.engagelab.cc/v1/codes

呼叫驗證

請參考 呼叫驗證 了解如何進行 API 驗證。

請求範例

請求標頭

              
              POST /v1/codes  HTTP/1.1  
Content-Type: application/json  
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

請求主體

              
              {
    "to": "+6591234567",
    "code":"398210",
    "template":{
      "id":"test-template-1",
      "language": "default",
        "params": {
        "key1": "value1",
        "key2": "value2"
        }
    }
}

            

請求參數

一個請求物件以 JSON 格式表示，因此請求標頭需要帶 Content-Type: application/json。

關於 params 的說明

1. 對於範本有預設的欄位如 from_id，若不傳 params 欄位值，則訊息下發時使用範本預設的 from_id；
2. 若傳遞了 params 欄位值，如 params:{"from_id":"12345"}，則訊息下發時，範本的 from_id 將會替換成 12345；
3. 同時對於建立範本時範本內容有自訂的變數欄位，也都透過 params 進行賦值，如範本內容 Hi {{name}}, your verify code is {{code}}，此時需要賦值參數 params:{"name":"Bob"}
4. Email 管道特殊變數：對於 Email 管道，支援透過 params 動態覆蓋郵件主旨（subject）、寄件者名稱（from_name）、寄件者信箱（from_mail）等。詳細的高階用法請參考 建立範本 - Email 範本變數高階用法。

回傳參數

成功返回

              
              {
    "message_id": "1725407449772531712",
    "send_channel": "sms"
}

            

注意，返回的 **send_channel** 值不代表最終下發到使用者的管道，僅代表現階段使用的管道；如範本配置的策略中配置了 WhatsApp 管道送達失敗然後自動補發 SMS 管道，則 API 返回將返回 whatsapp 值，一定時間後感知到送達失敗，系統將採用 SMS 管道發送

失敗返回

HTTP 狀態碼為 4xx 或者 5xx，回應主體包含欄位如下：

              
              {
    "code": 5001,
    "message": "sms send fail"
}

            

錯誤碼