Getting the Number of Online Users in an Audio-Video Group

Last updated: 2022-12-16 15:54:13

Feature Description

The app admin can use the group ID to obtain the number of online users in a live stream group.

API Description

Applicable group types

Group Type ID	REST API Support
Private	No. Same as Work (work group) in the new version.
Public	No.
ChatRoom	No. Same as Meeting (temporary meeting group) in the new version.
AVChatRoom	Yes.
Community	No.

Above are the IM built-in groups. For more information, see Group system.

Note：

The number of online users is updated every 10s.

When there are web users, the number of online users will be updated 10s to 20s after a user joins or quits the group.

When the group size is less than 300 and when there are no web users, the number of online users is updated immediately after a user joins or quits the group.

Sample request URL

https://xxxxxx/v4/group_open_http_svc/get_online_member_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Overview.

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST.
xxxxxx	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` India: `adminapiind.im.qcloud.com` Silicon Valley: `adminapiusa.im.qcloud.com`
v4/group_open_http_svc/get_online_member_num	The API to which the request is sent.
sdkappid	The SDKAppID assigned by the IM console when an application is created.
identifier	Must be the app admin account. For more information, please see the App Admin section in Login Authentication.
usersig	The signature generated by the app admin account. For more information on the operation, please see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format. The value is always `json`.

Maximum call frequency

200 times/second

Sample request packet

This API is used to obtain the number of online users in a live stream group (AVChatRoom). The number of online users is updated every 10s. We recommend that the service-end queries the number of online users every 10s and synchronizes it to all users in the group.

{
  "GroupId":"@TGS#a6I4ZUUGO"
}

Request packet fields

Field	Type	Required	Description
GroupId	String	Yes	The group ID.

Sample response packet

{
   "ActionStatus":"OK",
   "ErrorInfo":"", 
   "ErrorCode": 0, 
   "OnlineMemberNum":1000 // Number of online users
}

Response packet fields

Field	Type	Description
ActionStatus	String	The request result. `OK`: succeeded. `FAIL`: failed.
ErrorCode	Integer	The error code. `0`: succeeded. Other values: failed.
ErrorInfo	String	The error information.
OnlineMemberNum	Integer	The number of online users in the group.

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, please 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	You do not have required permissions. You can only obtain the number of online users for live stream groups.
10010	The group does not exist or has been disbanded.
10015	The group ID is invalid. Please check the group ID.

Debugging Tool

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

tencent cloud

Recent Pages