twilio.rest.insights.v1.conference package

Submodules

twilio.rest.insights.v1.conference.conference_participant module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantContext(version, conference_sid, participant_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch(events=<object object>, metrics=<object object>)[source]

Fetch the ConferenceParticipantInstance

Parameters:
  • events (unicode) – Conference events generated by application or participant activity.
  • metrics (unicode) – Object. Contains call quality metrics.
Returns:

The fetched ConferenceParticipantInstance

Return type:

twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantInstance

class twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantInstance(version, payload, conference_sid, participant_sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class CallDirection[source]

Bases: object

INBOUND = 'inbound'
OUTBOUND = 'outbound'
class CallStatus[source]

Bases: object

ANSWERED = 'answered'
BUSY = 'busy'
CANCELED = 'canceled'
COMPLETED = 'completed'
FAIL = 'fail'
NOANSWER = 'noanswer'
RINGING = 'ringing'
class CallType[source]

Bases: object

CARRIER = 'carrier'
CLIENT = 'client'
SIP = 'sip'
class JitterBufferSize[source]

Bases: object

LARGE = 'large'
MEDIUM = 'medium'
OFF = 'off'
SMALL = 'small'
class ProcessingState[source]

Bases: object

COMPLETE = 'complete'
IN_PROGRESS = 'in_progress'
TIMEOUT = 'timeout'
class Region[source]

Bases: object

AU1 = 'au1'
BR1 = 'br1'
DE1 = 'de1'
IE1 = 'ie1'
JP1 = 'jp1'
SG1 = 'sg1'
US1 = 'us1'
US2 = 'us2'
account_sid
Returns:Account SID.
Return type:unicode
call_direction
Returns:Call direction of the participant.
Return type:ConferenceParticipantInstance.CallDirection
call_sid
Returns:Unique SID identifier of the call.
Return type:unicode
call_status
Returns:Call status of the call that generated the participant.
Return type:ConferenceParticipantInstance.CallStatus
call_type
Returns:The Call Type of this Conference Participant.
Return type:ConferenceParticipantInstance.CallType
coached_participants
Returns:Call SIDs coached by this participant.
Return type:list[unicode]
conference_region
Returns:The Conference Region of this Conference Participant.
Return type:ConferenceParticipantInstance.Region
conference_sid
Returns:Conference SID.
Return type:unicode
country_code
Returns:ISO alpha-2 country code of the participant.
Return type:unicode
duration_seconds
Returns:Participant durations in seconds.
Return type:unicode
events
Returns:Object containing information of actions taken by participants. Nested resource URLs.
Return type:dict
fetch(events=<object object>, metrics=<object object>)[source]

Fetch the ConferenceParticipantInstance

Parameters:
  • events (unicode) – Conference events generated by application or participant activity.
  • metrics (unicode) – Object. Contains call quality metrics.
Returns:

The fetched ConferenceParticipantInstance

Return type:

twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantInstance

from_
Returns:Caller ID of the calling party.
Return type:unicode
is_coach
Returns:Boolean. Indicated whether participant was a coach.
Return type:bool
is_moderator
Returns:Boolean. Indicates whether participant had startConferenceOnEnter=true or endConferenceOnExit=true.
Return type:bool
jitter_buffer_size
Returns:The Jitter Buffer Size of this Conference Participant.
Return type:ConferenceParticipantInstance.JitterBufferSize
join_time
Returns:ISO 8601 timestamp of participant join event.
Return type:datetime
label
Returns:The user-specified label of this participant.
Return type:unicode
leave_time
Returns:ISO 8601 timestamp of participant leave event.
Return type:datetime
metrics
Returns:Object. Contains participant quality metrics.
Return type:dict
outbound_queue_length
Returns:Estimated time in queue at call creation.
Return type:unicode
outbound_time_in_queue
Returns:Actual time in queue (seconds).
Return type:unicode
participant_region
Returns:Twilio region where the participant media originates.
Return type:ConferenceParticipantInstance.Region
participant_sid
Returns:SID for this participant.
Return type:unicode
processing_state
Returns:Processing state of the Participant Summary.
Return type:ConferenceParticipantInstance.ProcessingState
properties
Returns:Participant properties and metadata.
Return type:dict
to
Returns:Called party.
Return type:unicode
url
Returns:The URL of this resource.
Return type:unicode
class twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantList(version, conference_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(participant_sid)[source]

Constructs a ConferenceParticipantContext

Parameters:participant_sid – Participant SID.
Returns:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantContext
Return type:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ConferenceParticipantInstance
Return type:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantPage
list(participant_sid=<object object>, label=<object object>, events=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • participant_sid (unicode) – Participant SID.
  • label (unicode) – User-specified label for a participant.
  • events (unicode) – Conference events generated by application or participant activity.
  • 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.conference.conference_participant.ConferenceParticipantInstance]

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

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

Parameters:
  • participant_sid (unicode) – Participant SID.
  • label (unicode) – User-specified label for a participant.
  • events (unicode) – Conference events generated by application or participant activity.
  • 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 ConferenceParticipantInstance

Return type:

twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantPage

stream(participant_sid=<object object>, label=<object object>, events=<object object>, limit=None, page_size=None)[source]

Streams ConferenceParticipantInstance 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:
  • participant_sid (unicode) – Participant SID.
  • label (unicode) – User-specified label for a participant.
  • events (unicode) – Conference events generated by application or participant activity.
  • 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.conference.conference_participant.ConferenceParticipantInstance]

class twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ConferenceParticipantInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantInstance
Return type:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.insights.v1.conference.ConferenceContext(version, conference_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

conference_participants

Access the conference_participants

Returns:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantList
Return type:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantList
fetch()[source]

Fetch the ConferenceInstance

Returns:The fetched ConferenceInstance
Return type:twilio.rest.insights.v1.conference.ConferenceInstance
class twilio.rest.insights.v1.conference.ConferenceInstance(version, payload, conference_sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class ConferenceEndReason[source]

Bases: object

CONFERENCE_ENDED_VIA_API = 'conference_ended_via_api'
LAST_PARTICIPANT_KICKED = 'last_participant_kicked'
LAST_PARTICIPANT_LEFT = 'last_participant_left'
PARTICIPANT_WITH_END_CONFERENCE_ON_EXIT_KICKED = 'participant_with_end_conference_on_exit_kicked'
PARTICIPANT_WITH_END_CONFERENCE_ON_EXIT_LEFT = 'participant_with_end_conference_on_exit_left'
class ConferenceStatus[source]

Bases: object

COMPLETED = 'completed'
IN_PROGRESS = 'in_progress'
NOT_STARTED = 'not_started'
SUMMARY_TIMEOUT = 'summary_timeout'
class ProcessingState[source]

Bases: object

COMPLETE = 'complete'
IN_PROGRESS = 'in_progress'
TIMEOUT = 'timeout'
class Region[source]

Bases: object

AU1 = 'au1'
BR1 = 'br1'
DE1 = 'de1'
IE1 = 'ie1'
JP1 = 'jp1'
SG1 = 'sg1'
US1 = 'us1'
class Tag[source]

Bases: object

DETECTED_SILENCE = 'detected_silence'
DUPLICATE_IDENTITY = 'duplicate_identity'
HIGH_JITTER = 'high_jitter'
HIGH_LATENCY = 'high_latency'
HIGH_PACKET_LOSS = 'high_packet_loss'
INVALID_REQUESTED_REGION = 'invalid_requested_region'
LOW_MOS = 'low_mos'
PARTICIPANT_BEHAVIOR_ISSUES = 'participant_behavior_issues'
QUALITY_WARNINGS = 'quality_warnings'
REGION_CONFIGURATION_ISSUES = 'region_configuration_issues'
START_FAILURE = 'start_failure'
account_sid
Returns:Account SID.
Return type:unicode
conference_participants

Access the conference_participants

Returns:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantList
Return type:twilio.rest.insights.v1.conference.conference_participant.ConferenceParticipantList
conference_sid
Returns:Conference SID.
Return type:unicode
connect_duration_seconds
Returns:Duration of the conference in seconds.
Return type:unicode
create_time
Returns:Conference creation date/time.
Return type:datetime
detected_issues
Returns:Potential issues detected during the conference.
Return type:dict
duration_seconds
Returns:Conference duration in seconds.
Return type:unicode
end_reason
Returns:Conference end reason.
Return type:ConferenceInstance.ConferenceEndReason
end_time
Returns:Conference end date/time.
Return type:datetime
ended_by
Returns:Call SID that ended the conference.
Return type:unicode
fetch()[source]

Fetch the ConferenceInstance

Returns:The fetched ConferenceInstance
Return type:twilio.rest.insights.v1.conference.ConferenceInstance
friendly_name
Returns:Custom label for the conference.
Return type:unicode
Returns:Nested resource URLs.
Return type:unicode
max_concurrent_participants
Returns:Actual maximum concurrent participants.
Return type:unicode
max_participants
Returns:Max participants specified in config.
Return type:unicode
mixer_region
Returns:Region where the conference was mixed.
Return type:ConferenceInstance.Region
mixer_region_requested
Returns:Configuration-requested conference mixer region.
Return type:ConferenceInstance.Region
processing_state
Returns:Processing state for the Conference Summary resource.
Return type:ConferenceInstance.ProcessingState
recording_enabled
Returns:Boolean. Indicates whether recording was enabled.
Return type:bool
start_time
Returns:Timestamp in ISO 8601 format when the conference started.
Return type:datetime
status
Returns:Status of conference
Return type:ConferenceInstance.ConferenceStatus
tag_info
Returns:Object. Contains details about conference tags.
Return type:dict
tags
Returns:Tags for detected conference conditions and participant behaviors.
Return type:list[ConferenceInstance.Tag]
unique_participants
Returns:Unique conference participants.
Return type:unicode
url
Returns:The URL of this resource.
Return type:unicode
class twilio.rest.insights.v1.conference.ConferenceList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(conference_sid)[source]

Constructs a ConferenceContext

Parameters:conference_sid – Conference SID.
Returns:twilio.rest.insights.v1.conference.ConferenceContext
Return type:twilio.rest.insights.v1.conference.ConferenceContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ConferenceInstance
Return type:twilio.rest.insights.v1.conference.ConferencePage
list(conference_sid=<object object>, friendly_name=<object object>, status=<object object>, created_after=<object object>, created_before=<object object>, mixer_region=<object object>, tags=<object object>, subaccount=<object object>, detected_issues=<object object>, end_reason=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • conference_sid (unicode) – The SID of the conference.
  • friendly_name (unicode) – Custom label for the conference.
  • status (unicode) – Conference status.
  • created_after (unicode) – Conferences created after timestamp.
  • created_before (unicode) – Conferences created before timestamp.
  • mixer_region (unicode) – Region where the conference was mixed.
  • tags (unicode) – Tags applied by Twilio for common issues.
  • subaccount (unicode) – Account SID for the subaccount.
  • detected_issues (unicode) – Potential issues detected during the conference.
  • end_reason (unicode) – Conference end reason.
  • 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.conference.ConferenceInstance]

page(conference_sid=<object object>, friendly_name=<object object>, status=<object object>, created_after=<object object>, created_before=<object object>, mixer_region=<object object>, tags=<object object>, subaccount=<object object>, detected_issues=<object object>, end_reason=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • conference_sid (unicode) – The SID of the conference.
  • friendly_name (unicode) – Custom label for the conference.
  • status (unicode) – Conference status.
  • created_after (unicode) – Conferences created after timestamp.
  • created_before (unicode) – Conferences created before timestamp.
  • mixer_region (unicode) – Region where the conference was mixed.
  • tags (unicode) – Tags applied by Twilio for common issues.
  • subaccount (unicode) – Account SID for the subaccount.
  • detected_issues (unicode) – Potential issues detected during the conference.
  • end_reason (unicode) – Conference end reason.
  • 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 ConferenceInstance

Return type:

twilio.rest.insights.v1.conference.ConferencePage

stream(conference_sid=<object object>, friendly_name=<object object>, status=<object object>, created_after=<object object>, created_before=<object object>, mixer_region=<object object>, tags=<object object>, subaccount=<object object>, detected_issues=<object object>, end_reason=<object object>, limit=None, page_size=None)[source]

Streams ConferenceInstance 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:
  • conference_sid (unicode) – The SID of the conference.
  • friendly_name (unicode) – Custom label for the conference.
  • status (unicode) – Conference status.
  • created_after (unicode) – Conferences created after timestamp.
  • created_before (unicode) – Conferences created before timestamp.
  • mixer_region (unicode) – Region where the conference was mixed.
  • tags (unicode) – Tags applied by Twilio for common issues.
  • subaccount (unicode) – Account SID for the subaccount.
  • detected_issues (unicode) – Potential issues detected during the conference.
  • end_reason (unicode) – Conference end reason.
  • 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.conference.ConferenceInstance]

class twilio.rest.insights.v1.conference.ConferencePage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ConferenceInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.insights.v1.conference.ConferenceInstance
Return type:twilio.rest.insights.v1.conference.ConferenceInstance