Check group channel freeze status

Check the freeze status of one or more group channels. This endpoint supports two modes:

• Query specific groups: Pass one or more group channel IDs to check their freeze status.
• List all frozen groups: Omit channelIds to retrieve a paginated list of all frozen group channels under the current App Key.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/group-channel/freeze-list/get

Rate limit: 100 per second

Signature: Required. See API request signature.

Request body

Content type: application/json

Parameter	Type	Required	Description
channelIds	Array	No	Group channel IDs to check. Max 20 per request.
page	Number	No	Page number (1-based). Used for paginated queries when channelIds is omitted. Default: 1.
pageSize	Number	No	Results per page. Used for paginated queries when channelIds is omitted. Default: 50. Maximum: 200.

note

When page or pageSize is specified, the channelIds parameter is ignored.

Request example

HTTP

POST /v4/group-channel/freeze-list/get HTTP/1.1
Host: api.sg-light-api.com
App-Key: c9kqb3rdkbb8j
Nonce: 97
Timestamp: 1480479442
Signature: 9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/json

{
    "channelIds": ["groupId1", "groupId2"]
}

Response

Field	Type	Description
code	Number	Return code. 0 indicates success.
result	Object	Result data.
result.freezeStatuses	Object[]	Array of group channel freeze statuses.
result.freezeStatuses[i].channelId	String	Group channel ID.
result.freezeStatuses[i].status	Number	Freeze status. 0: not frozen. 1: frozen.

Response example

HTTP

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

{
  "code": 0,
  "result": {
    "freezeStatuses": [
      {
        "channelId": "groupId1",
        "status": 1
      },
      {
        "channelId": "groupId2",
        "status": 1
      }
    ]
  }
}