Group Type ID | RESTful API Support |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | Yes |
Community | Yes |
https://xxxxxx/v4/group_open_http_svc/get_group_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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/get_group_info | The request API that is called. |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json . |
{"GroupIdList": [ // The list of group IDs specified for the query. This parameter is required."@TGS#1NVTZEAE4","@TGS#1CXTZEAET"]}
GroupBaseInfoFilter
.MemberInfoFilter
.{"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"]}}
Field | Type | Required | Description |
GroupIdList | Array | Required | The list of group IDs that you specify for the query. |
ResponseFilter | Object | Optional | It contains three filters: GroupBaseInfoFilter , MemberInfoFilter , and AppDefinedDataFilter_Group . |
GroupBaseInfoFilter | Array | Optional | Basic information field filter, which specifies the basic information fields to query. For more information, see Group basic data. |
MemberInfoFilter | Array | Optional | Member information field filter, which specifies the member information fields to query. For more information, see Group member information. |
AppDefinedDataFilter_Group | Array | Optional | The group-specific custom field filter, which specifies the group-specific custom fields to query. For more information, see Custom fields. |
AppDefinedDataFilter_GroupMember | Array | Optional | The group member-specific custom field filter, which specifies the group member-specific custom fields to be query. For more information, see Custom fields. |
{"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"}]}]}]}
{"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"}]}]}]}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
GroupInfo | Array | Group information array returned, including basic group information fields, group member information fields, group-specific custom fields, and group member-specific custom fields. For more information on the fields, see Group Data Structure. |
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 | A system error occurred. Try again or contact technical support. |
10003 | The request command is invalid. Try again or contact technical support. |
10004 | A parameter is invalid. Check the ErrorInfo field in the response packet to see whether the required fields have been specified or whether the fields are set according to protocol requirements. |
10007 | Insufficient operation permissions. Check whether the operator is the app admin. |
10010 | The group does not exist or has been deleted. |
10015 | The group ID is invalid. Please check the group ID. |
10018 | The response packet length exceeds the maximum packet length of 1 MB because too much content was requested. Try to reduce the amount of data requested at a time. |
Was this page helpful?