twilio.rest.api.v2010.account.call package¶
Submodules¶
twilio.rest.api.v2010.account.call.event module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.event.
EventInstance
(version, payload, account_sid, call_sid)[source]¶
-
class
twilio.rest.api.v2010.account.call.event.
EventList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get_page
(target_url)[source]¶ Retrieve a specific page of EventInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of EventInstance Return type: twilio.rest.api.v2010.account.call.event.EventPage
-
list
(limit=None, page_size=None)[source]¶ Lists EventInstance 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.call.event.EventInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of EventInstance records from the API. Request is executed immediately
Parameters: Returns: Page of EventInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams EventInstance 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.call.event.EventInstance]
-
-
class
twilio.rest.api.v2010.account.call.event.
EventPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of EventInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.event.EventInstance Return type: twilio.rest.api.v2010.account.call.event.EventInstance
-
twilio.rest.api.v2010.account.call.feedback module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.feedback.
FeedbackContext
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
create
(quality_score, issue=<object object>)[source]¶ Create the FeedbackInstance
Parameters: - quality_score (unicode) – The call quality expressed as an integer from 1 to 5
- issue (list[FeedbackInstance.Issues]) – Issues experienced during the call
Returns: The created FeedbackInstance
Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
fetch
()[source]¶ Fetch the FeedbackInstance
Returns: The fetched FeedbackInstance Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
update
(quality_score=<object object>, issue=<object object>)[source]¶ Update the FeedbackInstance
Parameters: - quality_score (unicode) – The call quality expressed as an integer from 1 to 5
- issue (list[FeedbackInstance.Issues]) – Issues experienced during the call
Returns: The updated FeedbackInstance
Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
-
class
twilio.rest.api.v2010.account.call.feedback.
FeedbackInstance
(version, payload, account_sid, call_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Issues
[source]¶ Bases:
object
-
AUDIO_LATENCY
= 'audio-latency'¶
-
DIGITS_NOT_CAPTURED
= 'digits-not-captured'¶
-
DROPPED_CALL
= 'dropped-call'¶
-
IMPERFECT_AUDIO
= 'imperfect-audio'¶
-
INCORRECT_CALLER_ID
= 'incorrect-caller-id'¶
-
ONE_WAY_AUDIO
= 'one-way-audio'¶
-
POST_DIAL_DELAY
= 'post-dial-delay'¶
-
UNSOLICITED_CALL
= 'unsolicited-call'¶
-
-
account_sid
¶ Returns: The unique sid that identifies this account Return type: unicode
-
create
(quality_score, issue=<object object>)[source]¶ Create the FeedbackInstance
Parameters: - quality_score (unicode) – The call quality expressed as an integer from 1 to 5
- issue (list[FeedbackInstance.Issues]) – Issues experienced during the call
Returns: The created FeedbackInstance
Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
date_created
¶ Returns: The date this resource was created Return type: datetime
-
date_updated
¶ Returns: The date this resource was last updated Return type: datetime
-
fetch
()[source]¶ Fetch the FeedbackInstance
Returns: The fetched FeedbackInstance Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
issues
¶ Returns: Issues experienced during the call Return type: list[FeedbackInstance.Issues]
-
quality_score
¶ Returns: 1 to 5 quality score Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this feedback resource Return type: unicode
-
update
(quality_score=<object object>, issue=<object object>)[source]¶ Update the FeedbackInstance
Parameters: - quality_score (unicode) – The call quality expressed as an integer from 1 to 5
- issue (list[FeedbackInstance.Issues]) – Issues experienced during the call
Returns: The updated FeedbackInstance
Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
class
-
class
twilio.rest.api.v2010.account.call.feedback.
FeedbackList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a FeedbackContext
Returns: twilio.rest.api.v2010.account.call.feedback.FeedbackContext Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackContext
-
-
class
twilio.rest.api.v2010.account.call.feedback.
FeedbackPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of FeedbackInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackInstance
-
twilio.rest.api.v2010.account.call.feedback_summary module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.feedback_summary.
FeedbackSummaryContext
(version, account_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the FeedbackSummaryInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the FeedbackSummaryInstance
Returns: The fetched FeedbackSummaryInstance Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryInstance
-
-
class
twilio.rest.api.v2010.account.call.feedback_summary.
FeedbackSummaryInstance
(version, payload, account_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Status
[source]¶ Bases:
object
-
COMPLETED
= 'completed'¶
-
FAILED
= 'failed'¶
-
IN_PROGRESS
= 'in-progress'¶
-
QUEUED
= 'queued'¶
-
-
account_sid
¶ Returns: The unique sid that identifies this account Return type: unicode
-
call_count
¶ Returns: The total number of calls Return type: unicode
-
call_feedback_count
¶ Returns: The total number of calls with a feedback entry Return type: unicode
-
date_created
¶ Returns: The date this resource was created Return type: datetime
-
date_updated
¶ Returns: The date this resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the FeedbackSummaryInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
end_date
¶ Returns: The latest feedback entry date in the summary Return type: date
-
fetch
()[source]¶ Fetch the FeedbackSummaryInstance
Returns: The fetched FeedbackSummaryInstance Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryInstance
-
quality_score_average
¶ Returns: The average QualityScore of the feedback entries Return type: unicode
-
quality_score_median
¶ Returns: The median QualityScore of the feedback entries Return type: unicode
-
quality_score_standard_deviation
¶ Returns: The standard deviation of the quality scores Return type: unicode
-
sid
¶ Returns: A string that uniquely identifies this feedback entry Return type: unicode
-
start_date
¶ Returns: The earliest feedback entry date in the summary Return type: date
-
status
¶ Returns: The status of the feedback summary Return type: FeedbackSummaryInstance.Status
-
class
-
class
twilio.rest.api.v2010.account.call.feedback_summary.
FeedbackSummaryList
(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(start_date, end_date, include_subaccounts=<object object>, status_callback=<object object>, status_callback_method=<object object>)[source]¶ Create the FeedbackSummaryInstance
Parameters: - start_date (date) – Only include feedback given on or after this date
- end_date (date) – Only include feedback given on or before this date
- include_subaccounts (bool) – true includes feedback from the specified account and its subaccounts
- status_callback (unicode) – The URL that we will request when the feedback summary is complete
- status_callback_method (unicode) – The HTTP method we use to make requests to the StatusCallback URL
Returns: The created FeedbackSummaryInstance
Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryInstance
-
get
(sid)[source]¶ Constructs a FeedbackSummaryContext
Parameters: sid – A string that uniquely identifies this feedback summary resource Returns: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryContext Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryContext
-
-
class
twilio.rest.api.v2010.account.call.feedback_summary.
FeedbackSummaryPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of FeedbackSummaryInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryInstance Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryInstance
-
twilio.rest.api.v2010.account.call.notification module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.notification.
NotificationContext
(version, account_sid, call_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
()[source]¶ Fetch the NotificationInstance
Returns: The fetched NotificationInstance Return type: twilio.rest.api.v2010.account.call.notification.NotificationInstance
-
-
class
twilio.rest.api.v2010.account.call.notification.
NotificationInstance
(version, payload, account_sid, call_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
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 Call Notification resource Return type: unicode
-
call_sid
¶ Returns: The SID of the Call the resource is associated with 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
-
error_code
¶ Returns: A unique error code corresponding to the notification Return type: unicode
-
fetch
()[source]¶ Fetch the NotificationInstance
Returns: The fetched NotificationInstance Return type: twilio.rest.api.v2010.account.call.notification.NotificationInstance
-
log
¶ Returns: An integer log level Return type: unicode
-
message_date
¶ Returns: The date the notification was generated Return type: datetime
-
message_text
¶ Returns: The text of the notification Return type: unicode
-
more_info
¶ Returns: A URL for more information about the error code Return type: unicode
-
request_method
¶ Returns: HTTP method used with the request url Return type: unicode
-
request_url
¶ Returns: URL of the resource that generated the notification Return type: unicode
-
request_variables
¶ Returns: Twilio-generated HTTP variables sent to the server Return type: unicode
-
response_body
¶ Returns: The HTTP body returned by your server Return type: unicode
-
response_headers
¶ Returns: The HTTP headers returned by your server Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource 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.call.notification.
NotificationList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(sid)[source]¶ Constructs a NotificationContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.api.v2010.account.call.notification.NotificationContext Return type: twilio.rest.api.v2010.account.call.notification.NotificationContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of NotificationInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of NotificationInstance Return type: twilio.rest.api.v2010.account.call.notification.NotificationPage
-
list
(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, limit=None, page_size=None)[source]¶ Lists NotificationInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - log (unicode) – Filter by log level
- message_date_before (date) – Filter by date
- message_date (date) – Filter by date
- message_date_after (date) – Filter by date
- 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.call.notification.NotificationInstance]
-
page
(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of NotificationInstance records from the API. Request is executed immediately
Parameters: - log (unicode) – Filter by log level
- message_date_before (date) – Filter by date
- message_date (date) – Filter by date
- message_date_after (date) – Filter by date
- 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 NotificationInstance
Return type: twilio.rest.api.v2010.account.call.notification.NotificationPage
-
stream
(log=<object object>, message_date_before=<object object>, message_date=<object object>, message_date_after=<object object>, limit=None, page_size=None)[source]¶ Streams NotificationInstance 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: - log (unicode) – Filter by log level
- message_date_before (date) – Filter by date
- message_date (date) – Filter by date
- message_date_after (date) – Filter by date
- 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.call.notification.NotificationInstance]
-
-
class
twilio.rest.api.v2010.account.call.notification.
NotificationPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of NotificationInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.notification.NotificationInstance Return type: twilio.rest.api.v2010.account.call.notification.NotificationInstance
-
twilio.rest.api.v2010.account.call.payment module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.payment.
PaymentContext
(version, account_sid, call_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
update
(idempotency_key, status_callback, capture=<object object>, status=<object object>)[source]¶ Update the PaymentInstance
Parameters: - idempotency_key (unicode) – A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions.
- status_callback (unicode) – Provide an absolute or relative URL to receive status updates regarding your Pay session.
- capture (PaymentInstance.Capture) – The piece of payment information that you wish the caller to enter.
- status (PaymentInstance.Status) – Indicates whether the current payment session should be cancelled or completed.
Returns: The updated PaymentInstance
Return type:
-
-
class
twilio.rest.api.v2010.account.call.payment.
PaymentInstance
(version, payload, account_sid, call_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
class
BankAccountType
[source]¶ Bases:
object
-
COMMERCIAL_CHECKING
= 'commercial-checking'¶
-
CONSUMER_CHECKING
= 'consumer-checking'¶
-
CONSUMER_SAVINGS
= 'consumer-savings'¶
-
-
class
Capture
[source]¶ Bases:
object
-
BANK_ACCOUNT_NUMBER
= 'bank-account-number'¶
-
BANK_ROUTING_NUMBER
= 'bank-routing-number'¶
-
EXPIRATION_DATE
= 'expiration-date'¶
-
PAYMENT_CARD_NUMBER
= 'payment-card-number'¶
-
POSTAL_CODE
= 'postal-code'¶
-
SECURITY_CODE
= 'security-code'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the Payments resource. Return type: unicode
-
call_sid
¶ Returns: The SID of the Call the resource is associated with. 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
-
sid
¶ Returns: The SID of the Payments resource. Return type: unicode
-
update
(idempotency_key, status_callback, capture=<object object>, status=<object object>)[source]¶ Update the PaymentInstance
Parameters: - idempotency_key (unicode) – A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions.
- status_callback (unicode) – Provide an absolute or relative URL to receive status updates regarding your Pay session.
- capture (PaymentInstance.Capture) – The piece of payment information that you wish the caller to enter.
- status (PaymentInstance.Status) – Indicates whether the current payment session should be cancelled or completed.
Returns: The updated PaymentInstance
Return type:
-
uri
¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.call.payment.
PaymentList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
create
(idempotency_key, status_callback, bank_account_type=<object object>, charge_amount=<object object>, currency=<object object>, description=<object object>, input=<object object>, min_postal_code_length=<object object>, parameter=<object object>, payment_connector=<object object>, payment_method=<object object>, postal_code=<object object>, security_code=<object object>, timeout=<object object>, token_type=<object object>, valid_card_types=<object object>)[source]¶ Create the PaymentInstance
Parameters: - idempotency_key (unicode) – A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions.
- status_callback (unicode) – Provide an absolute or relative URL to receive status updates regarding your Pay session..
- bank_account_type (PaymentInstance.BankAccountType) – Type of bank account if payment source is ACH.
- charge_amount (unicode) – A positive decimal value less than 1,000,000 to charge against the credit card or bank account.
- currency (unicode) – The currency of the charge_amount.
- description (unicode) – The description can be used to provide more details regarding the transaction.
- input (unicode) – A list of inputs that should be accepted. Currently only dtmf is supported.
- min_postal_code_length (unicode) – A positive integer that is used to validate the length of the PostalCode inputted by the user.
- parameter (dict) – A single level JSON string that is required when accepting certain information specific only to ACH payments.
- payment_connector (unicode) – This is the unique name corresponding to the Payment Gateway Connector installed in the Twilio Add-ons.
- payment_method (PaymentInstance.PaymentMethod) – Type of payment being captured.
- postal_code (bool) – Indicates whether the credit card PostalCode (zip code) is a required piece of payment information that must be provided by the caller.
- security_code (bool) – Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller.
- timeout (unicode) – The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured.
- token_type (PaymentInstance.TokenType) – Indicates whether the payment method should be tokenized as a one-time or reusable token.
- valid_card_types (unicode) – Credit card types separated by space that Pay should accept.
Returns: The created PaymentInstance
Return type:
-
get
(sid)[source]¶ Constructs a PaymentContext
Parameters: sid – The SID of Payments session Returns: twilio.rest.api.v2010.account.call.payment.PaymentContext Return type: twilio.rest.api.v2010.account.call.payment.PaymentContext
-
-
class
twilio.rest.api.v2010.account.call.payment.
PaymentPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
get_instance
(payload)[source]¶ Build an instance of PaymentInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.payment.PaymentInstance Return type: twilio.rest.api.v2010.account.call.payment.PaymentInstance
-
twilio.rest.api.v2010.account.call.recording module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.recording.
RecordingContext
(version, account_sid, call_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
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.call.recording.RecordingInstance
-
update
(status, pause_behavior=<object object>)[source]¶ Update the RecordingInstance
Parameters: - status (RecordingInstance.Status) – The new status of the recording
- pause_behavior (unicode) – Whether to record or not during the pause period.
Returns: The updated RecordingInstance
Return type: twilio.rest.api.v2010.account.call.recording.RecordingInstance
-
-
class
twilio.rest.api.v2010.account.call.recording.
RecordingInstance
(version, payload, account_sid, call_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
-
api_version
¶ Returns: The API version used to make 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 Return type: unicode
-
conference_sid
¶ Returns: The Conference SID that identifies 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
-
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.call.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
-
track
¶ Returns: The recorded track. Can be: inbound, outbound, or both. Return type: unicode
-
update
(status, pause_behavior=<object object>)[source]¶ Update the RecordingInstance
Parameters: - status (RecordingInstance.Status) – The new status of the recording
- pause_behavior (unicode) – Whether to record or not during the pause period.
Returns: The updated RecordingInstance
Return type: twilio.rest.api.v2010.account.call.recording.RecordingInstance
-
uri
¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.call.recording.
RecordingList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(recording_status_callback_event=<object object>, recording_status_callback=<object object>, recording_status_callback_method=<object object>, trim=<object object>, recording_channels=<object object>, recording_track=<object object>)[source]¶ Create the RecordingInstance
Parameters: - recording_status_callback_event (list[unicode]) – The recording status changes that should generate a callback
- recording_status_callback (unicode) – The callback URL on each selected recording event
- recording_status_callback_method (unicode) – The HTTP method we should use to call recording_status_callback
- trim (unicode) – Whether to trim the silence in the recording
- recording_channels (unicode) – The number of channels that the output recording will be configured with
- recording_track (unicode) – Which track(s) to record
Returns: The created RecordingInstance
Return type: twilio.rest.api.v2010.account.call.recording.RecordingInstance
-
get
(sid)[source]¶ Constructs a RecordingContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.api.v2010.account.call.recording.RecordingContext Return type: twilio.rest.api.v2010.account.call.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.call.recording.RecordingPage
-
list
(date_created_before=<object object>, date_created=<object object>, date_created_after=<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 (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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.call.recording.RecordingInstance]
-
page
(date_created_before=<object object>, date_created=<object object>, date_created_after=<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 (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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:
-
stream
(date_created_before=<object object>, date_created=<object object>, date_created_after=<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 (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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.call.recording.RecordingInstance]
-
-
class
twilio.rest.api.v2010.account.call.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.call.recording.RecordingInstance Return type: twilio.rest.api.v2010.account.call.recording.RecordingInstance
-
twilio.rest.api.v2010.account.call.siprec module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.siprec.
SiprecContext
(version, account_sid, call_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
update
(status)[source]¶ Update the SiprecInstance
Parameters: status (SiprecInstance.UpdateStatus) – The status. Must have the value stopped Returns: The updated SiprecInstance Return type: twilio.rest.api.v2010.account.call.siprec.SiprecInstance
-
-
class
twilio.rest.api.v2010.account.call.siprec.
SiprecInstance
(version, payload, account_sid, call_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Track
[source]¶ Bases:
object
-
BOTH_TRACKS
= 'both_tracks'¶
-
INBOUND_TRACK
= 'inbound_track'¶
-
OUTBOUND_TRACK
= 'outbound_track'¶
-
-
account_sid
¶ Returns: The SID of the Account that created this resource Return type: unicode
-
call_sid
¶ Returns: The SID of the Call the resource is associated with Return type: unicode
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT that this resource was last updated Return type: datetime
-
name
¶ Returns: The name of this resource Return type: unicode
-
sid
¶ Returns: The SID of the Siprec resource. Return type: unicode
-
status
¶ Returns: The status - one of stopped, in-progress Return type: SiprecInstance.Status
-
update
(status)[source]¶ Update the SiprecInstance
Parameters: status (SiprecInstance.UpdateStatus) – The status. Must have the value stopped Returns: The updated SiprecInstance Return type: twilio.rest.api.v2010.account.call.siprec.SiprecInstance
-
class
-
class
twilio.rest.api.v2010.account.call.siprec.
SiprecList
(version, account_sid, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(name=<object object>, connector_name=<object object>, track=<object object>, status_callback=<object object>, status_callback_method=<object object>, parameter1_name=<object object>, parameter1_value=<object object>, parameter2_name=<object object>, parameter2_value=<object object>, parameter3_name=<object object>, parameter3_value=<object object>, parameter4_name=<object object>, parameter4_value=<object object>, parameter5_name=<object object>, parameter5_value=<object object>, parameter6_name=<object object>, parameter6_value=<object object>, parameter7_name=<object object>, parameter7_value=<object object>, parameter8_name=<object object>, parameter8_value=<object object>, parameter9_name=<object object>, parameter9_value=<object object>, parameter10_name=<object object>, parameter10_value=<object object>, parameter11_name=<object object>, parameter11_value=<object object>, parameter12_name=<object object>, parameter12_value=<object object>, parameter13_name=<object object>, parameter13_value=<object object>, parameter14_name=<object object>, parameter14_value=<object object>, parameter15_name=<object object>, parameter15_value=<object object>, parameter16_name=<object object>, parameter16_value=<object object>, parameter17_name=<object object>, parameter17_value=<object object>, parameter18_name=<object object>, parameter18_value=<object object>, parameter19_name=<object object>, parameter19_value=<object object>, parameter20_name=<object object>, parameter20_value=<object object>, parameter21_name=<object object>, parameter21_value=<object object>, parameter22_name=<object object>, parameter22_value=<object object>, parameter23_name=<object object>, parameter23_value=<object object>, parameter24_name=<object object>, parameter24_value=<object object>, parameter25_name=<object object>, parameter25_value=<object object>, parameter26_name=<object object>, parameter26_value=<object object>, parameter27_name=<object object>, parameter27_value=<object object>, parameter28_name=<object object>, parameter28_value=<object object>, parameter29_name=<object object>, parameter29_value=<object object>, parameter30_name=<object object>, parameter30_value=<object object>, parameter31_name=<object object>, parameter31_value=<object object>, parameter32_name=<object object>, parameter32_value=<object object>, parameter33_name=<object object>, parameter33_value=<object object>, parameter34_name=<object object>, parameter34_value=<object object>, parameter35_name=<object object>, parameter35_value=<object object>, parameter36_name=<object object>, parameter36_value=<object object>, parameter37_name=<object object>, parameter37_value=<object object>, parameter38_name=<object object>, parameter38_value=<object object>, parameter39_name=<object object>, parameter39_value=<object object>, parameter40_name=<object object>, parameter40_value=<object object>, parameter41_name=<object object>, parameter41_value=<object object>, parameter42_name=<object object>, parameter42_value=<object object>, parameter43_name=<object object>, parameter43_value=<object object>, parameter44_name=<object object>, parameter44_value=<object object>, parameter45_name=<object object>, parameter45_value=<object object>, parameter46_name=<object object>, parameter46_value=<object object>, parameter47_name=<object object>, parameter47_value=<object object>, parameter48_name=<object object>, parameter48_value=<object object>, parameter49_name=<object object>, parameter49_value=<object object>, parameter50_name=<object object>, parameter50_value=<object object>, parameter51_name=<object object>, parameter51_value=<object object>, parameter52_name=<object object>, parameter52_value=<object object>, parameter53_name=<object object>, parameter53_value=<object object>, parameter54_name=<object object>, parameter54_value=<object object>, parameter55_name=<object object>, parameter55_value=<object object>, parameter56_name=<object object>, parameter56_value=<object object>, parameter57_name=<object object>, parameter57_value=<object object>, parameter58_name=<object object>, parameter58_value=<object object>, parameter59_name=<object object>, parameter59_value=<object object>, parameter60_name=<object object>, parameter60_value=<object object>, parameter61_name=<object object>, parameter61_value=<object object>, parameter62_name=<object object>, parameter62_value=<object object>, parameter63_name=<object object>, parameter63_value=<object object>, parameter64_name=<object object>, parameter64_value=<object object>, parameter65_name=<object object>, parameter65_value=<object object>, parameter66_name=<object object>, parameter66_value=<object object>, parameter67_name=<object object>, parameter67_value=<object object>, parameter68_name=<object object>, parameter68_value=<object object>, parameter69_name=<object object>, parameter69_value=<object object>, parameter70_name=<object object>, parameter70_value=<object object>, parameter71_name=<object object>, parameter71_value=<object object>, parameter72_name=<object object>, parameter72_value=<object object>, parameter73_name=<object object>, parameter73_value=<object object>, parameter74_name=<object object>, parameter74_value=<object object>, parameter75_name=<object object>, parameter75_value=<object object>, parameter76_name=<object object>, parameter76_value=<object object>, parameter77_name=<object object>, parameter77_value=<object object>, parameter78_name=<object object>, parameter78_value=<object object>, parameter79_name=<object object>, parameter79_value=<object object>, parameter80_name=<object object>, parameter80_value=<object object>, parameter81_name=<object object>, parameter81_value=<object object>, parameter82_name=<object object>, parameter82_value=<object object>, parameter83_name=<object object>, parameter83_value=<object object>, parameter84_name=<object object>, parameter84_value=<object object>, parameter85_name=<object object>, parameter85_value=<object object>, parameter86_name=<object object>, parameter86_value=<object object>, parameter87_name=<object object>, parameter87_value=<object object>, parameter88_name=<object object>, parameter88_value=<object object>, parameter89_name=<object object>, parameter89_value=<object object>, parameter90_name=<object object>, parameter90_value=<object object>, parameter91_name=<object object>, parameter91_value=<object object>, parameter92_name=<object object>, parameter92_value=<object object>, parameter93_name=<object object>, parameter93_value=<object object>, parameter94_name=<object object>, parameter94_value=<object object>, parameter95_name=<object object>, parameter95_value=<object object>, parameter96_name=<object object>, parameter96_value=<object object>, parameter97_name=<object object>, parameter97_value=<object object>, parameter98_name=<object object>, parameter98_value=<object object>, parameter99_name=<object object>, parameter99_value=<object object>)[source]¶ Create the SiprecInstance
Parameters: - name (unicode) – The name of this resource
- connector_name (unicode) – Unique name used when configuring the connector via Marketplace Add-on.
- track (SiprecInstance.Track) – One of inbound_track, outbound_track, both_tracks.
- status_callback (unicode) – Absolute URL of the status callback.
- status_callback_method (unicode) – The http method for the status_callback.
- parameter1_name (unicode) – Parameter name
- parameter1_value (unicode) – Parameter value
- parameter2_name (unicode) – Parameter name
- parameter2_value (unicode) – Parameter value
- parameter3_name (unicode) – Parameter name
- parameter3_value (unicode) – Parameter value
- parameter4_name (unicode) – Parameter name
- parameter4_value (unicode) – Parameter value
- parameter5_name (unicode) – Parameter name
- parameter5_value (unicode) – Parameter value
- parameter6_name (unicode) – Parameter name
- parameter6_value (unicode) – Parameter value
- parameter7_name (unicode) – Parameter name
- parameter7_value (unicode) – Parameter value
- parameter8_name (unicode) – Parameter name
- parameter8_value (unicode) – Parameter value
- parameter9_name (unicode) – Parameter name
- parameter9_value (unicode) – Parameter value
- parameter10_name (unicode) – Parameter name
- parameter10_value (unicode) – Parameter value
- parameter11_name (unicode) – Parameter name
- parameter11_value (unicode) – Parameter value
- parameter12_name (unicode) – Parameter name
- parameter12_value (unicode) – Parameter value
- parameter13_name (unicode) – Parameter name
- parameter13_value (unicode) – Parameter value
- parameter14_name (unicode) – Parameter name
- parameter14_value (unicode) – Parameter value
- parameter15_name (unicode) – Parameter name
- parameter15_value (unicode) – Parameter value
- parameter16_name (unicode) – Parameter name
- parameter16_value (unicode) – Parameter value
- parameter17_name (unicode) – Parameter name
- parameter17_value (unicode) – Parameter value
- parameter18_name (unicode) – Parameter name
- parameter18_value (unicode) – Parameter value
- parameter19_name (unicode) – Parameter name
- parameter19_value (unicode) – Parameter value
- parameter20_name (unicode) – Parameter name
- parameter20_value (unicode) – Parameter value
- parameter21_name (unicode) – Parameter name
- parameter21_value (unicode) – Parameter value
- parameter22_name (unicode) – Parameter name
- parameter22_value (unicode) – Parameter value
- parameter23_name (unicode) – Parameter name
- parameter23_value (unicode) – Parameter value
- parameter24_name (unicode) – Parameter name
- parameter24_value (unicode) – Parameter value
- parameter25_name (unicode) – Parameter name
- parameter25_value (unicode) – Parameter value
- parameter26_name (unicode) – Parameter name
- parameter26_value (unicode) – Parameter value
- parameter27_name (unicode) – Parameter name
- parameter27_value (unicode) – Parameter value
- parameter28_name (unicode) – Parameter name
- parameter28_value (unicode) – Parameter value
- parameter29_name (unicode) – Parameter name
- parameter29_value (unicode) – Parameter value
- parameter30_name (unicode) – Parameter name
- parameter30_value (unicode) – Parameter value
- parameter31_name (unicode) – Parameter name
- parameter31_value (unicode) – Parameter value
- parameter32_name (unicode) – Parameter name
- parameter32_value (unicode) – Parameter value
- parameter33_name (unicode) – Parameter name
- parameter33_value (unicode) – Parameter value
- parameter34_name (unicode) – Parameter name
- parameter34_value (unicode) – Parameter value
- parameter35_name (unicode) – Parameter name
- parameter35_value (unicode) – Parameter value
- parameter36_name (unicode) – Parameter name
- parameter36_value (unicode) – Parameter value
- parameter37_name (unicode) – Parameter name
- parameter37_value (unicode) – Parameter value
- parameter38_name (unicode) – Parameter name
- parameter38_value (unicode) – Parameter value
- parameter39_name (unicode) – Parameter name
- parameter39_value (unicode) – Parameter value
- parameter40_name (unicode) – Parameter name
- parameter40_value (unicode) – Parameter value
- parameter41_name (unicode) – Parameter name
- parameter41_value (unicode) – Parameter value
- parameter42_name (unicode) – Parameter name
- parameter42_value (unicode) – Parameter value
- parameter43_name (unicode) – Parameter name
- parameter43_value (unicode) – Parameter value
- parameter44_name (unicode) – Parameter name
- parameter44_value (unicode) – Parameter value
- parameter45_name (unicode) – Parameter name
- parameter45_value (unicode) – Parameter value
- parameter46_name (unicode) – Parameter name
- parameter46_value (unicode) – Parameter value
- parameter47_name (unicode) – Parameter name
- parameter47_value (unicode) – Parameter value
- parameter48_name (unicode) – Parameter name
- parameter48_value (unicode) – Parameter value
- parameter49_name (unicode) – Parameter name
- parameter49_value (unicode) – Parameter value
- parameter50_name (unicode) – Parameter name
- parameter50_value (unicode) – Parameter value
- parameter51_name (unicode) – Parameter name
- parameter51_value (unicode) – Parameter value
- parameter52_name (unicode) – Parameter name
- parameter52_value (unicode) – Parameter value
- parameter53_name (unicode) – Parameter name
- parameter53_value (unicode) – Parameter value
- parameter54_name (unicode) – Parameter name
- parameter54_value (unicode) – Parameter value
- parameter55_name (unicode) – Parameter name
- parameter55_value (unicode) – Parameter value
- parameter56_name (unicode) – Parameter name
- parameter56_value (unicode) – Parameter value
- parameter57_name (unicode) – Parameter name
- parameter57_value (unicode) – Parameter value
- parameter58_name (unicode) – Parameter name
- parameter58_value (unicode) – Parameter value
- parameter59_name (unicode) – Parameter name
- parameter59_value (unicode) – Parameter value
- parameter60_name (unicode) – Parameter name
- parameter60_value (unicode) – Parameter value
- parameter61_name (unicode) – Parameter name
- parameter61_value (unicode) – Parameter value
- parameter62_name (unicode) – Parameter name
- parameter62_value (unicode) – Parameter value
- parameter63_name (unicode) – Parameter name
- parameter63_value (unicode) – Parameter value
- parameter64_name (unicode) – Parameter name
- parameter64_value (unicode) – Parameter value
- parameter65_name (unicode) – Parameter name
- parameter65_value (unicode) – Parameter value
- parameter66_name (unicode) – Parameter name
- parameter66_value (unicode) – Parameter value
- parameter67_name (unicode) – Parameter name
- parameter67_value (unicode) – Parameter value
- parameter68_name (unicode) – Parameter name
- parameter68_value (unicode) – Parameter value
- parameter69_name (unicode) – Parameter name
- parameter69_value (unicode) – Parameter value
- parameter70_name (unicode) – Parameter name
- parameter70_value (unicode) – Parameter value
- parameter71_name (unicode) – Parameter name
- parameter71_value (unicode) – Parameter value
- parameter72_name (unicode) – Parameter name
- parameter72_value (unicode) – Parameter value
- parameter73_name (unicode) – Parameter name
- parameter73_value (unicode) – Parameter value
- parameter74_name (unicode) – Parameter name
- parameter74_value (unicode) – Parameter value
- parameter75_name (unicode) – Parameter name
- parameter75_value (unicode) – Parameter value
- parameter76_name (unicode) – Parameter name
- parameter76_value (unicode) – Parameter value
- parameter77_name (unicode) – Parameter name
- parameter77_value (unicode) – Parameter value
- parameter78_name (unicode) – Parameter name
- parameter78_value (unicode) – Parameter value
- parameter79_name (unicode) – Parameter name
- parameter79_value (unicode) – Parameter value
- parameter80_name (unicode) – Parameter name
- parameter80_value (unicode) – Parameter value
- parameter81_name (unicode) – Parameter name
- parameter81_value (unicode) – Parameter value
- parameter82_name (unicode) – Parameter name
- parameter82_value (unicode) – Parameter value
- parameter83_name (unicode) – Parameter name
- parameter83_value (unicode) – Parameter value
- parameter84_name (unicode) – Parameter name
- parameter84_value (unicode) – Parameter value
- parameter85_name (unicode) – Parameter name
- parameter85_value (unicode) – Parameter value
- parameter86_name (unicode) – Parameter name
- parameter86_value (unicode) – Parameter value
- parameter87_name (unicode) – Parameter name
- parameter87_value (unicode) – Parameter value
- parameter88_name (unicode) – Parameter name
- parameter88_value (unicode) – Parameter value
- parameter89_name (unicode) – Parameter name
- parameter89_value (unicode) – Parameter value
- parameter90_name (unicode) – Parameter name
- parameter90_value (unicode) – Parameter value
- parameter91_name (unicode) – Parameter name
- parameter91_value (unicode) – Parameter value
- parameter92_name (unicode) – Parameter name
- parameter92_value (unicode) – Parameter value
- parameter93_name (unicode) – Parameter name
- parameter93_value (unicode) – Parameter value
- parameter94_name (unicode) – Parameter name
- parameter94_value (unicode) – Parameter value
- parameter95_name (unicode) – Parameter name
- parameter95_value (unicode) – Parameter value
- parameter96_name (unicode) – Parameter name
- parameter96_value (unicode) – Parameter value
- parameter97_name (unicode) – Parameter name
- parameter97_value (unicode) – Parameter value
- parameter98_name (unicode) – Parameter name
- parameter98_value (unicode) – Parameter value
- parameter99_name (unicode) – Parameter name
- parameter99_value (unicode) – Parameter value
Returns: The created SiprecInstance
Return type:
-
get
(sid)[source]¶ Constructs a SiprecContext
Parameters: sid – The SID of the Siprec resource, or the name Returns: twilio.rest.api.v2010.account.call.siprec.SiprecContext Return type: twilio.rest.api.v2010.account.call.siprec.SiprecContext
-
-
class
twilio.rest.api.v2010.account.call.siprec.
SiprecPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of SiprecInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.siprec.SiprecInstance Return type: twilio.rest.api.v2010.account.call.siprec.SiprecInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.call.
CallContext
(version, account_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CallInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
events
¶ Access the events
Returns: twilio.rest.api.v2010.account.call.event.EventList Return type: twilio.rest.api.v2010.account.call.event.EventList
-
feedback
¶ Access the feedback
Returns: twilio.rest.api.v2010.account.call.feedback.FeedbackList Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackList
-
fetch
()[source]¶ Fetch the CallInstance
Returns: The fetched CallInstance Return type: twilio.rest.api.v2010.account.call.CallInstance
-
notifications
¶ Access the notifications
Returns: twilio.rest.api.v2010.account.call.notification.NotificationList Return type: twilio.rest.api.v2010.account.call.notification.NotificationList
-
payments
¶ Access the payments
Returns: twilio.rest.api.v2010.account.call.payment.PaymentList Return type: twilio.rest.api.v2010.account.call.payment.PaymentList
-
recordings
¶ Access the recordings
Returns: twilio.rest.api.v2010.account.call.recording.RecordingList Return type: twilio.rest.api.v2010.account.call.recording.RecordingList
-
siprec
¶ Access the siprec
Returns: twilio.rest.api.v2010.account.call.siprec.SiprecList Return type: twilio.rest.api.v2010.account.call.siprec.SiprecList
-
update
(url=<object object>, method=<object object>, status=<object object>, fallback_url=<object object>, fallback_method=<object object>, status_callback=<object object>, status_callback_method=<object object>, twiml=<object object>, time_limit=<object object>)[source]¶ Update the CallInstance
Parameters: - url (unicode) – The absolute URL that returns TwiML for this call
- method (unicode) – HTTP method to use to fetch TwiML
- status (CallInstance.UpdateStatus) – The new status to update the call with.
- fallback_url (unicode) – Fallback URL in case of error
- fallback_method (unicode) – HTTP Method to use with fallback_url
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – HTTP Method to use to call status_callback
- twiml (unicode) – TwiML instructions for the call
- time_limit (unicode) – The maximum duration of the call in seconds.
Returns: The updated CallInstance
Return type:
-
-
class
twilio.rest.api.v2010.account.call.
CallInstance
(version, payload, account_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Event
[source]¶ Bases:
object
-
ANSWERED
= 'answered'¶
-
COMPLETED
= 'completed'¶
-
INITIATED
= 'initiated'¶
-
RINGING
= 'ringing'¶
-
-
class
Status
[source]¶ Bases:
object
-
BUSY
= 'busy'¶
-
CANCELED
= 'canceled'¶
-
COMPLETED
= 'completed'¶
-
FAILED
= 'failed'¶
-
IN_PROGRESS
= 'in-progress'¶
-
NO_ANSWER
= 'no-answer'¶
-
QUEUED
= 'queued'¶
-
RINGING
= 'ringing'¶
-
-
account_sid
¶ Returns: The SID of the Account that created this resource Return type: unicode
-
annotation
¶ Returns: The annotation provided for the call Return type: unicode
-
answered_by
¶ Returns: Either human or machine if this call was initiated with answering machine detection. Empty otherwise. Return type: unicode
-
api_version
¶ Returns: The API Version used to create the call Return type: unicode
-
caller_name
¶ Returns: The caller’s name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT that this resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT that this resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the CallInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
direction
¶ Returns: A string describing the direction of the call. inbound for inbound calls, outbound-api for calls initiated via the REST API or outbound-dial for calls initiated by a Dial verb. Return type: unicode
-
duration
¶ Returns: The length of the call in seconds. Return type: unicode
-
end_time
¶ Returns: The end time of the call. Null if the call did not complete successfully. Return type: datetime
-
events
¶ Access the events
Returns: twilio.rest.api.v2010.account.call.event.EventList Return type: twilio.rest.api.v2010.account.call.event.EventList
-
feedback
¶ Access the feedback
Returns: twilio.rest.api.v2010.account.call.feedback.FeedbackList Return type: twilio.rest.api.v2010.account.call.feedback.FeedbackList
-
fetch
()[source]¶ Fetch the CallInstance
Returns: The fetched CallInstance Return type: twilio.rest.api.v2010.account.call.CallInstance
-
forwarded_from
¶ Returns: The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. Return type: unicode
-
from_
¶ Returns: The phone number, SIP address or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. Return type: unicode
-
from_formatted
¶ Returns: The calling phone number, SIP address, or Client identifier formatted for display. Return type: unicode
-
group_sid
¶ Returns: The Group SID associated with this call. If no Group is associated with the call, the field is empty. Return type: unicode
-
notifications
¶ Access the notifications
Returns: twilio.rest.api.v2010.account.call.notification.NotificationList Return type: twilio.rest.api.v2010.account.call.notification.NotificationList
-
parent_call_sid
¶ Returns: The SID that identifies the call that created this leg. Return type: unicode
-
payments
¶ Access the payments
Returns: twilio.rest.api.v2010.account.call.payment.PaymentList Return type: twilio.rest.api.v2010.account.call.payment.PaymentList
-
phone_number_sid
¶ Returns: If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed. Return type: unicode
-
price
¶ Returns: The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available. Return type: unicode
-
price_unit
¶ Returns: The currency in which Price is measured. Return type: unicode
-
queue_time
¶ Returns: The wait time in milliseconds before the call is placed. Return type: unicode
-
recordings
¶ Access the recordings
Returns: twilio.rest.api.v2010.account.call.recording.RecordingList Return type: twilio.rest.api.v2010.account.call.recording.RecordingList
-
sid
¶ Returns: The unique string that identifies this resource Return type: unicode
-
siprec
¶ Access the siprec
Returns: twilio.rest.api.v2010.account.call.siprec.SiprecList Return type: twilio.rest.api.v2010.account.call.siprec.SiprecList
-
start_time
¶ Returns: The start time of the call. Null if the call has not yet been dialed. Return type: datetime
-
status
¶ Returns: The status of this call. Return type: CallInstance.Status
-
subresource_uris
¶ Returns: A list of related subresources identified by their relative URIs Return type: unicode
-
to
¶ Returns: The phone number, SIP address or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com. Client identifiers are formatted client:name. Return type: unicode
-
to_formatted
¶ Returns: The phone number, SIP address or Client identifier that received this call. Formatted for display. Return type: unicode
-
trunk_sid
¶ Returns: The (optional) unique identifier of the trunk resource that was used for this call. Return type: unicode
-
update
(url=<object object>, method=<object object>, status=<object object>, fallback_url=<object object>, fallback_method=<object object>, status_callback=<object object>, status_callback_method=<object object>, twiml=<object object>, time_limit=<object object>)[source]¶ Update the CallInstance
Parameters: - url (unicode) – The absolute URL that returns TwiML for this call
- method (unicode) – HTTP method to use to fetch TwiML
- status (CallInstance.UpdateStatus) – The new status to update the call with.
- fallback_url (unicode) – Fallback URL in case of error
- fallback_method (unicode) – HTTP Method to use with fallback_url
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – HTTP Method to use to call status_callback
- twiml (unicode) – TwiML instructions for the call
- time_limit (unicode) – The maximum duration of the call in seconds.
Returns: The updated CallInstance
Return type:
-
uri
¶ Returns: The URI of this resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.call.
CallList
(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(to, from_, method=<object object>, fallback_url=<object object>, fallback_method=<object object>, status_callback=<object object>, status_callback_event=<object object>, status_callback_method=<object object>, send_digits=<object object>, timeout=<object object>, record=<object object>, recording_channels=<object object>, recording_status_callback=<object object>, recording_status_callback_method=<object object>, sip_auth_username=<object object>, sip_auth_password=<object object>, machine_detection=<object object>, machine_detection_timeout=<object object>, recording_status_callback_event=<object object>, trim=<object object>, caller_id=<object object>, machine_detection_speech_threshold=<object object>, machine_detection_speech_end_threshold=<object object>, machine_detection_silence_timeout=<object object>, async_amd=<object object>, async_amd_status_callback=<object object>, async_amd_status_callback_method=<object object>, byoc=<object object>, call_reason=<object object>, call_token=<object object>, recording_track=<object object>, time_limit=<object object>, url=<object object>, twiml=<object object>, application_sid=<object object>)[source]¶ Create the CallInstance
Parameters: - to (unicode) – Phone number, SIP address, or client identifier to call
- from (unicode) – Twilio number from which to originate the call
- method (unicode) – HTTP method to use to fetch TwiML
- fallback_url (unicode) – Fallback URL in case of error
- fallback_method (unicode) – HTTP Method to use with fallback_url
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_event (list[unicode]) – The call progress events that we send to the status_callback URL.
- status_callback_method (unicode) – HTTP Method to use with status_callback
- send_digits (unicode) – The digits to dial after connecting to the number
- timeout (unicode) – Number of seconds to wait for an answer
- record (bool) – Whether to record the call
- recording_channels (unicode) – The number of channels in the final recording
- recording_status_callback (unicode) – The URL that we call when the recording is available to be accessed
- recording_status_callback_method (unicode) – The HTTP method we should use when calling the recording_status_callback URL
- sip_auth_username (unicode) – The username used to authenticate the caller making a SIP call
- sip_auth_password (unicode) – The password required to authenticate the user account specified in sip_auth_username.
- machine_detection (unicode) – Enable machine detection or end of greeting detection
- machine_detection_timeout (unicode) – Number of seconds to wait for machine detection
- recording_status_callback_event (list[unicode]) – The recording status events that will trigger calls to the URL specified in recording_status_callback
- trim (unicode) – Set this parameter to control trimming of silence on the recording.
- caller_id (unicode) – The phone number, SIP address, or Client identifier that made this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as name@company.com.
- machine_detection_speech_threshold (unicode) – Number of milliseconds for measuring stick for the length of the speech activity
- machine_detection_speech_end_threshold (unicode) – Number of milliseconds of silence after speech activity
- machine_detection_silence_timeout (unicode) – Number of milliseconds of initial silence
- async_amd (unicode) – Enable asynchronous AMD
- async_amd_status_callback (unicode) – The URL we should call to send amd status information to your application
- async_amd_status_callback_method (unicode) – HTTP Method to use with async_amd_status_callback
- byoc (unicode) – BYOC trunk SID (Beta)
- call_reason (unicode) – Reason for the call (Branded Calls Beta)
- call_token (unicode) – A token string needed to invoke a forwarded call with a caller-id recieved on a previous incoming call
- recording_track (unicode) – Which track(s) to record
- time_limit (unicode) – The maximum duration of the call in seconds.
- url (unicode) – The absolute URL that returns TwiML for this call
- twiml (unicode) – TwiML instructions for the call
- application_sid (unicode) – The SID of the Application resource that will handle the call
Returns: The created CallInstance
Return type:
-
feedback_summaries
¶ Access the feedback_summaries
Returns: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryList Return type: twilio.rest.api.v2010.account.call.feedback_summary.FeedbackSummaryList
-
get
(sid)[source]¶ Constructs a CallContext
Parameters: sid – The SID of the Call resource to fetch Returns: twilio.rest.api.v2010.account.call.CallContext Return type: twilio.rest.api.v2010.account.call.CallContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CallInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CallInstance Return type: twilio.rest.api.v2010.account.call.CallPage
-
list
(to=<object object>, from_=<object object>, parent_call_sid=<object object>, status=<object object>, start_time_before=<object object>, start_time=<object object>, start_time_after=<object object>, end_time_before=<object object>, end_time=<object object>, end_time_after=<object object>, limit=None, page_size=None)[source]¶ Lists CallInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - to (unicode) – Phone number or Client identifier of calls to include
- from (unicode) – Phone number or Client identifier to filter from on
- parent_call_sid (unicode) – Parent call SID to filter on
- status (CallInstance.Status) – The status of the resources to read
- start_time_before (datetime) – Only include calls that started on this date
- start_time (datetime) – Only include calls that started on this date
- start_time_after (datetime) – Only include calls that started on this date
- end_time_before (datetime) – Only include calls that ended on this date
- end_time (datetime) – Only include calls that ended on this date
- end_time_after (datetime) – Only include calls that ended on this date
- 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:
-
page
(to=<object object>, from_=<object object>, parent_call_sid=<object object>, status=<object object>, start_time_before=<object object>, start_time=<object object>, start_time_after=<object object>, end_time_before=<object object>, end_time=<object object>, end_time_after=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CallInstance records from the API. Request is executed immediately
Parameters: - to (unicode) – Phone number or Client identifier of calls to include
- from (unicode) – Phone number or Client identifier to filter from on
- parent_call_sid (unicode) – Parent call SID to filter on
- status (CallInstance.Status) – The status of the resources to read
- start_time_before (datetime) – Only include calls that started on this date
- start_time (datetime) – Only include calls that started on this date
- start_time_after (datetime) – Only include calls that started on this date
- end_time_before (datetime) – Only include calls that ended on this date
- end_time (datetime) – Only include calls that ended on this date
- end_time_after (datetime) – Only include calls that ended on this date
- 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 CallInstance
Return type:
-
stream
(to=<object object>, from_=<object object>, parent_call_sid=<object object>, status=<object object>, start_time_before=<object object>, start_time=<object object>, start_time_after=<object object>, end_time_before=<object object>, end_time=<object object>, end_time_after=<object object>, limit=None, page_size=None)[source]¶ Streams CallInstance 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: - to (unicode) – Phone number or Client identifier of calls to include
- from (unicode) – Phone number or Client identifier to filter from on
- parent_call_sid (unicode) – Parent call SID to filter on
- status (CallInstance.Status) – The status of the resources to read
- start_time_before (datetime) – Only include calls that started on this date
- start_time (datetime) – Only include calls that started on this date
- start_time_after (datetime) – Only include calls that started on this date
- end_time_before (datetime) – Only include calls that ended on this date
- end_time (datetime) – Only include calls that ended on this date
- end_time_after (datetime) – Only include calls that ended on this date
- 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:
-
-
class
twilio.rest.api.v2010.account.call.
CallPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CallInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.call.CallInstance Return type: twilio.rest.api.v2010.account.call.CallInstance
-