Verify OTP API

ユーザーが入力した認証コード（OTP）の有効性を確認します。実装前に API共通仕様を確認してください。

Send OTP API で認証コードを送信した後、ユーザーの電話番号と入力された認証コードを指定するだけで、サーバー側にコードを保持することなく正当性を確認できます。

定義

Action: otp.verify
HTTP Method: POST
Content-Type: application/json

リクエストパラメータ

Name	Type	Required	Description	Example
to	string	Yes	認証対象の電話番号。E.164形式	+12068800123
code	string	Yes	検証対象の認証コード。4〜8桁の数字文字列	123456
intent	string	No	認証コードの利用目的。Send OTP APIで渡した値と同じにしてください。最大36文字	login
ttl	integer	No	認証コードの有効期限（秒）。最大 `1800`。既定値: `300`。 * 自動生成された認証コードにのみ適用され、カスタム認証コードには影響しません。	300

リクエスト例

以下の例では、ユーザーが入力した認証コードが正しいかどうかを判定します。

curl -X POST 'https://api.unimtx.com/?action=otp.verify&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+120688001xx",
  "code": "123456"
}'

レスポンスパラメータ

Name	Type	Description	Example
code	string	戻り値コード	0
message	string	戻り値メッセージ	Success
data	JSON	結果

Results `data`

Name	Type	Description	Example
to	string	認証対象の電話番号（E.164）	+12068800123
valid	boolean	認証コードが有効かどうか	true

レスポンス例

成功レスポンス例

Status Code: 200, Response Body:

{
  "code": "0",
  "message": "Success",
  "data": {
    "to": "+12068800123",
    "valid": true
  }
}

失敗レスポンス例

Status Code: 400, Response Body:

{
  "code": "104001",
  "message": "MissingParams"
}