tencent cloud

Feature Overview

This API is used by the app admin to query the detailed group information based on one or more group IDs.

API Calling Description

Applicable group types

These are the preset group types in Chat. For more information, see Group System.

Sample request URL

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

Maximum call frequency

200 calls per second

Sample request

• Basic format
  The following example is used to obtain the detailed group information, including all the basic group information, group member information, and custom information. The request contains only a list of group IDs. Each request supports the query for information on a maximum of 50 groups.

  {
    "GroupIdList": [ // The list of group IDs specified for the query. This parameter is required.
        "@TGS#1NVTZEAE4",
        "@TGS#1CXTZEAET"
    ]
  }
  

• Pulling specified information

• To specify the basic information fields to be pulled, set GroupBaseInfoFilter.

• To specify the member information fields to be pulled, set MemberInfoFilter.

• To specify the group-specific custom fields to be pulled, set AppDefinedDataFilter_Group. This field is unavailable by default and must be enabled additionally. For more information, see Request packet fields.

• To specify the group’s member-specific custom fields to be pulled, set AppDefinedDataFilter_GroupMember. This field is unavailable by default and must be enabled additionally. For more information, see Request packet fields.

  If filters are set, only the fields specified by filters are pulled.

  {
   "GroupIdList": [ // The list of group IDs specified for the query. This parameter is required.
       "@TGS#1NVTZEAE4",
       "@TGS#1CXTZEAET"
   ],
   "ResponseFilter": { // The filters that you specify for the response.
       "GroupBaseInfoFilter": [ // Add this array if you want to query the basic information.
           "Type",
           "Name",
           "Introduction",
           "Notification"
       ],
       "MemberInfoFilter": [ // Add this array if you want to query the member information.
           "Account", // Member ID
           "Role"
       ],
       "AppDefinedDataFilter_Group": [ // The filter for group-specific custom fields. This filter is disabled by default.
           "GroupTestData1",
           "GroupTestData2"
       ],
       "AppDefinedDataFilter_GroupMember": [ // The filter for group member-specific custom fields. This filter is disabled by default.
           "MemberDefined2",
           "MemberDefined1"
       ]
   }
  }
  

Request fields

Sample response

• Basic format

  {
    "ActionStatus": "OK",
    "ErrorInfo": "", // The ErrorInfo parameter here is meaningless. You need to check the ErrorInfo parameter of each group.
    "ErrorCode": 0, // The ErrorCode parameter here is meaningless. You need to check the ErrorCode parameter of each group.
    "GroupInfo": [ // A group information array is returned. Only one group is listed here for simplicity.
        {
            "GroupId": "@TGS#2J4SZEAEL",
            "ErrorCode": 0, // The result specific to this group
            "ErrorInfo": "" , // The result specific to this group
            "Type": "Public", // Group type
            "Name": "MyFirstGroup", // Group name
            "Appid":1400001001,// SDKAppID of the Chat app
            "Introduction": "TestGroup", // Group introduction
            "Notification": "TestGroup", // Group notice
            "FaceUrl": "http://this.is.face.url", // Group profile photo
            "Owner_Account": "leckie", // Group owner ID
            "CreateTime": 1426976500, // Group creation time in UTC
            "LastInfoTime": 1426976500, // The UTC time when the group information was last updated
            "LastMsgTime": 1426976600, // The UTC time when the last message in the group was sent
            "NextMsgSeq": 1234,
            "MemberNum": 2, // Current number of members in the group
            "MaxMemberNum": 50, // Maximum number of members in the group
            "ApplyJoinOption": "FreeAccess", // Method of handling requests to join the group
            "MuteAllMember": "On", // Whether to mute all members in the group
            "AppDefinedData": [ // Group-specific custom fields
                {
                    "Key": "GroupTestData1", // Key of the custom field
                    "Value": "xxxx" // Value of the custom field
                },
                {
                    "Key": "GroupTestData2",
                    "Value": "abc\u0000\u0001" // The custom field supports binary data.
                }
            ],
            "MemberList": [ // Group member list
                {
                    "Member_Account": "leckie", // Member ID
                    "Role": "Owner", // The role of the member in the group
                    "JoinTime": 1425976500, // The UTC time when the member joined the group
                    "MsgSeq": 1233,
                    "MsgFlag": "AcceptAndNotify", // Indicates whether the member blocks group messages.
                    "LastSendMsgTime": 1425976500, // The last time in UTC when the member sent a message in the group
                    "MuteUntil": 1431069882, // UTC time when the muting period expires
                    "AppMemberDefinedData": [ // Custom group member fields
                        {
                             "Key": "MemberDefined1",
                             "Value": "ModifyDefined1"
                        },
                        {
                             "Key": "MemberDefined2",
                             "Value": "ModifyDefined2"
                        }
                    ]
                },
                {
                    "Member_Account": "peter",
                    "Role": "Member",
                    "JoinTime": 1425976500, // Time when the member joined the group
                    "MsgSeq": 1233,
                    "MsgFlag": "AcceptAndNotify",
                    "LastSendMsgTime": 1425976500, // Last time when the member sent a message
                    "MuteUntil": 0, // The value `0` indicates that the member is not muted, and other values indicate the time when the member will be unmuted.
                    "AppMemberDefinedData":[ // Custom group member fields
                        {
                            "Key": "MemberDefined1",
                            "Value": "ModifyDefined1"
                        },
                        {
                            "Key":"MemberDefined2",
                            "Value":"ModifyDefined2"
                        }
                     ]
                }
            ]
        }
    ]
  }
  

• Pulling specified information

  {
    "ActionStatus": "OK",
    "ErrorInfo": "", // The ErrorInfo parameter here is meaningless. You need to check the ErrorInfo parameter of each group.
    "ErrorCode": 0, // The ErrorCode parameter here is meaningless. You need to check the ErrorCode parameter of each group.
    "GroupInfo": [ // A group information array is returned. Only one group is listed here for simplicity.
        {
            "GroupId": "@TGS#2J4SZEAEL",
            "ErrorCode": 0, // The result specific to this group
            "ErrorInfo":"" , // The result specific to this group
            "Type": "Public", // Group type
            "Name": "MyFirstGroup", // Group name
            "Introduction": "TestGroup", // Group introduction
            "Notification": "TestGroup", // Group notice
            "AppDefinedData": [ // Group-specific custom fields
                {
                    "Key": "GroupTestData1", // Key of the custom field
                    "Value": "xxxx" // Value of the custom field
                },
                {
                    "Key": "GroupTestData2",
                    "Value": "abc\u0000\u0001" // The custom field supports binary data.
                }
            ],
            "MemberList": [ // Group member list
                {
                    "Member_Account": "leckie", // Member ID
                    "Role": "Owner", // The role of the member in the group
                    "AppMemberDefinedData":[ // Custom group member fields
                        {
                            "Key":"MemberDefined1",
                            "Value":"ModifyDefined1"
                        },
                        {
                            "Key":"MemberDefined2",
                            "Value":"ModifyDefined2"
                        }
                     ]
                },
                {
                    "Member_Account": "peter",
                    "Role": "Member",
                    "AppMemberDefinedData":[ // Custom group member fields
                        {
                            "Key":"MemberDefined1",
                            "Value":"ModifyDefined1"
                        },
                        {
                            "Key":"MemberDefined2",
                            "Value":"ModifyDefined2"
                        }
                     ]
                }
            ]
        }
    ]
  }
  

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), see Error Codes.
The following table describes the error codes specific to this API:

API Debugging Tool

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

References

• Getting Group Member Profiles (v4/group_open_http_svc/get_group_member_info)
• Modifying the Profile of a Group (v4/group_open_http_svc/modify_group_base_info)
• Modifying the Profile of a Group Member (v4/group_open_http_svc/modify_group_member_info)