Twilio. Recordings
(twilio v0.2.0)
Copy Markdown
API calls: delete, list, retrieve.
Summary
Functions
Delete a recording from your account
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of recordings 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.Recording.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 recording
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec delete(String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Delete a recording from your account
DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Recording resource to delete.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.RecordingsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of recordings belonging to the account used to make the request
GET /2010-04-01/Accounts/{AccountSid}/Recordings.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
date_created- Only include recordings that were created on this date. Specify a date asYYYY-MM-DDin GMT, for example:2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read recordings that were created on or after midnight of this date.date_created_query- Only include recordings that were created on this date. Specify a date asYYYY-MM-DDin GMT, for example:2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read recordings that were created on or after midnight of this date.date_created_query_2- Only include recordings that were created on this date. Specify a date asYYYY-MM-DDin GMT, for example:2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such asDateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, andDateCreated>=YYYY-MM-DDto read recordings that were created on or after midnight of this date.call_sid- The Call SID of the resources to read.conference_sid- The Conference SID that identifies the conference associated with the recording to read.include_soft_deleted- A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.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.RecordingsListResponse.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.Recording.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(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Recording.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of a recording
GET /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Recording resource to fetch.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
include_soft_deleted- A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days.
@spec retrieve!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Recording.t()
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.