Modifying Group Member Profiles

Feature Description

The app admin can modify group members’ profiles through this API.

API Invocation Description

Applicable group types

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

For AVChatRoom groups, only the profiles of the admin and group owner can be modified due to internal implementation reasons. If you try to modify an ordinary member’s profile, error 10007 returns.

Request URL example

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 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

• Setting an admin
  Sets a specified group member as an admin.

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

• Canceling an admin
  Revokes a specified group member’s admin role.

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

• Setting the message blocking type for a member
  Sets the message blocking type for a specified member. AcceptAndNotify: accept and notify. Discard: do not accept nor notify. AcceptNotNotify: accept but do not notify.

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

• Setting the group name card for a specified member
  Sets the group name card for a specified member. The maximum length of the group name card is 50 bytes.

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

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

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

• Setting a mute time for a specified group member
  Sets a mute time for a specified group member.

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

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

Obtaining group members’ detailed profiles (v4/group_open_http_svc/get_group_member_info)