Skip to content Skip to navigation Skip to topbar

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

Property nameTypeRequiredDescriptionChild properties

account_sidSID<AC>Optional

Not PII

The SID of the Account that created this Conference resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_createdstring<date-time-rfc-2822>Optional

Not PII

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

date_updatedstring<date-time-rfc-2822>Optional

Not PII

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

api_versionstringOptional

Not PII

The API version used to create this conference.

friendly_namestringOptional

Not PII

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

regionstringOptional

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.

sidSID<CF>Optional

Not PII

The unique, Twilio-provided string used to identify this Conference resource.

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

statusenum<string>Optional

Not PII

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

Possible values:

initin-progresscompleted

uristringOptional

Not PII

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

subresource_urisobject<uri-map>Optional

Not PII

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

reason_conference_endedenum<string>Optional

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_conferenceSID<CA>Optional

Not PII

The call SID that caused the conference to end.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

(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

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.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<CF>required

Not PII

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

Pattern: ^CF[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a Conference resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchConference() {
11  const conference = await client
12    .conferences("CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(conference.accountSid);
16}
17
18fetchConference();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "api_version": "2010-04-01",
4  "date_created": "Fri, 18 Feb 2011 19:26:50 +0000",
5  "date_updated": "Fri, 18 Feb 2011 19:27:33 +0000",
6  "friendly_name": "AHH YEAH",
7  "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8  "region": "us1",
9  "status": "completed",
10  "subresource_uris": {
11    "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
12    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
13  },
14  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15  "reason_conference_ended": "last-participant-left",
16  "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
17}

Read multiple Conference resources

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.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

DateCreatedstring<date>Optional

Not PII

Only include conferences that were created on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read conferences that were created on or after midnight of this date.

DateCreated<string<date>Optional

Not PII

DateCreated>string<date>Optional

Not PII

DateUpdatedstring<date>Optional

Not PII

Only include conferences that were last updated on this date. Specify a date as YYYY-MM-DD in UTC, for example: 2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such as DateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, and DateUpdated>=YYYY-MM-DD to read conferences that were last updated on or after midnight of this date.

DateUpdated<string<date>Optional

Not PII

DateUpdated>string<date>Optional

Not PII

FriendlyNamestringOptional

Not PII

The string that identifies the Conference resources to read.

Statusenum<string>Optional

Not PII

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

Possible values:

initin-progresscompleted

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Read multiple Conference resources

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConference() {
11  const conferences = await client.conferences.list({ limit: 20 });
12
13  conferences.forEach((c) => console.log(c.accountSid));
14}
15
16listConference();

Output

1{
2  "conferences": [
3    {
4      "status": "in-progress",
5      "region": "jp1",
6      "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "date_updated": "Fri, 03 Jul 2020 11:23:45 +0000",
8      "date_created": "Fri, 03 Jul 2020 11:23:45 +0000",
9      "subresource_uris": {
10        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
11        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
12      },
13      "friendly_name": "friendly_name",
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15      "api_version": "2010-04-01",
16      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "reason_conference_ended": null,
18      "call_sid_ending_conference": null
19    },
20    {
21      "status": "in-progress",
22      "region": "de1",
23      "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
24      "date_updated": "Thu, 02 Jul 2020 11:23:45 +0000",
25      "date_created": "Thu, 02 Jul 2020 11:23:45 +0000",
26      "subresource_uris": {
27        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json",
28        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json"
29      },
30      "friendly_name": "MyRoom",
31      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json",
32      "api_version": "2010-04-01",
33      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
34      "reason_conference_ended": null,
35      "call_sid_ending_conference": null
36    },
37    {
38      "status": "completed",
39      "region": "br1",
40      "sid": "CFcccccccccccccccccccccccccccccccc",
41      "date_updated": "Wed, 01 Jul 2020 11:23:45 +0000",
42      "date_created": "Wed, 01 Jul 2020 11:23:45 +0000",
43      "subresource_uris": {
44        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json",
45        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json"
46      },
47      "friendly_name": "FRIEND",
48      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json",
49      "api_version": "2010-04-01",
50      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51      "reason_conference_ended": "participant-with-end-conference-on-exit-left",
52      "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
53    }
54  ],
55  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0",
56  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc",
57  "previous_page_uri": null,
58  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?PageSize=3&Page=0",
59  "page": 0,
60  "page_size": 3,
61  "start": 0,
62  "end": 2
63}

Read the conferences that started on a specific date

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConference() {
11  const conferences = await client.conferences.list({
12    dateCreated: "2020-07-07",
13    limit: 20,
14  });
15
16  conferences.forEach((c) => console.log(c.accountSid));
17}
18
19listConference();

Output

1{
2  "conferences": [
3    {
4      "status": "in-progress",
5      "region": "jp1",
6      "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
8      "date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
9      "subresource_uris": {
10        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
11        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
12      },
13      "friendly_name": "friendly_name",
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15      "api_version": "2010-04-01",
16      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "reason_conference_ended": null,
18      "call_sid_ending_conference": null
19    },
20    {
21      "status": "in-progress",
22      "region": "de1",
23      "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
24      "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
25      "date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
26      "subresource_uris": {
27        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json",
28        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json"
29      },
30      "friendly_name": "MyRoom",
31      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json",
32      "api_version": "2010-04-01",
33      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
34      "reason_conference_ended": null,
35      "call_sid_ending_conference": null
36    },
37    {
38      "status": "completed",
39      "region": "br1",
40      "sid": "CFcccccccccccccccccccccccccccccccc",
41      "date_updated": "Tue, 07 Jul 2020 11:23:45 +0000",
42      "date_created": "Tue, 07 Jul 2020 11:23:45 +0000",
43      "subresource_uris": {
44        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json",
45        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json"
46      },
47      "friendly_name": "FRIEND",
48      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json",
49      "api_version": "2010-04-01",
50      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51      "reason_conference_ended": "participant-with-end-conference-on-exit-left",
52      "call_sid_ending_conference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
53    }
54  ],
55  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0",
56  "next_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=1&PageToken=PACFcccccccccccccccccccccccccccccccc",
57  "previous_page_uri": null,
58  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?DateCreated=2020-07-07&PageSize=3&Page=0",
59  "page": 0,
60  "page_size": 3,
61  "start": 0,
62  "end": 2
63}

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

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConference() {
11  const conferences = await client.conferences.list({
12    dateCreatedAfter: "2021-01-01",
13    status: "in-progress",
14    limit: 20,
15  });
16
17  conferences.forEach((c) => console.log(c.accountSid));
18}
19
20listConference();

Output

1{
2  "conferences": [
3    {
4      "status": "in-progress",
5      "region": "jp1",
6      "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
8      "date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
9      "subresource_uris": {
10        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
11        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
12      },
13      "friendly_name": "friendly_name",
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15      "api_version": "2010-04-01",
16      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "reason_conference_ended": null,
18      "call_sid_ending_conference": null
19    },
20    {
21      "status": "in-progress",
22      "region": "de1",
23      "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
24      "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
25      "date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
26      "subresource_uris": {
27        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json",
28        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json"
29      },
30      "friendly_name": "MyRoom",
31      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json",
32      "api_version": "2010-04-01",
33      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
34      "reason_conference_ended": null,
35      "call_sid_ending_conference": null
36    },
37    {
38      "status": "in-progress",
39      "region": "br1",
40      "sid": "CFcccccccccccccccccccccccccccccccc",
41      "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
42      "date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
43      "subresource_uris": {
44        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json",
45        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json"
46      },
47      "friendly_name": "FRIEND",
48      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json",
49      "api_version": "2010-04-01",
50      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51      "reason_conference_ended": null,
52      "call_sid_ending_conference": null
53    }
54  ],
55  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0",
56  "next_page_uri": null,
57  "previous_page_uri": null,
58  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?Status=in-progress&DateCreated%3E=2021-01-01&PageSize=20&Page=0",
59  "page": 0,
60  "page_size": 20,
61  "start": 0,
62  "end": 2
63}

Read the conferences named "MyRoom"

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listConference() {
11  const conferences = await client.conferences.list({
12    friendlyName: "MyRoom",
13    limit: 20,
14  });
15
16  conferences.forEach((c) => console.log(c.accountSid));
17}
18
19listConference();

Output

1{
2  "conferences": [
3    {
4      "status": "in-progress",
5      "region": "jp1",
6      "sid": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7      "date_updated": "Sun, 03 Jan 2021 11:23:45 +0000",
8      "date_created": "Sun, 03 Jan 2021 11:23:45 +0000",
9      "subresource_uris": {
10        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
11        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
12      },
13      "friendly_name": "MyRoom",
14      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15      "api_version": "2010-04-01",
16      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "reason_conference_ended": null,
18      "call_sid_ending_conference": null
19    },
20    {
21      "status": "completed",
22      "region": "us1",
23      "sid": "CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
24      "date_updated": "Sat, 02 Jan 2021 11:23:45 +0000",
25      "date_created": "Sat, 02 Jan 2021 11:23:45 +0000",
26      "subresource_uris": {
27        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Participants.json",
28        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb/Recordings.json"
29      },
30      "friendly_name": "MyRoom",
31      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb.json",
32      "api_version": "2010-04-01",
33      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
34      "reason_conference_ended": "last-participant-left",
35      "call_sid_ending_conference": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
36    },
37    {
38      "status": "completed",
39      "region": "ie1",
40      "sid": "CFcccccccccccccccccccccccccccccccc",
41      "date_updated": "Fri, 01 Jan 2021 11:23:45 +0000",
42      "date_created": "Fri, 01 Jan 2021 11:23:45 +0000",
43      "subresource_uris": {
44        "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Participants.json",
45        "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc/Recordings.json"
46      },
47      "friendly_name": "MyRoom",
48      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFcccccccccccccccccccccccccccccccc.json",
49      "api_version": "2010-04-01",
50      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
51      "reason_conference_ended": "last-participant-left",
52      "call_sid_ending_conference": "CAcccccccccccccccccccccccccccccccc"
53    }
54  ],
55  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0",
56  "next_page_uri": null,
57  "previous_page_uri": null,
58  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences.json?FriendlyName=MyRoom&PageSize=20&Page=0",
59  "page": 0,
60  "page_size": 20,
61  "start": 0,
62  "end": 2
63}

Update a Conference resource

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.

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

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

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

Sidstringrequired

Not PII

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Statusenum<string>Optional

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

AnnounceUrlstring<uri>Optional

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.

AnnounceMethodenum<http-method>Optional

Not PII

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

Possible values:

GETPOST

Update a conference to end it

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateConference() {
11  const conference = await client
12    .conferences("Sid")
13    .update({ status: "completed" });
14
15  console.log(conference.accountSid);
16}
17
18updateConference();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "api_version": "2010-04-01",
4  "date_created": "Mon, 22 Aug 2011 20:58:45 +0000",
5  "date_updated": "Mon, 22 Aug 2011 20:58:46 +0000",
6  "friendly_name": null,
7  "region": "us1",
8  "sid": "Sid",
9  "status": "completed",
10  "subresource_uris": {
11    "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
12    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
13  },
14  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15  "reason_conference_ended": "conference-ended-via-api",
16  "call_sid_ending_conference": null
17}

Update a conference to announce something

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateConference() {
11  const conference = await client
12    .conferences("Sid")
13    .update({ announceUrl: "http://www.myapp.com/announce" });
14
15  console.log(conference.accountSid);
16}
17
18updateConference();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "api_version": "2010-04-01",
4  "date_created": "Mon, 08 Feb 2021 20:58:45 +0000",
5  "date_updated": "Mon, 08 Feb 2021 20:58:46 +0000",
6  "friendly_name": "MyRoom",
7  "region": "us1",
8  "sid": "Sid",
9  "status": "in-progress",
10  "subresource_uris": {
11    "participants": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants.json",
12    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json"
13  },
14  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conferences/CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
15  "reason_conference_ended": null,
16  "call_sid_ending_conference": null
17}

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

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.

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.