{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "video.v1.composition": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Composition resource." }, "status": { "$ref": "#/components/schemas/composition_enum_status" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_completed": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the composition's media processing task finished, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_deleted": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the composition generated media was deleted, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CJ[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Composition resource." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Group Room that generated the audio and video tracks used in the composition. All media sources included in a composition must belong to the same Group Room." }, "audio_sources": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The array of track names to include in the composition. The composition includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "audio_sources_excluded": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The array of track names to exclude from the composition. The composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "video_layout": { "nullable": true, "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "resolution": { "type": "string", "nullable": true, "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is `{width}x{height}`, such as `640x480`." }, "trim": { "type": "boolean", "nullable": true, "description": "Whether to remove intervals with no media, as specified in the POST request that created the composition. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "format": { "$ref": "#/components/schemas/composition_enum_format" }, "bitrate": { "type": "integer", "default": 0, "description": "The average bit rate of the composition's media." }, "size": { "type": "integer", "format": "int64", "nullable": true, "description": "The size of the composed media file in bytes." }, "duration": { "type": "integer", "default": 0, "description": "The duration of the composition's media file in seconds." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the media file associated with the composition when stored externally. See [External S3 Compositions](/docs/video/api/external-s3-compositions) for more details." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, "description": "The URL called using the `status_callback_method` to send status information on every composition event." }, "status_callback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true, "description": "The HTTP method used to call `status_callback`. Can be: `POST` or `GET`, defaults to `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URL of the media file associated with the composition." } } }, "composition_enum_status": { "type": "string", "enum": [ "enqueued", "processing", "completed", "deleted", "failed" ], "description": "The status of the composition. Can be: `enqueued`, `processing`, `completed`, `deleted` or `failed`. `enqueued` is the initial state and indicates that the composition request has been received and is scheduled for processing; `processing` indicates the composition is being processed; `completed` indicates the composition has been completed and is available for download; `deleted` means the composition media has been deleted from the system, but its metadata is still available for 30 days; `failed` indicates the composition failed to execute the media processing task." }, "composition_enum_format": { "type": "string", "enum": [ "mp4", "webm" ], "description": "The container format of the composition's media files as specified in the POST request that created the Composition resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information." }, "video.v1.composition_hook": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionHook resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource. Can be up to 100 characters long and must be unique within the account." }, "enabled": { "type": "boolean", "nullable": true, "description": "Whether the CompositionHook is active. When `true`, the CompositionHook is triggered for every completed Group Room on the account. When `false`, the CompositionHook is never triggered." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HK[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the CompositionHook resource." }, "audio_sources": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The array of track names to include in the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "audio_sources_excluded": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The array of track names to exclude from the compositions created by the composition hook. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this property can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "video_layout": { "nullable": true, "description": "A JSON object that describes the video layout of the composition in terms of regions as specified in the HTTP POST request that created the CompositionHook resource. See [POST Parameters](https://www.twilio.com/docs/video/api/compositions-resource#http-post-parameters) for more information. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "resolution": { "type": "string", "nullable": true, "description": "The dimensions of the video image in pixels expressed as columns (width) and rows (height). The string's format is `{width}x{height}`, such as `640x480`." }, "trim": { "type": "boolean", "nullable": true, "description": "Whether intervals with no media are clipped, as specified in the POST request that created the CompositionHook resource. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "format": { "$ref": "#/components/schemas/composition_hook_enum_format" }, "status_callback": { "type": "string", "format": "uri", "nullable": true, "description": "The URL we call using the `status_callback_method` to send status information to your application." }, "status_callback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true, "description": "The HTTP method we should use to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "composition_hook_enum_format": { "type": "string", "enum": [ "mp4", "webm" ], "description": "The container format of the media files used by the compositions created by the composition hook. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs." }, "video.v1.composition_settings": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionSettings resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource and that will be shown in the console" }, "aws_credentials_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the stored Credential resource." }, "aws_s3_url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", "nullable": true, "description": "Whether all compositions are written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud." }, "encryption_key_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Public Key resource used for encryption." }, "encryption_enabled": { "type": "boolean", "nullable": true, "description": "Whether all compositions are stored in an encrypted form. The default is `false`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "video.v1.recording": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource." }, "status": { "$ref": "#/components/schemas/recording_enum_status" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the Recording resource." }, "source_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the recording source. For a Room Recording, this value is a `track_sid`." }, "size": { "type": "integer", "format": "int64", "nullable": true, "description": "The size of the recorded track, in bytes." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "type": { "$ref": "#/components/schemas/recording_enum_type" }, "duration": { "type": "integer", "nullable": true, "description": "The duration of the recording in seconds rounded to the nearest second. Sub-second tracks have a `Duration` property of 1 second" }, "container_format": { "$ref": "#/components/schemas/recording_enum_format" }, "codec": { "$ref": "#/components/schemas/recording_enum_codec" }, "grouping_sids": { "nullable": true, "description": "A list of SIDs related to the recording. Includes the `room_sid` and `participant_sid`." }, "track_name": { "type": "string", "nullable": true, "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } }, "offset": { "type": "integer", "format": "int64", "nullable": true, "description": "The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, "description": "The URL called using the `status_callback_method` to send status information on every recording event." }, "status_callback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true, "description": "The HTTP method used to call `status_callback`. Can be: `POST` or `GET`, defaults to `POST`." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "recording_enum_status": { "type": "string", "enum": [ "processing", "completed", "deleted", "failed" ], "description": "The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the recording is still being captured; `completed` indicates the recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available." }, "recording_enum_type": { "type": "string", "enum": [ "audio", "video", "data" ], "description": "The recording's media type. Can be: `audio` or `video`." }, "recording_enum_format": { "type": "string", "enum": [ "mka", "mkv" ] }, "recording_enum_codec": { "type": "string", "enum": [ "VP8", "H264", "OPUS", "PCMU" ], "description": "The codec used to encode the track. Can be: `VP8`, `H264`, `OPUS`, and `PCMU`." }, "video.v1.recording_settings": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RecordingSettings resource." }, "friendly_name": { "type": "string", "nullable": true, "description": "The string that you assigned to describe the resource and show the user in the console" }, "aws_credentials_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the stored Credential resource." }, "aws_s3_url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the AWS S3 bucket where the recordings are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "aws_storage_enabled": { "type": "boolean", "nullable": true, "description": "Whether all recordings are written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud." }, "encryption_key_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Public Key resource used for encryption." }, "encryption_enabled": { "type": "boolean", "nullable": true, "description": "Whether all recordings are stored in an encrypted form. The default is `false`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "video.v1.room": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that Twilio created to identify the Room resource." }, "status": { "$ref": "#/components/schemas/room_enum_room_status" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Room resource." }, "enable_turn": { "type": "boolean", "nullable": true, "description": "Deprecated, now always considered to be true." }, "unique_name": { "type": "string", "nullable": true, "description": "An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`." }, "status_callback": { "type": "string", "format": "uri", "nullable": true, "description": "The URL Twilio calls using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info." }, "status_callback_method": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "nullable": true, "description": "The HTTP method Twilio uses to call `status_callback`. Can be `POST` or `GET` and defaults to `POST`." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The UTC end time of the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, "description": "The duration of the room in seconds." }, "type": { "$ref": "#/components/schemas/room_enum_room_type" }, "max_participants": { "type": "integer", "default": 0, "description": "The maximum number of concurrent Participants allowed in the room. " }, "max_participant_duration": { "type": "integer", "default": 0, "description": "The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours)." }, "max_concurrent_published_tracks": { "type": "integer", "nullable": true, "description": "The maximum number of published audio, video, and data tracks all participants combined are allowed to publish in the room at the same time. Check [Programmable Video Limits](https://www.twilio.com/docs/video/programmable-video-limits) for more details. If it is set to 0 it means unconstrained." }, "record_participants_on_connect": { "type": "boolean", "nullable": true, "description": "Whether to start recording when Participants connect." }, "video_codecs": { "type": "array", "items": { "$ref": "#/components/schemas/room_enum_video_codec" }, "nullable": true, "description": "An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`." }, "media_region": { "type": "string", "nullable": true, "description": "The region for the Room's media server. Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#media-servers)." }, "audio_only": { "type": "boolean", "nullable": true, "description": "When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed." }, "empty_room_timeout": { "type": "integer", "default": 0, "description": "Specifies how long (in minutes) a room will remain active after last participant leaves. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, "unused_room_timeout": { "type": "integer", "default": 0, "description": "Specifies how long (in minutes) a room will remain active if no one joins. Can be configured when creating a room via REST API. For Ad-Hoc rooms this value cannot be changed." }, "large_room": { "type": "boolean", "nullable": true, "description": "Indicates if this is a large room." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "room_enum_room_status": { "type": "string", "enum": [ "in-progress", "completed", "failed" ] }, "room_enum_room_type": { "type": "string", "enum": [ "go", "peer-to-peer", "group", "group-small" ] }, "room_enum_video_codec": { "type": "string", "enum": [ "VP8", "H264" ] }, "video.v1.room.room_participant": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the RoomParticipant resource." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the participant's room." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomParticipant resource." }, "status": { "$ref": "#/components/schemas/room_participant_enum_status" }, "identity": { "type": "string", "nullable": true, "description": "The application-defined string that uniquely identifies the resource's User within a Room. If a client joins with an existing Identity, the existing client is disconnected. See [access tokens](https://www.twilio.com/docs/video/tutorials/user-identity-access-tokens) and [limits](https://www.twilio.com/docs/video/programmable-video-limits) for more info. " }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time when the participant disconnected from the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, "description": "The duration in seconds that the participant was `connected`. Populated only after the participant is `disconnected`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "room_participant_enum_status": { "type": "string", "enum": [ "connected", "disconnected", "reconnecting" ], "description": "The status of the Participant. Can be: `connected` or `disconnected`." }, "video.v1.room.room_participant.room_participant_anonymize": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the RoomParticipant resource." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the participant's room." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomParticipant resource." }, "status": { "$ref": "#/components/schemas/room_participant_anonymize_enum_status" }, "identity": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the participant." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time of participant connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time when the participant disconnected from the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, "description": "The duration in seconds that the participant was `connected`. Populated only after the participant is `disconnected`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "room_participant_anonymize_enum_status": { "type": "string", "enum": [ "connected", "disconnected" ], "description": "The status of the Participant. Can be: `connected` or `disconnected`." }, "video.v1.room.room_participant.room_participant_published_track": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MT[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the RoomParticipantPublishedTrack resource." }, "participant_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Participant resource with the published track." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Room resource where the track is published." }, "name": { "type": "string", "nullable": true, "description": "The track name. Must be no more than 128 characters, and be unique among the participant's published tracks." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "enabled": { "type": "boolean", "nullable": true, "description": "Whether the track is enabled." }, "kind": { "$ref": "#/components/schemas/room_participant_published_track_enum_kind" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "room_participant_published_track_enum_kind": { "type": "string", "enum": [ "audio", "video", "data" ], "description": "The track type. Can be: `audio`, `video` or `data`." }, "video.v1.room.room_participant.room_participant_subscribe_rule": { "type": "object", "properties": { "participant_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Participant resource for the Subscribe Rules." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Room resource for the Subscribe Rules" }, "rules": { "type": "array", "items": { "type": "object", "format": "subscribe-rule", "properties": { "type": { "type": "string" }, "all": { "type": "boolean" }, "publisher": { "type": "string" }, "track": { "type": "string" }, "kind": { "type": "string" }, "priority": { "type": "string" } } }, "nullable": true, "description": "A collection of Subscribe Rules that describe how to include or exclude matching tracks. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, "video.v1.room.room_participant.room_participant_subscribed_track": { "type": "object", "properties": { "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MT[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the RoomParticipantSubscribedTrack resource." }, "participant_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the participant that subscribes to the track." }, "publisher_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the participant that publishes the track." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the room where the track is published." }, "name": { "type": "string", "nullable": true, "description": "The track name. Must have no more than 128 characters and be unique among the participant's published tracks." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "enabled": { "type": "boolean", "nullable": true, "description": "Whether the track is enabled." }, "kind": { "$ref": "#/components/schemas/room_participant_subscribed_track_enum_kind" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." } } }, "room_participant_subscribed_track_enum_kind": { "type": "string", "enum": [ "audio", "video", "data" ], "description": "The track type. Can be: `audio`, `video` or `data`." }, "video.v1.room.room_recording": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the RoomRecording resource." }, "status": { "$ref": "#/components/schemas/room_recording_enum_status" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique string that we created to identify the RoomRecording resource." }, "source_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the recording source. For a Room Recording, this value is a `track_sid`." }, "size": { "type": "integer", "format": "int64", "nullable": true, "description": "The size of the recorded track in bytes." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "type": { "$ref": "#/components/schemas/room_recording_enum_type" }, "duration": { "type": "integer", "nullable": true, "description": "The duration of the recording rounded to the nearest second. Sub-second duration tracks have a `duration` of 1 second" }, "container_format": { "$ref": "#/components/schemas/room_recording_enum_format" }, "codec": { "$ref": "#/components/schemas/room_recording_enum_codec" }, "grouping_sids": { "nullable": true, "description": "A list of SIDs related to the Recording. Includes the `room_sid` and `participant_sid`." }, "track_name": { "type": "string", "nullable": true, "description": "The name that was given to the source track of the recording. If no name is given, the `source_sid` is used." }, "offset": { "type": "integer", "format": "int64", "nullable": true, "description": "The time in milliseconds elapsed between an arbitrary point in time, common to all group rooms, and the moment when the source room of this track started. This information provides a synchronization mechanism for recordings belonging to the same room." }, "media_external_location": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the media file associated with the recording when stored externally. See [External S3 Recordings](/docs/video/api/external-s3-recordings) for more details." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Room resource the recording is associated with." }, "links": { "type": "object", "format": "uri-map", "nullable": true, "description": "The URLs of related resources." } } }, "room_recording_enum_status": { "type": "string", "enum": [ "processing", "completed", "deleted", "failed" ], "description": "The status of the recording. Can be: `processing`, `completed`, or `deleted`. `processing` indicates the Recording is still being captured. `completed` indicates the Recording has been captured and is now available for download. `deleted` means the recording media has been deleted from the system, but its metadata is still available for historical purposes." }, "room_recording_enum_type": { "type": "string", "enum": [ "audio", "video", "data" ], "description": "The recording's media type. Can be: `audio` or `video`." }, "room_recording_enum_format": { "type": "string", "enum": [ "mka", "mkv" ] }, "room_recording_enum_codec": { "type": "string", "enum": [ "VP8", "H264", "OPUS", "PCMU" ], "description": "The codec used for the recording. Can be: `VP8` or `H264`." }, "video.v1.room.room_recording_rule": { "type": "object", "properties": { "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Room resource for the Recording Rules" }, "rules": { "type": "array", "items": { "type": "object", "format": "recording-rule", "x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)", "properties": { "type": { "type": "string" }, "all": { "type": "boolean" }, "publisher": { "type": "string" }, "track": { "type": "string" }, "kind": { "type": "string" } } }, "nullable": true, "description": "A collection of Recording Rules that describe how to include or exclude matching tracks for recording" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." } } }, "video.v1.room.room_transcriptions": { "type": "object", "properties": { "ttid": { "type": "string", "nullable": true, "description": "The unique string that we created to identify the transcriptions resource." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Room resource." }, "room_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the transcriptions's room." }, "source_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CA[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the transcriptions's associated call." }, "status": { "$ref": "#/components/schemas/room_transcriptions_enum_status" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time of transcriptions connected to the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "end_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The time when the transcriptions disconnected from the room in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, "duration": { "type": "integer", "nullable": true, "description": "The duration in seconds that the transcriptions were `connected`. Populated only after the transcriptions is `stopped`." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The absolute URL of the resource." }, "configuration": { "type": "object", "nullable": true, "description": "An JSON object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", "x-twilio": { "pii": { "handling": "standard", "deleteSla": 30 } } } } }, "room_transcriptions_enum_status": { "type": "string", "enum": [ "started", "stopped", "failed" ], "description": "The status of the transcriptions resource." } } }, "info": { "title": "Twilio - Video", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v1/Compositions/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording compositions", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "resolution", "format" ], "dependentProperties": { "media": { "mapping": { "composition_sid": "sid" }, "resource_url": "/v1/Compositions/{composition_sid}/Media" } }, "pathType": "instance" }, "get": { "description": "Returns a single Composition resource identified by a Composition SID.", "summary": "Returns a single Composition resource identified by a Composition SID.", "tags": [ "VideoV1Composition" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Composition resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CJ[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "completed", "date_created": "2015-07-30T20:00:00Z", "date_completed": "2015-07-30T20:01:33Z", "date_deleted": null, "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user*" ], "audio_sources_excluded": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "video_layout": { "grid": { "video_sources": [ "*" ], "video_sources_excluded": [ "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] }, "pip": { "video_sources": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "video_sources_excluded": [], "reuse": "none", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] } }, "resolution": "1280x720", "format": "webm", "bitrate": 64, "size": 4, "duration": 6, "trim": true, "media_external_location": null, "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status_callback": "https://mycallbackurl.com", "status_callback_method": "POST", "links": { "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchComposition" }, "delete": { "description": "Delete a Recording Composition resource identified by a Composition SID.", "summary": "Delete a Recording Composition resource identified by a Composition SID.", "tags": [ "VideoV1Composition" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Composition resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CJ[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteComposition" } }, "/v1/Compositions": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording compositions", "x-twilio": { "defaultOutputProperties": [ "sid", "status", "resolution", "format" ], "dependentProperties": { "media": { "mapping": { "composition_sid": "sid" }, "resource_url": "/v1/Compositions/{composition_sid}/Media" } }, "pathType": "list" }, "get": { "description": "List of all Recording compositions.", "summary": "List of all Recording compositions.", "tags": [ "VideoV1Composition" ], "parameters": [ { "name": "Status", "in": "query", "description": "Read only Composition resources with this status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.", "schema": { "$ref": "#/components/schemas/composition_enum_status" }, "examples": { "readEnqueued": { "value": "enqueued" }, "readEmpty": { "value": "completed" }, "readResults": { "value": "completed" } } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-01-01T00:00:01Z" } } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only Composition resources created before this ISO 8601 date-time with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-12-31T23:59:59Z" } } }, { "name": "RoomSid", "in": "query", "description": "Read only Composition resources with this Room SID.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" }, "examples": { "readResults": { "value": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "compositions": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.composition" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListCompositionResponse" }, "examples": { "readEnqueued": { "value": { "compositions": [], "meta": { "page": 0, "page_size": 10, "first_page_url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Compositions?Status=enqueued&PageSize=10&Page=0", "next_page_url": null, "key": "compositions" } } }, "readEmpty": { "value": { "compositions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Compositions?Status=completed&PageSize=50&Page=0", "next_page_url": null, "key": "compositions" } } }, "readResults": { "value": { "compositions": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "completed", "date_created": "2015-07-30T20:00:00Z", "date_completed": "2015-07-30T20:01:33Z", "date_deleted": null, "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user*" ], "audio_sources_excluded": [], "video_layout": { "grid": { "video_sources": [ "user*" ], "video_sources_excluded": [], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] }, "pip": { "video_sources": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "video_sources_excluded": [], "reuse": "none", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] } }, "resolution": "1280x720", "format": "webm", "bitrate": 64, "size": 4, "duration": 6, "trim": true, "media_external_location": null, "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status_callback": "https://mycallbackurl.com", "status_callback_method": "POST", "links": { "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Compositions?Status=completed&RoomSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&PageSize=50&Page=0", "next_page_url": null, "key": "compositions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListComposition" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Composition" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "processing", "date_created": "2015-07-30T20:00:00Z", "date_completed": null, "date_deleted": null, "sid": "CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user*" ], "audio_sources_excluded": [ "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "video_layout": { "custom": { "video_sources": [ "user*" ], "video_sources_excluded": [ "RTcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 800, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [ 2, 3 ] } }, "trim": true, "format": "mp4", "resolution": "1920x1080", "bitrate": 0, "size": 0, "duration": 0, "media_external_location": null, "url": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status_callback": "https://mycallbackurl.com", "status_callback_method": "POST", "links": { "media": "https://video.twilio.com/v1/Compositions/CJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateComposition", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateCompositionRequest", "properties": { "RoomSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$", "description": "The SID of the Group Room with the media tracks to be used as composition sources." }, "VideoLayout": { "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" }, "AudioSources": { "type": "array", "items": { "type": "string" }, "description": "An array of track names from the same group room to merge into the new composition. Can include zero or more track names. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` includes `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request" }, "AudioSourcesExcluded": { "type": "array", "items": { "type": "string" }, "description": "An array of track names to exclude. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." }, "Resolution": { "type": "string", "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "Format": { "$ref": "#/components/schemas/composition_enum_format" }, "StatusCallback": { "type": "string", "format": "uri", "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched." }, "StatusCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`." }, "Trim": { "type": "boolean", "description": "Whether to clip the intervals where there is no active media in the composition. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." } }, "required": [ "RoomSid" ] }, "examples": { "create": { "value": { "RoomSid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "AudioSources": [ "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "user*" ], "AudioSourcesExcluded": [ "RTbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "VideoLayout": "{}", "Trim": true, "Format": "mp4", "Resolution": "1920x1080" } } } } } } } }, "/v1/CompositionHooks/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording composition hooks", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "instance" }, "get": { "description": "Returns a single CompositionHook resource identified by a CompositionHook SID.", "summary": "Returns a single CompositionHook resource identified by a CompositionHook SID.", "tags": [ "VideoV1CompositionHook" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the CompositionHook resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HK[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My composition hook", "enabled": true, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:01:33Z", "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "user*" ], "audio_sources_excluded": [ "moderator*" ], "video_layout": { "grid": { "video_sources": [ "*" ], "video_sources_excluded": [ "moderator*" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] }, "pip": { "video_sources": [ "student*" ], "video_sources_excluded": [], "reuse": "none", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] } }, "resolution": "1280x720", "format": "webm", "trim": true, "status_callback": "http://www.example.com", "status_callback_method": "POST", "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchCompositionHook" }, "delete": { "description": "Delete a Recording CompositionHook resource identified by a `CompositionHook SID`.", "summary": "Delete a Recording CompositionHook resource identified by a `CompositionHook SID`.", "tags": [ "VideoV1CompositionHook" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the CompositionHook resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HK[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteCompositionHook" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1CompositionHook" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the CompositionHook resource to update.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^HK[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" }, "examples": { "updateAllFields": { "value": { "friendly_name": "My composition hook", "enabled": true, "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "user*", "moderator" ], "audio_sources_excluded": [ "admin" ], "video_layout": { "custom": { "video_sources": [ "user*" ], "video_sources_excluded": [ "moderator" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 800, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [ 2, 3 ] } }, "trim": true, "format": "mp4", "resolution": "1280x720", "status_callback": "http://www.example.com", "status_callback_method": "POST", "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } }, "updateWithDefaults": { "value": { "friendly_name": "My composition hook", "enabled": true, "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "user*", "moderator" ], "audio_sources_excluded": [ "admin" ], "video_layout": {}, "trim": true, "format": "mp4", "resolution": "1280x720", "status_callback": null, "status_callback_method": "POST", "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateCompositionHook", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateCompositionHookRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account." }, "Enabled": { "type": "boolean", "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook never triggers." }, "VideoLayout": { "description": "A JSON object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "AudioSources": { "type": "array", "items": { "type": "string" }, "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`." }, "AudioSourcesExcluded": { "type": "array", "items": { "type": "string" }, "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." }, "Trim": { "type": "boolean", "description": "Whether to clip the intervals where there is no active media in the compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "Format": { "$ref": "#/components/schemas/composition_hook_enum_format" }, "Resolution": { "type": "string", "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "StatusCallback": { "type": "string", "format": "uri", "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched." }, "StatusCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`." } }, "required": [ "FriendlyName" ] }, "examples": { "updateAllFields": { "value": { "FriendlyName": "My composition hook", "Enabled": true, "AudioSources": [ "user*", "moderator" ], "AudioSourcesExcluded": [ "admin" ], "VideoLayout": "{}", "Trim": true, "Format": "mp4", "Resolution": "1280x720", "StatusCallback": "http://www.example.com", "StatusCallbackMethod": "POST" } }, "updateWithDefaults": { "value": { "FriendlyName": "My composition hook", "AudioSources": [ "user*", "moderator" ], "AudioSourcesExcluded": [ "admin" ], "Format": "mp4", "Resolution": "1280x720" } } } } } } } }, "/v1/CompositionHooks": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording composition hooks", "x-twilio": { "defaultOutputProperties": [ "sid", "friendly_name", "date_created" ], "pathType": "list" }, "get": { "description": "List of all Recording CompositionHook resources.", "summary": "List of all Recording CompositionHook resources.", "tags": [ "VideoV1CompositionHook" ], "parameters": [ { "name": "Enabled", "in": "query", "description": "Read only CompositionHook resources with an `enabled` value that matches this parameter.", "schema": { "type": "boolean" }, "examples": { "readEmpty": { "value": true }, "readResults": { "value": true } } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only CompositionHook resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-01-01T00:00:01Z" } } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only CompositionHook resources created before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-12-31T23:59:59Z" } } }, { "name": "FriendlyName", "in": "query", "description": "Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk `*` characters as wildcard match.", "schema": { "type": "string" }, "examples": { "readResults": { "value": "*Hook*" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "composition_hooks": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.composition_hook" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListCompositionHookResponse" }, "examples": { "readEmpty": { "value": { "composition_hooks": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/CompositionHooks?Enabled=true&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/CompositionHooks?Enabled=true&PageSize=50&Page=0", "next_page_url": null, "key": "composition_hooks" } } }, "readResults": { "value": { "composition_hooks": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My Special Hook1", "enabled": true, "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:01:33Z", "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "*" ], "audio_sources_excluded": [], "video_layout": { "grid": { "video_sources": [ "*" ], "video_sources_excluded": [ "moderator*" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] }, "pip": { "video_sources": [ "student*" ], "video_sources_excluded": [], "reuse": "none", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 0, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [] } }, "resolution": "1280x720", "format": "webm", "trim": true, "status_callback": "http://www.example.com", "status_callback_method": "POST", "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=true&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/CompositionHooks?FriendlyName=%2AHook%2A&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&Enabled=true&PageSize=50&Page=0", "next_page_url": null, "key": "composition_hooks" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListCompositionHook" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1CompositionHook" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_hook" }, "examples": { "create": { "value": { "friendly_name": "My composition hook", "enabled": false, "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": null, "sid": "HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "audio_sources": [ "user*", "moderator" ], "audio_sources_excluded": [ "admin" ], "video_layout": { "custom": { "video_sources": [ "user*" ], "video_sources_excluded": [ "moderator" ], "reuse": "show_oldest", "x_pos": 100, "y_pos": 600, "z_pos": 10, "width": 800, "height": 0, "max_columns": 0, "max_rows": 0, "cells_excluded": [ 2, 3 ] } }, "trim": true, "format": "mp4", "resolution": "1280x720", "status_callback": "http://www.example.com", "status_callback_method": "POST", "url": "https://video.twilio.com/v1/CompositionHooks/HKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateCompositionHook", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateCompositionHookRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account." }, "Enabled": { "type": "boolean", "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook will never be triggered." }, "VideoLayout": { "description": "An object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "AudioSources": { "type": "array", "items": { "type": "string" }, "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`." }, "AudioSourcesExcluded": { "type": "array", "items": { "type": "string" }, "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty." }, "Resolution": { "type": "string", "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." }, "Format": { "$ref": "#/components/schemas/composition_hook_enum_format" }, "StatusCallback": { "type": "string", "format": "uri", "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched." }, "StatusCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`." }, "Trim": { "type": "boolean", "description": "Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info." } }, "required": [ "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "My composition hook", "Enabled": false, "AudioSources": [ "user*", "moderator" ], "AudioSourcesExcluded": [ "admin" ], "VideoLayout": "{}", "Trim": true, "Format": "mp4", "Resolution": "1280x720", "StatusCallback": "http://www.example.com", "StatusCallbackMethod": "POST" } } } } } } } }, "/v1/CompositionSettings/Default": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording composition settings", "x-twilio": { "defaultOutputProperties": [ "friendly_name", "aws_storage_enabled", "encryption_enabled" ], "mountName": "composition_settings", "className": "composition_settings", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1CompositionSettings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "string", "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "aws_storage_enabled": true, "encryption_enabled": true, "url": "https://video.twilio.com/v1/CompositionSettings/Default" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchCompositionSettings" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1CompositionSettings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.composition_settings" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "aws_storage_enabled": true, "encryption_enabled": true, "url": "https://video.twilio.com/v1/CompositionSettings/Default" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateCompositionSettings", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateCompositionSettingsRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the resource and show to the user in the console" }, "AwsCredentialsSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The SID of the stored Credential resource." }, "EncryptionKeySid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The SID of the Public Key resource to use for encryption." }, "AwsS3Url": { "type": "string", "format": "uri", "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", "description": "Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud." }, "EncryptionEnabled": { "type": "boolean", "description": "Whether all compositions should be stored in an encrypted form. The default is `false`." } }, "required": [ "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "friendly_name", "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "AwsStorageEnabled": true, "EncryptionEnabled": true } } } } } } } }, "/v1/Recordings/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Single-track, single-media recordings", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "status", "type", "duration", "codec" ], "dependentProperties": { "media": { "mapping": { "recording_sid": "sid" }, "resource_url": "/v1/Recordings/{recording_sid}/Media" } }, "pathType": "instance" }, "get": { "description": "Returns a single Recording resource identified by a Recording SID.", "summary": "Returns a single Recording resource identified by a Recording SID.", "tags": [ "VideoV1Recording" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Recording resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "processing", "date_created": "2015-07-30T20:00:00Z", "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 0, "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "audio", "duration": 0, "container_format": "mka", "codec": "opus", "track_name": "A name", "offset": 10, "status_callback": "https://mycallbackurl.com", "status_callback_method": "POST", "grouping_sids": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "links": { "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRecording" }, "delete": { "description": "Delete a Recording resource identified by a Recording SID.", "summary": "Delete a Recording resource identified by a Recording SID.", "tags": [ "VideoV1Recording" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Recording resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteRecording" } }, "/v1/Recordings": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Single-track, single-media recordings", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "status", "type", "duration", "codec" ], "dependentProperties": { "media": { "mapping": { "recording_sid": "sid" }, "resource_url": "/v1/Recordings/{recording_sid}/Media" } }, "pathType": "list" }, "get": { "description": "List of all Track recordings.", "summary": "List of all Track recordings.", "tags": [ "VideoV1Recording" ], "parameters": [ { "name": "Status", "in": "query", "description": "Read only the recordings that have this status. Can be: `processing`, `completed`, or `deleted`.", "schema": { "$ref": "#/components/schemas/recording_enum_status" }, "examples": { "readEmpty": { "value": "completed" }, "readResults": { "value": "completed" } } }, { "name": "SourceSid", "in": "query", "description": "Read only the recordings that have this `source_sid`.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" }, "examples": { "readEmpty": { "value": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "readResults": { "value": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "GroupingSid", "in": "query", "description": "Read only recordings with this `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.", "schema": { "type": "array", "items": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" } }, "examples": { "readEmpty": { "value": [ "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] }, "readResults": { "value": [ "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] } } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-01-01T00:00:01Z" } } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-12-31T23:59:59Z" } } }, { "name": "MediaType", "in": "query", "description": "Read only recordings that have this media type. Can be either `audio` or `video`.", "schema": { "$ref": "#/components/schemas/recording_enum_type" }, "examples": { "readEmpty": { "value": "audio" }, "readResults": { "value": "audio" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.recording" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRecordingResponse" }, "examples": { "readEmpty": { "value": { "recordings": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Recordings?Status=completed&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "next_page_url": null, "key": "recordings" } } }, "readResults": { "value": { "recordings": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "completed", "date_created": "2015-07-30T20:00:00Z", "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 23, "type": "audio", "duration": 10, "container_format": "mka", "codec": "opus", "track_name": "A name", "offset": 10, "status_callback": "https://mycallbackurl.com", "status_callback_method": "POST", "grouping_sids": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "url": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "media": "https://video.twilio.com/v1/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Recordings?Status=completed&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&MediaType=audio&GroupingSid=RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "next_page_url": null, "key": "recordings" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRecording" } }, "/v1/RecordingSettings/Default": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Recording settings", "x-twilio": { "defaultOutputProperties": [ "friendly_name", "aws_storage_enabled", "encryption_enabled" ], "mountName": "recording_settings", "className": "recording_settings", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1RecordingSettings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "string", "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "aws_storage_enabled": true, "encryption_enabled": true, "url": "https://video.twilio.com/v1/RecordingSettings/Default" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRecordingSettings" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1RecordingSettings" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.recording_settings" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "friendly_name", "aws_credentials_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "encryption_key_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "aws_s3_url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "aws_storage_enabled": true, "encryption_enabled": true, "url": "https://video.twilio.com/v1/RecordingSettings/Default" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateRecordingSettings", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateRecordingSettingsRequest", "properties": { "FriendlyName": { "type": "string", "description": "A descriptive string that you create to describe the resource and be shown to users in the console" }, "AwsCredentialsSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The SID of the stored Credential resource." }, "EncryptionKeySid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The SID of the Public Key resource to use for encryption." }, "AwsS3Url": { "type": "string", "format": "uri", "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/recordings`, where `recordings` is the path in which you want the recordings to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2)." }, "AwsStorageEnabled": { "type": "boolean", "description": "Whether all recordings should be written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud." }, "EncryptionEnabled": { "type": "boolean", "description": "Whether all recordings should be stored in an encrypted form. The default is `false`." } }, "required": [ "FriendlyName" ] }, "examples": { "create": { "value": { "FriendlyName": "friendly_name", "AwsCredentialsSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "EncryptionKeySid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab", "AwsS3Url": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "AwsStorageEnabled": true, "EncryptionEnabled": true } } } } } } } }, "/v1/Rooms/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Video rooms with one or more participants", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "status" ], "dependentProperties": { "recordings": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Recordings" }, "participants": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants" }, "recording_rules": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" }, "transcriptions": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Transcriptions" } }, "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Room" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Room resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "peer-to-peer", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "unique_name", "max_participants": 10, "max_participant_duration": 86400, "max_concurrent_published_tracks": 0, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "audio_only": false, "media_region": "us1", "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoom" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Room" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The SID of the Room resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "completed", "type": "peer-to-peer", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "unique_name", "max_participants": 10, "max_participant_duration": 86400, "max_concurrent_published_tracks": 10, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "duration": 10, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoom", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoomRequest", "properties": { "Status": { "$ref": "#/components/schemas/room_enum_room_status" } }, "required": [ "Status" ] }, "examples": { "update": { "value": { "Status": "completed" } } } } } } } }, "/v1/Rooms": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Video rooms with one or more participants", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "status" ], "dependentProperties": { "recordings": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Recordings" }, "participants": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants" }, "recording_rules": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/RecordingRules" }, "transcriptions": { "mapping": { "room_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Transcriptions" } }, "pathType": "list" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Room" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "peer-to-peer", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "max_concurrent_published_tracks": 0, "max_participants": 10, "max_participant_duration": 86400, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createWebrtcGo": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "go", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "room1", "max_participants": 10, "max_participant_duration": 86400, "max_concurrent_published_tracks": 0, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createGroupRooms": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "group", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "grouproom", "max_participants": 50, "max_participant_duration": 86400, "max_concurrent_published_tracks": 170, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createGroupRoomsWithAudioOnlyEnabled": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "group", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "grouproom", "max_participants": 50, "max_participant_duration": 86400, "max_concurrent_published_tracks": 170, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [], "media_region": "us1", "audio_only": true, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createSmallGroupRooms": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "group-small", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "SmallDailyStandup", "max_participants": 4, "max_participant_duration": 86400, "max_concurrent_published_tracks": 170, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createLargeGroupRooms": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "group", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "MyWebinar", "max_participants": 50, "max_participant_duration": 86400, "max_concurrent_published_tracks": 16, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } }, "createLargeGroupRoomsWithAudioOnlyEnabled": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "status": "in-progress", "type": "group", "sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "enable_turn": true, "unique_name": "MyWebinar", "max_participants": 50, "max_participant_duration": 86400, "max_concurrent_published_tracks": 16, "duration": 0, "status_callback_method": "POST", "status_callback": null, "record_participants_on_connect": false, "video_codecs": [], "media_region": "us1", "audio_only": true, "empty_room_timeout": 5, "unused_room_timeout": 5, "end_time": "2015-07-30T20:00:00Z", "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "participants": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RecordingRules" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateRoom", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateRoomRequest", "properties": { "EnableTurn": { "type": "boolean", "description": "Deprecated, now always considered to be true." }, "Type": { "$ref": "#/components/schemas/room_enum_room_type" }, "UniqueName": { "type": "string", "description": "An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource, assuming it does not contain any [reserved characters](https://tools.ietf.org/html/rfc3986#section-2.2) that would need to be URL encoded. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`." }, "StatusCallback": { "type": "string", "format": "uri", "description": "The URL Twilio should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info." }, "StatusCallbackMethod": { "type": "string", "format": "http-method", "enum": [ "GET", "POST" ], "description": "The HTTP method Twilio should use to call `status_callback`. Can be `POST` or `GET`." }, "MaxParticipants": { "type": "integer", "description": "The maximum number of concurrent Participants allowed in the room. The maximum allowed value is 50." }, "RecordParticipantsOnConnect": { "type": "boolean", "description": "Whether to start recording when Participants connect." }, "TranscribeParticipantsOnConnect": { "type": "boolean", "description": "Whether to start transcriptions when Participants connect. If TranscriptionsConfiguration is not provided, default settings will be used." }, "VideoCodecs": { "type": "array", "items": { "$ref": "#/components/schemas/room_enum_video_codec" }, "description": "An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`." }, "MediaRegion": { "type": "string", "description": "The region for the Room's media server. Can be one of the [available Media Regions](https://www.twilio.com/docs/video/ip-addresses#group-rooms-media-servers)." }, "RecordingRules": { "description": "A collection of Recording Rules that describe how to include or exclude matching tracks for recording" }, "TranscriptionsConfiguration": { "type": "object", "description": "A collection of properties that describe transcription behaviour. If TranscribeParticipantsOnConnect is set to true and TranscriptionsConfiguration is not provided, default settings will be used." }, "AudioOnly": { "type": "boolean", "description": "When set to true, indicates that the participants in the room will only publish audio. No video tracks will be allowed." }, "MaxParticipantDuration": { "type": "integer", "description": "The maximum number of seconds a Participant can be connected to the room. The maximum possible value is 86400 seconds (24 hours). The default is 14400 seconds (4 hours)." }, "EmptyRoomTimeout": { "type": "integer", "description": "Configures how long (in minutes) a room will remain active after last participant leaves. Valid values range from 1 to 60 minutes (no fractions)." }, "UnusedRoomTimeout": { "type": "integer", "description": "Configures how long (in minutes) a room will remain active if no one joins. Valid values range from 1 to 60 minutes (no fractions)." }, "LargeRoom": { "type": "boolean", "description": "When set to true, indicated that this is the large room." } } }, "examples": { "create": { "value": {} }, "createWebrtcGo": { "value": { "Type": "go", "UniqueName": "room1" } }, "createGroupRooms": { "value": { "Type": "group", "UniqueName": "grouproom", "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" } }, "createGroupRoomsWithAudioOnlyEnabled": { "value": { "Type": "group", "UniqueName": "grouproom", "RecordingRules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D", "AudioOnly": true } }, "createSmallGroupRooms": { "value": { "Type": "group-small", "UniqueName": "SmallDailyStandup" } }, "createLargeGroupRooms": { "value": { "Type": "group", "UniqueName": "MyWebinar", "MaxParticipants": 90 } }, "createLargeGroupRoomsWithAudioOnlyEnabled": { "value": { "Type": "group", "UniqueName": "MyWebinar", "MaxParticipants": 90, "AudioOnly": true } } } } } } }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Room" ], "parameters": [ { "name": "Status", "in": "query", "description": "Read only the rooms with this status. Can be: `in-progress` (default) or `completed`", "schema": { "$ref": "#/components/schemas/room_enum_room_status" }, "examples": { "readWithStatus": { "value": "completed" } } }, { "name": "UniqueName", "in": "query", "description": "Read only rooms with the this `unique_name`.", "schema": { "type": "string" } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only rooms that started on or after this date, given as `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date-time" } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only rooms that started before this date, given as `YYYY-MM-DD`.", "schema": { "type": "string", "format": "date-time" } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rooms": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomResponse" }, "examples": { "readEmpty": { "value": { "rooms": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms?PageSize=50&Page=0", "next_page_url": null, "key": "rooms" } } }, "readWithStatus": { "value": { "rooms": [ { "sid": "RM4070b618362c1682b2385b1f9982833c", "status": "completed", "date_created": "2017-04-03T22:21:49Z", "date_updated": "2017-04-03T22:21:51Z", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "type": "peer-to-peer", "enable_turn": true, "unique_name": "RM4070b618362c1682b2385b1f9982833c", "status_callback": null, "status_callback_method": "POST", "end_time": "2017-04-03T22:21:51Z", "duration": 2, "max_participants": 10, "max_participant_duration": 86400, "max_concurrent_published_tracks": 10, "record_participants_on_connect": false, "video_codecs": [ "VP8" ], "media_region": "us1", "audio_only": false, "empty_room_timeout": 5, "unused_room_timeout": 5, "large_room": false, "url": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c", "links": { "participants": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Participants", "recordings": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Recordings", "transcriptions": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/Transcriptions", "recording_rules": "https://video.twilio.com/v1/Rooms/RM4070b618362c1682b2385b1f9982833c/RecordingRules" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms?Status=completed&PageSize=50&Page=0", "next_page_url": null, "key": "rooms" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoom" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Participants in video rooms", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "status" ], "dependentProperties": { "published_tracks": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks" }, "subscribed_tracks": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks" }, "subscribe_rules": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules" }, "anonymize": { "mapping": { "room_sid": "room_sid", "sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, "parent": "/Rooms/{Sid}", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Participant" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the Participant resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomParticipant resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "bob", "status": "connected", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "duration": null, "links": { "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomParticipant" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Participant" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the participant to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomParticipant resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2017-07-30T20:00:00Z", "date_updated": "2017-07-30T20:00:00Z", "start_time": "2017-07-30T20:00:00Z", "end_time": "2017-07-30T20:00:01Z", "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "alice", "status": "disconnected", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "duration": 1, "links": { "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoomParticipant", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoomParticipantRequest", "properties": { "Status": { "$ref": "#/components/schemas/room_participant_enum_status" } } }, "examples": { "update": { "value": { "Status": "disconnected" } } } } } } } }, "/v1/Rooms/{RoomSid}/Participants": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Participants in video rooms", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "status" ], "dependentProperties": { "published_tracks": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/PublishedTracks" }, "subscribed_tracks": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribedTracks" }, "subscribe_rules": { "mapping": { "room_sid": "room_sid", "participant_sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{participant_sid}/SubscribeRules" }, "anonymize": { "mapping": { "room_sid": "room_sid", "sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Participants/{sid}/Anonymize" } }, "parent": "/Rooms/{Sid}", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Participant" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the Participant resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "Status", "in": "query", "description": "Read only the participants with this status. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.", "schema": { "$ref": "#/components/schemas/room_participant_enum_status" }, "examples": { "readFilters": { "value": "disconnected" } } }, { "name": "Identity", "in": "query", "description": "Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.", "schema": { "type": "string" }, "examples": { "readFilters": { "value": "alice" } } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readFilters": { "value": "2017-01-01T00:00:01Z" } } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only Participants that started before this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readFilters": { "value": "2017-12-31T23:59:59Z" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room.room_participant" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomParticipantResponse" }, "examples": { "readEmpty": { "value": { "participants": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0", "next_page_url": null, "key": "participants" } } }, "readFilters": { "value": { "participants": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2017-07-30T20:00:00Z", "date_updated": "2017-07-30T20:00:00Z", "start_time": "2017-07-30T20:00:00Z", "end_time": "2017-07-30T20:00:01Z", "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "alice", "status": "disconnected", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "duration": 1, "links": { "published_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks", "subscribed_tracks": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks", "subscribe_rules": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribeRules", "anonymize": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?Status=disconnected&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&Identity=alice&PageSize=50&Page=0", "next_page_url": null, "key": "participants" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoomParticipant" } }, "/v1/Rooms/{RoomSid}/Participants/{Sid}/Anonymize": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "identity", "status" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "pathType": "instance" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Anonymize" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the participant to update.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomParticipant resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_anonymize" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "identity": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "disconnected", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Anonymize", "duration": 1 } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoomParticipantAnonymize" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "enabled", "kind" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "pathType": "instance" }, "get": { "description": "Returns a single Track resource represented by TrackName or SID.", "summary": "Returns a single Track resource represented by TrackName or SID.", "tags": [ "VideoV1PublishedTrack" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the Track resource to fetch is published.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the Participant resource with the published track to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomParticipantPublishedTrack resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" }, "examples": { "fetch": { "value": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "name": "bob-track", "kind": "data", "enabled": true, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/PublishedTracks": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "enabled", "kind" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "pathType": "list" }, "get": { "description": "Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource.", "summary": "Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource.", "tags": [ "VideoV1PublishedTrack" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the Track resources to read are published.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the Participant resource with the published tracks to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "published_tracks": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomParticipantPublishedTrackResponse" }, "examples": { "readEmpty": { "value": { "published_tracks": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PublishedTracks?PageSize=50&Page=0", "next_page_url": null, "key": "published_tracks" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoomParticipantPublishedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribeRules": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "participant_sid", "room_sid", "rules" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "className": "subscribe_rules", "pathType": "list" }, "get": { "description": "Returns a list of Subscribe Rules for the Participant.", "summary": "Returns a list of Subscribe Rules for the Participant.", "tags": [ "VideoV1SubscribeRules" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the subscribe rules to fetch apply.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the Participant resource with the subscribe rules to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" }, "examples": { "readEmpty": { "value": { "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": null, "date_updated": null, "rules": [ { "type": "include", "all": true, "publisher": null, "track": null, "kind": null, "priority": null } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomParticipantSubscribeRule" }, "post": { "description": "Update the Subscribe Rules for the Participant", "summary": "Update the Subscribe Rules for the Participant", "tags": [ "VideoV1SubscribeRules" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the subscribe rules to update apply.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the Participant resource to update the Subscribe Rules.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" }, "examples": { "updateFilters": { "value": { "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": null, "date_updated": null, "rules": [ { "type": "exclude", "all": true, "publisher": null, "track": null, "kind": null, "priority": null } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoomParticipantSubscribeRule", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoomParticipantSubscribeRuleRequest", "properties": { "Rules": { "description": "A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information." } } }, "examples": { "updateFilters": { "value": { "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" } } } } } } } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "enabled", "kind" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "pathType": "instance" }, "get": { "description": "Returns a single Track resource represented by `track_sid`. Note: This is one resource with the Video API that requires a SID, be Track Name on the subscriber side is not guaranteed to be unique.", "summary": "Returns a single Track resource represented by `track_sid`. Note: This is one resource with the Video API that requires a SID, be Track Name on the subscriber side is not guaranteed to be unique.", "tags": [ "VideoV1SubscribedTrack" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room where the Track resource to fetch is subscribed.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the participant that subscribes to the Track resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomParticipantSubscribedTrack resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^MT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track" }, "examples": { "fetch": { "value": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "publisher_sid": "PAbaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "name": "bob-track", "kind": "data", "enabled": true, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks/MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Participants/{ParticipantSid}/SubscribedTracks": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "name", "enabled", "kind" ], "parent": "/Rooms/{RoomSid}/Participants/{Sid}", "pathType": "list" }, "get": { "description": "Returns a list of tracks that are subscribed for the participant.", "summary": "Returns a list of tracks that are subscribed for the participant.", "tags": [ "VideoV1SubscribedTrack" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource with the Track resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "ParticipantSid", "in": "path", "description": "The SID of the participant that subscribes to the Track resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "subscribed_tracks": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomParticipantSubscribedTrackResponse" }, "examples": { "readEmpty": { "value": { "subscribed_tracks": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SubscribedTracks?PageSize=50&Page=0", "next_page_url": null, "key": "subscribed_tracks" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoomParticipantSubscribedTrack" } }, "/v1/Rooms/{RoomSid}/Recordings/{Sid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Single-track, single-media room recordings", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "status", "type", "duration", "codec" ], "dependentProperties": { "media": { "mapping": { "room_sid": "room_sid", "sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" } }, "parent": "/Rooms/{Sid}", "className": "room_recording", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1RoomRecording" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource with the recording to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomRecording resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "processing", "date_created": "2015-07-30T20:00:00Z", "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 0, "type": "audio", "duration": 0, "container_format": "mka", "codec": "opus", "track_name": "A name", "offset": 10, "grouping_sids": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomRecording" }, "delete": { "description": "", "summary": "", "tags": [ "VideoV1RoomRecording" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the RoomRecording resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Sid", "in": "path", "description": "The SID of the RoomRecording resource to delete.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteRoomRecording" } }, "/v1/Rooms/{RoomSid}/Recordings": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "Single-track, single-media room recordings", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "status", "type", "duration", "codec" ], "dependentProperties": { "media": { "mapping": { "room_sid": "room_sid", "sid": "sid" }, "resource_url": "/v1/Rooms/{room_sid}/Recordings/{sid}/Media" } }, "parent": "/Rooms/{Sid}", "className": "room_recording", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1RoomRecording" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the RoomRecording resources to read.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RM[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Status", "in": "query", "description": "Read only the recordings with this status. Can be: `processing`, `completed`, or `deleted`.", "schema": { "$ref": "#/components/schemas/room_recording_enum_status" }, "examples": { "readResults": { "value": "completed" } } }, { "name": "SourceSid", "in": "query", "description": "Read only the recordings that have this `source_sid`.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$" }, "examples": { "readResults": { "value": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "DateCreatedAfter", "in": "query", "description": "Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-01-01T00:00:01Z" } } }, { "name": "DateCreatedBefore", "in": "query", "description": "Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "schema": { "type": "string", "format": "date-time" }, "examples": { "readResults": { "value": "2017-12-31T23:59:59Z" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room.room_recording" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomRecordingResponse" }, "examples": { "readEmpty": { "value": { "recordings": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?PageSize=50&Page=0", "next_page_url": null, "key": "recordings" } } }, "readResults": { "value": { "recordings": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "status": "completed", "date_created": "2015-07-30T20:00:00Z", "sid": "RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "size": 23, "type": "audio", "duration": 10, "container_format": "mka", "codec": "opus", "track_name": "A name", "offset": 10, "grouping_sids": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "participant_sid": "PAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "media_external_location": "https://my-super-duper-bucket.s3.amazonaws.com/my/path/", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "media": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/RTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings?Status=completed&DateCreatedBefore=2017-12-31T23%3A59%3A59Z&DateCreatedAfter=2017-01-01T00%3A00%3A01Z&SourceSid=MTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "next_page_url": null, "key": "recordings" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoomRecording" } }, "/v1/Rooms/{RoomSid}/RecordingRules": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "room_sid", "rules" ], "parent": "/Rooms/{Sid}", "className": "recording_rules", "pathType": "list" }, "get": { "description": "Returns a list of Recording Rules for the Room.", "summary": "Returns a list of Recording Rules for the Room.", "tags": [ "VideoV1RecordingRules" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the recording rules to fetch apply.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" }, "examples": { "fetch": { "value": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "rules": [ { "type": "include", "all": true } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomRecordingRule" }, "post": { "description": "Update the Recording Rules for the Room", "summary": "Update the Recording Rules for the Room", "tags": [ "VideoV1RecordingRules" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the Room resource where the recording rules to update apply.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_recording_rule" }, "examples": { "update": { "value": { "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "rules": [ { "type": "include", "all": true } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoomRecordingRule", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoomRecordingRuleRequest", "properties": { "Rules": { "description": "A JSON-encoded array of recording rules." } } }, "examples": { "update": { "value": { "Rules": "%5B%7B%22type%22%3A%22exclude%22%2C%22all%22%3A%20true%7D%5D" } } } } } } } }, "/v1/Rooms/{RoomSid}/Transcriptions/{Ttid}": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "transcriptions in video rooms", "x-twilio": { "defaultOutputProperties": [ "ttid", "account_sid", "room_sid" ], "parent": "/Rooms/{Sid}", "className": "transcriptions", "pathType": "instance" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Transcriptions" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the transcriptions resource to fetch.", "schema": { "type": "string" }, "required": true }, { "name": "Ttid", "in": "path", "description": "The Twilio type id of the transcriptions resource to fetch.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_transcriptions" }, "examples": { "fetch": { "value": { "ttid": "video_extension_2c70be23-4788-423d-9351-df6705efa035", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "duration": null, "configuration": { "languageCode": "en-US" }, "status": "started", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/video_extension_2c70be23-4788-423d-9351-df6705efa035" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchRoomTranscriptions" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Transcriptions" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the transcriptions resource to update.", "schema": { "type": "string" }, "required": true }, { "name": "Ttid", "in": "path", "description": "The Twilio type id of the transcriptions resource to update.", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_transcriptions" }, "examples": { "update": { "value": { "ttid": "video_extension_2c70be23-4788-423d-9351-df6705efa035", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "duration": null, "configuration": { "languageCode": "en-US" }, "status": "started", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/video_extension_2c70be23-4788-423d-9351-df6705efa035" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateRoomTranscriptions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateRoomTranscriptionsRequest", "properties": { "Status": { "$ref": "#/components/schemas/room_transcriptions_enum_status" }, "Configuration": { "type": "object", "description": "A collection of properties that describe transcription behaviour." } } }, "examples": { "updateStatus": { "value": { "Status": "stopped" } }, "updateConfiguration": { "value": { "Configuration": "{\"LanguageCode\": \"EN-us\", \"ProfanityFilter\": true}" } }, "updateAllFields": { "value": { "Status": "started", "Configuration": "{\"LanguageCode\": \"EN-us\", \"ProfanityFilter\": true}" } } } } } } } }, "/v1/Rooms/{RoomSid}/Transcriptions": { "servers": [ { "url": "https://video.twilio.com" } ], "description": "transcriptions in video rooms", "x-twilio": { "defaultOutputProperties": [ "ttid", "account_sid", "room_sid" ], "parent": "/Rooms/{Sid}", "className": "transcriptions", "pathType": "list" }, "get": { "description": "", "summary": "", "tags": [ "VideoV1Transcriptions" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room with the transcriptions resources to read.", "schema": { "type": "string" }, "required": true }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transcriptions": { "type": "array", "items": { "$ref": "#/components/schemas/video.v1.room.room_transcriptions" } }, "meta": { "properties": { "first_page_url": { "format": "uri", "type": "string" }, "key": { "type": "string" }, "next_page_url": { "format": "uri", "nullable": true, "type": "string" }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "previous_page_url": { "format": "uri", "nullable": true, "type": "string" }, "url": { "format": "uri", "type": "string" } }, "type": "object" } }, "title": "ListRoomTranscriptionsResponse" }, "examples": { "readEmpty": { "value": { "transcriptions": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions?PageSize=50&Page=0", "next_page_url": null, "key": "transcriptions" } } }, "readList": { "value": { "transcriptions": [ { "ttid": "video_extension_2c70be23-4788-423d-9351-df6705efa035", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "duration": null, "configuration": { "languageCode": "en-US" }, "status": "started", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/video_extension_2c70be23-4788-423d-9351-df6705efa035" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions?PageSize=50&Page=0", "previous_page_url": null, "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions?PageSize=50&Page=0", "next_page_url": null, "key": "transcriptions" } } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListRoomTranscriptions" }, "post": { "description": "", "summary": "", "tags": [ "VideoV1Transcriptions" ], "parameters": [ { "name": "RoomSid", "in": "path", "description": "The SID of the room new transcriptions resource to be created.", "schema": { "type": "string" }, "required": true } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video.v1.room.room_transcriptions" }, "examples": { "update": { "value": { "ttid": "video_extension_2c70be23-4788-423d-9351-df6705efa035", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "room_sid": "RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "source_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2015-07-30T20:00:00Z", "date_updated": "2015-07-30T20:00:00Z", "start_time": "2015-07-30T20:00:00Z", "end_time": null, "duration": null, "configuration": { "languageCode": "en-US" }, "status": "started", "url": "https://video.twilio.com/v1/Rooms/RMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions/video_extension_2c70be23-4788-423d-9351-df6705efa035" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateRoomTranscriptions", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateRoomTranscriptionsRequest", "properties": { "Configuration": { "type": "object", "description": "A collection of properties that describe transcription behaviour." } } }, "examples": { "create": { "value": { "Configuration": "{\"LanguageCode\": \"EN-us\", \"ProfanityFilter\": true}" } } } } } } } } }, "servers": [ { "url": "https://video.twilio.com" } ], "tags": [ { "name": "VideoV1Anonymize" }, { "name": "VideoV1Composition" }, { "name": "VideoV1CompositionHook" }, { "name": "VideoV1CompositionSettings" }, { "name": "VideoV1Index" }, { "name": "VideoV1Media" }, { "name": "VideoV1Participant" }, { "name": "VideoV1PublishedTrack" }, { "name": "VideoV1Recording" }, { "name": "VideoV1RecordingRules" }, { "name": "VideoV1RecordingSettings" }, { "name": "VideoV1Room" }, { "name": "VideoV1RoomRecording" }, { "name": "VideoV1SubscribeRules" }, { "name": "VideoV1SubscribedTrack" }, { "name": "VideoV1Transcriptions" }, { "name": "VideoV1Version" } ], "security": [ { "accountSid_authToken": [] } ] }