Twilio. Calls. Recordings
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve, update.
Summary
Functions
Create a recording for the call
Like create/3, but returns the result or raises Infusion.Runtime.Error.
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.CallRecording.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: Pass Twilio.CURRENT instead of recording sid to reference current active recording.
Like update/4, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.CallRecording.t()} | {:error, Infusion.Runtime.Error.t()}
Create a recording for the call
POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json
Path parameters
call_sid(required) - The SID of the Call to associate the resource with.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
recording_channels- The number of channels used in the recording. Can be:monoordualand the default ismono.monorecords all parties of the call into one channel.dualrecords each party of a 2-party call into separate channels.recording_configuration_id- The identifier of the configuration to be used when creating and processing the recordingrecording_status_callback- The URL we should call using therecording_status_callback_methodon each recording event specified inrecording_status_callback_event. For more information, see RecordingStatusCallback parameters.recording_status_callback_event- The recording status events on which we should call therecording_status_callbackURL. Can be:in-progress,completedandabsentand the default iscompleted. Separate multiple event values with a space.recording_status_callback_method- The HTTP method we should use to callrecording_status_callback. Can be:GETorPOSTand the default isPOST.recording_track- The audio track to record for the call. Can be:inbound,outboundorboth. The default isboth.inboundrecords the audio that is received by Twilio.outboundrecords the audio that is generated from Twilio.bothrecords the audio that is received and generated by Twilio.trim- Whether to trim any leading and trailing silence in the recording. Can be:trim-silenceordo-not-trimand the default isdo-not-trim.trim-silencetrims the silence from the beginning and end of the recording anddo-not-trimdoes not.
@spec create!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.CallRecording.t()
Like create/3, but returns the result or raises Infusion.Runtime.Error.
@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}/Calls/{CallSid}/Recordings/{Sid}.json
Path parameters
call_sid(required) - The Call SID of the resources to delete.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/3, but returns the result or raises Infusion.Runtime.Error.
@spec list(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.CallsRecordingsListResponse.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}/Calls/{CallSid}/Recordings.json
Path parameters
call_sid(required) - The Call SID of the resources 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.CallsRecordingsListResponse.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.CallRecording.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.CallRecording.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an instance of a recording for a call
GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json
Path parameters
call_sid(required) - The Call SID of the resource to fetch.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.
@spec retrieve!(String.t(), String.t(), keyword()) :: Twilio.Schemas.CallRecording.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.CallRecording.t()} | {:error, Infusion.Runtime.Error.t()}
Changes the status of the recording to paused, stopped, or in-progress. Note: Pass Twilio.CURRENT instead of recording sid to reference current active recording.
POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json
Path parameters
call_sid(required) - The Call SID of the resource to update.sid(required) - The Twilio-provided string that uniquely identifies the Recording resource to update.
{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.CallRecording.t()
Like update/4, but returns the result or raises Infusion.Runtime.Error.