OTP 驗證碼發送

OTP 驗證碼發送介面由 EngageLab 平台產生驗證碼，並依照範本中指定的通道策略進行發送。

如果您希望自行產生驗證碼，而不透過 EngageLab 平台產生，可以呼叫 EngageLab OTP 自訂驗證碼發送 介面。

呼叫位址

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

呼叫驗證

採用 HTTP 基本驗證 的驗證方式，在 HTTP Header（標頭）中加入 Authorization：

              
              Authorization: Basic ${base64_auth_string}

            

上述 base64_auth_string 的產生演算法為：base64(dev_key:dev_secret)

請求範例

請求頭

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

            

請求體

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

            

請求參數

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

關於params的說明

1. 若範本有預設欄位（例如 from_id），當未傳入 param_vars 欄位值時，訊息發送時將使用範本預設的 from_id；
2. 若傳入了 param_vars 欄位值，例如 param_vars:{"from_id":"12345"}，則訊息發送時，範本的 from_id 會被替換為 12345；
3. 同樣地，對於建立範本時在範本內容中自訂的變數欄位，也都透過 param_vars 指派值，例如範本內容為 Hi {{name}}, your verify code is {{code}}，此時需要傳入參數 param_vars:{"name":"Bob"}。

回傳參數

成功回傳

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

            

請注意，回傳的**send_channel**值不代表最終送達使用者的通道，僅代表目前階段所使用的通道；例如，若範本設定的策略中配置了 WhatsApp 通道送達失敗後自動補發 SMS 通道，則介面回傳將會是 whatsapp 值；待一段時間後偵測到送達失敗，系統將改採 SMS 通道發送。

失敗回傳

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

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

            

錯誤碼