Feature Description

This API allows the app administrator to add new members to a group.

API Call Description

Applicable group types

Above are the IM built-in groups. For more information, please see Group System.

Note：

Audio-video groups (AVChatRoom) do not support this API. If you use this API on an audio-video group, error 10007 will be returned. The only way for users to join this type of group is to apply to join.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/add_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.

Maximum call frequency

200 calls per second

Sample request packets

• Basic request
  Used to invite users to a group. A single request supports adding up to 300 members. By default, the backend delivers group system notifications to all group members, except for private groups (or work groups in the new version) that have not been activated.

  {
   "GroupId": "@TGS#2J4SZEAEL", // The group to which to add members (required)
   "MemberList": [ // Up to 300 members can be added at a time.
   {
       "Member_Account": "tommy" // The ID of the member to be added (required)
   },
   {
       "Member_Account": "jared"
   }]
  }
  

• Adding members silently
  When Silence is set to 1, the system does not notify anyone after successfully adding members.

  {
   "GroupId": "@TGS#2J4SZEAEL", // The group to which to add members (required)
   "Silence": 1, // Whether to add members silently (optional)
   "MemberList": [ // Up to 300 members can be added at a time.
   {
       "Member_Account": "tommy" // The ID of the member to be added (required)
   },
   {
       "Member_Account": "jared"
   }]
  }
  

Request packet fields

Sample response packet

{
   "ActionStatus": "OK",
   "ErrorInfo":"",
   "ErrorCode": 0,
   "MemberList": [
   {
        "Member_Account": "tommy",
        "Result": 1 // The result of adding the member. 0: failed. 1: successful. 2: already in the group.
   },
   {
        "Member_Account": "jared",
        "Result": 1
   }]
}

Response packet fields

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.

Reference

Deleting Group Members (v4/group_open_http_svc/delete_group_member)

Possible Callbacks

• Callback Before Accepting a Request to Add a User to a Group
• Callback After a User Joins a Group
• Callback After a Group Is Full