コンテンツにスキップ

アプリ利用停止ユーザーを確認する

This API checks whether a user is blocked from entering the app when the user attempts web login from a community or web page.


リクエストURL

本番URL https://auth.qpyou.cn/v2/game/block/get
サンドボックスURL https://sandbox-auth.qpyou.cn/v2/game/block/get
HTTPメソッド POST
Content-Type application/json
データ形式 JSON


リクエストヘッダー

フィールド名 説明 タイプ 必須
X-Access-Token アプリサーバー認証用のOAuth 2.0 Access Token
(OAuth Tokenを発行するを参照)		 String Y
ISCRYPT データ暗号化の有無（0 = 暗号化しない）（必ず0を送信） Integer Y


リクエスト本文

フィールド名 説明 タイプ 必須
appid App ID String Y
player_id Player ID Integer Y
language Language value. If omitted, English is used by default.
  • ko (Korean)
  • en (English)
  • ja (Japanese)
  • zh-hans (Simplified Chinese)
  • zh-hant (Traditional Chinese)
  • de (German)
  • fr (French)
  • ru (Russian)
  • es (Spanish)
  • pt (Portuguese)
  • id (Indonesian)
  • th (Thai)
  • vi (Vietnamese)
  • it (Italian)
  • tr (Turkish)
  • ar (Arabic)
String N


リクエスト例

{"appid":"com.com2us.hivesdk.normal.freefull.apple.global.ios.universal","player_id":20000020208,"language":"ko"}


レスポンス本文

フィールド名 説明 タイプ
result_code レスポンスコード 詳細 Integer
result_msg 結果メッセージ String
token_validation JWT検証結果（JWT検証エラー） Object
token_validation.result_code JWT検証結果コード Integer
token_validation.result_msg JWT検証結果メッセージ String
data 結果データ Object
data.is_blocked Whether access is suspended
  • true: suspended user
  • false: normal user
 Boolean
data.status Suspension status
  • N: normal user
  • P: permanently suspended user
  • B: user suspended for a specified period
 String
data.start_date Suspension start date String
data.end_date Suspension end date String
data.remaining_date Remaining suspension period (returned in the requested language; default: English) String
data.reason Suspension reason (returned in the requested language; default: English) String

レスポンスコード

Code value 説明
0 成功
2499 JWT検証失敗（token_validationを参照）
4000 無効なパラメータ
6000 無効なappid


レスポンス例

成功 (normal user)

{"result_code":0,"result_msg":"SUCCESS","token_validation":{"result_code":0,"result_msg":"success"},"data":{"is_blocked":false,"status":"N","start_date":null,"end_date":null,"remaining_date":null,"reason":null}}

成功 (user suspended for a specified period)

{"result_code":0,"result_msg":"SUCCESS","token_validation":{"result_code":0,"result_msg":"success"},"data":{"is_blocked":true,"status":"B","start_date":"2024-05-15 10:00:00","end_date":"2024-06-30 23:59:59","remaining_date":"27d 5hr 8min","reason":"Temporary Restriction (Retrieve game money)"}}

成功 (permanently suspended user)

{"result_code":0,"result_msg":"SUCCESS","token_validation":{"result_code":0,"result_msg":"success"},"data":{"is_blocked":true,"status":"P","start_date":"2024-05-15 10:00:00","end_date":"9999-12-31 00:00:00","remaining_date":"Permanent","reason":"Temporary Restriction (Retrieve game money)"}}

JWT validation failure

{
  "result_code": 2499,
  "result_msg": "JWT validation failed. See token_validation for details.",
  "token_validation": {
    "result_code": 2408,
    "result_msg": "The access token is expired. Please refresh your token."
  }
}

失敗

{"result_code":4000,"result_msg":"Request has invalid format.","token_validation":{"result_code":0,"result_msg":"success"},"data":"player_id"}
Note

JWT検証に失敗した場合、token_validationフィールドで詳細なエラー情報を確認できます。詳細はJWT検証エラーコードを参照してください。