• UIKit
  • SDK
  • 서버 API
Chat/
서버 API/
RESTful 인터페이스/
그룹 관련/
그룹 관리/
서버 API
  • UserSig 생성
  • RESTful 인터페이스
    • RESTful 인터페이스 개요
    • RESTful 인터페이스 목록
    • 메시지 관련
      • 메시지 보내기
        • 단일 사용자에게 1대1 메시지 보내기
        • 여러 사용자에게 1대1 메시지 보내기
        • 그룹 내 일반 메시지 보내기
        • 그룹 내 시스템 메시지 보내기
        • 라이브 방송 그룹 브로드캐스트 메시지
        • 1대1 메시지 가져오기
        • 그룹 메시지 가져오기
      • 과거 메시지
        • 과거 1대1 메시지 수정
        • 과거 그룹 메시지 수정
        • 1대1 과거 메시지 풀링
        • 그룹 과거 메시지 풀링
      • 메시지 삭제
        • 지정 사용자가 보낸 메시지 삭제하기
      • 메시지 철회
        • 1대1 메시지 철회
        • 그룹 메시지 철회
      • 읽음 확인
        • 1대1 메시지 읽음 설정
        • 그룹 메시지 읽음 확인 상세정보 풀링
        • 그룹 메시지 읽음 확인 풀링
      • 메시지 확장
        • 1대1 메시지 확장 풀링
        • 1대1 메시지 확장 설정
        • 그룹 메시지 확장 풀링
        • 그룹 메시지 확장 설정
      • 모든 사용자에게 푸시하기
        • 전원 푸시 인터페이스
        • 모든 사용자에게 푸시하기
        • 애플리케이션 속성 이름 설정
        • 애플리케이션 속성 이름 획득
        • 사용자 속성 획득
        • 사용자 속성 설정
        • 사용자 속성 삭제
        • 사용자 태그 획득
        • 사용자 태그 추가
        • 사용자 태그 삭제
        • 사용자 모든 태그 삭제
    • 대화 관련
      • 대화 목록
        • 대화 목록 풀링
      • 읽지 않은 대화 수
        • 멤버의 읽지 않은 메시지 수 설정
        • 읽지 않은 1대1 메시지 수 조회
      • 대화 삭제
        • 대화 삭제
      • 대화 그룹 태그
        • 대화 그룹 데이터 생성
        • 대화 그룹 데이터 업데이트
        • 대화 그룹 데이터 삭제
        • 대화 마크 데이터 생성 또는 업데이트
        • 대화 그룹 마크 검색
        • 대화 그룹 마크 데이터 풀링
    • 그룹 관련
      • 그룹 관리
        • 애플리케이션 내 모든 그룹 획득
        • 그룹 생성
        • 그룹 해체
        • 사용자가 가입한 그룹 획득
      • 그룹 정보
        • 그룹 정보 획득
        • 그룹 정보 수정
        • 그룹 정보 가져오기
      • 그룹 멤버 관리
        • 그룹 멤버 추가
        • 그룹 멤버 삭제
        • 그룹 멤버 금지
        • 그룹 멤버 금지 해제
        • 일괄 음소거 및 음소거 취소
        • 음소거된 그룹 멤버 목록 획득
        • 그룹 오너 변경
        • 그룹 내 사용자의 신분 조회
        • 그룹 멤버 가져오기
      • 그룹 멤버 정보
        • 그룹 멤버 정보 획득
        • 그룹 멤버 정보 수정
      • 그룹 사용자 정의 속성
        • 그룹 사용자 정의 속성 획득
        • 그룹 사용자 정의 속성 수정
        • 그룹 사용자 정의 속성 비우기
        • 그룹 사용자 정의 속성 리셋
        • 그룹 사용자 정의 속성 삭제
      • 라이브 방송 그룹 관리
        • 라이브 방송 그룹 온라인 인원수 획득
        • 라이브 방송 온라인 멤버 목록 획득
        • 라이브 방송 그룹 멤버 마크 설정
        • 금지된 멤버 목록 획득
      • 커뮤니티 관리
        • 화제 생성
        • 화제 삭제
        • 화제 정보 획득
        • 화제 정보 수정
        • 화제 정보 가져오기
      • 그룹 카운터
        • 그룹 카운터 획득
        • 그룹 카운터 업데이트
        • 그룹 카운터 삭제
    • 사용자 관리
      • 계정 관리
        • 단일 계정 가져오기
        • 다중 계정 가져오기
        • 계정 삭제
        • 계정 조회
      • 사용자 정보
        • 정보 설정
        • 정보 풀링
      • 사용자 상태
        • 계정 로그인 상태 무효화
        • 계정 온라인 상태 조회
      • 친구 관리
        • 친구 추가
        • 친구 가져오기
        • 친구 업데이트
        • 친구 삭제
        • 모든 친구 삭제
        • 친구 인증
        • 친구 풀링
        • 지정 친구 풀링
      • 친구 목록
        • 목록 추가
        • 목록 삭제
        • 풀링 목록
      • 블록리스트
        • 사용자 블록리스트 추가
        • 사용자를 블록리스트에서 제거
        • 블록리스트 풀링
        • 블록리스트 내의 사용자 인증
    • 전원 음소거 관리
      • 전원 음소거 설정
      • 전원 음소거 조회
    • 운영 및 유지관리
      • 운영 및 유지관리 데이터 풀링
      • 최신 메시지 다운로드
      • 서버 IP 주소 획득
    • 챗봇
      • 챗봇 계정 풀링
      • 챗봇 계정 생성
      • 챗봇 계정 삭제
  • 트리거
    • 콜백 개요
    • 콜백 명령 목록
    • 콜백 운영 및 유지관리
      • 인터페이스 오버클록킹 알람 콜백
    • 온라인 상태 콜백
      • 상태 변경 콜백
    • 관계망 콜백
      • 정보 업데이트 후
      • 친구 추가 전
      • 친구 추가 응답 전
      • 친구 추가 후
      • 친구 삭제 후
      • 사용자를 블록리스트에 추가한 후
      • 사용자를 블록리스트에서 제거한 후
    • 1대1 메시지 콜백
      • 1대1 메시지 보내기 전
      • 1대1 메시지 보낸 후
      • 1대1 메시지 읽음 설정 후
      • 1대1 메시지 철회 후
    • 그룹 콜백
      • 그룹 생선 전
      • 그룹 생성 후
      • 그룹 가입 신청 전
      • 사용자를 그룹에 초대하기 전
      • 사용자 그룹 가입 후
      • 멤버 탈퇴 후
      • 그룹 메시지 보내기 전
      • 그룹 메시지 보낸 후
      • 그룹 만원 후
      • 그룹 해체 후
      • 그룹 정보 변경 후
      • 그룹 메시지 회수 후 콜백
      • 라이브 방송 그룹 멤버 온라인 및 오프라인 상태 콜백
      • 그룹 메시지 보내기 이상 콜백
      • 화제 생성 전
      • 화제 생성 후
      • 화제 삭제 후
      • 화제 정보 변경 콜백
      • 그룹 멤버 정보 변경 후 콜백
      • 그룹 속성 변경 후 콜백
      • 읽음 확인 후 콜백
      • 그룹 오너 변경 후 콜백
    • 콜백 상호 인증 구성 가이드
      • Apache 상호 인증 구성
      • Nginx 상호 인증 구성
    • 챗봇 콜백
      • 챗봇 1대1 메시지 사용자 정의 콜백
이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

사용자가 가입한 그룹 획득

Feature Overview

This API is used by app admins to obtain the list of groups a certain user has joined. The information of work groups (Work) and audio-video groups (AVChatRoom) that the user has joined but are not activated is not pulled by default.

API Calling Description

Applicable group types

Group Type ID
RESTful API Support
Private
Yes. Same as work groups (Work) in the new version. The information of work groups that the user has joined but are not activated is not returned by default.
Public
Yes
ChatRoom
Yes. Same as meeting groups (Meeting) in the new version.
AVChatRoom
Yes. The information of audio-video groups (AVChatRoom) that the user has joined is not returned by default. If you specify to pull audio-video group information, the obtained group information may not be complete. Audio-video groups do not store all group member data.
Community
Yes
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_joined_group_list?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/get_joined_group_list
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

Basic format A basic request is used to obtain the information about groups that a user has joined. The group information contains only the IDs of users in the group.
{
"Member_Account": "leckie"
}
Pulling by page You can use the Limit and Offset fields to control the pagination mode:
The Limit field specifies the maximum number of groups in GroupIdList in the response packet, which cannot exceed 5,000.
The Offset field specifies the sequence number of the group in the entire group list, starting from which the information is read. Offset is 0 by default. If pagination is requested (the page number starts from 1), the Offset value of each page should be: (Page number – 1) × Number of groups displayed on each page. For example, to display 20 group members on each page, the request parameters for the first page should be {"Limit": 20, "Offset": 0}, the request parameters for the second page should be {"Limit": 20, "Offset": 20}, and so on.
The value of Limit or Offset does not affect TotalCount in the response packet.
{
"Member_Account": "leckie",
"Limit": 10, // Number of groups to be pulled. If this field is not specified, all groups will be pulled.
"Offset": 0 // Sequence number of the group starting from which information is pulled.
}
Specifying the group type You can specify the type of groups to be pulled, for example, Public (social networking group for strangers), Private (same as Work groups in the new version), and ChatRoom (same as Meeting groups in the new version). If AVChatRoom (audio-video group) is specified, you may obtain an incomplete list of members.
{
"Member_Account": "leckie",
"GroupType" : "Public" // Type of groups to be pulled. If this parameter is not specified, all types of groups will be pulled.
}
Pulling specified information To specify the basic information fields to be pulled, set GroupBaseInfoFilter. To specify the group member information in the group that needs to be pulled, set SelfInfoFilter.
{
"Member_Account": "leckie",
"WithHugeGroups":1, // Supports pulling the information of audio-video groups (AVChatRoom).
"WithNoActiveGroups":1,// Supports pulling the information of Private groups (same as Work groups in the new version) that the user has joined but are not activated.
"Limit": 10, // Number of groups to be pulled. If this field is not specified, all groups will be pulled.
"Offset": 0, // Sequence number of the group starting from which information is pulled.
"ResponseFilter": {
"GroupBaseInfoFilter": [ // Basic information fields to be pulled
"Type",
"Name",
"Introduction",
"Notification"
],
"SelfInfoFilter": [ // Member's personal information in the group
"Role", // Role in the group
"JoinTime" // Time when the member joined the group
]
}
}

Pulling topic-enabled community groups
{
"Member_Account": "107867",// User account to be queried (required)
"SupportTopic": 1// Whether the specified group type supports topics. This field is supported only by community groups.
}
ALL IN ONE
{
"Member_Account": "leckie",
"WithHugeGroups":1,
"WithNoActiveGroups":1,
"ResponseFilter": {
"GroupBaseInfoFilter": [
"Type",
"Name",
"Introduction",
"Notification",
"FaceUrl",
"CreateTime",
"Owner_Account",
"LastInfoTime",
"LastMsgTime",
"NextMsgSeq",
"MemberNum",
"MaxMemberNum",
"ApplyJoinOption",
"MuteAllMember"
],
"SelfInfoFilter": [
"Role",
"JoinTime",
"MsgFlag",
"MsgSeq"
]
}
}

Request fields

Field
Type
Required
Description
Member_Account
String
Yes
User account to be queried
WithHugeGroups
Integer
No
Whether to pull the information of audio-video groups (AVChatRoom) that the user has joined. 0: No (default value); 1: Yes
WithNoActiveGroups
Integer
No
Whether to pull the information of Private groups (same as Work groups in the new version) that the user has joined but are not activated. 0: No (default value); 1: Yes
Limit
Integer
No
Number of groups pulled each time. If no value is specified, all groups will be pulled.
Offset
Integer
No
Sequence number of the group starting from which information is pulled.
GroupType
String
No
Type of groups to be pulled, for example, Public (social networking group for strangers), Private (same as Work groups in the new version), ChatRoom (same as Meeting groups in the new version), AVChatRoom (audio-video groups), and Community. If no value is specified, all types of groups are pulled.
ResponseFilter
Object
No
It contains two filters: GroupBaseInfoFilter and SelfInfoFilter. GroupBaseInfoFilter specifies the basic information fields to pull. For more information, see Group basic information. SelfInfoFilter specifies members' personal information to be pulled from groups. For more information, see Group member profile.
SupportTopic
Integer
No
Whether the specified group type supports topics. 1: Yes; 0: No. If this field is specified, GroupType must be Community.

Sample response

Basic or paged pull request
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TotalCount": 2, // This value is the total number of groups that meet the conditions, regardless of the `Limit` and `Offset` settings.
"GroupIdList": [
{
"GroupId": "@TGS#2J4SZEAEL"
},
{
"GroupId": "@TGS#2C5SZEAEF"
}
]
}
Specifying the group type
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TotalCount": 1,
"GroupIdList": [
{
"GroupId": "@TGS#2J4SZEAEL"
}
]
}
Pulling specified information
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TotalCount": 2,
"GroupIdList": [
{
"GroupId": "@TGS#16UMONKGG",
"Introduction": "",
"Name": "d",
"Notification": "",
"SelfInfo": {
"JoinTime": 1588148506,
"Role": "Member"
},
"Type": "Private"
},
{
"GroupId": "@TGS#3FCOX2MGW",
"Introduction": "",
"Name": "TestGroup",
"Notification": "",
"SelfInfo": {
"JoinTime": 1588041114,
"Role": "Member"
},
"Type": "ChatRoom"
}
]
}
Pulling topic-enabled community groups
{
"ActionStatus": "OK",
"ErrorInfo": "ok",
"ErrorCode": 0,
"TotalCount": 1,
"GroupIdList": [
{
"GroupId": "@TGS#_@TGS#cMOQ7HIM62CD",
"Type": "Community",
"SupportTopic": 1,
"GrossTopicNextMsgSeq": 3,
"SelfInfo": {
"GrossTopicReadSeq": 2
}
}
]
}

ALL IN ONE
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"TotalCount": 1, // This value is the total number of groups that meet the conditions, regardless of the `Limit` and `Offset` settings.
"GroupIdList": [
{
"ApplyJoinOption": "DisableApply",
"CreateTime": 1585718204,
"FaceUrl": "",
"GroupId": "@TGS#16UMONKGG",
"Introduction": "",
"LastInfoTime": 1588148506,
"LastMsgTime": 0,
"MaxMemberNum": 200,
"MemberNum": 1,
"Name": "d",
"NextMsgSeq": 2,
"Notification": "",
"Owner_Account": "",
"SelfInfo": {
"JoinTime": 1588148506,
"MsgFlag": "AcceptAndNotify",
"Role": "Member",
"MsgSeq": 1
},
"MuteAllMember": "Off",
"Type": "Private"
}
]
}

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
TotalCount
Integer
Number of groups that the user has joined
GroupIdList
Array
Group information pulled. The returned result is the information filtered based on the filtering fields set in the filter. For more information on the fields, see Group Data Structure.

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
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.
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.

API Debugging Tool

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