Skip to main content

Unban a user

Unban one or more app users.

After unbanning, users can reconnect to the messaging service, send and receive messages normally, and receive offline messages from the ban period upon reconnection. Offline messages are stored for up to 7 days — messages older than 7 days are discarded.

Request method

POST: https://Base URL/v4/user/unban

Rate limit: 100 requests per second

Signature required: All server API requests require signature verification. See API request signature.

Request body

The request body is in application/json format and supports the following parameters:

ParameterTypeRequiredDescription
userIdsString[]YesUser IDs to unban. Maximum 20 per request.

Request example

HTTP
POST /v4/user/unban HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: xxxxxxxxxxxxxxxx
Content-Type: application/json

{
"userIds": [
"jlk456j5",
"jlk45211"
]
}

Response

FieldTypeDescription
codeNumberStatus code. 0 indicates success.

Response example

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":0}