Join a Group
The IM Service does not manage the business logic of groups. Therefore, all group business logic is implemented on the App server. For client developers, creating a group only requires interaction with the App backend.
Each group can have up to 3000 members. There is no limit to the number of groups within an App, and there is no limit to the number of groups a user can join or create.
Basic Process:
-
The client requests the App backend to join a group.
-
The App backend calls the IM Service API to request joining the group. The group ID is managed by the App server and is returned to the client upon successful creation.
-
After successfully joining the group, the user can send and receive messages within the group.
After joining a group, users can only view messages sent after the time they joined by default. If you want users to view historical messages after joining, enable the following features in the Console:
- Cloud Storage for One-to-One and Group Messages
- New Users Can Retrieve Historical Messages Before Joining the Group
Sequence Diagram for Joining a Group
Request Method
POST: https://Data Center Domain/group/join.json
Rate Limit: 100 requests per second
Signature Rule: All server API requests must be validated according to the rules. For details, see API Request Signature.
Body Parameters
The HTTP request body data format is application/x-www-form-urlencoded, and the following HTTP form parameters are supported:
| Parameter | Type | Required | Description |
|---|---|---|---|
| userId | String | Yes | The user ID(s) to join the group. Multiple IDs can be submitted, up to a maximum of 1000. |
| groupId | String | Yes | The group ID to join. |
| groupName | String | No | The name of the group to join. Note: If groupName is provided when joining the group, it will modify the group name in push notifications, similar to calling the refresh group information API. |
Request Example
POST /group/join.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 Value | Type | Description |
|---|---|---|
| code | Number | Return code, 200 indicates success. |
Response Example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}