Manage group members

Group member management involves operations such as member creation and deletion. Chat provides multiple APIs for adding and retrieving group members, adding a group administrator, and transferring the group owner.

This page shows how to manage group members by calling the Chat RESTful APIs. Before calling the following methods, ensure that you understand the call frequency limit described in Limitations.

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

​

Parameter	Type	Description	Required
host	String	The 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_name	String	The 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_name	String	The 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
username	String	The 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) 10 numbers (0-9) "_", "-", "." info Do not use any of the 26 uppercase English letters (A-Z). Ensure that each username under the same app is unique.	Yes

​

Parameter	Type	Description
action	String	The request method.
organization	String	The unique identifier assigned to each company (organization) by the Chat service. This is the same as org_name.
application	String	A unique internal ID assigned to each app by the Chat service. You can safely ignore this parameter.
applicationName	String	The unique identifier assigned to each app by the Chat service. This is the same as app_name.
uri	String	The request URI.
path	String	The request path, which is part of the request URI. You can safely ignore this parameter.
entities	JSON	The response entity.
data	JSON	The details of the response.
timestamp	Number	The Unix timestamp (ms) of the HTTP response.
duration	Number	The duration (ms) from when the HTTP request is sent to the time the response is received.

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.

Retrieves the member list of the specified chat group with pagination.

_4

GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users

_4

_4

// Gets the member list of the group with pagination.

_4

GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users?pagenum={N}&pagesize={N}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

Parameter	Type	Description	Required
pagenum	Number	The current page number. The query starts from the first page by default.	No
pagesize	Number	The number of members to retrieve per page. The default value is 10. The value range is [1,100].	No

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

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

Parameter	Type	Description
owner	String	The username of the group owner, for example, {"owner":"user1"}.
member	String	The username of a group admin or regular group member, for example, {"member":"user2"}.
count	String	The number of group members retrieved at this call of this API.

For other fields and descriptions, see Common parameters.

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

_1

curl -X GET -H 'Accept: application/json' 'http://XXXX/XXXX/XXXX/chatgroups/10130212061185/users?pagenum=2&pagesize=2' -H 'Authorization: Bearer <YourAppToken>'

_27

{

_27

"action": "get",

_27

"application": "527cd7e0-XXXX-XXXX-9f59-ef10ecd81ff0",

_27

"params": {

_27

"pagesize": [

_27

"2"

_27

],

_27

"pagenum": [

_27

"2"

_27

]

_27

},

_27

"uri": "http://XXXX/XXXX/XXXX/chatgroups/10130212061185/users",

_27

"entities": [],

_27

"data": [

_27

{

_27

"owner": "user1"

_27

},

_27

{

_27

"member": "user2"

_27

}

_27

],

_27

"timestamp": 1489074511416,

_27

"duration": 0,

_27

"organization": "XXXX",

_27

"applicationName": "XXXX",

_27

"count": 2

_27

}

Adds the specified user to the chat group. If the user is already a member of the chat group, an error is returned.

_1

POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{username}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

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

Parameter	Type	Description
result	Boolean	Whether the user is successfully added to the chat group. true: Yes. false: No.
groupid	String	The group ID.
action	String	The request method.
user	String	The username added to the chat group.

For other fields and descriptions, see Common parameters.

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

_1

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users/user4'

_16

{

_16

"action": "post",

_16

"application": "8be024f0-XXXX-XXXX-b697-5d598d5f8402",

_16

"uri": "http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users/user4",

_16

"entities": [],

_16

"data": {

_16

"result": true,

_16

"groupid": "66016455491585",

_16

"action": "add_member",

_16

"user": "user4"

_16

},

_16

"timestamp": 1542364958405,

_16

"duration": 0,

_16

"organization": "XXXX",

_16

"applicationName": "XXXX"

_16

}

Adds multiple users to the specified chat group. You can add a maximum of 60 users into a chat group each time. If the users are already members of the chat group, an error is returned in the response body.

_1

POST https://{host}/{org_name}/{app_name}/chatgroups/{chatgroupid}/users

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

Parameter	Type	Description	Required
usernames	Array	The usernames to add to the chat group. You can pass in a maximum of 60 usernames each time.	Yes

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

Parameter	Type	Description
newmembers	Array	The array of usernames that are added to the group.
groupid	String	The group ID.
action	String	The request method.

For other fields and descriptions, see Common parameters.

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

_5

curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{

_5

"usernames": [

_5

"user4","user5"

_5

]

_5

}' 'http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users'

_18

{

_18

"action": "post",

_18

"application": "8be024f0-XXXX-XXXX-b697-5d598d5f8402",

_18

"uri": "http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users",

_18

"entities": [],

_18

"data": {

_18

"newmembers": [

_18

"user5",

_18

"user4"

_18

],

_18

"groupid": "66016455491585",

_18

"action": "add_member"

_18

},

_18

"timestamp": 1542365557942,

_18

"duration": 0,

_18

"organization": "XXXX",

_18

"applicationName": "XXXX"

_18

}

Removes the specified user from the chat group. If the specified user is not in the chat group, an error is returned.

Once a member is removed from a chat group, they are also removed from all the threads they have joined in this chat group.

_1

DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{username}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

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

Parameter	Type	Description
result	Boolean	Whether the user is successfully removed from the chat group. true: Yes. false: No.
groupid	String	The group ID.
action	String	The request method.
user	String	The usernames removed from the chat group.

For other fields and descriptions, see Common parameters.

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

_1

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users/user3'

_16

{

_16

"action": "delete",

_16

"application": "8be024f0-XXXX-XXXX-b697-5d598d5f8402",

_16

"uri": "http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users/user3",

_16

"entities": [],

_16

"data": {

_16

"result": true,

_16

"action": "remove_member",

_16

"user": "user3",

_16

"groupid": "66016455491585"

_16

},

_16

"timestamp": 1542365943067,

_16

"duration": 0,

_16

"organization": "XXXX",

_16

"applicationName": "XXXX"

_16

}

Removes multiple users from the chat group. You can remove a maximum of 60 members from the chat group each time. If the specified users are not in the group, an error is returned.

Once a member is removed from a chat group, they are also removed from all the threads they have joined in this chat group.

_1

DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/users/{members}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes
members	String	The usernames of group members separated by the comma (,). For example, user1, user2.	Yes

For the descriptions of other path parameters, see Common Parameters.

Parameter	Type	Description	Required
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

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

Parameter	Type	Description
result	Boolean	Whether the user is successfully removed from the chat group. true: Yes. false: No.
groupid	String	The group ID.
reason	String	The reason why the users fail to be removed from the chat group.
action	String	The request method.
user	String	The usernames removed from the chat group.

For other fields and descriptions, see Common parameters.

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

_1

curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'http://XXXX/XXXX/XXXX/chatgroups/66016455491585/users/ttestuser0015981,user2,user3'

_29

{

_29

"action": "delete",

_29

"application": "9b848cf0-XXXX-XXXX-b5b8-0f74e8e740f7",

_29

"uri": "https://XXXX/XXXX/XXXX",

_29

"entities": [],

_29

"data": [{

_29

"result": false,

_29

"action": "remove_member",

_29

"reason": "user ttestuser0015981 doesn't exist.",

_29

"user": "user1",

_29

"groupid": "1433492852257879"

_29

},

_29

{

_29

"result": true,

_29

"action": "remove_member",

_29

"user": "user2",

_29

"groupid": "1433492852257879"

_29

},

_29

{

_29

"result": true,

_29

"action": "remove_member",

_29

"user": "user3",

_29

"groupid": "1433492852257879"

_29

}],

_29

"timestamp": 1433492935318,

_29

"duration": 84,

_29

"organization": "XXXX",

_29

"applicationName": "XXXX"

_29

}

Sets the custom attributes of a group member, such as adding a nickname or avatar. Each custom attribute should be in key-value format.

_1

PUT https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{username}

Parameter	Type	Description	Required
username	String	The user ID of a group member for which custom attributes are set.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The authentication token of the user or administrator, in the format of Bearer ${YourAppToken}, where Bearer is a fixed character, followed by a space and then the obtained token value.	Yes

Parameter	Type	Description
metaData	JSON	Custom attributes of a group member to set. Each attribute is represented as a key-value pair: The key indicates the attribute name and cannot exceed 16 bytes. The value indicates the attribute value and cannot exceed 512 bytes. Passing an empty string to the value means to delete the attribute. For a single group member, the total length of custom attributes cannot exceed 4 KB.

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

Field	Type	Description
data	JSON	Custom attributes of a group member that are set.

For other fields and descriptions, see Common parameters.

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

_9

curl --location --request PUT 'https://XXXX/XXXX/XXXX/metadata/chatgroup/207059303858177/user/test2' \

_9

-H 'Content-Type: application/json' \

_9

-H 'Accept: application/json'

_9

-H 'Authorization: Bearer <YourAppToken>' \

_9

-d '{

_9

"metaData": {

_9

"key1": "value1"

_9

}

_9

}'

_7

{

_7

"timestamp": 1678674135533,

_7

"data": {

_7

"key1": "value1"

_7

},

_7

"duration": 53

_7

}

Retrieves all custom attributes of a group member.

_1

GET https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{username}

Parameter	Type	Description	Required
username	String	The user ID of a group member whose custom attributes are to be retrieved.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The authentication token of the user or administrator, in the format of Bearer ${YourAppToken}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.	Yes

If the returned HTTP status code is 200, the request succeeds and the response body will contain the following parameters.

Field	Type	Description
data	JSON	All custom attributes of a group member that are retrieved.

For other fields and descriptions, see Common parameters.

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

_5

curl --location --request GET 'https://XXXX/XXXX/XXXX/metadata/chatgroup/207059303858177/user/test2' \

_5

-H 'Content-Type: application/json' \

_5

-H 'Accept: application/json'

_5

-H 'Authorization: Bearer <YourAppToken>' \

_5

-d ''

_7

{

_7

"timestamp": 1678674211840,

_7

"data": {

_7

"key1": "value1"

_7

},

_7

"duration": 6

_7

}

Retrieves custom attributes of multiple group members by attribute key. You can retrieve custom attributes of at most 10 group members each time.

_1

POST https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/get

For the parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The authentication token of the user or administrator, in the format of Bearer ${YourAppToken}, where Bearer is a fixed character, followed by an English space, and then the obtained token value.	Yes

Parameter	Type	Description	Required
targets	JSON Array	The user IDs of group members whose custom attributes are to be retrieved. You can pass in at most 10 user IDs.	Yes
properties	JSON Array	The array of keys of custom attributes to retrieve. If you pass in an empty string or no value to the parameter, all custom attributes of the group members will be returned.	Yes

If the returned HTTP status code is 200, the request succeeds and the response body will contain the following parameters.

Field	Type	Description
data	JSON	The custom attributes of the group members that are retrieved. As shown in the following response example, test1 and test2 are user IDs of group members to which the retrieved custom attributes belong.

For other fields and descriptions, see Common parameters.

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

_8

curl --location --request POST 'https://XXXX/XXXX/XXXX/metadata/chatgroup/207059303858177/get' \

_8

-H 'Content-Type: application/json' \

_8

-H 'Accept: application/json'

_8

-H 'Authorization: Bearer <YourAppToken>' \

_8

-d '{

_8

"targets":["test1","test2"],

_8

"properties":["key1","key2"]

_8

}'

_12

{

_12

"timestamp": 1678674292783,

_12

"data": {

_12

"test1": {

_12

"key1": "value1"

_12

},

_12

"test2": {

_12

"key1": "value1"

_12

}

_12

},

_12

"duration": 2

_12

}

Retrieves the list of the chat group admins.

_1

GET https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

If the returned HTTP status code is 200, the request succeeds， and the data field in the response body contain the information of the chat group admins. For other fields and descriptions, see Common parameters.

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

_1

curl -X GET HTTP://XXXX/XXXX/XXXX/chatgroups/10130212061185/admin -H 'Authorization: Bearer <YourAppToken>'

_12

{

_12

"action": "get",

_12

"application": "527cd7e0-XXXX-XXXX-9f59-ef10ecd81ff0",

_12

"uri": "http://XXXX/XXXX/XXXX/chatgroups/10130212061185/admin",

_12

"entities": [],

_12

"data": ["user1"],

_12

"timestamp": 1489073361210,

_12

"duration": 0,

_12

"organization": "XXXX",

_12

"applicationName": "XXXX",

_12

"count": 1

_12

}

Adds a regular group member to the group admin list. A chat group admin has the privilege to manage the chat group blocklist and mute chat group members. You can add a maximum of 99 chat group admins.

_1

POST https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

Parameter	Type	Description	Required
newadmin	String	The username of the chat group admin.	Yes

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

Parameter	Type	Description
data	String	The user IDs promoted to group admins.
count	Number	The number of users to be promoted as group admins.

For other fields and descriptions, see Common parameters.

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

_1

curl -X POST -H 'Content-type: application/json' -H 'Accept: application/json' 'http://XXXX/XXXX/XXXX/chatgroups/10130212061185/admin' -d '{"newadmin":"user1"}' -H 'Authorization: Bearer <YourAppToken>'

_15

{

_15

"action": "post",

_15

"application": "52XXXXf0",

_15

"applicationName": "demo",

_15

"data": {

_15

"result": "success",

_15

"newadmin": "man"

_15

},

_15

"duration": 0,

_15

"entities": [],

_15

"organization": "XXXX",

_15

"properties": {},

_15

"timestamp": 1680074570600,

_15

"uri": "http://XXXX/XXXX/XXXX/chatgroups/190141728620545/admin"

_15

}

Removes the specified user from the chat group admin list.

_1

DELETE https://{host}/{org_name}/{app_name}/chatgroups/{group_id}/admin/{username}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

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

Parameter	Type	Description
result	Boolean	Whether the group admin is successfully demoted to a regular group member: true: Yes. false: No.
oldadmin	String	The ID of the group admin demoted to a regular group member.

For other fields and descriptions, see Common parameters.

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

_1

curl -X DELETE -H 'Accept: application/json' 'http://XXXX/XXXX/XXXX/chatgroups/10130212061185/admin/user1' -H 'Authorization: Bearer <YourAppToken>'

_14

{

_14

"action": "delete",

_14

"application": "527cd7e0-XXXX-XXXX-9f59-ef10ecd81ff0",

_14

"uri": "http://XXXX/XXXX/XXXX/chatgroups/10130212061185/admin/user1",

_14

"entities": [],

_14

"data": {

_14

"result": "success",

_14

"oldadmin": "user1"

_14

},

_14

"timestamp": 1489073432732,

_14

"duration": 1,

_14

"organization": "XXXX",

_14

"applicationName": "XXXX"

_14

}

Changes the group owner to another group member. Group owners possess all group privileges.

_1

PUT https://{host}/{org_name}/{app_name}/chatgroups/{group_id}

Parameter	Type	Description	Required
group_id	String	The group ID.	Yes

For other parameters and detailed descriptions, see Common parameters.

Parameter	Type	Description	Required
Content-Type	String	The parameter type. Set it as application/json.	Yes
Accept	String	The parameter type. Set it as application/json.	Yes
Authorization	String	The 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

Parameter	Type	Description	Required
newowner	String	The username of the new group owner.	Yes

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

Parameter	Type	Description
newowner	Boolean	Whether the user is successfully set as the chat group owner. true: Yes; false: No.

For other fields and descriptions, see Common parameters.

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

_1

curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' -d '{ "newowner": "user2" }' 'http://XXXX/XXXX/XXXX/chatgroups/66016455491585'

_13

{

_13

"action": "put",

_13

"application": "8be024f0-XXXX-XXXX-b697-5d598d5f8402",

_13

"uri": "http://XXXX/XXXX/XXXX/chatgroups/66016455491585",

_13

"entities": [],

_13

"data": {

_13

"newowner": true

_13

},

_13

"timestamp": 1542537813420,

_13

"duration": 0,

_13

"organization": "XXXX",

_13

"applicationName": "XXXX"

_13

}

For details, see HTTP Status Codes.