twilio.rest.insights.v1.call package¶
Submodules¶
twilio.rest.insights.v1.call.event module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.call.event.EventInstance(version, payload, call_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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
Level[source]¶ Bases:
object-
DEBUG= 'DEBUG'¶
-
ERROR= 'ERROR'¶
-
INFO= 'INFO'¶
-
UNKNOWN= 'UNKNOWN'¶
-
WARNING= 'WARNING'¶
-
-
class
TwilioEdge[source]¶ Bases:
object-
CARRIER_EDGE= 'carrier_edge'¶
-
CLIENT_EDGE= 'client_edge'¶
-
SDK_EDGE= 'sdk_edge'¶
-
SIP_EDGE= 'sip_edge'¶
-
UNKNOWN_EDGE= 'unknown_edge'¶
-
-
account_sid¶ Returns: The account_sid Return type: unicode
-
call_sid¶ Returns: The call_sid Return type: unicode
-
edge¶ Returns: The edge Return type: EventInstance.TwilioEdge
-
group¶ Returns: The group Return type: unicode
-
level¶ Returns: The level Return type: EventInstance.Level
-
name¶ Returns: The name Return type: unicode
-
timestamp¶ Returns: The timestamp Return type: unicode
-
class
-
class
twilio.rest.insights.v1.call.event.EventList(version, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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_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.insights.v1.call.event.EventPage
-
list(edge=<object object>, 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: - edge (EventInstance.TwilioEdge) – The edge
- 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(edge=<object object>, 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: - edge (EventInstance.TwilioEdge) – The edge
- 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 EventInstance
Return type:
-
stream(edge=<object object>, 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: - edge (EventInstance.TwilioEdge) – The edge
- 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.insights.v1.call.event.EventPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 EventInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.call.event.EventInstance Return type: twilio.rest.insights.v1.call.event.EventInstance
-
twilio.rest.insights.v1.call.metric module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.call.metric.MetricInstance(version, payload, call_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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
StreamDirection[source]¶ Bases:
object-
BOTH= 'both'¶
-
INBOUND= 'inbound'¶
-
OUTBOUND= 'outbound'¶
-
UNKNOWN= 'unknown'¶
-
-
class
TwilioEdge[source]¶ Bases:
object-
CARRIER_EDGE= 'carrier_edge'¶
-
CLIENT_EDGE= 'client_edge'¶
-
SDK_EDGE= 'sdk_edge'¶
-
SIP_EDGE= 'sip_edge'¶
-
UNKNOWN_EDGE= 'unknown_edge'¶
-
-
account_sid¶ Returns: The account_sid Return type: unicode
-
call_sid¶ Returns: The call_sid Return type: unicode
-
direction¶ Returns: The direction Return type: MetricInstance.StreamDirection
-
edge¶ Returns: The edge Return type: MetricInstance.TwilioEdge
-
timestamp¶ Returns: The timestamp Return type: unicode
-
class
-
class
twilio.rest.insights.v1.call.metric.MetricList(version, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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_page(target_url)[source]¶ Retrieve a specific page of MetricInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of MetricInstance Return type: twilio.rest.insights.v1.call.metric.MetricPage
-
list(edge=<object object>, direction=<object object>, limit=None, page_size=None)[source]¶ Lists MetricInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - edge (MetricInstance.TwilioEdge) – The edge
- direction (MetricInstance.StreamDirection) – The direction
- 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(edge=<object object>, direction=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of MetricInstance records from the API. Request is executed immediately
Parameters: - edge (MetricInstance.TwilioEdge) – The edge
- direction (MetricInstance.StreamDirection) – The direction
- 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 MetricInstance
Return type:
-
stream(edge=<object object>, direction=<object object>, limit=None, page_size=None)[source]¶ Streams MetricInstance 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: - edge (MetricInstance.TwilioEdge) – The edge
- direction (MetricInstance.StreamDirection) – The direction
- 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.insights.v1.call.metric.MetricPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 MetricInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.call.metric.MetricInstance Return type: twilio.rest.insights.v1.call.metric.MetricInstance
-
twilio.rest.insights.v1.call.summary module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.call.summary.CallSummaryContext(version, call_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext-
fetch(processing_state=<object object>)[source]¶ Fetch the CallSummaryInstance
Parameters: processing_state (CallSummaryInstance.ProcessingState) – The processing_state Returns: The fetched CallSummaryInstance Return type: twilio.rest.insights.v1.call.summary.CallSummaryInstance
-
-
class
twilio.rest.insights.v1.call.summary.CallSummaryInstance(version, payload, call_sid)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource-
class
CallState[source]¶ Bases:
object-
ANSWERED= 'answered'¶
-
BUSY= 'busy'¶
-
CANCELED= 'canceled'¶
-
COMPLETED= 'completed'¶
-
FAIL= 'fail'¶
-
NOANSWER= 'noanswer'¶
-
RINGING= 'ringing'¶
-
UNDIALED= 'undialed'¶
-
-
class
CallType[source]¶ Bases:
object-
CARRIER= 'carrier'¶
-
CLIENT= 'client'¶
-
SIP= 'sip'¶
-
TRUNKING= 'trunking'¶
-
-
account_sid¶ Returns: The account_sid Return type: unicode
-
call_sid¶ Returns: The call_sid Return type: unicode
-
call_state¶ Returns: The call_state Return type: CallSummaryInstance.CallState
-
call_type¶ Returns: The call_type Return type: CallSummaryInstance.CallType
-
connect_duration¶ Returns: The connect_duration Return type: unicode
-
created_time¶ Returns: The created_time Return type: datetime
-
duration¶ Returns: The duration Return type: unicode
-
end_time¶ Returns: The end_time Return type: datetime
-
fetch(processing_state=<object object>)[source]¶ Fetch the CallSummaryInstance
Parameters: processing_state (CallSummaryInstance.ProcessingState) – The processing_state Returns: The fetched CallSummaryInstance Return type: twilio.rest.insights.v1.call.summary.CallSummaryInstance
-
processing_state¶ Returns: The processing_state Return type: CallSummaryInstance.ProcessingState
-
start_time¶ Returns: The start_time Return type: datetime
Returns: The tags Return type: list[unicode]
-
url¶ Returns: The url Return type: unicode
-
class
-
class
twilio.rest.insights.v1.call.summary.CallSummaryList(version, call_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
get()[source]¶ Constructs a CallSummaryContext
Returns: twilio.rest.insights.v1.call.summary.CallSummaryContext Return type: twilio.rest.insights.v1.call.summary.CallSummaryContext
-
-
class
twilio.rest.insights.v1.call.summary.CallSummaryPage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of CallSummaryInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.call.summary.CallSummaryInstance Return type: twilio.rest.insights.v1.call.summary.CallSummaryInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.call.CallContext(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE 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.
-
events¶ Access the events
Returns: twilio.rest.insights.v1.call.event.EventList Return type: twilio.rest.insights.v1.call.event.EventList
-
fetch()[source]¶ Fetch the CallInstance
Returns: The fetched CallInstance Return type: twilio.rest.insights.v1.call.CallInstance
-
metrics¶ Access the metrics
Returns: twilio.rest.insights.v1.call.metric.MetricList Return type: twilio.rest.insights.v1.call.metric.MetricList
-
summary¶ Access the summary
Returns: twilio.rest.insights.v1.call.summary.CallSummaryList Return type: twilio.rest.insights.v1.call.summary.CallSummaryList
-
-
class
twilio.rest.insights.v1.call.CallInstance(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE 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.
-
events¶ Access the events
Returns: twilio.rest.insights.v1.call.event.EventList Return type: twilio.rest.insights.v1.call.event.EventList
-
fetch()[source]¶ Fetch the CallInstance
Returns: The fetched CallInstance Return type: twilio.rest.insights.v1.call.CallInstance
-
links¶ Returns: The links Return type: unicode
-
metrics¶ Access the metrics
Returns: twilio.rest.insights.v1.call.metric.MetricList Return type: twilio.rest.insights.v1.call.metric.MetricList
-
sid¶ Returns: The sid Return type: unicode
-
summary¶ Access the summary
Returns: twilio.rest.insights.v1.call.summary.CallSummaryList Return type: twilio.rest.insights.v1.call.summary.CallSummaryList
-
url¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.insights.v1.call.CallList(version)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE 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(sid)[source]¶ Constructs a CallContext
Parameters: sid – The sid Returns: twilio.rest.insights.v1.call.CallContext Return type: twilio.rest.insights.v1.call.CallContext
-
-
class
twilio.rest.insights.v1.call.CallPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE 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 CallInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.call.CallInstance Return type: twilio.rest.insights.v1.call.CallInstance
-