Get Started

REST API: Conferences

The Conference instance resource allows you to query and manage the state of individual conferences. When a caller joins a conference via the TwiML <Dial> verb and <Conference> noun, Twilio creates a Conference instance resource to represent the conference room and a Participant instance resource to represent the caller who joined. See the Participants documentation for details.

The Conferences list resource allows you to list the conferences within an account.

Conference Instance Resource

This resource represents an individual conference instance. Each conference that starts and ends is considered a unique conference instance. There can be many conference instances that share the same FriendlyName, but only one can be in-progress at any given time.

Resource URI

/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}

Resource Properties

A Conference resource is represented by the following properties:

Property Description
Sid A 34 character string that uniquely identifies this conference.
FriendlyName A user provided string that identifies this conference room.
Status A string representing the status of the conference. May be init, in-progress, or completed.
DateCreated The date that this conference was created, given as GMT in RFC 2822 format.
DateUpdated The date that this conference was last updated, given as GMT in RFC 2822 format.
AccountSid The unique id of the Account responsible for creating this conference.
Uri The URI for this resource, relative to https://api.twilio.com.

HTTP GET

Returns a representation of the conference identified by {ConferenceSid}.

Example

HTTP POST

Not supported

HTTP PUT

Not supported

HTTP DELETE

Not supported

Conference Instance Subresources

Each Conference instance resource has a Participants subresource which represents the set of participants currently connected to a running conference.

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

Represents the set of participants currently connected to the conference identified by {ConferenceSid}. See the Participants resource documentation for properties and response formats.

Conferences List Resource

Resource URI

/2010-04-01/Accounts/{AccountSid}/Conferences

HTTP GET

Returns a list of conferences within an account. The list includes paging information.

List Filters

The following GET query string parameters allow you to limit the list returned. Note, parameters are case-sensitive:

Parameter Description
Status Only show conferences currently in with this status. May be init, in-progress, or completed.
FriendlyName List conferences whose FriendlyName exactly matches this string.
DateCreated Only show conferences that started on this date, given as YYYY-MM-DD. You can also specify inequality, such as DateCreated<=YYYY-MM-DD for conferences that started at or before midnight on a date, and DateCreated>=YYYY-MM-DD for conferences that started at or after midnight on a date.
DateUpdated Only show conferences that were last updated on this date, given as YYYY-MM-DD. You can also specify inequality, such as DateUpdated<=YYYY-MM-DD for conferences that were last updated at or before midnight on a date, and DateUpdated>=YYYY-MM-DD for conferences that were updated at or after midnight on a date.
Example 1
Example 2

Show the in progress conference named "MyRoom".

Example 3

Only show completed conferences started on Jul 06th, 2009.

Example 4

Only show in progress conferences started on or after midnight Jul 06th, 2009.

HTTP POST

Not supported

HTTP PUT

Not supported

HTTP DELETE

Not supported