twilio.rest.insights.v1 package¶
Subpackages¶
Submodules¶
twilio.rest.insights.v1.annotation module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.annotation.
AnnotationContext
(version, call_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
()[source]¶ Fetch the AnnotationInstance
Returns: The fetched AnnotationInstance Return type: twilio.rest.insights.v1.annotation.AnnotationInstance
-
update
(answered_by=<object object>, connectivity_issue=<object object>, quality_issues=<object object>, spam=<object object>, call_score=<object object>, comment=<object object>, incident=<object object>)[source]¶ Update the AnnotationInstance
Parameters: - answered_by (AnnotationInstance.AnsweredBy) – The answered_by
- connectivity_issue (AnnotationInstance.ConnectivityIssue) – The connectivity_issue
- quality_issues (unicode) – The quality_issues
- spam (bool) – The spam
- call_score (unicode) – The call_score
- comment (unicode) – The comment
- incident (unicode) – The incident
Returns: The updated AnnotationInstance
Return type:
-
-
class
twilio.rest.insights.v1.annotation.
AnnotationInstance
(version, payload, call_sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
AnsweredBy
[source]¶ Bases:
object
-
HUMAN
= 'human'¶
-
MACHINE
= 'machine'¶
-
UNKNOWN_ANSWERED_BY
= 'unknown_answered_by'¶
-
-
class
ConnectivityIssue
[source]¶ Bases:
object
-
CALLER_ID
= 'caller_id'¶
-
DROPPED_CALL
= 'dropped_call'¶
-
INVALID_NUMBER
= 'invalid_number'¶
-
NO_CONNECTIVITY_ISSUE
= 'no_connectivity_issue'¶
-
NUMBER_REACHABILITY
= 'number_reachability'¶
-
UNKNOWN_CONNECTIVITY_ISSUE
= 'unknown_connectivity_issue'¶
-
-
class
QualityIssues
[source]¶ Bases:
object
-
CHOPPY_ROBOTIC
= 'choppy_robotic'¶
-
DTMF
= 'dtmf'¶
-
ECHO
= 'echo'¶
-
LATENCY
= 'latency'¶
-
LOW_VOLUME
= 'low_volume'¶
-
NO_QUALITY_ISSUE
= 'no_quality_issue'¶
-
OWA
= 'owa'¶
-
STATIC_NOISE
= 'static_noise'¶
-
UNKNOWN_QUALITY_ISSUE
= 'unknown_quality_issue'¶
-
-
account_sid
¶ Returns: The account_sid Return type: unicode
-
answered_by
¶ Returns: The answered_by Return type: AnnotationInstance.AnsweredBy
-
call_score
¶ Returns: The call_score Return type: unicode
-
call_sid
¶ Returns: The call_sid Return type: unicode
-
comment
¶ Returns: The comment Return type: unicode
-
connectivity_issue
¶ Returns: The connectivity_issue Return type: AnnotationInstance.ConnectivityIssue
-
fetch
()[source]¶ Fetch the AnnotationInstance
Returns: The fetched AnnotationInstance Return type: twilio.rest.insights.v1.annotation.AnnotationInstance
-
incident
¶ Returns: The incident Return type: unicode
-
update
(answered_by=<object object>, connectivity_issue=<object object>, quality_issues=<object object>, spam=<object object>, call_score=<object object>, comment=<object object>, incident=<object object>)[source]¶ Update the AnnotationInstance
Parameters: - answered_by (AnnotationInstance.AnsweredBy) – The answered_by
- connectivity_issue (AnnotationInstance.ConnectivityIssue) – The connectivity_issue
- quality_issues (unicode) – The quality_issues
- spam (bool) – The spam
- call_score (unicode) – The call_score
- comment (unicode) – The comment
- incident (unicode) – The incident
Returns: The updated AnnotationInstance
Return type:
-
url
¶ Returns: The url Return type: unicode
-
class
-
class
twilio.rest.insights.v1.annotation.
AnnotationList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(call_sid)[source]¶ Constructs a AnnotationContext
Parameters: call_sid – The call_sid Returns: twilio.rest.insights.v1.annotation.AnnotationContext Return type: twilio.rest.insights.v1.annotation.AnnotationContext
-
-
class
twilio.rest.insights.v1.annotation.
AnnotationPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of AnnotationInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.annotation.AnnotationInstance Return type: twilio.rest.insights.v1.annotation.AnnotationInstance
-
twilio.rest.insights.v1.call_summaries module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.call_summaries.
CallSummariesInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
CallDirection
[source]¶ Bases:
object
-
INBOUND
= 'inbound'¶
-
OUTBOUND_API
= 'outbound_api'¶
-
OUTBOUND_DIAL
= 'outbound_dial'¶
-
TRUNKING_ORIGINATING
= 'trunking_originating'¶
-
TRUNKING_TERMINATING
= 'trunking_terminating'¶
-
-
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'¶
-
-
class
ProcessingStateRequest
[source]¶ Bases:
object
-
ALL
= 'all'¶
-
COMPLETED
= 'completed'¶
-
PARTIAL
= 'partial'¶
-
STARTED
= 'started'¶
-
-
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: CallSummariesInstance.CallState
-
call_type
¶ Returns: The call_type Return type: CallSummariesInstance.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
-
processing_state
¶ Returns: The processing_state Return type: CallSummariesInstance.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_summaries.
CallSummariesList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get_page
(target_url)[source]¶ Retrieve a specific page of CallSummariesInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CallSummariesInstance Return type: twilio.rest.insights.v1.call_summaries.CallSummariesPage
-
list
(from_=<object object>, to=<object object>, from_carrier=<object object>, to_carrier=<object object>, from_country_code=<object object>, to_country_code=<object object>, branded=<object object>, verified_caller=<object object>, has_tag=<object object>, start_time=<object object>, end_time=<object object>, call_type=<object object>, call_state=<object object>, direction=<object object>, processing_state=<object object>, sort_by=<object object>, subaccount=<object object>, abnormal_session=<object object>, limit=None, page_size=None)[source]¶ Lists CallSummariesInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - from (unicode) – The from
- to (unicode) – The to
- from_carrier (unicode) – The from_carrier
- to_carrier (unicode) – The to_carrier
- from_country_code (unicode) – The from_country_code
- to_country_code (unicode) – The to_country_code
- branded (bool) – The branded
- verified_caller (bool) – The verified_caller
- has_tag (bool) – The has_tag
- start_time (unicode) – The start_time
- end_time (unicode) – The end_time
- call_type (unicode) – The call_type
- call_state (unicode) – The call_state
- direction (unicode) – The direction
- processing_state (CallSummariesInstance.ProcessingStateRequest) – The processing_state
- sort_by (CallSummariesInstance.SortBy) – The sort_by
- subaccount (unicode) – The subaccount
- abnormal_session (bool) – The abnormal_session
- 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.insights.v1.call_summaries.CallSummariesInstance]
-
page
(from_=<object object>, to=<object object>, from_carrier=<object object>, to_carrier=<object object>, from_country_code=<object object>, to_country_code=<object object>, branded=<object object>, verified_caller=<object object>, has_tag=<object object>, start_time=<object object>, end_time=<object object>, call_type=<object object>, call_state=<object object>, direction=<object object>, processing_state=<object object>, sort_by=<object object>, subaccount=<object object>, abnormal_session=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CallSummariesInstance records from the API. Request is executed immediately
Parameters: - from (unicode) – The from
- to (unicode) – The to
- from_carrier (unicode) – The from_carrier
- to_carrier (unicode) – The to_carrier
- from_country_code (unicode) – The from_country_code
- to_country_code (unicode) – The to_country_code
- branded (bool) – The branded
- verified_caller (bool) – The verified_caller
- has_tag (bool) – The has_tag
- start_time (unicode) – The start_time
- end_time (unicode) – The end_time
- call_type (unicode) – The call_type
- call_state (unicode) – The call_state
- direction (unicode) – The direction
- processing_state (CallSummariesInstance.ProcessingStateRequest) – The processing_state
- sort_by (CallSummariesInstance.SortBy) – The sort_by
- subaccount (unicode) – The subaccount
- abnormal_session (bool) – The abnormal_session
- 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 CallSummariesInstance
Return type:
-
stream
(from_=<object object>, to=<object object>, from_carrier=<object object>, to_carrier=<object object>, from_country_code=<object object>, to_country_code=<object object>, branded=<object object>, verified_caller=<object object>, has_tag=<object object>, start_time=<object object>, end_time=<object object>, call_type=<object object>, call_state=<object object>, direction=<object object>, processing_state=<object object>, sort_by=<object object>, subaccount=<object object>, abnormal_session=<object object>, limit=None, page_size=None)[source]¶ Streams CallSummariesInstance 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: - from (unicode) – The from
- to (unicode) – The to
- from_carrier (unicode) – The from_carrier
- to_carrier (unicode) – The to_carrier
- from_country_code (unicode) – The from_country_code
- to_country_code (unicode) – The to_country_code
- branded (bool) – The branded
- verified_caller (bool) – The verified_caller
- has_tag (bool) – The has_tag
- start_time (unicode) – The start_time
- end_time (unicode) – The end_time
- call_type (unicode) – The call_type
- call_state (unicode) – The call_state
- direction (unicode) – The direction
- processing_state (CallSummariesInstance.ProcessingStateRequest) – The processing_state
- sort_by (CallSummariesInstance.SortBy) – The sort_by
- subaccount (unicode) – The subaccount
- abnormal_session (bool) – The abnormal_session
- 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.insights.v1.call_summaries.CallSummariesInstance]
-
-
class
twilio.rest.insights.v1.call_summaries.
CallSummariesPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CallSummariesInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.call_summaries.CallSummariesInstance Return type: twilio.rest.insights.v1.call_summaries.CallSummariesInstance
-
twilio.rest.insights.v1.setting module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.setting.
SettingContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
(subaccount_sid=<object object>)[source]¶ Fetch the SettingInstance
Parameters: subaccount_sid (unicode) – The subaccount_sid Returns: The fetched SettingInstance Return type: twilio.rest.insights.v1.setting.SettingInstance
-
-
class
twilio.rest.insights.v1.setting.
SettingInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The account_sid Return type: unicode
-
fetch
(subaccount_sid=<object object>)[source]¶ Fetch the SettingInstance
Parameters: subaccount_sid (unicode) – The subaccount_sid Returns: The fetched SettingInstance Return type: twilio.rest.insights.v1.setting.SettingInstance
-
update
(advanced_features=<object object>, voice_trace=<object object>, subaccount_sid=<object object>)[source]¶ Update the SettingInstance
Parameters: Returns: The updated SettingInstance
Return type:
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.insights.v1.setting.
SettingList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a SettingContext
Returns: twilio.rest.insights.v1.setting.SettingContext Return type: twilio.rest.insights.v1.setting.SettingContext
-
-
class
twilio.rest.insights.v1.setting.
SettingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of SettingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.setting.SettingInstance Return type: twilio.rest.insights.v1.setting.SettingInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
annotation
¶ Return type: twilio.rest.insights.v1.annotation.AnnotationList
-
call_summaries
¶ Return type: twilio.rest.insights.v1.call_summaries.CallSummariesList
-
calls
¶ Return type: twilio.rest.insights.v1.call.CallList
-
conferences
¶ Return type: twilio.rest.insights.v1.conference.ConferenceList
-
rooms
¶ Return type: twilio.rest.insights.v1.room.RoomList
-
settings
¶ Return type: twilio.rest.insights.v1.setting.SettingList
-