驗證結果上報
透過 EngageLab 下發驗證碼後，如果您在自有系統中完成了驗證碼校驗，可呼叫本 API 上報驗證成功結果，用於回填統計。
本 API 免費，僅接收驗證成功結果。
呼叫網址
POST https://otp.api.engagelab.cc/v1/backfill
呼叫驗證
請參考 呼叫驗證 了解如何進行 API 驗證。
請使用下發該訊息的應用所配置的 API Key，並確保該 API Key 具有驗證碼校驗（verify）權限。
請求範例
請求標頭
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
此代碼塊在浮窗中顯示
請求主體
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
此代碼塊在浮窗中顯示
請求參數
請求主體使用 JSON 格式，請設定請求標頭 Content-Type: application/json。
| 參數 | 類型 | 選項 | 說明 |
|---|---|---|---|
| message_id | String | 必填 | 驗證碼對應的訊息 ID，由下發 API 返回 |
| verified_at | Integer | 必填 | 驗證碼校驗成功的時間，Unix 時間戳，單位為秒 |
回傳參數
成功返回
HTTP 狀態碼為 200，表示平台已記錄本次驗證成功結果。
| 欄位 | 類型 | 選項 | 描述 |
|---|---|---|---|
| code | Integer | 必填 | 成功時為 0 |
| message | String | 必填 | 結果說明，成功時為 success |
{
"code": 0,
"message": "success"
}
{
"code": 0,
"message": "success"
}
此代碼塊在浮窗中顯示
失敗返回
HTTP 狀態碼為 4xx 或 5xx，回應主體包含錯誤碼和錯誤說明。例如，訊息已驗證成功時返回 HTTP 400：
| 欄位 | 類型 | 選項 | 描述 |
|---|---|---|---|
| code | Integer | 必填 | 錯誤碼，詳見下方錯誤碼說明 |
| message | String | 必填 | 錯誤說明 |
{
"code": 3012,
"message": "verify code has already validated"
}
{
"code": 3012,
"message": "verify code has already validated"
}
此代碼塊在浮窗中顯示
錯誤碼
| 錯誤碼 | http code | 說明 |
|---|---|---|
| 1000 | 500 | 服務內部錯誤，請稍後重試 |
| 2001 | 401 | 認證資訊缺失或無效 |
| 2002 | 401 | API Key 已過期或已被停用 |
| 2002 | 403 | 目前應用不可用 |
| 2004 | 403 | API Key 沒有呼叫本 API 的權限 |
| 3001 | 400 | 請求 JSON 無效或參數類型不正確 |
| 3002 | 400 | 參數值無效、時間超出允許範圍，或訊息不支援回填 |
| 3012 | 400 | 訊息已驗證成功，無需再次上報 |
| 4001 | 400 | 訊息不存在或不屬於目前應用 |
請根據 code 處理錯誤，message 用於說明具體原因。
使用說明
- 僅支援成功發送的驗證碼訊息。此前在平台校驗失敗或逾時的訊息，仍可上報您自行校驗成功的結果。
- 首次上報須在原訊息發送後不足 30 天內完成，以平台接收請求的時間為準。
- 驗證成功時間不能早於原訊息發送時間，也不能晚於平台接收本次請求的時間。
- 訊息已透過本 API 或 驗證碼校驗 API 記錄為驗證成功後，再次上報或校驗均返回
3012。
回填成功後，平台將按應用的 回調配置 推送相應訊息狀態。
