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

account_sid
sid<AC> Not PII

The unique id of the Account responsible for creating this conference.

date_created
date_time<rfc2822> Not PII

The date that this conference was created, given as GMT in RFC 2822 format.

date_updated
date_time<rfc2822> Not PII

The date that this conference was last updated, given as GMT in RFC 2822 format.

friendly_name
string Not PII

A user provided string that identifies this conference room.

region
string Not PII

A string representing the Twilio Region where the conference audio was mixed. May be us1, us2, 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

A 34 character string that uniquely identifies this conference.

status
enum:status Not PII

A string representing the status of the conference. May be init, in-progress, or completed.

uri
uri Not PII

The URI for this resource, 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
Sid
Required
get sid<CF> Not PII

The conference Sid that uniquely identifies this resource

Example 1
Loading Code Sample...
      
      
      
      

      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
      DateCreated
      Optional
      get date_inequality<iso8601> Not PII

      Only show conferences that started on this date, given as YYYY-MM-DD. You can also specify inequality – for conferences that started at or before midnight on a date use DateCreated<=YYYY-MM-DD, or specify conferences that started at or after midnight on a date with DateCreated>=YYYY-MM-DD.

      DateUpdated
      Optional
      get date_inequality<iso8601> Not PII

      Only show conferences that were last updated on this date, given as YYYY-MM-DD. You can also specify inequality – for conferences that were last updated at or before midnight on a date use DateUpdated<=YYYY-MM-DD, or specify conferences updated at or after midnight on a given date with DateUpdated>=YYYY-MM-DD.

      FriendlyName
      Optional
      get string Not PII

      Only show results who's friendly name exactly matches the string

      Status
      Optional
      get enum:status Not PII

      A string representing the status of the conference. May be init, in-progress, or completed.

      Example 1
      Loading Code Sample...
          
          
          
          
          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
          Loading Code Sample...
              
              
              
              
              Returns the in-progress conference named 'MyRoom'

              Read: List an in-progress Conference

              Returns the in-progress conference named 'MyRoom'
              Example 3
              Loading Code Sample...
                  
                  
                  
                  
                  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
                  Loading Code Sample...
                      
                      
                      
                      
                      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
                      AnnounceMethod
                      Optional
                      post http_method Not PII

                      Specify GET or POST, defaults to POST

                      AnnounceUrl
                      Optional
                      post url Not PII

                      The 'AnnounceUrl' attribute lets you specify a URL for announcing something into a conference. The URL may return an MP3, a WAV or a TwiML document with <Play> or <Say>.

                      Status
                      Optional
                      post enum:update_status Not PII

                      Specifying completed will end the conference and kick all participants

                      Example 1
                      Loading Code Sample...
                          
                          
                          
                          
                          End this conference by setting its status to 'completed'

                          Update: end a conference

                          End this conference by setting its status to 'completed'
                          Example 2
                          Loading Code Sample...
                              
                              
                              
                              
                              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.

                              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.

                              Loading Code Sample...