Obtaining Basic Player Information

POST

/v2/player/current/online-status

TIP

This interface is used for obtaining the current player status (online/offline), player type, screen resolution, system version, IP address, etc.

Sub-accounts can only manage data within their specific workgroup and its sub-workgroups.

Basic interface.

Request

Header Params

AppKey

string

required

Access key

Default:

Nonce

string

required

Random string (8-64 characters, only numbers or letters)

CurTime

string

required

The current UTC timestamp

CheckSum

string

required

Request signature

Body Params application/json

playerIds

array[string]

required

A collection of player IDs to be handled. At most 100 player IDs can be handled simultaneously.

playerSns

array[string]

required

A maximum of 100 players can be processed at the same time. With playerIds, this parameter is mandatory

Example

{
    "playerIds": [
        "8208967d40e9980bab6d12367dc88e0b"
    ]
}
or
{
    "playerSns": [
        "2KKA02B12N0A10000151"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-us.vnnox.com/v2/player/current/online-status' \
--header 'AppKey;' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "playerIds": [
        "8208967d40e9980bab6d12367dc88e0b"
    ]
}
or
{
    "playerSns": [
        "2KKA02B12N0A10000151"
    ]
}'

Responses

🟢200OK

application/json

Body

array of:

playerId

string

optional

Player ID

string

optional

Unique ID of a player. Null denotes that the player is not bound.

onlineStatus

integer

optional

Player status, 0-Offline, 1-Online.

lastOnlineTime

string

optional

Last heartbeat time of the player

Example

[
  {
    "playerId": "130c0a9f4cd9f2c9d421a97b0293e5d6",
    "sn": "BZSA07216J0550000373",
    "onlineStatus": 1,
    "lastOnlineTime": "2020-09-09 14:48:50"
  }
]

Modified at 2024-08-07 01:35:37

Obtain player list

Obtaining Player Configuration Status