Skip to content

Latest commit

 

History

History
429 lines (245 loc) · 23.7 KB

Api20100401RecordingApi.md

File metadata and controls

429 lines (245 loc) · 23.7 KB

\Api20100401RecordingApi

All URIs are relative to https://api.twilio.com

Method HTTP request Description
create_call_recording POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json
delete_call_recording DELETE /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json
delete_conference_recording DELETE /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
delete_recording DELETE /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
fetch_call_recording GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json
fetch_conference_recording GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json
fetch_recording GET /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json
list_call_recording GET /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json
list_conference_recording GET /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json
list_recording GET /2010-04-01/Accounts/{AccountSid}/Recordings.json
update_call_recording POST /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json
update_conference_recording POST /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json

create_call_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording create_call_recording(account_sid, call_sid, recording_status_callback_event, recording_status_callback, recording_status_callback_method, trim, recording_channels, recording_track)

Create a recording for the call

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that will create the resource. [required]
call_sid String The SID of the Call to associate the resource with. [required]
recording_status_callback_event Option<Vec> The recording status events on which we should call the recording_status_callback URL. Can be: in-progress, completed and absent and the default is completed. Separate multiple event values with a space.
recording_status_callback Option<String> The URL we should call using the recording_status_callback_method on each recording event specified in recording_status_callback_event. For more information, see RecordingStatusCallback parameters.
recording_status_callback_method Option<String> The HTTP method we should use to call recording_status_callback. Can be: GET or POST and the default is POST.
trim Option<String> Whether to trim any leading and trailing silence in the recording. Can be: trim-silence or do-not-trim and the default is do-not-trim. trim-silence trims the silence from the beginning and end of the recording and do-not-trim does not.
recording_channels Option<String> The number of channels used in the recording. Can be: mono or dual and the default is mono. mono records all parties of the call into one channel. dual records each party of a 2-party call into separate channels.
recording_track Option<String> The audio track to record for the call. Can be: inbound, outbound or both. The default is both. inbound records the audio that is received by Twilio. outbound records the audio that is generated from Twilio. both records the audio that is received and generated by Twilio.

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_call_recording

delete_call_recording(account_sid, call_sid, sid)

Delete a recording from your account

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resources to delete. [required]
call_sid String The Call SID of the resources to delete. [required]
sid String The Twilio-provided string that uniquely identifies the Recording resource to delete. [required]

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_conference_recording

delete_conference_recording(account_sid, conference_sid, sid)

Delete a recording from your account

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Conference Recording resources to delete. [required]
conference_sid String The Conference SID that identifies the conference associated with the recording to delete. [required]
sid String The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. [required]

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_recording

delete_recording(account_sid, sid)

Delete a recording from your account

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resources to delete. [required]
sid String The Twilio-provided string that uniquely identifies the Recording resource to delete. [required]

Return type

(empty response body)

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_call_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording fetch_call_recording(account_sid, call_sid, sid)

Fetch an instance of a recording for a call

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resource to fetch. [required]
call_sid String The Call SID of the resource to fetch. [required]
sid String The Twilio-provided string that uniquely identifies the Recording resource to fetch. [required]

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_conference_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodConferencePeriodConferenceRecording fetch_conference_recording(account_sid, conference_sid, sid)

Fetch an instance of a recording for a call

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Conference Recording resource to fetch. [required]
conference_sid String The Conference SID that identifies the conference associated with the recording to fetch. [required]
sid String The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. [required]

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodConferencePeriodConferenceRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodRecording fetch_recording(account_sid, sid, include_soft_deleted)

Fetch an instance of a recording

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resource to fetch. [required]
sid String The Twilio-provided string that uniquely identifies the Recording resource to fetch. [required]
include_soft_deleted Option<bool> 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.

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_call_recording

crate::models::ListCallRecordingResponse list_call_recording(account_sid, call_sid, date_created, date_created_less_than, date_created_greater_than, page_size, page, page_token)

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

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resources to read. [required]
call_sid String The Call SID of the resources to read. [required]
date_created Option<String> 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_less_than Option<String> 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_greater_than Option<String> 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 Option<i32> How many resources to return in each list page. The default is 50, and the maximum is 1000.
page Option<i32> The page index. This value is simply for client state.
page_token Option<String> The page token. This is provided by the API.

Return type

crate::models::ListCallRecordingResponse

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_conference_recording

crate::models::ListConferenceRecordingResponse list_conference_recording(account_sid, conference_sid, date_created, date_created_less_than, date_created_greater_than, page_size, page, page_token)

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

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Conference Recording resources to read. [required]
conference_sid String The Conference SID that identifies the conference associated with the recording to read. [required]
date_created Option<String> 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_less_than Option<String> 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_greater_than Option<String> 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 Option<i32> How many resources to return in each list page. The default is 50, and the maximum is 1000.
page Option<i32> The page index. This value is simply for client state.
page_token Option<String> The page token. This is provided by the API.

Return type

crate::models::ListConferenceRecordingResponse

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_recording

crate::models::ListRecordingResponse list_recording(account_sid, date_created, date_created_less_than, date_created_greater_than, call_sid, conference_sid, include_soft_deleted, page_size, page, page_token)

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

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resources to read. [required]
date_created Option<String> Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
date_created_less_than Option<String> Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
date_created_greater_than Option<String> Only include recordings that were created on this date. Specify a date as YYYY-MM-DD in GMT, for example: 2009-07-06, to read recordings that were created on this date. You can also specify an inequality, such as DateCreated<=YYYY-MM-DD, to read recordings that were created on or before midnight of this date, and DateCreated>=YYYY-MM-DD to read recordings that were created on or after midnight of this date.
call_sid Option<String> The Call SID of the resources to read.
conference_sid Option<String> The Conference SID that identifies the conference associated with the recording to read.
include_soft_deleted Option<bool> 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 Option<i32> How many resources to return in each list page. The default is 50, and the maximum is 1000.
page Option<i32> The page index. This value is simply for client state.
page_token Option<String> The page token. This is provided by the API.

Return type

crate::models::ListRecordingResponse

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_call_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording update_call_recording(account_sid, call_sid, sid, status, pause_behavior)

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.

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Recording resource to update. [required]
call_sid String The Call SID of the resource to update. [required]
sid String The Twilio-provided string that uniquely identifies the Recording resource to update. [required]
status crate::models::CallRecordingEnumStatus [required]
pause_behavior Option<String> 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.

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodCallPeriodCallRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_conference_recording

crate::models::ApiPeriodV2010PeriodAccountPeriodConferencePeriodConferenceRecording update_conference_recording(account_sid, conference_sid, sid, status, pause_behavior)

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

Parameters

Name Type Description Required Notes
account_sid String The SID of the Account that created the Conference Recording resource to update. [required]
conference_sid String The Conference SID that identifies the conference associated with the recording to update. [required]
sid String The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use Twilio.CURRENT to reference the current active recording. [required]
status crate::models::ConferenceRecordingEnumStatus [required]
pause_behavior Option<String> 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.

Return type

crate::models::ApiPeriodV2010PeriodAccountPeriodConferencePeriodConferenceRecording

Authorization

accountSid_authToken

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]