Kick Player
Forcefully terminate all sessions or specific sessions of a designated Player.
API Information
- URL:
POST /v2/members/sessions/logout - Authentication: Bearer Token
- Encryption: Requests are encrypted using AES-256-GCM; responses are returned as plaintext JSON
- Note:
- If the Player is online, the Player will receive a notification message.
- If the Player is playing a Games, the Games will be terminated and settled immediately.
request
Request Headers
POST /v2/members/sessions/logout HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
x-agentid: integratorNBTest04
x-timestamp: 1769746894501
x-nonce: 56ffd5ecd8a3a4457863a0bd7c298fb2
x-signature: 904e97bee2589b93e9747eed0346c68b23d8ff8b568dabaf4b94a5e89093df67
Request Parameters
Parameters Before Encryption
{
"username": "player001",
}
Encrypted Request Body
{
"cipherText": "G0ZMDELeJwx+7JcIfIFOLJjkSzANPu6krGM2uw==..."
}
| Field | Type | Required | Description |
|---|---|---|---|
username | string | Yes | Player Account |
Response
Success Response
{
"code": 0,
"message": "No error.",
"logUUID": "6589bf8d-fe74-48bd-841a-71bf8f848f86"
}
Error Response
{
"code": 8,
"message": "The User is not exist.",
"logUUID": "6589bf8d-fe74-48bd-841a-71bf8f848f86"
}
Common Error Codes
| Code | Description |
|---|---|
| 8 | Player doesn't exist |
| 11 | Parameters error |
| 81 | Branch config not found |
| 83 | Authentication Failed |
| 84 | Decryption Failed |
For more error code descriptions, please refer to: Appendix - Error Code Overview