Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Conference Resource


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

(information)

Info

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

conference-properties page anchor
Resource properties
account_sidtype: SID<AC>Not PII

date_createdtype: string<DATE TIME RFC 2822>Not PII

The date and time in GMT that this resource was created specified in RFC 2822(link takes you to an external page) format.


date_updatedtype: string<DATE TIME RFC 2822>Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822(link takes you to an external page) format.


api_versiontype: stringNot PII

The API version used to create this conference.


friendly_nametype: stringNot PII

A string that you assigned to describe this conference room. Maxiumum length is 128 characters.


regiontype: stringNot 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.


sidtype: SID<CF>Not PII

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


statustype: enum<STRING>Not PII

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

Possible values:
initin-progresscompleted

uritype: stringNot PII

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


subresource_uristype: object<URI MAP>Not PII

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


reason_conference_endedtype: enum<STRING>Not PII

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.

Possible values:
conference-ended-via-apiparticipant-with-end-conference-on-exit-leftparticipant-with-end-conference-on-exit-kickedlast-participant-kickedlast-participant-left

call_sid_ending_conferencetype: SID<CA>Not PII

The call SID that caused the conference to end.

(warning)

Warning

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

fetch-a-conference-resource page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json

(information)

Info

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

fetch-parameters page anchor
URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the Conference resource(s) to fetch.


Sidtype: SID<CF>Not PII
Path Parameter

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

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(conference => console.log(conference.friendlyName));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"api_version": "2010-04-01",
_17
"date_created": "Fri, 18 Feb 2011 19:26:50 +0000",
_17
"date_updated": "Fri, 18 Feb 2011 19:27:33 +0000",
_17
"friendly_name": "AHH YEAH",
_17
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"region": "us1",
_17
"status": "completed",
_17
"subresource_uris": {
_17
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_17
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_17
},
_17
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_17
"reason_conference_ended": "last-participant-left",
_17
"call_sid_ending_conference": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_17
}


Read multiple Conference resources

read-multiple-conference-resources page anchor
GET 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.

URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the Conference resource(s) to read.


DateCreatedtype: string<DATE>Not PII
Query Parameter

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.


DateCreated<type: string<DATE>Not PII
Query Parameter

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.


DateCreated>type: string<DATE>Not PII
Query Parameter

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.


DateUpdatedtype: string<DATE>Not PII
Query Parameter

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.


DateUpdated<type: string<DATE>Not PII
Query Parameter

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.


DateUpdated>type: string<DATE>Not PII
Query Parameter

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.


FriendlyNametype: stringNot PII
Query Parameter

The string that identifies the Conference resources to read.


Statustype: enum<STRING>Not PII
Query Parameter

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

Possible values:
initin-progresscompleted

PageSizetype: integerNot PII
Query Parameter

How many resources to return in each list page. The default is 50, and the maximum is 1000.


Pagetype: integerNot PII
Query Parameter

The page index. This value is simply for client state.


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

Read multiple Conference resources

read-multiple-conference-resources-1 page anchor

Returns the list of all Conferences in the account

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences.list({limit: 20})
_10
.then(conferences => conferences.forEach(c => console.log(c.sid)));

Output

_63
{
_63
"conferences": [
_63
{
_63
"status": "in-progress",
_63
"region": "jp1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Fri, 03 Jul 2020 11:23:45 +0000",
_63
"date_created": "Fri, 03 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "friendly_name",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "in-progress",
_63
"region": "de1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Thu, 02 Jul 2020 11:23:45 +0000",
_63
"date_created": "Thu, 02 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "completed",
_63
"region": "br1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Wed, 01 Jul 2020 11:23:45 +0000",
_63
"date_created": "Wed, 01 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "FRIEND",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": "participant-with-end-conference-on-exit-left",
_63
"call_sid_ending_conference": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_63
}
_63
],
_63
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?PageSize=3&Page=0",
_63
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?PageSize=3&Page=1&PageToken=PACFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?PageSize=3&Page=0",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?PageSize=3&Page=0",
_63
"page": 0,
_63
"page_size": 3,
_63
"start": 0,
_63
"end": 2
_63
}

Read the conferences that started on a specific date

read-the-conferences-that-started-on-a-specific-date page anchor

Returns a list of conferences that started on July 07, 2020

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences
_10
.list({dateCreated: new Date(Date.UTC(2020, 6, 7)), limit: 20})
_10
.then(conferences => conferences.forEach(c => console.log(c.sid)));

Output

_63
{
_63
"conferences": [
_63
{
_63
"status": "in-progress",
_63
"region": "jp1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "friendly_name",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "in-progress",
_63
"region": "de1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "completed",
_63
"region": "br1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "FRIEND",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": "participant-with-end-conference-on-exit-left",
_63
"call_sid_ending_conference": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_63
}
_63
],
_63
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0",
_63
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0",
_63
"page": 0,
_63
"page_size": 3,
_63
"start": 0,
_63
"end": 2
_63
}

Read the in-progress conferences that were created on or after a specific date

read-the-in-progress-conferences-that-were-created-on-or-after-a-specific-date page anchor

Returns a list of in-progress conferences that started on or after midnight on January 1, 2021

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = require('twilio')(accountSid, authToken);
_14
_14
client.conferences
_14
.list({
_14
dateCreatedAfter: new Date(Date.UTC(2021, 0, 1)),
_14
status: 'in-progress',
_14
limit: 20
_14
})
_14
.then(conferences => conferences.forEach(c => console.log(c.sid)));

Output

_63
{
_63
"conferences": [
_63
{
_63
"status": "in-progress",
_63
"region": "jp1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "friendly_name",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "in-progress",
_63
"region": "de1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "in-progress",
_63
"region": "br1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "FRIEND",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
}
_63
],
_63
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0",
_63
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=20",
_63
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0",
_63
"page": 0,
_63
"page_size": 20,
_63
"start": 0,
_63
"end": 2
_63
}

Read the conferences named "MyRoom"

read-the-conferences-named-myroom page anchor

Returns the conferences named 'MyRoom'

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences.list({friendlyName: 'MyRoom', limit: 20})
_10
.then(conferences => conferences.forEach(c => console.log(c.sid)));

Output

_63
{
_63
"conferences": [
_63
{
_63
"status": "in-progress",
_63
"region": "jp1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Sun, 03 Jan 2021 11:23:45 +0000",
_63
"date_created": "Sun, 03 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": null,
_63
"call_sid_ending_conference": null
_63
},
_63
{
_63
"status": "completed",
_63
"region": "us1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Sat, 02 Jan 2021 11:23:45 +0000",
_63
"date_created": "Sat, 02 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": "last-participant-left",
_63
"call_sid_ending_conference": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_63
},
_63
{
_63
"status": "completed",
_63
"region": "ie1",
_63
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
_63
"subresource_uris": {
_63
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_63
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_63
},
_63
"friendly_name": "MyRoom",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_63
"api_version": "2010-04-01",
_63
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_63
"reason_conference_ended": "last-participant-left",
_63
"call_sid_ending_conference": "CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_63
}
_63
],
_63
"first_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0",
_63
"next_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=20",
_63
"previous_page_uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0",
_63
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0",
_63
"page": 0,
_63
"page_size": 20,
_63
"start": 0,
_63
"end": 2
_63
}


Update a Conference resource

update-a-conference-resource page anchor
POST 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.

URI parameters
AccountSidtype: SID<AC>Not PII
Path Parameter

The SID of the Account(link takes you to an external page) that created the Conference resource(s) to update.


Sidtype: stringNot PII
Path Parameter

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


Request body parameters
Statustype: enum<STRING>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

Possible values:
completed

AnnounceUrltype: string<URI>Not PII

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 <Play>, <Say>, <Pause>, or <Redirect> verbs.


AnnounceMethodtype: enum<HTTP METHOD>Not PII

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

Possible values:
HEADGETPOSTPATCHPUTDELETE

Update a conference to end it

update-a-conference-to-end-it page anchor

End this conference by setting its status to 'completed'

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({status: 'completed'})
_10
.then(conference => console.log(conference.friendlyName));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"api_version": "2010-04-01",
_17
"date_created": "Mon, 22 Aug 2011 20:58:45 +0000",
_17
"date_updated": "Mon, 22 Aug 2011 20:58:46 +0000",
_17
"friendly_name": null,
_17
"region": "us1",
_17
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"status": "completed",
_17
"subresource_uris": {
_17
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_17
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_17
},
_17
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_17
"reason_conference_ended": "conference-ended-via-api",
_17
"call_sid_ending_conference": null
_17
}

Update a conference to announce something

update-a-conference-to-announce-something page anchor

Include the AnnounceUrl parameter to play something for your conference participants

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conferences('CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({announceUrl: 'http://www.myapp.com/announce'})
_10
.then(conference => console.log(conference.friendlyName));

Output

_17
{
_17
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"api_version": "2010-04-01",
_17
"date_created": "Mon, 08 Feb 2021 20:58:45 +0000",
_17
"date_updated": "Mon, 08 Feb 2021 20:58:46 +0000",
_17
"friendly_name": "MyRoom",
_17
"region": "us1",
_17
"sid": "CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_17
"status": "in-progress",
_17
"subresource_uris": {
_17
"participants": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Participants.json",
_17
"recordings": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Recordings.json"
_17
},
_17
"uri": "/2010-04-01/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Conferences/CFXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.json",
_17
"reason_conference_ended": null,
_17
"call_sid_ending_conference": null
_17
}


Manage conference participants

manage-conference-participants page anchor

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:


_10
GET 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.)


_10
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.


Conference Log Retention

conference-log-retention page anchor

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(link takes you to an external page) and Participant(link takes you to an external page) 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.


Rate this page: