List subchannels

Retrieve the list of subchannels in a specified community channel. Each community channel supports up to 50 subchannels.

Request method

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

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.
page	Number	No	Page number. Defaults to 1.
pageSize	Number	No	Number of items per page. Defaults to 20. Maximum 100.

Request example

HTTP

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

{
    "channelId": "abcdefg",
    "page": 1,
    "pageSize": 20
}

Response

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

Field	Type	Description
code	Number	Status code. 0 indicates success.
result.subchannels	Array	List of subchannels.
result.subchannels[i].subchannelId	String	The subchannel ID.
result.subchannels[i].createdAt	String	The subchannel creation time.
result.subchannels[i].channelVisibility	Number	Subchannel type. 0 = public. 1 = private.

Response example

HTTP

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

{
    "code": 0,
    "result": {
        "subchannels": [
            {
                "subchannelId": "channel001",
                "createdAt": "2022-02-14 11:19:42",
                "channelVisibility": 0
            }
        ]
    }
}