Skip to main content

Globally unmute a user

Remove the global mute status for one or more users across all open channels under the current App Key.

Request

POST: https://Base URL/v4/open-channel/global-mute-list/remove

Rate limit: 100 per second

Signature: Required. See API request signature.

Request body

Content type: application/json

ParameterTypeRequiredDescription
participantIdsArrayYesUser IDs to unmute globally. Maximum 20 per request.
extraStringNoJSON-formatted extra data carried in the notification. Valid only when needNotify is true.
needNotifyBooleanNoWhether to notify the unmuted user. The default is false, which sends no notification. If true, the client triggers the corresponding callback.

Request example

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

{
"participantIds": [
"2582",
"2583"
]
}

Response

FieldTypeDescription
codeNumberReturn code. 0 indicates success.

Response example

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

{
"code": 0
}