tencent cloud

Feedback

Modifying the Profile of a Group Member

Last updated: 2024-07-16 11:15:59

    Feature Overview

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

    API Call Description

    Applicable group types

    Group Type ID
    RESTful API Support
    Private
    Yes. Same as work groups (Work) in the new version.
    Public
    Yes
    ChatRoom
    Yes. Same as the meeting group (Meeting) in the new version.
    AVChatRoom
    No
    Community
    Yes
    These are the preset group types in Chat. For more information, see Group System.
    Note
    Audio-video groups (AVChatRoom) do not store group member profiles and therefore do not allow member profile modification.

    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 describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
    Parameter
    Description
    xxxxxx
    Domain name corresponding to the country/region where your SDKAppID is located.
    China: console.tim.qq.com
    Singapore: adminapisgp.im.qcloud.com
    Seoul: adminapikr.im.qcloud.com
    Frankfurt: adminapiger.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/group_open_http_svc/modify_group_member_info
    Request API.
    sdkappid
    SDKAppID assigned by the Chat console when an app is created
    identifier
    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.
    contenttype
    Request format, which should always be json.

    Maximum call frequency

    200 calls per second

    Sample request

    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 Chat 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)
    "MuteTime":86400 // Muting period for the specified user, in seconds
    }
    Note
    Private groups (same as Work groups in the new version) do not support muting group users.

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Yes
    The ID of the Group whose historical messages will be modified
    Member_Account
    String
    Required
    Target group member.
    Role
    String
    Optional
    Role of the member. Admin: Set as an admin. Member: Cancel the admin role. (The group owner identity cannot be modified.)
    MsgFlag
    String
    Optional
    Message blocking type.
    NameCard
    String
    Optional
    Group name card (with a maximum length of 50 bytes).
    AppMemberDefinedData
    Array
    Optional
    Group member custom field. By default, this field is not available and needs to be enabled in the Chat console. For details, see Group System.
    MuteTime
    Integer
    Optional
    Muting period, in seconds. 0: Unmute

    Sample response

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

    Response fields

    Field
    Type
    Description
    ActionStatus
    String
    Request result. OK: successful. FAIL: failed
    ErrorCode
    Integer
    Error code. 0: Successful. Other values: Failed
    ErrorInfo
    String
    Error information

    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), see Error Codes. The following table describes the error codes specific to this API:
    Error Code
    Description
    10002
    Internal server error. Try again.
    10003
    Invalid command word.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10007
    No operation permissions. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so.
    10010
    The group does not exist or has been deleted.
    10015
    Invalid group ID. Use the correct group ID.

    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)
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support