twilio.rest.insights.v1.room package¶
Submodules¶
twilio.rest.insights.v1.room.participant module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.room.participant.ParticipantContext(version, room_sid, participant_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
fetch()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.insights.v1.room.participant.ParticipantInstance
-
-
class
twilio.rest.insights.v1.room.participant.ParticipantInstance(version, payload, room_sid, participant_sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
class
EdgeLocation[source]¶ Bases:
object-
ASHBURN= 'ashburn'¶
-
DUBLIN= 'dublin'¶
-
FRANKFURT= 'frankfurt'¶
-
ROAMING= 'roaming'¶
-
SAO_PAULO= 'sao_paulo'¶
-
SINGAPORE= 'singapore'¶
-
SYDNEY= 'sydney'¶
-
TOKYO= 'tokyo'¶
-
UMATILLA= 'umatilla'¶
-
-
class
TwilioRealm[source]¶ Bases:
object-
AU1= 'au1'¶
-
BR1= 'br1'¶
-
DE1= 'de1'¶
-
GLL= 'gll'¶
-
IE1= 'ie1'¶
-
IN1= 'in1'¶
-
JP1= 'jp1'¶
-
SG1= 'sg1'¶
-
US1= 'us1'¶
-
US2= 'us2'¶
-
-
account_sid¶ Returns: The account_sid Return type: unicode
-
codecs¶ Returns: The codecs Return type: list[ParticipantInstance.Codec]
-
duration_sec¶ Returns: The duration_sec Return type: unicode
-
edge_location¶ Returns: The edge_location Return type: ParticipantInstance.EdgeLocation
-
end_reason¶ Returns: The end_reason Return type: unicode
-
error_code¶ Returns: The error_code Return type: unicode
-
error_code_url¶ Returns: The error_code_url Return type: unicode
-
fetch()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.insights.v1.room.participant.ParticipantInstance
-
join_time¶ Returns: The join_time Return type: datetime
-
leave_time¶ Returns: The leave_time Return type: datetime
-
media_region¶ Returns: The media_region Return type: ParticipantInstance.TwilioRealm
-
participant_identity¶ Returns: The participant_identity Return type: unicode
-
participant_sid¶ Returns: The participant_sid Return type: unicode
-
room_sid¶ Returns: The room_sid Return type: unicode
-
status¶ Returns: The status Return type: ParticipantInstance.RoomStatus
-
url¶ Returns: The url Return type: unicode
-
class
-
class
twilio.rest.insights.v1.room.participant.ParticipantList(version, room_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get(participant_sid)[source]¶ Constructs a ParticipantContext
Parameters: participant_sid – The participant_sid Returns: twilio.rest.insights.v1.room.participant.ParticipantContext Return type: twilio.rest.insights.v1.room.participant.ParticipantContext
-
get_page(target_url)[source]¶ Retrieve a specific page of ParticipantInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of ParticipantInstance Return type: twilio.rest.insights.v1.room.participant.ParticipantPage
-
list(limit=None, page_size=None)[source]¶ Lists ParticipantInstance 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.insights.v1.room.participant.ParticipantInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of ParticipantInstance records from the API. Request is executed immediately
Parameters: Returns: Page of ParticipantInstance
Return type:
-
stream(limit=None, page_size=None)[source]¶ Streams ParticipantInstance 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.insights.v1.room.participant.ParticipantInstance]
-
-
class
twilio.rest.insights.v1.room.participant.ParticipantPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get_instance(payload)[source]¶ Build an instance of ParticipantInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.room.participant.ParticipantInstance Return type: twilio.rest.insights.v1.room.participant.ParticipantInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.insights.v1.room.RoomContext(version, room_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
fetch()[source]¶ Fetch the RoomInstance
Returns: The fetched RoomInstance Return type: twilio.rest.insights.v1.room.RoomInstance
-
participants¶ Access the participants
Returns: twilio.rest.insights.v1.room.participant.ParticipantList Return type: twilio.rest.insights.v1.room.participant.ParticipantList
-
-
class
twilio.rest.insights.v1.room.RoomInstance(version, payload, room_sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
class
EdgeLocation[source]¶ Bases:
object-
ASHBURN= 'ashburn'¶
-
DUBLIN= 'dublin'¶
-
FRANKFURT= 'frankfurt'¶
-
ROAMING= 'roaming'¶
-
SAO_PAULO= 'sao_paulo'¶
-
SINGAPORE= 'singapore'¶
-
SYDNEY= 'sydney'¶
-
TOKYO= 'tokyo'¶
-
UMATILLA= 'umatilla'¶
-
-
class
EndReason[source]¶ Bases:
object-
ROOM_ENDED_VIA_API= 'room_ended_via_api'¶
-
TIMEOUT= 'timeout'¶
-
-
class
RoomType[source]¶ Bases:
object-
GO= 'go'¶
-
GROUP= 'group'¶
-
GROUP_SMALL= 'group_small'¶
-
PEER_TO_PEER= 'peer_to_peer'¶
-
-
class
TwilioRealm[source]¶ Bases:
object-
AU1= 'au1'¶
-
BR1= 'br1'¶
-
DE1= 'de1'¶
-
GLL= 'gll'¶
-
IE1= 'ie1'¶
-
IN1= 'in1'¶
-
JP1= 'jp1'¶
-
SG1= 'sg1'¶
-
US1= 'us1'¶
-
US2= 'us2'¶
-
-
account_sid¶ Returns: The account_sid Return type: unicode
-
codecs¶ Returns: The codecs Return type: list[RoomInstance.Codec]
-
concurrent_participants¶ Returns: The concurrent_participants Return type: unicode
-
create_time¶ Returns: The create_time Return type: datetime
-
created_method¶ Returns: The created_method Return type: RoomInstance.CreatedMethod
-
duration_sec¶ Returns: The duration_sec Return type: unicode
-
edge_location¶ Returns: The edge_location Return type: RoomInstance.EdgeLocation
-
end_reason¶ Returns: The end_reason Return type: RoomInstance.EndReason
-
end_time¶ Returns: The end_time Return type: datetime
-
fetch()[source]¶ Fetch the RoomInstance
Returns: The fetched RoomInstance Return type: twilio.rest.insights.v1.room.RoomInstance
-
links¶ Returns: The links Return type: unicode
-
max_concurrent_participants¶ Returns: The max_concurrent_participants Return type: unicode
-
max_participants¶ Returns: The max_participants Return type: unicode
-
media_region¶ Returns: The media_region Return type: RoomInstance.TwilioRealm
-
participants¶ Access the participants
Returns: twilio.rest.insights.v1.room.participant.ParticipantList Return type: twilio.rest.insights.v1.room.participant.ParticipantList
-
processing_state¶ Returns: The processing_state Return type: RoomInstance.ProcessingState
-
room_name¶ Returns: The room_name Return type: unicode
-
room_sid¶ Returns: The room_sid Return type: unicode
-
room_status¶ Returns: The room_status Return type: RoomInstance.RoomStatus
-
room_type¶ Returns: The room_type Return type: RoomInstance.RoomType
-
status_callback¶ Returns: The status_callback Return type: unicode
-
status_callback_method¶ Returns: The status_callback_method Return type: unicode
-
total_participant_duration_sec¶ Returns: The total_participant_duration_sec Return type: unicode
-
total_recording_duration_sec¶ Returns: The total_recording_duration_sec Return type: unicode
-
unique_participant_identities¶ Returns: The unique_participant_identities Return type: unicode
-
unique_participants¶ Returns: The unique_participants Return type: unicode
-
url¶ Returns: The url Return type: unicode
-
class
-
class
twilio.rest.insights.v1.room.RoomList(version)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get(room_sid)[source]¶ Constructs a RoomContext
Parameters: room_sid – The room_sid Returns: twilio.rest.insights.v1.room.RoomContext Return type: twilio.rest.insights.v1.room.RoomContext
-
get_page(target_url)[source]¶ Retrieve a specific page of RoomInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of RoomInstance Return type: twilio.rest.insights.v1.room.RoomPage
-
list(room_type=<object object>, codec=<object object>, room_name=<object object>, created_after=<object object>, created_before=<object object>, limit=None, page_size=None)[source]¶ Lists RoomInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - room_type (list[RoomInstance.RoomType]) – The room_type
- codec (list[RoomInstance.Codec]) – The codec
- room_name (unicode) – The room_name
- created_after (datetime) – The created_after
- created_before (datetime) – The created_before
- 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(room_type=<object object>, codec=<object object>, room_name=<object object>, created_after=<object object>, created_before=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of RoomInstance records from the API. Request is executed immediately
Parameters: - room_type (list[RoomInstance.RoomType]) – The room_type
- codec (list[RoomInstance.Codec]) – The codec
- room_name (unicode) – The room_name
- created_after (datetime) – The created_after
- created_before (datetime) – The created_before
- 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 RoomInstance
Return type:
-
stream(room_type=<object object>, codec=<object object>, room_name=<object object>, created_after=<object object>, created_before=<object object>, limit=None, page_size=None)[source]¶ Streams RoomInstance 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: - room_type (list[RoomInstance.RoomType]) – The room_type
- codec (list[RoomInstance.Codec]) – The codec
- room_name (unicode) – The room_name
- created_after (datetime) – The created_after
- created_before (datetime) – The created_before
- 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.room.RoomPage(version, response, solution)[source]¶ Bases:
twilio.base.page.PagePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
get_instance(payload)[source]¶ Build an instance of RoomInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.insights.v1.room.RoomInstance Return type: twilio.rest.insights.v1.room.RoomInstance
-