検証結果の報告
EngageLab から検証コードを送信した後、独自システムで検証を完了した場合は、この API を呼び出して検証成功の結果をバックフィル統計用に報告できます。
この API は無料で、検証成功の結果のみを受け付けます。
リクエスト URL
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 コード | 説明 |
|---|---|---|
| 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 または OTP 検証 API で検証成功として記録された後、再度の報告または検証はいずれも
3012を返します。
バックフィルが成功すると、プラットフォームはアプリケーションの コールバック設定 に従って、対応するメッセージ状態をプッシュします。
