Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Conference

The Conference resource allows you to query and manage the state of conferences on your Twilio account.

You can leverage the REST API to:

You cannot create a conference room directly from the Programmable Voice API.

To create a new conference, you must use TwiML's <Dial> verb with the <Conference> noun. Only then will a Conference instance be created and reachable via 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

Names in Ruby format
account_sid
sid<AC> Not PII

The SID of the Account that created this Conference resource.

date_created
date_time<rfc2822> Not PII

The date and time in GMT that this resource was created specified in RFC 2822 format.

date_updated
date_time<rfc2822> Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.

api_version
string Not PII

The API version used to create this conference.

friendly_name
string Not PII

A string that you assigned to describe this conference room.

region
string Not PII

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.

sid
sid<CF> Not PII

The unique string that that we created to identify this Conference resource.

status
enum:status Not PII

The status of this conference. Can be: init, in-progress, or completed.

uri
uri Not PII

The URI of this resource, relative to https://api.twilio.com.

subresource_uris
uri_map Not PII

A list of related resources identified by their URIs relative to https://api.twilio.com.

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. If you have two separate conferences with the friendly_name "my-conference," you cannot add participants to one instance while the other is in process.

Fetch a Conference resource

get
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json

Retrieve a single conference by specifying the ConferenceSid.

Parameters
Names in None format
account_sid
Required
get sid<AC> Not PII

The SID of the Account that created the Conference resource(s) to fetch.

sid
Required
get sid<CF> Not PII

The Twilio-provided string that uniquely identifies the Conference resource to fetch

Example 1
        
        
        
        

        Read multiple Conference resources

        get
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences.json

        Get a list of conferences within your account.

        The list of conferences that Twilio returns will include paging information.

        The following GET query string parameters allow you to filter the list Twilio returns:

        Parameters
        Names in None format
        date_created
        Optional
        get date_inequality<iso8601> Not PII

        The date_created value, specified as YYYY-MM-DD, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD.

        date_updated
        Optional
        get date_inequality<iso8601> Not PII

        The date_updated value, specified as YYYY-MM-DD, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD.

        friendly_name
        Optional
        get string Not PII

        The string that identifies the Conference resources to read.

        status
        Optional
        get enum:status Not PII

        The status of the resources to read. Can be: init, in-progress, or completed.

        account_sid
        Required
        get sid<AC> Not PII

        The SID of the Account that created the Conference resource(s) to read.

        Example 1
              
              
              
              
              Returns the list of all Conferences tied to your account

              Read: List all Conferences

              Returns the list of all Conferences tied to your account
              Example 2
                    
                    
                    
                    
                    Returns the in-progress conference named 'MyRoom'

                    Read: List an in-progress Conference

                    Returns the in-progress conference named 'MyRoom'
                    Example 3
                          
                          
                          
                          
                          Returns a list of completed conferences that started on July 06, 2009

                          Read: List Conferences that started on a given date

                          Returns a list of completed conferences that started on July 06, 2009
                          Example 4
                                
                                
                                
                                
                                Returns a list of in-progress conferences that started on or after midnight on July 06, 2009

                                Read: List in-progress conferences on or after a given date

                                Returns a list of in-progress conferences that started on or after midnight on July 06, 2009

                                Update a Conference resource

                                post
                                https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json

                                Update the status of a Conference.

                                Twilio will return a JSON representation of the Conference including the updated status.

                                You may update the properties of a Conference by POSTing any of the following parameters to your ConferenceSid:

                                Parameters
                                Names in None format
                                account_sid
                                Required
                                post sid<AC> Not PII

                                The SID of the Account that created the Conference resource(s) to update.

                                sid
                                Required
                                post sid_like<CF> Not PII

                                The Twilio-provided string that uniquely identifies the Conference resource to update

                                status
                                Optional
                                post enum:update_status Not PII

                                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

                                announce_url
                                Optional
                                post url Not PII

                                The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with <Play> or <Say>.

                                announce_method
                                Optional
                                post http_method Not PII

                                The HTTP method used to call announce_url. Can be: GET or POST and the default is POST

                                Example 1
                                      
                                      
                                      
                                      
                                      End this conference by setting its status to 'completed'

                                      Update: end a conference

                                      End this conference by setting its status to 'completed'
                                      Example 2
                                            
                                            
                                            
                                            
                                            Include the AnnounceUrl parameter to play something for your conference participants

                                            Update: announce something into the conference

                                            Include the AnnounceUrl parameter to play something for your conference participants

                                            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 URI:

                                            /2010-04-01/Accounts/{YourAccountSid}/Conferences/{ConferenceSid}/Participants

                                            See 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.json
                                            

                                            See the Recordings reference documentation for resource properties and response formats.

                                            Rate this page:

                                            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 browsing the Twilio tag on Stack Overflow.