検証

API エンドポイント

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

認証

HTTP ヘッダーに Authorization を追加して HTTP Basic 認証 を使用します:

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 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 への後続リクエストは失敗します。これは、このメッセージの検証コードが既に検証済みであることを示します。検証済みコードの再検証はサポートされていません

失敗レスポンス

HTTP ステータスコードは 4xx または 5xx となり、レスポンスボディには以下のフィールドが含まれます:

フィールド タイプ 必須 説明
code int 必須 エラーコード、詳細は エラーコード を参照してください
message String 必須 エラーの詳細
{ "code": 3003, "message": "verify code has expired" }
              
              {
    "code": 3003,
    "message": "verify code has expired"
}

            
このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

エラーコード HTTP コード 説明
1000 500 内部エラー
2001 401 認証失敗、不正なトークンが提供されました
2002 401 認証失敗、トークンが期限切れまたは無効化されています
2004 403 この API を呼び出す権限がありません
3001 400 無効なリクエストパラメータ形式、JSON コンテンツがパラメータ形式要件を満たしているか確認してください
3002 400 無効なリクエストパラメータ、リクエストパラメータが要件を満たしているか確認してください
3003 400 検証コードが期限切れまたは既に検証済み、新しい検証コードメッセージを送信する必要があります
4001 400 メッセージが存在しません
icon
お問い合わせ