Modifying the Profile of a Group

Last updated: 2021-04-13 17:01:57

    Feature Description

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

    API Calling Description

    Applicable group types

    Group Type ID RESTful API Support
    Private Yes. Same as work group (Work) in the new version.
    Public Yes.
    ChatRoom Yes. Same as meeting group (Meeting) in the new version.
    AVChatRoom Yes.

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

    Sample request URL

    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 only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Introduction.

    Parameter Description
    v4/group_open_http_svc/modify_group_base_info Request API.
    sdkappid SDKAppID assigned by the IM console when the application is created.
    identifier The value must be the app admin account. For more information, see the App Admin section in Login Authentication.
    usersig Signature generated by the app admin account. For details, see Generating UserSig.
    random A random 32-bit unsigned integer ranging from 0 to 4294967295.

    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

    Field Type Required Description
    GroupId String Yes ID of the group whose basic information you want to modify.
    Name String No Group name, whose maximum length is 30 bytes.
    Introduction String No Group introduction, whose maximum length is 240 bytes.
    Notification String No Group announcement, whose maximum length is 300 bytes.
    FaceUrl String No URL of the group profile photo, whose maximum length is 100 bytes.
    MaxMemberNum Integer No Maximum number of group members.
  • For Private, Public, and ChatRoom: see Group System and Pricing for the maximum number of group members for each type of group.
  • For AVChatRoom and BChatRoom: this field is invalid and can be left blank.
  • ApplyJoinOption String No Method for handling requests to join the group. Valid values: FreeAccess, NeedPermission, DisableApply
    AppDefinedData Array No By default, this field is not available. To learn how to enable group-level custom fields, see Custom Fields.
    ShutUpAllMember String No Mutes all members in a group and allows only the group admin, group owner, and system admin to speak.

    Sample response packet body

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

    Response packet fields

    Field Type Description
    ActionStatus String Request result. OK: successful. FAIL: failed
    ErrorCode Integer Error code. 0: successful; other values: failed
    ErrorInfo String Detailed error information

    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:

    Error Code Description
    10002 Internal server error. Please try again.
    10003 Invalid command word.
    10004 Invalid parameter. Check the error description and troubleshoot the issue.
    10026 The command word of the SDKAppID request is disabled. Please submit a ticket.
    10007 Insufficient operation permissions. Check whether the operator is the app admin or whether the operator has the permission to modify the fields in the request.
    10010 The group does not exist or has been deleted.
    10015 Invalid group ID. Be sure to use the correct group ID.
    80001 The modified group member information failed text content filtering. Check whether the modified group member information contains sensitive words.

    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)

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help