Twilio. Conferences. Recordings
(twilio v0.2.0)
Copy Markdown
API calls: delete, list, retrieve, update.
Summary
Functions
Delete a recording from your account
Like delete/3, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of recordings belonging to the call used to make the request
Like list/3, but returns the result or raises Infusion.Runtime.Error.
Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.ConferenceRecording.t() that fetches pages as it is read.
Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.
Fetch an instance of a recording for a call
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.
Changes the status of the recording to paused, stopped, or in-progress. Note: To use Twilio.CURRENT, pass it as recording sid.
Like update/4, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec delete(String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Delete a recording from your account
DELETE /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
Path parameters
conference_sid(required) - The Conference SID that identifies the conference associated with the recording to delete.sid(required) - The Twilio-provided string that uniquely identifies the Conference Recording resource to delete.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/3, but returns the result or raises Infusion.Runtime.Error.
@spec list(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.ConferencesRecordingsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of recordings belonging to the call used to make the request
GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json
Path parameters
conference_sid(required) - The Conference SID that identifies the conference associated with the recording to read.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
date_created- Thedate_createdvalue, specified asYYYY-MM-DD, of the resources to read. You can also specify inequality:DateCreated<=YYYY-MM-DDwill return recordings generated at or before midnight on a given date, andDateCreated>=YYYY-MM-DDreturns recordings generated at or after midnight on a date.date_created_query- Thedate_createdvalue, specified asYYYY-MM-DD, of the resources to read. You can also specify inequality:DateCreated<=YYYY-MM-DDwill return recordings generated at or before midnight on a given date, andDateCreated>=YYYY-MM-DDreturns recordings generated at or after midnight on a date.date_created_query_2- Thedate_createdvalue, specified asYYYY-MM-DD, of the resources to read. You can also specify inequality:DateCreated<=YYYY-MM-DDwill return recordings generated at or before midnight on a given date, andDateCreated>=YYYY-MM-DDreturns recordings generated at or after midnight on a date.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!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.ConferencesRecordingsListResponse.t()
Like list/3, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(String.t(), map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/3, but returns every item, from every page: a lazy stream of Twilio.Schemas.ConferenceRecording.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!(String.t(), map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), String.t(), keyword()) :: {:ok, Twilio.Schemas.ConferenceRecording.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of a recording for a call
GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
Path parameters
conference_sid(required) - The Conference SID that identifies the conference associated with the recording to fetch.sid(required) - The Twilio-provided string that uniquely identifies the Conference Recording 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(), String.t(), keyword()) :: Twilio.Schemas.ConferenceRecording.t()
Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.ConferenceRecording.t()} | {:error, Infusion.Runtime.Error.t()}
Changes the status of the recording to paused, stopped, or in-progress. Note: To use Twilio.CURRENT, pass it as recording sid.
POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
Path parameters
conference_sid(required) - The Conference SID that identifies the conference associated with the recording to update.sid(required) - The Twilio-provided string that uniquely identifies the Conference Recording resource to update. UseTwilio.CURRENTto reference the current active recording.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
pause_behavior- Whether to record during a pause. Can be:skiporsilenceand the default issilence.skipdoes not record during the pause period, whilesilencewill replace the actual audio of the call with silence during the pause period. This parameter only applies when settingstatusis set topaused.status(required)
@spec update!(String.t(), String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.ConferenceRecording.t()
Like update/4, but returns the result or raises Infusion.Runtime.Error.