Get freeze status

Query the freeze status for a specified community channel or subchannel.

Request method

POST: https://Base URL/v4/community-channel/freeze-list/get

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:

Parameter	Type	Required	Description
channelId	String	Yes	The community channel ID.
subchannelId	String	No	The subchannel ID.

Request example

HTTP

POST /v4/community-channel/freeze-list/get HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "channelId": "abcdefg"
}

Response

The response body contains a JSON object with the following structure:

Field	Type	Description
code	Number	Status code. 0 indicates success.
result.status	Boolean	true = frozen. false = unfrozen.

Response example

HTTP

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

{
    "code": 0,
    "result": {
        "status": true
    }
}