https://xxxxxx/v4/live_engine_http_srv/get_room_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | The reserved domain for the country/region where the SDKAppID is located: Others in China: console.tim.qq.com Singapore : adminapisgp.im.qcloud.com |
v4/live_engine_http_srv/get_room_list | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format fixed value: json |
{"Next":"","Count":20}
Field | Type | Attribute | Description |
Next | String | Mandatory | Pagination parameters for pagination request. The first time it is an empty string. Subsequently, use the Next field in the response body. When the Next field in the response body is an empty string, it indicates that the pull is completed |
Count | Integer | Mandatory | Number of rooms for a single pull. The default is 20, and the upper limit is 20 |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720","Response" : {"Next":"1693271355-123123123123","RoomList":[{"RoomName":"name","RoomId":"room_id0","Owner_Account":"bren","CoverURL":"cover_url","Category":[1,2,3],"CreateTime":1693271354,"ActivityStatus":1,"ViewCount":1000},...{"RoomName":"name","RoomId":"room_id19","Owner_Account":"bren","CoverURL":"cover_url","Category":[1,2,3],"CreateTime":1693271354,"ActivityStatus":1,"ViewCount":900}]}}
Field | Type | Description |
ActionStatus | String | Results of request processing. OK indicates success, FAIL indicates failure |
ErrorCode | Integer | Error code. 0 indicates success, non-zero indicates failure |
ErrorInfo | String | Error message |
RequestId | String | Unique Request ID, each request will return a Request ID, which is required when locating issues |
RoomList | Array | Room ID List, sorted by view count in descending order by default |
RoomName | String | Room Name |
RoomId | String | Room ID |
Owner_Account | String | Room Owner ID |
CoverURL | String | Room cover |
Category | Array | Live Room Category Tags, maximum array size is 3 |
CreateTime | Integer | Room Creation Time |
ActivityStatus | Integer | Live room active status: user-defined Definition tag |
ViewCount | Integer | Total number of times the user has entered the room |
Next | String | When the room list is fully loaded, it will return an empty string; otherwise, it returns the Next for the next request |
Error code | Description |
100001 | Internal server error, please retry |
100002 | Invalid parameter, please check the request for correctness based on the error description |
Was this page helpful?