이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

Checking Whether Users Are in a Live Streaming Group

Feature Overview
App administrators can check whether a batch of users is in a live streaming group by using the group ID. This feature requires the Premium Edition, and the live streaming group online member list feature must have been enabled under group feature configuration in the Chat console.
API Call Description
Applicable Group Types
Group Type ID
REST API Support
Private
No. It is similar to Work (friend work group) in the new version.
Public
No.
ChatRoom
No. It is similar to Meeting (temporary meeting group) in the new version.
AVChatRoom
Yes.
Community
No.
Chat incorporates the aforementioned group types. For details, see Group System.
Note
This feature requires the Premium Edition Package, and the live streaming group online member list feature must have been enabled (under group feature configuration in the console).
The overall update granularity of online members is 40s.
When there are more than 1,000 people in the live streaming group, the API can still query whether members outside of the 1,000 people are in the live streaming group.
Sample Request URL
https://xxxxxx/v4/group_open_avchatroom_http_svc/check_members?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table only lists the parameters involved when this API is called and their descriptions. For details on other parameters, see REST API Overview.
Parameter
Description
xxxxxx
The dedicated domain name corresponding to the country/region of the SDKAppID:
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_avchatroom_http_svc/check_members
Request API.
sdkappid
The SDKAppID assigned by the Chat console when an application is created.
identifier
It must be an app admin account. For details, see App Admins.
usersig
The 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
The request format is fixed to json.
Maximum Call Frequency
200 times/second
Sample Request Packets
Query whether a batch of users is in the live streaming group, and return the users who are in the group.
{
    "GroupId":"@TGS#a6I4ZUUGO",
    "Member_Account": ["245000","202200","239017","361697"]
}
Request Packet Fields
Field
Type
Attribute
Description
GroupId
String
Required
ID of the operated group.
Member_Account
Array
Required
UserID list of queried users.
Sample Response Packets
{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "Member_Account": ["245000", "239017"]
}
Response Packet Fields
Field
Type
Description
ActionStatus
String
Processing results:
OK: succeeded.
FAIL: failed.
ErrorCode
Integer
Error code:
0: succeeded.
Other values: failed.
ErrorInfo
String
Error message.
Member_Account
Array
UserID list of users in the live streaming group.
Error Codes
Unless a network error occurs (such as a 502 error), the HTTP return code for this API is always 200. The real error code and error message are indicated by ErrorCode and ErrorInfo in the response packets.
Common error codes (60000 to 79999) can be found in Error Codes.
The private error codes for this API are as follows:
Error Code
Description
10001
The user does not log in. Please check whether the admin account and usersig are correct.
10002
System error. Please try again or contact technical support.
10003
Invalid request command. Please try again or contact technical support.
10004
Invalid parameters. Please check whether the required fields are filled in or whether the field fillings meet the protocol requirements based on the ErrorInfo field in the response packets.
10007
Insufficient permissions. Non-AVChatRoom group types do not support obtaining the online user count.
10010
The group does not exist, or it once existed but has now been dissolved.
10015
Invalid group ID. Please check whether the group ID is filled in correctly.

Feature Overview
API Call Description
Error Codes

Group Type ID	REST API Support
Private	No. It is similar to Work (friend work group) in the new version.
Public	No.
ChatRoom	No. It is similar to Meeting (temporary meeting group) in the new version.
AVChatRoom	Yes.
Community	No.

Parameter	Description
xxxxxx	The dedicated domain name corresponding to the country/region of the SDKAppID: 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_avchatroom_http_svc/check_members	Request API.
sdkappid	The SDKAppID assigned by the Chat console when an application is created.
identifier	It must be an app admin account. For details, see App Admins.
usersig	The 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	The request format is fixed to `json`.

Field	Type	Attribute	Description
GroupId	String	Required	ID of the operated group.
Member_Account	Array	Required	UserID list of queried users.

Error Code	Description
10001	The user does not log in. Please check whether the admin account and usersig are correct.
10002	System error. Please try again or contact technical support.
10003	Invalid request command. Please try again or contact technical support.
10004	Invalid parameters. Please check whether the required fields are filled in or whether the field fillings meet the protocol requirements based on the ErrorInfo field in the response packets.
10007	Insufficient permissions. Non-AVChatRoom group types do not support obtaining the online user count.
10010	The group does not exist, or it once existed but has now been dissolved.
10015	Invalid group ID. Please check whether the group ID is filled in correctly.