驗證碼校驗
呼叫網址
POST https://otp.api.engagelab.cc/v1/verifications
呼叫驗證
請參考 呼叫驗證 了解如何進行 API 驗證。
請求範例
請求標頭
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 API 返回 |
| verify_code | String | 必填 | 需要校驗的驗證碼 |
回傳參數
成功返回
| 欄位 | 類型 | 選項 | 描述 |
|---|---|---|---|
| message_id | String | 必填 | 驗證碼對應的訊息 ID，由 /v1/messages API 返回 |
| verify_code | String | 必填 | 需要校驗的驗證碼 |
| verified | Boolean | 必填 | 校驗結果，true 表示校驗成功，false 表示校驗失敗 |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
此代碼塊在浮窗中顯示
注意，對同一訊息的驗證碼進行校驗請求，若驗證碼校驗成功，再次請求本校驗 API，則 API 將返回失敗，提示為本訊息校驗碼已完成校驗；即不支援對驗證成功後的驗證碼再次進行驗證。
失敗返回
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 | 驗證碼過期或已驗證，對於該錯誤碼的回應，需要重新下發新的驗證碼訊息 |
| 3011 | 400 | 驗證碼過期 |
| 4001 | 400 | 該訊息不存在 |
