OTP 検証

リクエスト URL

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 インターフェースで返却される
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 コード	説明
1000	500	内部エラー
2001	401	認証失敗。付与されたトークンが正しくない
2002	401	認証失敗。トークンが期限切れまたは無効化されている
2004	403	この API を呼び出す権限がない
3001	400	リクエストパラメータの形式が不正。JSON の内容がパラメータ形式に準拠しているか確認してください
3002	400	リクエストパラメータが正しくない。リクエストパラメータが要件を満たしているか確認してください
3003	400	検証コードが期限切れ、またはすでに検証済み。このエラーコードのレスポンスに対しては、新しい検証コードメッセージを再送信する必要があります
3011	400	検証コードの期限切れ
4001	400	メッセージが存在しない