DYdyte-io
Recordings

Pause/Resume/Stop recording

Changed on

Pause/Resume/Stop a given recording ID.

put/recordings/{recording_id}

Request

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

Path parameters

recording_idstring required

ID of the recording

Request body

action'stop' | 'pause' | 'resume' required

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

      added the new path request parameter recording_id

    • breaking

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

    • info

      the endpoint scheme security Authorization was added to the API

  • v268b9e665bfccRevision changes
    • breaking

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

    • warning

      deleted the path request parameter recording_id

    • info

      the endpoint scheme security Authorization was removed from the API