The Conference resource allows you to query and manage the state of conferences on your Twilio account.
Conference rooms are not directly created from the Programmable Voice API.
In order to create a new conference, you must use TwiML's <Dial> verb with the <Conference> noun, or by creating a conference participant using the /Participants API. After a Conference instance has been created, you can access it by using the REST API.
For step-by-step instructions on how to write this TwiML and programmatically handle the conference, check out our guides on how to create conference calls using Twilio's supported helper libraries.
The SID of the Account that created this Conference resource.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The date and time in UTC that this resource was created specified in RFC 2822 format.
The date and time in UTC that this resource was last updated, specified in RFC 2822 format.
A string that you assigned to describe this conference room. Maximum length is 128 characters.
A string that represents the Twilio Region where the conference audio was mixed. May be us1, ie1, de1, sg1, br1, au1, and jp1. Basic conference audio will always be mixed in us1. Global Conference audio will be mixed nearest to the majority of participants.
The unique, Twilio-provided string used to identify this Conference resource.
^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34The status of this conference. Can be: init, in-progress, or completed.
initin-progresscompletedA list of related resources identified by their URIs relative to https://api.twilio.com.
The reason why a conference ended. When a conference is in progress, will be null. When conference is completed, can be: conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left.
conference-ended-via-apiparticipant-with-end-conference-on-exit-leftparticipant-with-end-conference-on-exit-kickedlast-participant-kickedlast-participant-leftThe call SID that caused the conference to end.
^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34You may have many conference instances that share the same friendly_name. Only one of these distinct conferences may be in-progress at any given time. For instance, if you have two separate conferences with the friendly_name of "my-conference" you cannot add participants to one instance while the other is in progress.
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.jsonThe recommended way to monitor the state of a Conference and its participants is to use the Conference statusCallback. This webhook callback will be fired when the state of the Conference or a participant changes.
At any time you can use the REST API to query the Conference and Participant resources, however continuously polling these resources is not recommended.
Please also note that when fetching conferences after the conference has ended, associated participant subresources will not be returned. For fetching conference participants after a conference has ended, please see the Voice Insights Conference Summary resource.
The SID of the Account that created the Conference resource(s) to fetch.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the Conference resource to fetch
^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences.jsonRead all the conferences within your account.
The list of conferences that we return includes paging information.
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.
Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.
The status of the resources to read. Can be: init, in-progress, or completed.
initin-progresscompletedHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1Maximum: 1000The page token. This is provided by the API.
Returns the list of all Conferences in the account
Returns a list of conferences that started on July 07, 2020
Returns a list of in-progress conferences that started on or after midnight on January 1, 2021
Returns the conferences named 'MyRoom'
POST https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.jsonYou can use the update action to change the conference's properties as well as to end the conference.
The SID of the Account that created the Conference resource(s) to update.
^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34The Twilio-provided string that uniquely identifies the Conference resource to update
The new status of the resource. Can be: Can be: init, in-progress, or completed. Specifying completed will end the conference and hang up all participants
completedThe URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs.
The HTTP method used to call announce_url. Can be: GET or POST and the default is POST
GETPOSTEnd this conference by setting its status to 'completed'
Include the AnnounceUrl parameter to play something for your conference participants
Each Conference has a Participants subresource. Participants represent the set of people currently connected to a running conference.
You can request all participants from a given Conference by requesting the following:
_10GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json
See the full Participant API reference documentation for Participant properties, parameters, and actions.
You can access the Recordings list subresource on any given Conference.
The following will return a list of all of the recordings generated for a given conference, identified by its ConferenceSid. (Note that recordings associated with an individual call leg of the conference will not be returned.)
_10GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json
See the Recordings reference documentation for resource properties and response formats.
Starting on February 5, 2021 you will be able to retrieve resources via GET to the /Conferences and /Participants endpoints for thirteen months after the resource is created. This represents a significant change as these logs are currently stored indefinitely by Twilio and retrievable via Console and API.
It's important to note that we are not deleting your logs, just changing where they will be available to you. We provide a Bulk Export utility in Console for Conferences and Participant resources, as well as an API. Bulk Export will generate S3 files containing one day of data per file and deliver the download link via webhook, email, or Console. Records older than thirteen months will only be able to be retrieved via Bulk Export.
If you perform log extraction via API on a rolling basis, it is important to verify that you are pulling the logs at a frequency that will remain unaffected by this change.
Explore Voice Insights with its Conference Insights Event Stream and Conference Insights REST API which allow you to see conference parameters, investigate participant event timelines, and understand detected quality issues.