Conference Resource
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.
Conference properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created this Conference resource. |
date_created
|
The date and time in GMT that this resource was created specified in RFC 2822 format. |
date_updated
|
The date and time in GMT that this resource was last updated, specified in RFC 2822 format. |
api_version
|
The API version used to create this conference. |
friendly_name
|
A string that you assigned to describe this conference room. Maxiumum length is 128 characters. |
region
|
A string that represents the Twilio Region where the conference audio was mixed. May be |
sid
|
The unique string that that we created to identify this Conference resource. |
status
|
The status of this conference. Can be: |
uri
|
The URI of this resource, relative to |
subresource_uris
|
A list of related resources identified by their URIs relative to |
reason_conference_ended
|
The reason why a conference ended. When a conference is in progress, will be |
call_sid_ending_conference
|
The call SID that caused the conference to end. |
You 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.
Fetch a Conference resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
The 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.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
The SID of the Account that created the Conference resource(s) to fetch. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Conference resource to fetch |
Example 1
Read multiple Conference resources
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences.json
Read all the conferences within your account.
The list of conferences that we return includes paging information.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
The SID of the Account that created the Conference resource(s) to read. |
date_created
Optional
|
The |
date_updated
Optional
|
The |
friendly_name
Optional
|
The string that identifies the Conference resources to read. |
status
Optional
|
The status of the resources to read. Can be: |
Example 1
Example 2
Example 3
Example 4
Update a Conference resource
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
You can use the update action to change the conference's properties as well as to end the conference.
Parameters
| Parameters in REST API format | |
|---|---|
account_sid
Path
|
The SID of the Account that created the Conference resource(s) to update. |
sid
Path
|
The Twilio-provided string that uniquely identifies the Conference resource to update |
status
Optional
|
The new status of the resource. Can be: Can be: |
announce_url
Optional
|
The 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 |
announce_method
Optional
|
The HTTP method used to call |
Example 1
Example 2
Manage 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:
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.jsonSee the full Participant API reference documentation for Participant properties, parameters, and actions.
Conference Recordings
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.)
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.jsonSee the Recordings reference documentation for resource properties and response formats.
Conference Log Retention
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.
What's next?
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.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
