API Overview
Message Callbacks
Status Codes
Overview
When global mute is enabled for a chatroom, no members except allowlisted users can send messages. Messages sent through the Server API are not affected by the mute setting.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/chatrooms/chrmmute/set
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| chat_id | string | Yes | Chatroom ID. Maximum length: 32 characters. | |
| is_mute | int | Yes | Global mute status. 0: disabled; 1: enabled. |
Request Example
POST /apigateway/chatrooms/chrmmute/set HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"chat_id":"chatroomid1",
"is_mute":1
}
Response Example
{
"code":0,
"msg":"sucess"
}