Returns a list of Recording Rules for the Room

GET /v1/Rooms/{RoomSid}/RecordingRules

TODO: Resource-level docs

Returns a list of Recording Rules for the Room.

Path parameters

  • RoomSid string Required

    The SID of the Room resource where the recording rules to fetch apply.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • room_sid string | null

      The SID of the Room resource for the Recording Rules

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RM[0-9a-fA-F]{32}$.

    • rules array[object(recording-rule)] | null

      A collection of recording Rules that describe how to include or exclude matching tracks for recording

      Hide rules attributes Show rules attributes array[object(recording-rule)] | null
GET /v1/Rooms/{RoomSid}/RecordingRules 
curl \
 -X GET https://video.twilio.com/v1/Rooms/{RoomSid}/RecordingRules \
 --user "username:password"
Response examples (200) 
{
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "room_sid": "string",
  "rules": [
    {
      "all": true,
      "kind": "string",
      "publisher": "string",
      "track": "string",
      "type": "string"
    }
  ]
}
Response examples (200) 
{
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "room_sid": "string",
  "rules": [
    {
      "all": true,
      "kind": "string",
      "publisher": "string",
      "track": "string",
      "type": "string"
    }
  ]
}