Twilio. Conferences
(twilio v0.2.0)
Copy Markdown
API calls: list, retrieve, update.
Summary
Functions
Retrieve a list of conferences belonging to the account used to make the request
Like list/2, but returns the result or raises Infusion.Runtime.Error.
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Conference.t() that fetches pages as it is read.
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
Fetch an instance of a conference
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
POST /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
Like update/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.ConferencesListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of conferences belonging to the account used to make the request
GET /2010-04-01/Accounts/{AccountSid}/Conferences.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
date_created- Only include conferences that were created on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read conferences that were created on or after midnight of this date.date_created_query- Only include conferences that were created on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read conferences that were created on or after midnight of this date.date_created_query_2- Only include conferences that were created on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read conferences that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read conferences that were created on or after midnight of this date.date_updated- Only include conferences that were last updated on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such asDateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, andDateUpdated>=YYYY-MM-DDto read conferences that were last updated on or after midnight of this date.date_updated_query- Only include conferences that were last updated on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such asDateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, andDateUpdated>=YYYY-MM-DDto read conferences that were last updated on or after midnight of this date.date_updated_query_2- Only include conferences that were last updated on this date. Specify a date asYYYY-MM-DDin UTC, for example:2009-07-06, to read only conferences that were last updated on this date. You can also specify an inequality, such asDateUpdated<=YYYY-MM-DD, to read conferences that were last updated on or before midnight of this date, andDateUpdated>=YYYY-MM-DDto read conferences that were last updated on or after midnight of this date.friendly_name- The string that identifies the Conference resources to read.status- The status of the resources to read. Can be:init,in-progress, orcompleted. Starting from September 30th, 2026, the default isin-progress. To read completed conferences, setStatustocompleted.page_size- How many resources to return in each list page. The default is 50, and the maximum is 1000.page- The page index. This value is simply for client state.page_token- The page token. This is provided by the API.
To read every item across all pages, use list_all.
@spec list!(map() | keyword(), keyword()) :: Twilio.Schemas.ConferencesListResponse.t()
Like list/2, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Conference.t() that fetches pages as it is read.
The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.
@spec list_all!(map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), keyword()) :: {:ok, Twilio.Schemas.Conference.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of a conference
GET /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Conference resource to fetch
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.Conference.t()
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Conference.t()} | {:error, Infusion.Runtime.Error.t()}
POST /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Conference resource to update
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
announce_method- The HTTP method used to callannounce_url. Can be:GETorPOSTand the default isPOSTannounce_url- 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.status
@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Conference.t()
Like update/3, but returns the result or raises Infusion.Runtime.Error.