twilio.rest.api.v2010.account.recording package

Submodules

twilio.rest.api.v2010.account.recording.transcription module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/recording/transcription.py:docstring of twilio.rest.api.v2010.account.recording.transcription, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.recording.transcription.TranscriptionContext(version, account_sid, recording_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the TranscriptionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the TranscriptionInstance

Returns:The fetched TranscriptionInstance
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance
class twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance(version, payload, account_sid, recording_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

COMPLETED = 'completed'
FAILED = 'failed'
IN_PROGRESS = 'in-progress'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
api_version
Returns:The API version used to create the transcription
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT that the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT that the resource was last updated
Return type:datetime
delete()[source]

Deletes the TranscriptionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
duration
Returns:The duration of the transcribed audio in seconds.
Return type:unicode
fetch()[source]

Fetch the TranscriptionInstance

Returns:The fetched TranscriptionInstance
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance
price
Returns:The charge for the transcription
Return type:unicode
price_unit
Returns:The currency in which price is measured
Return type:unicode
recording_sid
Returns:The SID that identifies the transcription’s recording
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
status
Returns:The status of the transcription
Return type:TranscriptionInstance.Status
transcription_text
Returns:The text content of the transcription.
Return type:unicode
type
Returns:The transcription type
Return type:unicode
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.recording.transcription.TranscriptionList(version, account_sid, recording_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a TranscriptionContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.recording.transcription.TranscriptionContext
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionContext
get_page(target_url)[source]

Retrieve a specific page of TranscriptionInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of TranscriptionInstance
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionPage
list(limit=None, page_size=None)[source]

Lists TranscriptionInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of TranscriptionInstance records from the API. Request is executed immediately

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of TranscriptionInstance

Return type:

twilio.rest.api.v2010.account.recording.transcription.TranscriptionPage

stream(limit=None, page_size=None)[source]

Streams TranscriptionInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance]

class twilio.rest.api.v2010.account.recording.transcription.TranscriptionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of TranscriptionInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/api/v2010/account/recording/__init__.py:docstring of twilio.rest.api.v2010.account.recording, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.api.v2010.account.recording.RecordingContext(version, account_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

add_on_results

Access the add_on_results

Returns:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultList
Return type:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultList
delete()[source]

Deletes the RecordingInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the RecordingInstance

Returns:The fetched RecordingInstance
Return type:twilio.rest.api.v2010.account.recording.RecordingInstance
transcriptions

Access the transcriptions

Returns:twilio.rest.api.v2010.account.recording.transcription.TranscriptionList
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionList
class twilio.rest.api.v2010.account.recording.RecordingInstance(version, payload, account_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Source[source]

Bases: object

CONFERENCE = 'Conference'
DIALVERB = 'DialVerb'
OUTBOUNDAPI = 'OutboundAPI'
RECORDVERB = 'RecordVerb'
STARTCALLRECORDINGAPI = 'StartCallRecordingAPI'
STARTCONFERENCERECORDINGAPI = 'StartConferenceRecordingAPI'
TRUNKING = 'Trunking'
class Status[source]

Bases: object

ABSENT = 'absent'
COMPLETED = 'completed'
IN_PROGRESS = 'in-progress'
PAUSED = 'paused'
PROCESSING = 'processing'
STOPPED = 'stopped'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
add_on_results

Access the add_on_results

Returns:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultList
Return type:twilio.rest.api.v2010.account.recording.add_on_result.AddOnResultList
api_version
Returns:The API version used during the recording.
Return type:unicode
call_sid
Returns:The SID of the Call the resource is associated with
Return type:unicode
channels
Returns:The number of channels in the final recording file as an integer.
Return type:unicode
conference_sid
Returns:The unique ID for the conference associated with the recording.
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT that the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT that the resource was last updated
Return type:datetime
delete()[source]

Deletes the RecordingInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
duration
Returns:The length of the recording in seconds.
Return type:unicode
encryption_details
Returns:How to decrypt the recording.
Return type:dict
error_code
Returns:More information about why the recording is missing, if status is absent.
Return type:unicode
fetch()[source]

Fetch the RecordingInstance

Returns:The fetched RecordingInstance
Return type:twilio.rest.api.v2010.account.recording.RecordingInstance
price
Returns:The one-time cost of creating the recording.
Return type:unicode
price_unit
Returns:The currency used in the price property.
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
source
Returns:How the recording was created
Return type:RecordingInstance.Source
start_time
Returns:The start time of the recording, given in RFC 2822 format
Return type:datetime
status
Returns:The status of the recording.
Return type:RecordingInstance.Status
subresource_uris
Returns:A list of related resources identified by their relative URIs
Return type:unicode
transcriptions

Access the transcriptions

Returns:twilio.rest.api.v2010.account.recording.transcription.TranscriptionList
Return type:twilio.rest.api.v2010.account.recording.transcription.TranscriptionList
uri
Returns:The URI of the resource, relative to https://api.twilio.com
Return type:unicode
class twilio.rest.api.v2010.account.recording.RecordingList(version, account_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a RecordingContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.api.v2010.account.recording.RecordingContext
Return type:twilio.rest.api.v2010.account.recording.RecordingContext
get_page(target_url)[source]

Retrieve a specific page of RecordingInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of RecordingInstance
Return type:twilio.rest.api.v2010.account.recording.RecordingPage
list(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, call_sid=<object object>, conference_sid=<object object>, limit=None, page_size=None)[source]

Lists RecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • date_created_before (datetime) – Only include recordings that were created on this date
  • date_created (datetime) – Only include recordings that were created on this date
  • date_created_after (datetime) – Only include recordings that were created on this date
  • call_sid (unicode) – The Call SID of the resources to read
  • conference_sid (unicode) – Read by unique Conference SID for the recording
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.recording.RecordingInstance]

page(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, call_sid=<object object>, conference_sid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of RecordingInstance records from the API. Request is executed immediately

Parameters:
  • date_created_before (datetime) – Only include recordings that were created on this date
  • date_created (datetime) – Only include recordings that were created on this date
  • date_created_after (datetime) – Only include recordings that were created on this date
  • call_sid (unicode) – The Call SID of the resources to read
  • conference_sid (unicode) – Read by unique Conference SID for the recording
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of RecordingInstance

Return type:

twilio.rest.api.v2010.account.recording.RecordingPage

stream(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, call_sid=<object object>, conference_sid=<object object>, limit=None, page_size=None)[source]

Streams RecordingInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • date_created_before (datetime) – Only include recordings that were created on this date
  • date_created (datetime) – Only include recordings that were created on this date
  • date_created_after (datetime) – Only include recordings that were created on this date
  • call_sid (unicode) – The Call SID of the resources to read
  • conference_sid (unicode) – Read by unique Conference SID for the recording
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.api.v2010.account.recording.RecordingInstance]

class twilio.rest.api.v2010.account.recording.RecordingPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of RecordingInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.api.v2010.account.recording.RecordingInstance
Return type:twilio.rest.api.v2010.account.recording.RecordingInstance