{ "opencollection": "1.0.0", "info": { "name": "Twilio - Accounts A2p Rooms API", "version": "1.52.0" }, "items": [ { "info": { "name": "Rooms", "type": "folder" }, "items": [ { "info": { "name": "Twilio List Rooms", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/Rooms", "params": [ { "name": "Status", "value": "", "type": "query", "description": "Filter by room status" }, { "name": "UniqueName", "value": "", "type": "query", "description": "Filter by unique room name" }, { "name": "DateCreatedAfter", "value": "", "type": "query" }, { "name": "DateCreatedBefore", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of video rooms in your account." }, { "info": { "name": "Twilio Create a Room", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/Rooms", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Create a new video room. Rooms can be configured as group rooms (up to 50 participants), small group rooms (up to 4), or peer-to-peer rooms (up to 10)." }, { "info": { "name": "Twilio Fetch a Room", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/Rooms/:RoomSid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID or unique name of the room" } ] }, "docs": "Retrieve details of a specific video room." }, { "info": { "name": "Twilio Update a Room", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/Rooms/:RoomSid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID or unique name of the room" } ], "body": { "type": "form-urlencoded", "data": [ { "name": "Status", "value": "" } ] } }, "docs": "End an in-progress room by setting its status to completed." }, { "info": { "name": "FetchRoom", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The SID of the Room resource to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "UpdateRoom", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms/:Sid", "params": [ { "name": "Sid", "value": "", "type": "path", "description": "The SID of the Room resource to update." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "ListRoom", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms", "params": [ { "name": "Status", "value": "", "type": "query", "description": "Read only the rooms with this status. Can be: `in-progress` (default) or `completed`" }, { "name": "UniqueName", "value": "", "type": "query", "description": "Read only rooms with the this `unique_name`." }, { "name": "DateCreatedAfter", "value": "", "type": "query", "description": "Read only rooms that started on or after this date, given as `YYYY-MM-DD`." }, { "name": "DateCreatedBefore", "value": "", "type": "query", "description": "Read only rooms that started before this date, given as `YYYY-MM-DD`." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "CreateRoom", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms", "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "FetchRoomParticipant", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the Participant resource to fetch." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomParticipant resource to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "UpdateRoomParticipant", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the participant to update." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomParticipant resource to update." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "ListRoomParticipant", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the Participant resources to read." }, { "name": "Status", "value": "", "type": "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." }, { "name": "Identity", "value": "", "type": "query", "description": "Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value." }, { "name": "DateCreatedAfter", "value": "", "type": "query", "description": "Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, { "name": "DateCreatedBefore", "value": "", "type": "query", "description": "Read only Participants that started before this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "UpdateRoomParticipantAnonymize", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:Sid/Anonymize", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the participant to update." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomParticipant resource to update." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "FetchRoomParticipantPublishedTrack", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/PublishedTracks/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the Track resource to fetch is published." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the Participant resource with the published track to fetch." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomParticipantPublishedTrack resource to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a single Track resource represented by TrackName or SID." }, { "info": { "name": "ListRoomParticipantPublishedTrack", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/PublishedTracks", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the Track resources to read are published." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the Participant resource with the published tracks to read." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of tracks associated with a given Participant. Only `currently` Published Tracks are in the list resource." }, { "info": { "name": "FetchRoomParticipantSubscribeRule", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/SubscribeRules", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the subscribe rules to fetch apply." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the Participant resource with the subscribe rules to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of Subscribe Rules for the Participant." }, { "info": { "name": "UpdateRoomParticipantSubscribeRule", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/SubscribeRules", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the subscribe rules to update apply." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the Participant resource to update the Subscribe Rules." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update the Subscribe Rules for the Participant" }, { "info": { "name": "FetchRoomParticipantSubscribedTrack", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/SubscribedTracks/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room where the Track resource to fetch is subscribed." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the participant that subscribes to the Track resource to fetch." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomParticipantSubscribedTrack resource to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "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." }, { "info": { "name": "ListRoomParticipantSubscribedTrack", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Participants/:ParticipantSid/SubscribedTracks", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource with the Track resources to read." }, { "name": "ParticipantSid", "value": "", "type": "path", "description": "The SID of the participant that subscribes to the Track resources to read." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of tracks that are subscribed for the participant." }, { "info": { "name": "FetchRoomRecording", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Recordings/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource with the recording to fetch." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomRecording resource to fetch." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "DeleteRoomRecording", "type": "http" }, "http": { "method": "DELETE", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Recordings/:Sid", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the RoomRecording resource to delete." }, { "name": "Sid", "value": "", "type": "path", "description": "The SID of the RoomRecording resource to delete." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "ListRoomRecording", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/Recordings", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the room with the RoomRecording resources to read." }, { "name": "Status", "value": "", "type": "query", "description": "Read only the recordings with this status. Can be: `processing`, `completed`, or `deleted`." }, { "name": "SourceSid", "value": "", "type": "query", "description": "Read only the recordings that have this `source_sid`." }, { "name": "DateCreatedAfter", "value": "", "type": "query", "description": "Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone." }, { "name": "DateCreatedBefore", "value": "", "type": "query", "description": "Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone." }, { "name": "PageSize", "value": "", "type": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, { "name": "Page", "value": "", "type": "query", "description": "The page index. This value is simply for client state." }, { "name": "PageToken", "value": "", "type": "query", "description": "The page token. This is provided by the API." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } } }, { "info": { "name": "FetchRoomRecordingRule", "type": "http" }, "http": { "method": "GET", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/RecordingRules", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the recording rules to fetch apply." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of Recording Rules for the Room." }, { "info": { "name": "UpdateRoomRecordingRule", "type": "http" }, "http": { "method": "POST", "url": "https://accounts.twilio.com/v1/Rooms/:RoomSid/RecordingRules", "params": [ { "name": "RoomSid", "value": "", "type": "path", "description": "The SID of the Room resource where the recording rules to update apply." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update the Recording Rules for the Room" } ] } ], "bundled": true }