Skip to main content

Check community channel membership

Check whether a specified user is a member of a specified community channel.

Request method

POST: https://Base URL/v4/community-channel/member/exist

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
userIdStringYesThe user ID to check.
channelIdStringYesThe community channel ID to check.

Request example

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

{
"userId": "1",
"channelId": "123"
}

Response

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

FieldTypeDescription
codeNumberStatus code. 0 indicates success.
result.isMemberBooleanWhether the user is a member. true = member, false = not a member.

Response example

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

{
"code": 0,
"result": {
"isMember": true
}
}