Skip to main content

Create a Group

The IM Service does not manage the business logic of groups. Therefore, all the business logic of groups is implemented on the App server. For client developers, creating a group only requires interaction with the App backend.

tip

Each group can have up to 3000 members. There is no limit to the number of groups within the App, and there is no limit to the number of groups a user can join or create.

Basic Process:

  1. When the App client needs to create a group, it sends a request to the App backend.
  2. The App backend generates a group ID and calls the IM Service server API to create the group. It can also pass in the user IDs of those who need to join the group.
  3. After the IM Service successfully creates the group, it returns the result to the App backend.
  4. The App backend notifies the client that the group has been successfully created. The user has joined the group and can send and receive messages within the group.

Group Creation Sequence Diagram

Request Method​

POST: https://Data Center Domain/group/create.json

Rate Limit: 100 requests per second

Signature Rule: All server API requests require rule validation. For details, see API Request Signature.

Body Parameters​

The HTTP request body data format is application/x-www-form-urlencoded. The following HTTP form parameters are supported:

ParameterTypeRequiredDescription
userIdStringRequiredThe user ID to be added to the group, up to 1000.
groupIdStringRequiredThe group ID to be created, with a maximum length of 64 characters. Supports a combination of uppercase and lowercase letters and numbers.
groupNameStringRequiredThe name corresponding to the group ID, used when sending group messages to display remote Push notifications. If the group name changes, the Refresh Group Information interface needs to be called to synchronize.

Request Example​

POST /group/create.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=1&userId=2&groupId=123&groupName=TestGroup

Response​

The HTTP response body contains a JSON object with the following structure:

Return ValueReturn TypeDescription
codeNumberReturn code, 200 indicates success.

Response Example​

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

{"code":200}

Frequently Asked Questions

The IM Service does not maintain basic group information (avatar, name, group member profiles, etc.), which needs to be maintained by the developer's App server.

Creating a group must be implemented by the App server requesting the IM Service server API. The IM Service mobile SDK does not provide a method for creating groups.

The IM Service does not send notification messages after completing group operations such as creating a group, users joining, or leaving a group. Group notification messages for creating a group, successfully joining, or leaving a group need to be decided by the customer based on their business scenarios, whether to send and when to send.

Taking group creation as an example, the process of sending group notification messages is as follows:

  1. The App requests its own App Server to create a group.

  2. The App Server calls the IM Service server API to apply for group creation.

  3. After returning 200 successfully, use the send group message API interface to send the group creation notification message.

Last updated on