Twilio.Conferences.Recordings (twilio v0.2.0)

Copy Markdown

API calls: delete, list, retrieve, update.

Summary

Functions

Delete a recording from your account

Retrieve a list of recordings belonging to the call used to make the request

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.

Fetch an instance of a recording for a call

Changes the status of the recording to paused, stopped, or in-progress. Note: To use Twilio.CURRENT, pass it as recording sid.

Functions

delete(conference_sid, sid, opts \\ [])

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

delete!(conference_sid, sid, opts \\ [])

@spec delete!(String.t(), String.t(), keyword()) :: nil

Like delete/3, but returns the result or raises Infusion.Runtime.Error.

list(conference_sid, params \\ %{}, opts \\ [])

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 - The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
  • date_created_query - The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns recordings generated at or after midnight on a date.
  • date_created_query_2 - The date_created value, specified as YYYY-MM-DD, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD returns 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.

list!(conference_sid, params \\ %{}, opts \\ [])

Like list/3, but returns the result or raises Infusion.Runtime.Error.

list_all(conference_sid, params \\ %{}, opts \\ [])

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

list_all!(conference_sid, params \\ %{}, opts \\ [])

@spec list_all!(String.t(), map() | keyword(), keyword()) :: Enumerable.t()

Like list_all/3, but returns the stream or raises Infusion.Runtime.Error.

retrieve(conference_sid, sid, opts \\ [])

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

retrieve!(conference_sid, sid, opts \\ [])

Like retrieve/3, but returns the result or raises Infusion.Runtime.Error.

update(conference_sid, sid, params \\ %{}, opts \\ [])

@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. Use Twilio.CURRENT to 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: skip or silence and the default is silence. skip does not record during the pause period, while silence will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status is set to paused.
  • status (required)

update!(conference_sid, sid, params \\ %{}, opts \\ [])

Like update/4, but returns the result or raises Infusion.Runtime.Error.