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.InstanceContext
PLEASE 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.InstanceResource
PLEASE 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: Account SID associated with the room. Return type: unicode
-
codecs
¶ Returns: Codecs detected from the participant. Return type: list[ParticipantInstance.Codec]
-
duration_sec
¶ Returns: Amount of time in seconds the participant was in the room. Return type: unicode
-
edge_location
¶ Returns: Name of the edge location the participant connected to. Return type: ParticipantInstance.EdgeLocation
-
end_reason
¶ Returns: Reason the participant left the room. Return type: unicode
-
error_code
¶ Returns: Errors encountered by the participant. Return type: unicode
-
error_code_url
¶ Returns: Twilio error code dictionary link. Return type: unicode
-
fetch
()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.insights.v1.room.participant.ParticipantInstance
-
join_time
¶ Returns: When the participant joined the room. Return type: datetime
-
leave_time
¶ Returns: When the participant left the room Return type: datetime
-
media_region
¶ Returns: Twilio media region the participant connected to. Return type: ParticipantInstance.TwilioRealm
-
participant_identity
¶ Returns: The application-defined string that uniquely identifies the participant within a Room. Return type: unicode
-
participant_sid
¶ Returns: Unique identifier for the participant. Return type: unicode
-
properties
¶ Returns: Object containing information about the participant’s data from the room. Return type: dict
-
publisher_info
¶ Returns: Object containing information about the SDK name and version. Return type: dict
-
room_sid
¶ Returns: Unique identifier for the room. Return type: unicode
-
status
¶ Returns: Status of the room. Return type: ParticipantInstance.RoomStatus
-
url
¶ Returns: URL of the participant resource. Return type: unicode
-
class
-
class
twilio.rest.insights.v1.room.participant.
ParticipantList
(version, room_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE 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 SID of the Participant resource. 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.Page
PLEASE 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.InstanceContext
PLEASE 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.InstanceResource
PLEASE 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: Account SID associated with this room. Return type: unicode
-
codecs
¶ Returns: Codecs used by participants in the room. Return type: list[RoomInstance.Codec]
-
concurrent_participants
¶ Returns: Actual number of concurrent participants. Return type: unicode
-
create_time
¶ Returns: Creation time of the room. Return type: datetime
-
created_method
¶ Returns: How the room was created. Return type: RoomInstance.CreatedMethod
-
duration_sec
¶ Returns: Total room duration from create time to end time. Return type: unicode
-
edge_location
¶ Returns: Edge location of Twilio media servers for the room. Return type: RoomInstance.EdgeLocation
-
end_reason
¶ Returns: Reason the room ended. Return type: RoomInstance.EndReason
-
end_time
¶ Returns: End time for the room. Return type: datetime
-
fetch
()[source]¶ Fetch the RoomInstance
Returns: The fetched RoomInstance Return type: twilio.rest.insights.v1.room.RoomInstance
-
links
¶ Returns: Room subresources. Return type: unicode
-
max_concurrent_participants
¶ Returns: Maximum number of participants allowed in the room at the same time allowed by the application settings. Return type: unicode
-
max_participants
¶ Returns: Max number of total participants allowed by the application settings. Return type: unicode
-
media_region
¶ Returns: Region of Twilio media servers for the room. 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: Video Log Analyzer resource state. Will be either in-progress or complete. Return type: RoomInstance.ProcessingState
-
recording_enabled
¶ Returns: Boolean indicating if recording is enabled for the room. Return type: bool
-
room_name
¶ Returns: room friendly name. Return type: unicode
-
room_sid
¶ Returns: Unique identifier for the room. Return type: unicode
-
room_status
¶ Returns: Status of the room. Return type: RoomInstance.RoomStatus
-
room_type
¶ Returns: Type of room. Return type: RoomInstance.RoomType
-
status_callback
¶ Returns: Webhook provided for status callbacks. Return type: unicode
-
status_callback_method
¶ Returns: HTTP method provided for status callback URL. Return type: unicode
-
total_participant_duration_sec
¶ Returns: Combined amount of participant time in the room. Return type: unicode
-
total_recording_duration_sec
¶ Returns: Combined amount of recorded seconds for participants in the room. Return type: unicode
-
unique_participant_identities
¶ Returns: Unique number of participant identities. Return type: unicode
-
unique_participants
¶ Returns: Number of participants. May include duplicate identities for participants who left and rejoined. Return type: unicode
-
url
¶ Returns: URL for the room resource. Return type: unicode
-
class
-
class
twilio.rest.insights.v1.room.
RoomList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE 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 SID of the Room resource. 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]) – Type of room.
- codec (list[RoomInstance.Codec]) – Codecs used by participants in the room.
- room_name (unicode) – Room friendly name.
- created_after (datetime) – Only read rooms that started on or after this ISO 8601 timestamp.
- created_before (datetime) – Only read rooms that started before this ISO 8601 timestamp.
- 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]) – Type of room.
- codec (list[RoomInstance.Codec]) – Codecs used by participants in the room.
- room_name (unicode) – Room friendly name.
- created_after (datetime) – Only read rooms that started on or after this ISO 8601 timestamp.
- created_before (datetime) – Only read rooms that started before this ISO 8601 timestamp.
- 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]) – Type of room.
- codec (list[RoomInstance.Codec]) – Codecs used by participants in the room.
- room_name (unicode) – Room friendly name.
- created_after (datetime) – Only read rooms that started on or after this ISO 8601 timestamp.
- created_before (datetime) – Only read rooms that started before this ISO 8601 timestamp.
- 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.Page
PLEASE 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
-