Adding Group Members

Feature Description

Through this API, the app admin can add new members to a specified group.

API Invocation Description

Applicable group types

IM provides the preceding five built-in group types. For details, see Group Systems.

AVChatRoom and BChatRoom groups do not support adding group members. If you attempt to add members to such groups, error 10007 returns. To add users to these groups, you must apply to join them.

Request URL example

https://console.tim.qq.com/v4/group_open_http_svc/add_group_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.

Maximum invocation frequency

The maximum invocation frequency is 200 times per second.

Request packet examples

• Basic form
  Invites users to a group. A single request supports adding up to 500 members. By default, the backend will deliver group system notifications to all group members (except for Private groups that have not been activated).

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

• Adding Members Silently
  When Silence is set to 1, the system will not notify anyone after successfully adding members.

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

Request packet fields

Response packet example

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

Response packet fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.

API Commissioning Tool

Use the online commissioning tool for RESTful APIs to commission this API.

References

Deleting a group member (v4/group_open_http_svc/delete_group_member)

Callback That May Be Triggered

• Callback before inviting a user to a group
• Callback after a new member joins a group
• Callback after the group is full