tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Create a Room

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

      Feature Overview

      App administrators can create rooms and schedule meetings through this API.

      API Calling Description

      Sample Request URL

      https://xxxxxx/v4/room_engine_http_srv/create_room?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/create_room
      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
      {
        "RoomInfo":{
            "RoomId": "room-test",
            "RoomName": "room-name-test",
            "RoomType": "Conference",
            "Owner_Account": "user2",
            "MaxMemberCount": 300,
            "ScheduleStartTime" : 1693271355,
            "ScheduleEndTime" : 1693272355,
            "IsVideoDisabled": true,
            "IsAudioDisabled": true,
            "IsMessageDisabled": true,
            "IsScreenSharingDisabled": true,
            "IsCloudRecordingDisabled": true,
            "CustomInfo": "custom123",
            "IsSeatEnabled": true,
            "MaxSeatCount": 16,
            "TakeSeatMode": "ApplyToTake"
        },
        "ScheduleInviteeList_Account":[
            "user1", "user2", "user3"
        ]
      }

      Request Packet Field Description

      Field
      Type
      Attribute
      Description
      RoomId
      String
      Mandatory
      Room ID, up to 48 bytes
      RoomName
      String
      Optional
      Room Name, defaults to Room ID, up to 100 bytes
      RoomType
      String
      Mandatory
      Room Type: Conference (Meeting Room)
      Owner_Account
      String
      Optional
      Host ID (must be an imported account), defaults to the User ID of the API caller
      MaxMemberCount
      Integer
      Optional
      Maximum number of room members, default value when not specified: Upper limit of paid package, for example, the trial version is 20, if upgrading the package, this field must be updated according to modify room information.
      ScheduleStartTime
      Integer
      Optional
      Scheduled meeting start time, the default is current time.
      ScheduleEndTime
      Integer
      Optional
      Scheduled meeting end time, default is 1 hour after the start time, the minimum meeting time cannot be less than 5 minutes, and the maximum time cannot exceed 24h.
      IsVideoDisabled
      Bool
      Optional
      Mute all video, default false
      IsAudioDisabled
      Bool
      Optional
      Mute all audio, default false
      IsMessageDisabled
      Bool
      Optional
      Disable all members from sending text messages, default false
      IsScreenSharingDisabled
      Bool
      Optional
      Disable screen sharing, default false
      IsCloudRecordingDisabled
      Bool
      Optional
      Disable cloud recording, default false
      CustomInfo
      String
      Optional
      Custom Information, maximum 500 bytes
      IsSeatEnabled
      Bool
      Optional
      Whether to support seat position. Not supported by default.
      MaxSeatCount
      Integer
      Optional
      Maximum number of seats, default is the package limit (max 20 by default).
      TakeSeatMode
      String
      Optional
      Seat mode: FreeToTake (open mic), ApplyToTake (mic on request)
      ScheduleInviteeList_Account
      Array
      Optional
      Scheduled member list, up to 300 members
      Note:
      After the meeting ends, users need to manually call the Destroy Room interface to end the meeting.
      If the Destroy Room interface is not called manually, the backend will try to recycle the room 6 hours after the meeting ends. The condition for recycling is that no members left in the room.

      Sample Response Packets

      Basic Form
      {
        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode": 0,
        "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
      }

      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.

      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.
      100003
      The room ID already exists, please choose another room ID.
      100007
      No payment information, you need to purchase a package in the console.
      100010
      The room ID has been used, and the operator is the home owner, you can use it directly.
      100011
      The room ID has been used by Chat, you can change to another room ID or destroy the group through the Chat interface.
      100012
      The frequency limit for creating a room has been exceeded. The same room ID can only be created once per second.

      Possible Callbacks

      After a Room Is Created
      
      
      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