Freeze an open channel
Freeze an open channel. When frozen, all participants are prevented from sending messages via the client SDK.
- Use the allowed senders list to exempt specific users from the freeze.
- The freeze is automatically lifted when the open channel is destroyed.
important
Messages sent via the Platform Chat API are not affected by the freeze. Users can still send messages through the server API.
Request
POST: https://[Base URL](/platform-chat-api/base-url)/v4/open-channel/freeze-list/add
Rate limit: 100 per second
Signature: Required. See API request signature.
Request body
Content type: application/json
| Parameter | Type | Required | Description |
|---|---|---|---|
channelId | String | Yes | The open channel ID to freeze. |
extra | String | No | JSON-formatted extra data for the notification. Only effective when needNotify is true. |
needNotify | Boolean | No | Whether to notify participants. Default: false. When true, notifies all participants (requires Android/iOS IMLib >= 5.4.5; Web IMLib >= 5.7.9). |
Request example
HTTP
POST /v4/open-channel/freeze-list/add HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json
{
"channelId": "123"
}
Response
| Field | Type | Description |
|---|---|---|
code | Number | Return code. 0 indicates success. |
Response example
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":0}