製品の概要
Basic Concepts
ユースケース
機能概要
アカウントシステム
ユーザープロフィールとリレーションシップチェーン
メッセージ管理
グループシステム
Official Account
Audio/Video Call
使用制限
Group Type ID | Whether This RESTful API Is Supported |
Private | Not supported, same as Work (Work Friend Group) in the new version |
Public | Not supported |
ChatRoom | Not supported, same as Meeting (Temporary Meeting Group) in the new version |
AVChatRoom | Not supported |
Community | Supported |
https://xxxxxx/v4/group_open_http_svc/get_permission_group_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | The dedicated domain name for the country/region where your SDKAppID is located: China: console.tim.qq.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comTokyo： adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/get_permission_group_member_list | Request API |
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 fixed value: json |
{"GroupId": "@TGS#_@TGS#cAVQXXXXXX", // Group ID (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group ID (required)}
{"Limit": 20, "Next": ""}, and the server returns the following content.{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1","MemberList": [....
{"Limit": 20, "Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1"}.
And so on, until the server's response packet returns Next as "", indicating there is no subsequent member information, and the client shall end the query.{"GroupId":"@TGS#_@TGS#cAVQXXXXXX", // Group ID (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group ID (required)"Limit": 50, // The maximum number of members whose information to be obtained"Next": "" // Start pulling from the end of the last pull}
{"GroupId":"@TGS#_@TGS#cAVQXXXXXX", // Group ID (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group ID (required)"MemberInfoFilter": [ // Which information is needed (Member_Account is included by default). If this field is not specified, then information of all members is included."Role","JoinTime","MsgSeq","MsgFlag","LastSendMsgTime","JoinPermissionGroupTime","MuteUntil","NameCard"]}
{"GroupId":"@TGS#_@TGS#cAVQXXXXXX", // Group ID (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group ID (required)"AppDefinedDataFilter_GroupMember": [ // Filter for custom field of group members"MemberDefined2" // Key of the custom field for group members]}
{"GroupId":"@TGS#_@TGS#cAVQXXXXXX", // Group ID (required)"PermissionGroupId":"@PMG#_@PMG#cDR",// Permission group ID (required)"MemberInfoFilter": [ // Which information is needed. If this field is not specified, then information of all members is included."Role","JoinTime","JoinPermissionGroupTime","MsgSeq","MsgFlag","LastSendMsgTime","MuteUntil","NameCard"],"AppDefinedDataFilter_GroupMember": [ // Filter for custom field of group members"MemberDefined2", // Key of the custom field for group members"MemberDefined1"],"Limit": 50, // The maximum number of members whose information to be obtained"Offset": 0 // The starting point to obtain member information}
Field | Type | Attribute | Description |
GroupId | String | Required | ID of the group from which member information needs to be obtained |
PermissionGroupId | String | Required | ID of the permission group to operate on |
MemberInfoFilter | Array | Optional | Which information is needed. If this field is not specified, then information of all members is included. For details on member information fields, refer to Group Member Information. |
AppDefinedDataFilter_GroupMember | Array | Optional | By default, this is not available. This field is used as a filter for custom fields in the group member dimension, specifying the custom fields of the group member dimension that need to be obtained For details, refer to Custom Fields. |
Next | String | Optional | The member location obtained last time. It is required for communities, as communities do not support the Offset parameter. Use the Next parameter instead. Fill in "" for the first call, and use the Next value returned for subsequent retrievals. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1","MemberNum": 2, // Total number of members in this permission group"MemberList": [ // Permission group member list{"Member_Account": "bob","Role": "Owner","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500, // Last message sent time"MuteUntil": 1431069882, // Mute until (seconds)"AppMemberDefinedData": [ // Group member's custom definition field{"Key": "MemberDefined1","Value": "ModifyDefined1"},{"Key": "MemberDefined2","Value": "ModifyDefined2"}]},{"Member_Account": "peter","Role": "Member ","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500,"MuteUntil": 0, // 0 indicates not muted; otherwise, it's the mute expiry timestamp."AppMemberDefinedData": [ // Group member's custom definition field{"Key": "MemberDefined1","Value": "ModifyDefined1"},{"Key": "MemberDefined2","Value": "ModifyDefined2"}]}]}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1","MemberNum": 2, // Total number of members in this permission group"MemberList": [ // Permission group member list{"Member_Account": "bob","Role": "Owner","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500, // Last message sent time"MuteUntil": 1431069882, // Mute until (seconds)},{"Member_Account": "peter","Role": "Member ","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500,"MuteUntil": 0, // 0 indicates not muted; otherwise, it's the mute expiry timestamp.}]}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1","MemberNum": 2, // Total number of members in this permission group"MemberList": [ // Permission group member list{"Member_Account": "bob","Role": "Owner","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500, // Last message sent time"MuteUntil": 1431069882, // Mute until (seconds)"AppMemberDefinedData": [ // Custom fields for group members{"Key": "MemberDefined2","Value": "ModifyDefined2"}]},{"Member_Account": "peter","Role": "Member","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500,"MuteUntil": 0, // 0 indicates not muted; otherwise, it's the mute expiry timestamp."AppMemberDefinedData": [ // Group member's custom definition field{"Key": "MemberDefined2","Value": "ModifyDefined2"}]}]}
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"Next": "TGSMTQ0MTE1MjM1MTUyNDI0MzY1","MemberNum": 2, // Total number of members in this permission group"MemberList": [ // Permission group member list{"Member_Account": "bob","Role": "Owner","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500, // Last message sent time"MuteUntil": 1431069882, // Mute until (seconds)"AppMemberDefinedData":[ // Custom fields for group members{"Key":"MemberDefined1","Value":"ModifyDefined1"},{"Key":"MemberDefined2","Value":"ModifyDefined2"}]},{"Member_Account": "peter","Role": "Member","JoinTime": 1425976500, // Join time"JoinPermissionGroupTime": 1704804868, // Time joined the permission group"MsgSeq": 1233,"MsgFlag": "AcceptAndNotify","LastSendMsgTime": 1425976500,"MuteUntil": 0, // 0 indicates not muted; otherwise, it's the mute expiry timestamp."AppMemberDefinedData": [ // Group member's custom definition field{"Key": "MemberDefined1","Value": "ModifyDefined1"},{"Key": "MemberDefined2","Value": "ModifyDefined2"}]}]}
Field | Type | Description |
ActionStatus | String | Result of the request processing: OK: Indicates successful processing. FAIL: Indicates failure. |
ErrorCode | Integer | Error code 0: Indicates success. Non-zero: Indicates failure. |
ErrorInfo | String | Error message |
MemberNum | Integer | Total number of members in this permission group |
MemberList | Array | Obtained permission group members list, which includes all or specified group member information. For details on member information fields, refer to Group Member Information. |
AppMemberDefinedData | Array | Returned group member custom field information |
Next | String | Next value that shall be passed in the next request |
Error Code | Description |
10002 | Internal server error. Try again. |
10003 | Illegal request command word |
10004 | Invalid parameter. Check if the request is correct based on the error description. |
10007 | Insufficient operation permissions. Confirm whether the operator is an app admin or has permission to read the fields in the request. |
10010 | The group does not exist, or it existed in the past but has now been dissolved. |
10015 | Invalid group ID. Check if the group ID is filled in correctly. |
110006 | The permission group does not exist, or it existed in the past but has now been dissolved. |
110008 | Invalid permission group ID. Check if the permission group ID is filled in correctly. |
文档反馈