DYdyte-io
Recordings

Start recording a meeting

Changed on

Starts recording a meeting. The meeting can be started by an organization admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

post/recordings

Request

  • Base URL
    https://api.dyte.io/v2
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

meeting_idstring uuid required

ID of the meeting to record.

max_secondsinteger

Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.

file_name_prefixstring

Update the recording file name.

urlstring uri

Pass a custom url to record arbitary screen

allow_multiple_recordingsboolean

By default, a meeting allows only one recording to run at a time. Enabling the allow_multiple_recordings parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode.

Example request

{
  "storage_config": {
    "region": "us-east-1"
  },
  "video_config": {
    "width": 1280,
    "height": 720
  },
  "rtmp_out_config": {
    "rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
  }
}

Response

Success response

successboolean required

Success status of the operation

Example response

{
  "data": {
    "storage_config": {
      "region": "us-east-1"
    },
    "start_reason": {
      "caller": {
        "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec",
        "name": "Dyte_test"
      }
    },
    "stop_reason": {
      "caller": {
        "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec",
        "name": "Dyte_test"
      }
    }
  }
}

Changes

  • v2cb67ff854c71Revision changes
    • breaking

      the / request property type changed from no type to string

    • breaking

      the //// response's property type changed from no type to string for status

    • info

      added the new optional request property

    • info

      added the new optional request property

  • v268b9e665bfccRevision changes
    • breaking

      the / request property type changed from string to no type

    • breaking

      the //// response's property type changed from string to no type for status

    • warning

      removed the request property

    • warning

      removed the request property