Modifying Basic Group Profiles

Feature Description

The app admin can modify the basic information of a specified group through this API.

API Invocation Description

Applicable group types

IM supports the preceding five types of groups. For details, see Group Systems.

Request URL example

https://console.tim.qq.com/v4/group_open_http_svc/modify_group_base_info?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

• Modifying the basic information of a group
  Modifies the basic information of a group, such as the group name and group announcements.

  {
    "GroupId": "@TGS#1NVTZEAE4", // Group whose basic information you want to modify (required)
    "Name": "NewName", // Group name (optional)
    "Introduction": "NewIntroduction", // Group introduction (optional)
    "Notification": "NewNotification", // Group announcement (optional)
    "FaceUrl": "http://this.is.new.face.url", // Group profile photo (optional)
    "MaxMemberNum": 500, // Maximum number of group members (optional)
    "ApplyJoinOption": "NeedPermission", // Method for applying to join the group (optional)
    "ShutUpAllMember": "On" // Mute all members: "On": enable, "Off": disable.
  }

• Setting custom group information
  Sets custom field information for a group. By default, custom information is unavailable and needs to be enabled before use. For details, see the explanatory table of request packet fields.

  {
    "GroupId": "@TGS#1NVTZEAE4", // Group whose basic information you want to modify (required)
    "AppDefinedData": [ // Custom field (optional)
        {
            "Key": "GroupTestData1", // To-be-modified custom field Key
            "Value": "NewData"  // New value of the custom field
        }
    ]
  }

• Deleting custom group information
  Deletes the custom field information that you have set for a group.

  {
    "GroupId": "@TGS#1NVTZEAE4", // Group whose basic information you want to modify (required)
    "AppDefinedData": [  // Custom field (optional)
        {
            "Key": "GroupTestData2",
            "Value": "" // If this parameter is empty, it indicates the custom field is to be deleted.
        }
    ]
  }

• ALL IN ONE

  {
    "GroupId": "@TGS#2J4SZEAEL", // Group whose basic information you want to modify (required)
    "Name": "NewName", // Group name (optional)
    "Introduction": "NewIntroduction", // Group introduction (optional)
    "Notification": "NewNotification", // Group announcement (optional)
    "FaceUrl": "http://this.is.new.face.url", // Group profile photo (optional)
    "MaxMemberNum": 500, // Maximum number of group members (optional)
    "ApplyJoinOption": "NeedPermission", // Method for applying to join the group (optional)
    "ShutUpAllMember": "On", // Mute all members: "On": enable, "Off": disable.
    "AppDefinedData": [ // Custom field (optional)
        {
            "Key": "GroupTestData1", // To-be-modified custom field Key
            "Value": "NewData" // New value of the custom field
        },
        {
            "Key": "GroupTestData2",
            "Value": "" // If this parameter is empty, it indicates the custom field is to be deleted.
        }
    ]
  }

Request packet fields

Response packet example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

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 RESTful online commissioning tool for APIs to commission this API.

References

Deleting a group member (v4/group_open_http_svc/delete_group_member)