Skip to main content

You are viewing Agora Docs forBeta products and features. Switch to Docs

Manage chat room allow list

A chat room allow list refers to a list of chat room members that can send messages after the chat room owner or admins have muted all the chat room members using the global mute method. Chat provides a complete set of allow list management methods, including adding users to the allow list and removing them from it, as well as retrieving the members on the allow list.

This page shows how to manage a chat room allow list using the Chat RESTful APIs. Before calling the following methods, ensure that you understand the call frequency limit described in Limitations.

Common parameters

The following table lists common request and response parameters of the Chat RESTful APIs:

Request parameters

ParameterTypeDescriptionRequired
hostStringThe domain name assigned by the Chat service to access RESTful APIs. For how to get the domain name, see Get the information of your project.Yes
org_nameStringThe unique identifier assigned to each company (organization) by the Chat service. For how to get the org name, see Get the information of your project.Yes
app_nameStringThe unique identifier assigned to each app by the Chat service. For how to get the app name, see Get the information of your project.Yes
usernameStringThe unique login account of the user. The user ID must be 64 characters or less and cannot be empty. The following character sets are supported:
  • 26 lowercase English letters (a-z)
  • 26 uppercase English letters (A-Z)
  • 10 numbers (0-9)
  • "_", "-", "."
  • The username is case insensitive, so Aa and aa are the same username.
  • Ensure that each username under the same app is unique.
Yes
chatroom_idStringThe chat room ID. The unique chat room identifier assigned to each chat room by the Chat. You can get the chat room ID from the response body in Retrieve the basic information of all chat rooms.Yes

Response parameters

ParameterTypeDescription
actionStringThe request method.
organizationStringThe unique identifier assigned to each company (organization) by the Chat service. This is the same as org_name.
applicationStringA unique internal ID assigned to each app by the Chat service. You can safely ignore this parameter.
applicationNameStringThe unique identifier assigned to each app by the Chat service. This is the same as app_name.
uriStringThe request URI.
pathStringThe request path, which is part of the request URI. You can safely ignore this parameter.
entities JSONThe response entity.
dataJSONThe details of the response.
timestampNumberThe Unix timestamp (ms) of the HTTP response.
durationNumberThe duration (ms) from when the HTTP request is sent to the time the response is received.
chatroomidStringThe unique identifier of the chat room.

Authorization

Chat RESTful APIs require Bearer HTTP authentication. Every time an HTTP request is sent, the following Authorization field must be filled in the request header:


_1
Authorization: Bearer ${YourAppToken}

In order to improve the security of the project, Agora uses a token (dynamic key) to authenticate users before they log in to the chat system. Chat RESTful APIs only support authenticating users using app tokens. For details, see Authentication using App Token.

Retrieving the chat room allow list

Retrieves the list of all the members on the chat group allow list.

For each App Key, the call frequency limit of this method is 100 per second.

HTTP request


_1
GET https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

Path parameter

For the parameters and detailed descriptions, see Common parameters.

Request header

ParameterTypeDescriptionRequired
Content-TypeStringThe parameter type. Set it as application/json.Yes
AuthorizationStringThe authentication token of the user or administrator, in the format of Bearer ${token}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.Yes

HTTP response

Response body

If the returned HTTP status code is 200, the request succeeds, and the data field in the response body contains the usernames in the chat room allow list.

If the returned HTTP status code is not 200, the request fails. You can refer to Status code for possible causes.

Example

Request example


_1
curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://XXXX/XXXX/XXXX/chatrooms/XXXX/white/users'

Response example


_18
{
_18
"action": "get",
_18
"application": "5cf28979-XXXX-XXXX-b969-60141fb9c75d",
_18
"uri": "http://XXXX/XXXX/XXXX/chatrooms/XXXX/white/users",
_18
"entities": [],
_18
"data": [
_18
"wzy_test",
_18
"wzy_vivo",
_18
"wzy_huawei",
_18
"wzy_xiaomi",
_18
"wzy_meizu"
_18
],
_18
"timestamp": 1594724947117,
_18
"duration": 3,
_18
"organization": "XXXX",
_18
"applicationName": "XXXX",
_18
"count": 5
_18
}

Adding a user to the chat room allow list

Adds the specified user to the chat room allow list. Members in the chat room allow list can still send messages after the chat room owner or an admin has muted all the chat room members using the global mute method.

For each App Key, the call frequency limit of this method is 100 per second.

HTTP request


_1
POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

Path parameter

For the parameters and detailed descriptions, see Common parameters.

Request header

ParameterTypeDescriptionRequired
Content-TypeStringThe parameter type. Set it as application/json.Yes
AuthorizationStringThe authentication token of the user or administrator, in the format of Bearer ${token}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.Yes

HTTP response

Response body

If the returned HTTP status code is 200, the request succeeds, and the data field in the response body contains the following fields:

ParameterTypeDescription
resultBooleanWhether the user is successfully added to the chat room allow list.
  • true: Yes.
  • false: No.
  • userStringThe username added to the chat room block list.

    For other parameters and detailed descriptions, see Common parameters.

    If the returned HTTP status code is not 200, the request fails. You can refer to Status code for possible causes.

    Example

    Request example


    _1
    curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://XXXX/XXXX/XXXX/chatrooms/{XXXX}/white/users/{username}'

    Response example


    _16
    {
    _16
    "action": "post",
    _16
    "application": "5cf28979-13e7-4c87-b969-60141fb9c75d",
    _16
    "uri": "http://XXXX/XXXX/XXXX/chatrooms/XXXX/white/users/wzy_xiaomi",
    _16
    "entities": [],
    _16
    "data": {
    _16
    "result": true,
    _16
    "action": "add_user_whitelist",
    _16
    "user": "wzy_xiaomi",
    _16
    "chatroomid": "XXXX"
    _16
    },
    _16
    "timestamp": 1594724293063,
    _16
    "duration": 4,
    _16
    "organization": "XXXX",
    _16
    "applicationName": "XXXX"
    _16
    }

    Adding multiple members to the chat room allow list

    Adds multiple users to the chat room allow list. You can add a maximum of 60 users to the chat room allow list each time.

    For each App Key, the call frequency limit of this method is 100 per second.

    HTTP request


    _1
    POST https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users

    Path parameter

    For the parameters and detailed descriptions, see Common parameters.

    Request header

    ParameterTypeDescriptionRequired
    Content-TypeStringThe parameter type. Set it as application/json.Yes
    AuthorizationStringThe authentication token of the user or administrator, in the format of Bearer ${token}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.Yes

    Request body

    ParameterTypeDescription
    usernamesArrayThe array of usernames to be added to the chat room allow list. You can specify a maximum of 60 usernames, separated by commas (,).

    HTTP response

    Response body

    If the returned HTTP status code is 200, the request succeeds, and the data field in the response body contains the following parameters.

    ParameterTypeDescription
    resultBooleanWhether the users are successfully added to the chat room allow list.
  • true: Yes.
  • false: No.
  • reasonStringThe reason why the users fail to be added to the chat room allow list.
    userStringThe usernames added to the chat room allow list.

    For the parameters and detailed descriptions, see Common parameters.

    If the returned HTTP status code is not 200, the request fails. You can refer to Status code for possible causes.

    Example

    Request example


    _1
    curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' -d '{"usernames" : ["user1"]}' 'http://XXXX/XXXX/XXXX/chatrooms/{XXXX}/white/users'

    Response example


    _24
    {
    _24
    "action": "post",
    _24
    "application": "5cf28979-XXXX-XXXX-b969-60141fb9c75d",
    _24
    "uri": "http://XXXX/XXXX/XXXX/chatrooms/XXXX/white/users",
    _24
    "entities": [],
    _24
    "data": [
    _24
    {
    _24
    "result": true,
    _24
    "action": "add_user_whitelist",
    _24
    "user": "wzy_test",
    _24
    "chatroomid": "XXXX"
    _24
    },
    _24
    {
    _24
    "result": true,
    _24
    "action": "add_user_whitelist",
    _24
    "user": "wzy_meizu",
    _24
    "chatroomid": "XXXX"
    _24
    }
    _24
    ],
    _24
    "timestamp": 1594724634191,
    _24
    "duration": 2,
    _24
    "organization": "XXXX",
    _24
    "applicationName": "XXXX"
    _24
    }

    Removing users from the chat room allow list

    Removes the specified users from the chat room allow list. You can remove a maximum of 60 group members from the chat room allow list each time.

    For each App Key, the call frequency limit of this method is 100 per second.

    HTTP request


    _1
    DELETE https://{host}/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}

    Path parameter

    For the parameters and detailed descriptions, see Common parameters.

    Request header

    ParameterTypeDescriptionRequired
    Content-TypeStringThe parameter type. Set it as application/json.Yes
    AuthorizationStringThe authentication token of the user or administrator, in the format of Bearer ${token}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.Yes

    HTTP response

    Response body

    If the returned HTTP status code is 200, the request succeeds, and the data field in the response body contains the following parameters.

    ParameterTypeDescription
    resultBooleanWhether the users are successfully removed from the chat room allow list.
  • true: Yes.
  • false: No.
  • userStringThe username removed from the chat room allow list.

    For the parameters and detailed descriptions, see Common parameters.

    If the returned HTTP status code is not 200, the request fails. You can refer to Status code for possible causes.

    Example

    Request example


    _1
    curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt4LqJIul7EeizhBO5TSO_UgAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnG7GyAQBPGgDv4ENRUku7fg05Kev0a_aVC8NyA6O6PgpxIRjajSVN3g' 'http://XXXX/XXXX/XXXX/chatrooms/{XXXX}/white/users/{username}'

    Response example


    _24
    {
    _24
    "action": "delete",
    _24
    "application": "5cf28979-XXXX-XXXX-b969-60141fb9c75d",
    _24
    "uri": "http://XXXX/XXXX/XXXX/chatrooms/XXXX/white/users/wzy_huawei,wzy_meizu",
    _24
    "entities": [],
    _24
    "data": [
    _24
    {
    _24
    "result": true,
    _24
    "action": "remove_user_whitelist",
    _24
    "user": "wzy_huawei",
    _24
    "chatroomid": "XXXX"
    _24
    },
    _24
    {
    _24
    "result": true,
    _24
    "action": "remove_user_whitelist",
    _24
    "user": "wzy_meizu",
    _24
    "chatroomid": "XXXX"
    _24
    }
    _24
    ],
    _24
    "timestamp": 1594725137704,
    _24
    "duration": 1,
    _24
    "organization": "XXXX",
    _24
    "applicationName": "XXXX"
    _24
    }

    Status codes

    For details, see HTTP Status Code.

    vundefined