Feature Description

This API is used by the app admin to modify the profile of a specified group.

API Calling Description

Applicable group types

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

Sample request URL

https://xxxxxx/v4/group_open_http_svc/modify_group_base_info?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 calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

• Modify basic group information
  Modify basic group information, such as the group name and group announcement.

  {
   "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" // Mutes all members (optional). "On": enable, "Off": disable
  }
  

• Set custom group information
  Set a group's custom field information. By default, custom information is not available and needs to be enabled in the IM console. For details, see the description table for request packet fields.

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

• Delete custom group information
  Delete a group's custom field information that you have set.

  {
   "GroupId": "@TGS#1NVTZEAE4", // Group whose basic information you want to modify (required)
   "AppDefinedData": [  // Custom field (optional)
       {
           "Key": "GroupTestData2",
           "Value": "" // If this parameter is left empty, 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", // Mutes all members (optional). "On": enable, "Off": disable
   "AppDefinedData": [ // Custom field (optional)
       {
           "Key": "GroupTestData1", // Custom field key to be modified
           "Value": "NewData" // New value of the custom field
       },
       {
           "Key": "GroupTestData2",
           "Value": "" // If this parameter is left empty, the custom field is to be deleted.
       }
   ]
  }
  

Request packet fields

Sample response packet body

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

Response packet fields

Error Codes

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

API Debugging Tool

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

Reference

Deleting group members (v4/group_open_http_svc/delete_group_member)