tencent cloud

Feature Description

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

API Calling Description

Applicable group types

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

Note：

Audio-video groups do not store group member profiles and therefore do not allow member profile modification. They 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 common group members.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/modify_group_member_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 Overview.

Maximum call frequency

200 calls per second

Sample requests

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

  {
   "GroupId": "@TGS#2CLUZEAEJ", // Target group (required)
   "Member_Account": "bob", // Target group member (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 member (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 member (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 member (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 in the IM console before use. For details, see the description table for request 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 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 member (required)
   "ShutUpTime":86400 // Muting period for the specified user, in seconds
  }
  

  Private groups (i.e., same as work groups in the new version) do not support muting members.

  Request fields

Sample response

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

Response fields

Error Codes

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

Debugging Tool

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

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