Create a subchannel

Create an independent subchannel (busChannel) within a specified community channel. Each community channel supports up to 50 subchannels.

Community channels support creating independent subchannels where messages, conversations, and unread counts are aggregated separately. Each subchannel maintains its own message stream while sharing the community channel's member list.

Subchannels are either public or private. You can specify the type at creation or change it later via API.

• Public subchannel: Open to all community channel members (no explicit join required). All members can send and receive messages in any public subchannel.
• Private subchannel: Only users on the private subchannel member list can send and receive messages.

Request method

POST: https://Base URL/v4/community-channel/subchannel/create

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. Must already exist.
subchannelId	String	Yes	The subchannel ID. Supports uppercase and lowercase letters and numbers. Maximum 20 characters.
channelVisibility	Number	No	Subchannel type. 0 = public (default). 1 = private.

Request example

HTTP

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

{
    "channelId": "abcdefg",
    "subchannelId": "channel001",
    "channelVisibility": 1
}

Response

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

Field	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

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

{"code":0}