Create, delete, and retrieve chat groups
Upon login to the Chat, you can create, modify, or delete a group chat.
This page shows how to create, retrieve, modify, and delete a group by calling 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
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:
info
| Yes |
Response parameters
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. |
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:
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.
Creating a group
Creates a new group chat and sets the group information. The group information includes the group name, description, whether the group is public or private, the maximum number of group members (including the group owner), whether a user requesting to join the group requires approval, the group owner, and group members.
HTTP request
Path parameter
For the descriptions of other path parameters, see Common Parameters.
Request header
Parameter | Type | Description | Required |
---|---|---|---|
Content-Type | String | The content type. Set it as application/json . | Yes |
Accept | String | The content 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 |
Request body
Parameter | Type | Description | Required |
---|---|---|---|
groupname | String | The group name. It cannot exceed 128 characters. | No |
avatar | String | The group avatar URL. It cannot exceed 1024 characters. | No |
description | String | The group description. It cannot exceed 512 characters. | No |
public | Boolean | Whether the group is a public group. Public groups can be searched and chat users can apply to join a public group. Private groups cannot be searched, and chat users can join a private group only if the group owner or admin invites the user to join the group.
| No |
maxusers | String | The maximum number of group members (including the group owner). The default value is 200 . If you set this parameter to a value greater than 3000 , the offline push function is not available to such a large group. To enable the offline push function for a large group, contact support@agoro.io before creating it. Note that it is impossible to enable the offline push function for a large group that is created. The upper limit varies with your price plans. For details, see Pricing Plan Details. | No |
allowinvites | Boolean | Whether a regular group member is allowed to invite other users to join the group chat.
public is set to true ), even if allowinvites is set to true , this setting will be automatically modified to false . If you want to allow ordinary members of a public group to add people to the group, you can call the [Modify Group Information](#Modify Group Information) interface to modify the setting of allowinvites to true after creating the group. | No |
membersonly | Boolean | Whether the user requesting to join the public group requires approval from the group owner or admin:
| No |
invite_need_confirm | Boolean | Whether the invitee needs to confirm the received group invitation before joining the group:
| No |
owner | String | The group chat owner. | Yes |
members | Array | The array of user IDs of group chat members, excluding the group owner. The number of user IDs in the array cannot exceed the value of maxusers . | No |
custom | String | The extension information of the group chat. The extension information cannot exceed 8 KB. | No |
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.
Parameter | Type | Descriptions |
---|---|---|
groupid | String | The group ID. |
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 code table for possible causes.
Example
Request example
Response example
Banning a group chat
Bans the specified group chat. Groups are typically banned when too many users or messages violate community guidelines.
Once a group chat is banned, the group chat members in the group can no longer send or receive messages, and the owner and admins cannot perform supervisory operations.
HTTP request
Path parameter
For the descriptions of other path parameters, see Common Parameters.
Request header
Parameter | Type | Description | Required |
---|---|---|---|
Content-Type | String | The content type. Set it as application/json . | Yes |
Accept | String | The content 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 |
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:
Parameter | Type | Description |
---|---|---|
disabled | Bool | Whether the group chat is banned: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 code for possible causes.
Example
Request example
Response example
Unbanning a group chat
Lifts a ban on the specified group chat.
After unbanning a group chat, all group chat members regain permission to send and receive messages in the group, and the owner and admins regain the privileges necessary to perform supervisory operations.
HTTP request
Path parameter
For the descriptions of other path parameters, see Common Parameters.
Request header
Parameter | Type | Description | Required |
---|---|---|---|
Content-Type | String | The content type. Set it as application/json . | Yes |
Accept | String | The content 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 |
HTTP response
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 |
---|---|---|
disabled | Bool | Whether the group chat is banned: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 code for possible causes.
Example
Request example
Response example
Checking whether a user has joined a group
Checks whether a user has joined a group.
HTTP request
Path parameter
For the descriptions of path parameters, see Common Parameters.
Request header
Parameter | Type | Description | Required |
---|---|---|---|
Accept | String | The content type. Set it as application/json . | Yes |
Authorization | String | The authentication token of the app 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 |
HTTP response
Response body
If the returned HTTP status code is 200
, the request succeeds, and the response body contains the following parameters:
Parameter | Type | Descriptions |
---|---|---|
data | Boolean | Whether the user has joined the 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.
Example
Request example
Response example
Retrieving group details
Retrieves the detailed information of one or more groups. You can retrieve details of up to 100 groups, with each group containing at most 10,000 group members (including the group owner).
If you specify multiple groups, details of the existing groups are returned. If the specified groups do not exist, "group id doesn't exist" is reported.
HTTP request
Path parameter
Parameter | Type | Description | Required |
---|---|---|---|
group_ids | String | The ID of the group whose details you want to retrieve. You can type a maximum of 100 group IDs that are separated with the comma (,). | Yes |
For other parameters and detailed descriptions, see Common parameters.
Request header
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 |
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.
Parameter | Type | Descriptions |
---|---|---|
id | String | The group ID. The group's unique identifier. |
name | String | The group name. |
avatar | String | The group avatar URL. |
description | String | The group description. |
membersonly | Boolean | Whether a user requesting to join the group requires the approval from the group owner or admin:
|
allowinvites | Boolean | Whether a regular group chat member can invite other users to join the group.
|
maxusers | Number | The maximum number of members (including the group owner) allowed in the group chat. |
owner | String | The username of the group owner, for example, {"owner":"user1"} . |
created | Long | The Unix timestamp for creating the group chat. |
affiliations_count | Number | The total number of the group chat members. |
disabled | Bool | Whether the group chat is banned:true : Yes.false : No. |
affiliations | Array | The list of existing group members, including the group owner and regular group members, for example, [{"owner":"user1"},{"member":"user2"},{"member":"user3"}] . |
public | Boolean | Whether the group chat is a public group.
|
custom | String | The extension information of the group chat. |
count | Number | The number of retrieved group chats. |
For other parameters and detailed descriptions, see Common parameters.
If the returned HTTP status code is not 200, it means the request fails. You can refer to status code for possible causes.
Example
Request example
Response example
Modifying group information
Modifies the group chat information. You can modify the groupname
, avatar
, description
, maxusers
, membersonly
, allowinvites
, public
, invite_need_confirm
, and custom
fields. If you pass in fields that cannot be modified or do not exist in the request, an error is reported.
HTTP request
Path parameter
Parameter | Type | Description | Required |
---|---|---|---|
group_id | String | The group ID. | Yes |
For other parameters and detailed descriptions, see Common parameters.
Request header
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 |
Request body
Parameter | Type | Description | Required |
---|---|---|---|
groupname | String | The group name. It cannot exceed 128 characters. The group name cannot contain "/" or spaces. You can use "+" to represent the space. | Yes |
avatar | String | The group avatar URL. It cannot exceed 1024 characters. | No |
description | String | The group description. It cannot exceed 512 characters. The group name cannot contain "/" or spaces. You can use "+" to represent the space. | Yes |
maxusers | String | The maximum number of group chat members (including the group owner). The default value is 200 and the maximum value is 2000. The upper limit varies with your price plans. For details, see Pricing Plan Details. | No |
allowinvites | Boolean | Whether a regular group chat member can invite other users to join the group.
| No |
membersonly | Boolean | Whether the user requesting to join the public group requires approval from the group owner or admin:
| No |
custom | String | The extension information of the group chat. The extension information cannot exceed 1024 characters. | No |
invite_need_confirm | Boolean | Whether the invitee needs to accept the group invitation before joining the group:
| No |
public | Boolean | Whether the group is a public one:
| 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.
Parameter | Type | Descriptions |
---|---|---|
groupname | String | The group name. |
description | String | The group description. |
avatar | Boolean | Whether the group avatar is successfully modified:
|
membersonly | Boolean | Whether a user requesting to join the group requires the approval from the group owner or admin:
|
allowinvites | Boolean | Whether a regular group member can invite other users to join the group.
|
maxusers | Number | The maximum number of group chat members (including the group owner. |
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 code for possible causes.
Example
Request example
Response example
Deleting a group chat
Deletes the specified group chat. Once a group chat is deleted, all the threads in this group chat are deleted as well.
HTTP request
Path parameter
Parameter | Type | Description | Required |
---|---|---|---|
group_id | String | The group ID. | Yes |
For other parameters and detailed descriptions, see Common parameters.
Request header
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 |
HTTP response
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 |
---|---|---|
success | Boolean | The result of this method: |
groupid | String | The group ID to be deleted. |
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 code for possible causes.
Example
Request example
Response example
Retrieving all group chats
Retrieves all the group chats under the app.
HTTP request
Path parameter
For other parameters and detailed descriptions, see Common parameters.
Query parameter
Parameter | Type | Description | Required |
---|---|---|---|
limit | Number | The number of group chats to retrieve per page. The default value is 10 . The value range is [1,1000]. This parameter is required only for paginated queries. | No |
cursor | String | The starting position for data query. This parameter is required only for paginated queries. For the first query, you do not need to set cursor and the server returns group chats of the number specified with limit in the descending order of their creation time. You can get the cursor from the response body and pass it in the URL of the next query request. If there is no longer a cursor field in the response body, all group chats in the app are retrieved. | No |
limit
nor cursor
parameter is specified, the server returns the latest 10 groups by creation time.Request header
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 |
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.
Parameter | Type | Description |
---|---|---|
owner | String | The username of the group owner, for example, {"owner":"user1"} . |
groupid | String | The group ID. |
affiliations | Number | The number of existing group members. |
type | String | The group type. |
lastModified | String | When the group information was last modified, in milliseconds. |
groupname | String | The group name. |
count | Number | The number of groups that are returned. |
cursor | String | The current page number. |
For other fields and descriptions, see Common parameter.
If the returned HTTP status code is not 200, the request fails. You can refer to Status code for possible causes.
Example
Request example
Response example
Retrieving all the group chats a user joins
Retrieves all the group chats that a user joins.
HTTP request
Path parameter
For the descriptions of path parameters of this method, see Common parameters.
Query parameter
Parameter | Type | Description | Required |
---|---|---|---|
pagesize | String | The number of group chats to retrieve per page. The value range is [1,20] and the default value is 5 . If you pass in a value greater than 20 , the server still returns 20 groups. | No |
pagenum | String | The start position for the next query. | No |
Request header
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 |
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.
Parameter | Type | Description |
---|---|---|
groupid | String | The group ID. |
groupname | String | The group name. |
For other fields and descriptions, see Common parameter.
If the returned HTTP status code is not 200, the request fails. You can refer to status code for possible causes.
Example
Request example
Response example
Status codes
For details, see HTTP Status Code.