EngageLab

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

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

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

此代碼塊在浮窗中顯示

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

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

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

此代碼塊在浮窗中顯示

{ "message_id": "1725407449772531712", "verify_code": "667090" }

              
              {
    "message_id": "1725407449772531712",
    "verify_code": "667090"
}

此代碼塊在浮窗中顯示

參數	類型	選項	說明
message_id	String	必填	一次性密碼對應的訊息 ID，由 /messages 介面回傳
verify_code	String	必填	需要驗證的一次性密碼

欄位	類型	選項	描述
message_id	String	必填	一次性密碼對應的訊息 ID，由 /v1/messages 介面回傳
verify_code	String	必填	需要驗證的一次性密碼
verified	Boolean	必填	驗證結果，true 表示驗證成功，false 表示驗證失敗

{ "message_id": "1725407449772531712", "verify_code": "667090", "verified": true }

              
              {
    "message_id": "1725407449772531712",
    "verify_code": "667090",
    "verified": true
}

此代碼塊在浮窗中顯示

注意，對同一則訊息的一次性密碼發送驗證請求時，若一次性密碼已驗證成功，再次請求本驗證介面，則介面將回傳失敗，並提示本訊息驗證碼已完成驗證；亦即不支援對驗證成功後的一次性密碼再次進行驗證。

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

欄位	類型	選項	描述
code	int	必填	錯誤碼，詳見錯誤碼說明
message	String	必填	錯誤詳情

{ "code": 3003, "message": "verify code has expired" }

              
              {
    "code": 3003,
    "message": "verify code has expired"
}

此代碼塊在浮窗中顯示

錯誤碼	http code	說明
1000	500	內部錯誤
2001	401	驗證失敗，未攜帶正確的 token
2002	401	驗證失敗，token 已過期或已被停用
2004	403	無呼叫此 API 的權限
3001	400	請求參數格式無效，請檢查是否為符合參數格式的 JSON 內容
3002	400	請求參數有誤，請檢查請求參數是否符合要求
3003	400	一次性密碼已過期或已驗證；對於此錯誤碼的回應，需要重新下發新的一次性密碼訊息
4001	400	該訊息不存在

一次性密碼驗證