tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Get the Room Information

    Last updated: 2024-08-21 18:04:59
    Download PDF

      Feature Overview

      App Administrator can retrieve room information through this interface.

      API Calling Description

      Sample request URL

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

      Request parameters

      The table below only lists the parameters modified when this interface is called. For more details on other parameters, please refer to RESTful API Overview.
      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_info
      Request API
      sdkappid
      SDKAppID assigned by the Chat console when an app is created
      identifier
      Must be an App Administrator account. For more details, please refer to App Admin
      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

      Maximum calling frequency

      200 queries/sec.

      Sample request packets

      Basic Form
      {
           "RoomId":"live-room",
      }

      Request packet fields

      Field
      Type
      Attribute
      Description
      RoomId
      String
      Mandatory
      Room ID

      Sample response packets

      Basic Form
      {
        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode": 0,
        "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720",
        "Response":  {// Response body
          "RoomInfo" : {
            "RoomId" : "rid-123",
            "RoomName" : "rname-123", 
            "RoomType" : "Live", 
            "Owner_Account" : 144115233775727695,
            "CreateTime": 1693271354,
            "IsSeatEnabled" : true, 
             "TakeSeatMode":1, 
             "MaxSeatCount" : 8,  
             "MaxMemberCount" : 300, 
             "IsMessageDisabled" : false,   
             "CoverURL": "https://xxxx.png", 
             "Category": [1,2,3], 
             "ActivityStatus":1, 
             "ViewCount":10, 
             "IsPublicVisible": true 
          }
        }
      }

      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
      RoomInfo
      Object
      Room Details
      RoomId
      String
      Room ID
      RoomName
      String
      Room Name
      RoomType
      String
      Room Type: Live (Live Room)
      Owner_Account
      String
      Room Owner ID
      IsSeatEnabled
      Bool
      Microphone Position Toggle
      TakeSeatMode
      Integer
      Seat Mode:
      1: Free to Join the Podium
      2: Apply to join the microphone
      MaxSeatCount
      Integer
      Number of Microphone Positions, limited by package bundles
      MaxMemberCount
      Integer
      Maximum Room Capacity
      IsMessageDisabled
      String
      Group-wide Mute Toggle
      CoverURL
      String
      Room cover
      Category
      Array
      Live Room Category Tags, maximum array size is 3
      ActivityStatus
      Integer
      Live room active status: user-defined Definition tag
      IsPublicVisible
      Bool
      Whether the room is publicly visible, used for retrieving the Live Room List
      CreateTime
      Integer
      Room Creation Time
      ViewCount
      Integer
      Total number of times the user has entered the room

      Error codes

      Unless a network error occurs (e.g., 502 Error), the HTTP return code for this interface will always be 200. The actual error code and error information are indicated in the response payload by ErrorCode and ErrorInfo. Common Error Codes (60000 to 79999) can be found in the Error Code document. The private error codes for this API are as follows:
      Error code
      Description
      100001
      Internal server error, please retry
      100002
      Invalid parameter, please check the request for correctness based on the error description
      100004
      The room does not exist, possibly because it was never created or has already been dissolved
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy