跳转至

检查被限制进入应用的用户

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 验证错误代码。