OTP検証
Endpoint
POST https://otp.api.engagelab.cc/v1/verifications
認証
認証には HTTP Basic Authentication を使用し、HTTPヘッダーに Authorization を含めてください。
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"
}
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
| Parameter | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | 検証コードに対応するメッセージID。/messages API によって返されます |
| verify_code | String | Required | 検証対象の認証コード |
レスポンスパラメータ
成功レスポンス
| Field | Type | Required | Description |
|---|---|---|---|
| message_id | String | Required | 検証コードに対応するメッセージID。/v1/messages API によって返されます |
| verify_code | String | Required | 検証対象の認証コード |
| verified | Boolean | Required | 検証結果。true は検証成功、false は検証失敗を示します |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
このコードブロックはフローティングウィンドウ内に表示されます
注: 同じメッセージの認証コードに対して検証リクエストが送信され、そのコードが正常に検証された場合、この検証APIに対する以後のすべてのリクエストは失敗し、このメッセージの認証コードはすでに検証済みであることを示すメッセージが返されます。つまり、一度正常に検証された認証コードは再度検証できません。
失敗レスポンス
HTTPステータスコードは 4xx または 5xx で、レスポンスボディには次のフィールドが含まれます。
| Field | Type | Required | Description |
|---|---|---|---|
| code | int | Required | エラーコード。詳細は Error Codes を参照してください |
| message | String | Required | エラーの詳細 |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
このコードブロックはフローティングウィンドウ内に表示されます
Error Codes
| Error Code | HTTP Code | Description |
|---|---|---|
| 1000 | 500 | 内部エラー |
| 2001 | 401 | 認証失敗：正しいトークンが提供されていません |
| 2002 | 401 | 認証失敗：トークンの有効期限が切れているか、無効化されています |
| 2004 | 403 | このAPIを呼び出す権限がありません |
| 3001 | 400 | 無効なリクエストパラメータ形式です。JSONコンテンツが必要なパラメータ形式に準拠しているか確認してください |
| 3002 | 400 | 無効なリクエストパラメータです。リクエストパラメータが要件を満たしているか確認してください |
| 3003 | 400 | 認証コードの有効期限が切れているか、すでに検証されています。このエラーコードに対するレスポンスでは、新しい認証コードメッセージを送信する必要があります |
| 4001 | 400 | メッセージが存在しません |
