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. |
https://xxxxxx/v4/group_open_http_svc/get_online_member_num?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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 Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.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 . |
{"GroupId":"@TGS#a6I4ZUUGO"}
Field | Type | Required | Description |
GroupId | String | Yes | The group ID. |
{"ActionStatus":"OK","ErrorInfo":"","ErrorCode": 0,"OnlineMemberNum":1000 // Number of online users}
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. |
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. |
Was this page helpful?