twilio.rest.proxy.v1.service.session.participant package¶
Submodules¶
twilio.rest.proxy.v1.service.session.participant.message_interaction module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionContext(version, service_sid, session_sid, participant_sid, 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 MessageInteractionInstance
Returns: The fetched MessageInteractionInstance Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance
-
-
class
twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance(version, payload, service_sid, session_sid, participant_sid, 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
ResourceStatus[source]¶ Bases:
object-
ACCEPTED= 'accepted'¶
-
ANSWERED= 'answered'¶
-
BUSY= 'busy'¶
-
CANCELED= 'canceled'¶
-
COMPLETED= 'completed'¶
-
DELETED= 'deleted'¶
-
DELIVERED= 'delivered'¶
-
DELIVERY_UNKNOWN= 'delivery-unknown'¶
-
FAILED= 'failed'¶
-
INITIATED= 'initiated'¶
-
IN_PROGRESS= 'in-progress'¶
-
NO_ANSWER= 'no-answer'¶
-
QUEUED= 'queued'¶
-
RECEIVED= 'received'¶
-
RECEIVING= 'receiving'¶
-
RINGING= 'ringing'¶
-
SCHEDULED= 'scheduled'¶
-
SENDING= 'sending'¶
-
SENT= 'sent'¶
-
UNDELIVERED= 'undelivered'¶
-
UNKNOWN= 'unknown'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
data¶ Returns: A JSON string that includes the message body sent to the participant Return type: unicode
-
date_created¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
fetch()[source]¶ Fetch the MessageInteractionInstance
Returns: The fetched MessageInteractionInstance Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance
-
inbound_participant_sid¶ Returns: Always empty for Message Interactions Return type: unicode
-
inbound_resource_sid¶ Returns: Always empty for Message Interactions Return type: unicode
-
inbound_resource_status¶ Returns: Always empty for Message Interactions Return type: MessageInteractionInstance.ResourceStatus
-
inbound_resource_type¶ Returns: Always empty for Message Interactions Return type: unicode
-
inbound_resource_url¶ Returns: Always empty for Message Interactions Return type: unicode
-
outbound_participant_sid¶ Returns: The SID of the outbound Participant resource Return type: unicode
-
outbound_resource_sid¶ Returns: The SID of the outbound Message resource Return type: unicode
-
outbound_resource_status¶ Returns: The outbound resource status Return type: MessageInteractionInstance.ResourceStatus
-
outbound_resource_type¶ Returns: The outbound resource type Return type: unicode
-
outbound_resource_url¶ Returns: The URL of the Twilio message resource Return type: unicode
-
participant_sid¶ Returns: The SID of the Participant resource Return type: unicode
-
service_sid¶ Returns: The SID of the resource’s parent Service Return type: unicode
-
session_sid¶ Returns: The SID of the resource’s parent Session Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
type¶ Returns: The Type of Message Interaction Return type: MessageInteractionInstance.Type
-
url¶ Returns: The absolute URL of the MessageInteraction resource Return type: unicode
-
class
-
class
twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionList(version, service_sid, session_sid, participant_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
create(body=<object object>, media_url=<object object>)[source]¶ Create the MessageInteractionInstance
Parameters: - body (unicode) – Message body
- media_url (list[unicode]) – Reserved
Returns: The created MessageInteractionInstance
Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance
-
get(sid)[source]¶ Constructs a MessageInteractionContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionContext Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionContext
-
get_page(target_url)[source]¶ Retrieve a specific page of MessageInteractionInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of MessageInteractionInstance Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionPage
-
list(limit=None, page_size=None)[source]¶ Lists MessageInteractionInstance 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.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of MessageInteractionInstance records from the API. Request is executed immediately
Parameters: Returns: Page of MessageInteractionInstance
Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionPage
-
stream(limit=None, page_size=None)[source]¶ Streams MessageInteractionInstance 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.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance]
-
-
class
twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionPage(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 MessageInteractionInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.proxy.v1.service.session.participant.ParticipantContext(version, service_sid, session_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContextPLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
delete()[source]¶ Deletes the ParticipantInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.proxy.v1.service.session.participant.ParticipantInstance
-
message_interactions¶ Access the message_interactions
Returns: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionList Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionList
-
-
class
twilio.rest.proxy.v1.service.session.participant.ParticipantInstance(version, payload, service_sid, session_sid, 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.
-
account_sid¶ Returns: The SID of the Account that created the resource Return type: unicode
-
date_created¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_deleted¶ Returns: The ISO 8601 date the Participant was removed Return type: datetime
-
date_updated¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete()[source]¶ Deletes the ParticipantInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.proxy.v1.service.session.participant.ParticipantInstance
-
friendly_name¶ Returns: The string that you assigned to describe the participant Return type: unicode
-
identifier¶ Returns: The phone number of the Participant Return type: unicode
-
links¶ Returns: The URLs to resources related the participant Return type: unicode
-
message_interactions¶ Access the message_interactions
Returns: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionList Return type: twilio.rest.proxy.v1.service.session.participant.message_interaction.MessageInteractionList
-
proxy_identifier¶ Returns: The phone number or short code of the participant’s partner Return type: unicode
-
proxy_identifier_sid¶ Returns: The SID of the Proxy Identifier assigned to the Participant Return type: unicode
-
service_sid¶ Returns: The SID of the resource’s parent Service Return type: unicode
-
session_sid¶ Returns: The SID of the resource’s parent Session Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource Return type: unicode
-
url¶ Returns: The absolute URL of the Participant resource Return type: unicode
-
-
class
twilio.rest.proxy.v1.service.session.participant.ParticipantList(version, service_sid, session_sid)[source]¶ Bases:
twilio.base.list_resource.ListResourcePLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
-
create(identifier, friendly_name=<object object>, proxy_identifier=<object object>, proxy_identifier_sid=<object object>, fail_on_participant_conflict=<object object>)[source]¶ Create the ParticipantInstance
Parameters: - identifier (unicode) – The phone number of the Participant
- friendly_name (unicode) – The string that you assigned to describe the participant
- proxy_identifier (unicode) – The proxy phone number to use for the Participant
- proxy_identifier_sid (unicode) – The Proxy Identifier Sid
- fail_on_participant_conflict (bool) – An experimental parameter to override the ProxyAllowParticipantConflict account flag on a per-request basis.
Returns: The created ParticipantInstance
Return type: twilio.rest.proxy.v1.service.session.participant.ParticipantInstance
-
get(sid)[source]¶ Constructs a ParticipantContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.proxy.v1.service.session.participant.ParticipantContext Return type: twilio.rest.proxy.v1.service.session.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.proxy.v1.service.session.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.proxy.v1.service.session.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: twilio.rest.proxy.v1.service.session.participant.ParticipantPage
-
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.proxy.v1.service.session.participant.ParticipantInstance]
-
-
class
twilio.rest.proxy.v1.service.session.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.proxy.v1.service.session.participant.ParticipantInstance Return type: twilio.rest.proxy.v1.service.session.participant.ParticipantInstance
-