Feature Description

This API is used by app admins to modify group members’ profiles.

API Calling Description

Applicable group types

These are the 4 built-in group types in IM. For detailed information, see the Group System.

Note：

Due to the internal implementation, AVChatRooms (livestreaming groups) only support modifying the member profiles of admins and the group owner. Error 10007 will be returned if you try to modify the profiles of ordinary group members.

Sample request URL

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

Request parameters

The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.

Maximum calling frequency

The maximum calling frequency is 200 calls per second.

Sample request packet

• Set an admin
  Set a specified group member as an admin.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "Role": "Admin" // Set as an admin
  }

• Cancel an admin
  Revoke a specified group member’s admin role.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "Role": "Member" // Cancel the admin role
  }

• Set a member’s message blocking type
  Set a specified member’s message blocking type, whose possible values are as follows. AcceptAndNotify: accept and notify. Discard: neither accept nor notify. AcceptNotNotify: accept but do not notify.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "MsgFlag": "AcceptAndNotify" // Message blocking type, which can be AcceptAndNotify, Discard, or AcceptNotNotify
  }

• Set a member’s group name card
  Set a specified user’s group name card, whose maximum length is 50 bytes.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "NameCard": "bob" // Group name card (optional)
  }

• Set member custom fields
  Set group member custom fields. By default, AppMemberDefinedData is not available and needs to be enabled before use. For details, see the description table for request packet fields.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "AppMemberDefinedData": [ // Target member custom field (optional)
        {
            "Key":"MemberDefined1", // Key of the target group member custom field
            "Value":"ModifyData1" // Value of the key
        },
        {
            "Key":"MemberDefined3",
            "Value":"ModifyData3"
        }
    ]
  }

• Set a group member’s muting period
  Set a specified group member’s muting period.

  {
    "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
    "Member_Account": "bob", // Target group (required)
    "ShutUpTime":86400 // Muting period for the specified user, in seconds
  }

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 such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:

API Debugging Tool

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

Reference

Obtaining detailed information on group members (v4/group_open_http_svc/get_group_member_info)