Skip to main content

Dismiss a community channel

Dismiss a specific community channel.

  • All members are removed and can no longer receive messages in this community channel.
  • After dismissal, member relationships no longer exist. Server-side message history becomes inaccessible from the client, though messages previously saved to local storage can still be viewed.

Workflow

Nexconn does not host community channel business logic, so all business logic must be implemented on your app server. For client developers, dismissing a community channel only requires interacting with your app backend.

To dismiss a community channel from the app client, the app sends a request to your app server, which then calls the Nexconn Server API.

Request method

POST: https://Base URL/v4/community-channel/dismiss

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
channelIdStringYesThe community channel ID to dismiss.

Request example

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

{
"channelId": "abcdefg"
}

Response

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

FieldTypeDescription
codeNumberStatus code. 0 indicates success.

Response example

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

{"code":0}