tencent cloud

Chat

ドキュメントChatサービス側 APIsRESTful APIsGroup RelatedGroup Member ManagementQuerying the Roles of Users in a Group

Querying the Roles of Users in a Group

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-04-17 10:20:37

Feature Overview

This API is used by the app admin to batch obtain the roles of users in a group.

API Calling Description

Applicable group types

Group Type ID
Support for This RESTful API
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
No.
Community
Yes.
Above are the preset group types of Chat. For more information, see Group System.
Note
Audio-video groups (AVChatRoom) do not support this API. If this API is called for an audio-video group, a 10007 error will be returned. To get the current administrator list, see Obtaining the List of Live Streaming Group Administrators.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/get_role_in_group?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
Tokyo: adminapijpn.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_role_in_group
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

Obtain the list of groups a user has joined. The group information includes the group ID and the IDs of group members whose roles are to be queried.
{
    "GroupId": "@TGS#2C5SZEAEF",
    "User_Account": [ // Up to 500 member accounts are supported
        "leckie",
        "peter",
        "wesley"
    ]
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
The ID of the group to be queried.
User_Account
Array
Yes
User accounts to be queried. Up to 500 accounts are supported.

Sample response

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "UserIdList": [ // Result
        {
            "Member_Account": "leckie",
            "Role": "Owner" // Member role: Owner/Admin/Member/NotMember
        },
        {
            "Member_Account": "peter",
            "Role": "Member"
        },
        {
            "Member_Account": "wesley",
            "Role": "NotMember"
        }
    ]
}

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.
UserIdList
Array
Member roles that are pulled, including Owner, Admin, Member, and NotMember.

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. The operator must have permissions to perform corresponding operations.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Please confirm that the group ID is entered correctly.

API Debugging Tool

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

References

Getting the Groups a User Has Joined (v4/group_open_http_svc/get_joined_group_list)
前の記事へ: Changing Group Owner次の記事へ: Importing Group Members

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック