tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Get the Room Information

    Last updated: 2024-06-12 11:46:26
    Download PDF

      Feature Overview

      App administrator can get room information through this API.

      API Calling Description

      Sample Request URL

      https://xxxxxx/v4/room_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 calling this API. For more details, please refer to RESTful API Overview.
      Parameter
      Description
      xxxxxx
      The reserved domain name for the country/region where the SDKAppID is located:
      Singapore :adminapisgp.im.qcloud.com
      v4/room_engine_http_srv/get_room_info
      Request API
      sdkappid
      The 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 Administrator.
      usersig
      The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
      random
      Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
      contenttype
      The request format fixed value is json

      Maximum Calling Frequency

      200 times per second.

      Sample Request Packets

      Basic Form
      {
        "RoomId": "room-test"
      }

      Request Packet Field Description

      Field
      Type
      Attribute
      Description
      RoomId
      String
      Mandatory
      Room ID

      Sample Response Packets

      Basic Form
      {
        "ErrorCode": 0,
        "ErrorInfo": "",
        "ActionStatus": "OK",
        "RequestId": "Id-81fb8ae1529f409a9ed83ef3c3071657-O-Seq-56057",
        "Response": {
            "RoomInfo": {
                "RoomId": "room-test",
                "RoomName": "room-name-test",
                "RoomType": "Conference",
                "Owner_Account": "user2",
                "MaxMemberCount": 300,
                "MaxSeatCount": 16,
                "IsVideoDisabled": true,
                "IsAudioDisabled": true,
                "IsMessageDisabled": true,
                "IsScreenSharingDisabled": true,
                "IsCloudRecordingDisabled": true,
                "CustomInfo": "custom123",
                "ScheduleStartTime": 1703491546,
                "ScheduleEndTime": 1703495146,
                "RoomStatus": "Running",
                "IsSeatEnabled": true,
                "TakeSeatMode": "ApplyToTake",
                "CreateTime": 1703491546,
                "MemberCount": 1
            }
        }
      }

      Response Packet Field Description

      Field
      Type
      Description
      ActionStatus
      String
      The result of the request process. OK for success, FAIL for failure.
      ErrorCode
      Integer
      Error code. 0 for success, others for failure.
      ErrorInfo
      String
      Error message
      RequestId
      String
      The unique request ID is returned for each request and required to provide this RequestId when locating issues.
      RoomId
      String
      Room ID
      RoomName
      String
      Room Name
      RoomType
      String
      Room Type: Conference (Meeting Room)
      Owner_Account
      String
      Host ID
      MaxMemberCount
      Integer
      Maximum number of room members
      ScheduleStartTime
      Integer
      Scheduled meeting start time
      ScheduleEndTime
      Integer
      Scheduled meeting end time
      IsVideoDisabled
      Bool
      Mute all video
      IsAudioDisabled
      Bool
      Mute all audio
      IsMessageDisabled
      Bool
      Disable all members from sending text messages
      IsScreenSharingDisabled
      Bool
      Disable screen sharing
      IsCloudRecordingDisabled
      Bool
      Disable cloud recording
      CustomInfo
      String
      Custom Information
      RoomStatus
      String
      Room Status: None, NotStarted, Running
      IsSeatEnabled
      Bool
      Is microphone support available?
      MaxSeatCount
      Integer
      Maximum Number of Microphones
      TakeSeatMode
      String
      Seat Mode: None, FreeToTake (open mic), ApplyToTake (mic on request)
      CreateTime
      Integer
      Scheduled meeting start time
      MemberCount
      Integer
      Number of room members

      Error Codes

      Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see Error Code documentation. 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
      Room does not exist, or it once existed but now has been destroyed.
      100005
      Non-room members
      100006
      Insufficient operational permissions
      
      
      
      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