このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
ドキュメンテーション概要/
Get Room Member List/

Get Room Member List

Feature Overview

App Administrators can retrieve the Room Member List through this interface.

API Calling Description

Sample request URL

https://xxxxxx/v4/live_engine_http_srv/get_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Note:
The overall update granularity of the online member list is 40s.
When the room member count exceeds 1000, the interface only returns 1000 members.

Request parameters

The table below only lists the parameters modified when this interface is called. For more details on other parameters, please refer to REST API.
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
v4/live_engine_http_srv/get_member_list
Request API
sdkappid
SDKAppID assigned when creating the application
identifier
Must be an App administrator account. For more details, please refer to App Admin
usersig
Signature generated by the App administrator account, for specific steps please refer to Generate UserSig
random
A random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
Request format fixed value: `json`

Maximum calling frequency

200 queries/sec.

Sample request packets

Basic Form
{
    "Next": "" // Initially an empty string, for subsequent requests use the Next value from the previous response, until an empty string indicates all data has been retrieved
}

Request packet fields

Field
Type
Attribute
Description
Next
String
Mandatory
Pagination parameters

Sample response packets

Basic Form
{
  "ErrorCode": 0, 
  "ErrorInfo": "",
  "ActionStatus": "OK",
  "RequestId": "requestId-123-456",
  "Response" : {
    "Next": "",  //An empty return indicates that all members have been retrieved
    "MemberCount": 2, //Total number of people in the room
    "MemberList":[
      {
        "Member_Account" : "brennan1"
      },
      {
        "Member_Account" : "tandy"
      },
   ] 
  }
}

Response Packet Field Description

Field
Type
Description
ActionStatus
String
The result of the request process: OK indicates success; FAIL indicates failure
ErrorCode
Integer
Error code. 0: success; other values: failure
ErrorInfo
String
Error message
RequestId
String
Unique Request ID is returned with each request and required to provide this RequestId when locating issues
MemberList
Array
Room Member List
Next
String
The Next value in the next request parameters
MemberCount
Integer
Total number of people in the room

Error codes

Unless a network error occurs (such as a 502 error), the HTTP return code for this interface is always 200. The actual error code and error message are in the response body ErrorCode and ErrorInfo representation.
Common Error Codes (60000 to 79999) refer to Error Code documentation.
The private error codes for this API are as follows:
Error code
Description
100001
System error, retry
100004
The room does not exist, possibly because it was never created or has already been dissolved
100006
Indicates that this room is not a live room and does not have permission to use live query interfaces