Get blocked user information
If a user tries to sign in at a community or game web page with Web Login API, this API lets you know whether this user was blocked in the game or not.
Basics
| Description | |
|---|---|
| Request URL |
|
| Method | POST |
| HTTP Header | Content-type: application/json |
| Response Format | JSON |
Request
| Name | Type | Required | Description |
|---|---|---|---|
| appid | String | O | the AppID |
| player_id | Integer | O | the PlayerID |
| language | String | X |
This is the language value. If left empty, it is automatically set to English.
|
Response
| Name | Type | Description | Notes |
|---|---|---|---|
| code | Integer | Result Code |
* not valid: No value or a null value exists. If you get 2016 or 2019, go to Hive console AppCenter and check out the game or the company configurations. |
| data | Object | the result data | |
| data.is_blocked | Boolean | Whether the user is blocked in the game or not. |
|
| data.status | String | blocking status |
|
| data.start_date | String | the start date and time of blocking | |
| data.end_data | String | the end date and time of blocking | |
| data.remaining_date | String | the remaining days until the blocking is released | This will be shown following the provided language value(default: English) |
| data.reason | String | the reasons for blocking | This will be shown following the provided language value(default: English) |
Request Examples
|
1 2 3 |
curl -X POST https://weblogin.withhive.com/block_info -H 'Content-Type: application/json' -d '{"appid": "com.com2us.hivesdk.normal.freefull.google.global.android.common", "player_id": 20000020208, "language": "ko"}' |
Response Examples
Success (normal user)
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "code": 100, "data": { "is_blocked": false, "status": "N", "start_date": null, "end_date": null, "remaining_date": null, "reason": null } } |
Success (a user blocked for a specific period of time)
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "code": 100, "data": { "is_blocked": true, "status": "B", "start_date": "2023-07-12 14:42:17", "end_date": "2023-10-10 14:42:17", "remaining_date": "90 day(s)", "reason": "Temporary Restriction (Retrieve game money)" } } |
Success (a user permanently blocked)
|
1 2 3 4 5 6 7 8 9 10 11 |
{ "code": 100, "data": { "is_blocked": true, "status": "P", "start_date": "2023-07-12 14:42:17", "end_date": "9999-12-31 00:00:00", "remaining_date": "Permanent", "reason": "Temporary Restriction (Retrieve game money)" } } |
Failure
|
1 2 3 4 |
{ "code": 2002, "data": {} } |