twilio.rest.api.v2010.account.conference package¶
Submodules¶
twilio.rest.api.v2010.account.conference.participant module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.conference.participant.
ParticipantContext
(version, account_sid, conference_sid, call_sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
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.api.v2010.account.conference.participant.ParticipantInstance
-
update
(muted=<object object>, hold=<object object>, hold_url=<object object>, hold_method=<object object>, announce_url=<object object>, announce_method=<object object>, wait_url=<object object>, wait_method=<object object>, beep_on_exit=<object object>, end_conference_on_exit=<object object>, coaching=<object object>, call_sid_to_coach=<object object>)[source]¶ Update the ParticipantInstance
Parameters: - muted (bool) – Whether the participant should be muted
- hold (bool) – Whether the participant should be on hold
- hold_url (unicode) – The URL we call using the hold_method for music that plays when the participant is on hold
- hold_method (unicode) – The HTTP method we should use to call hold_url
- announce_url (unicode) – The URL we call using the announce_method for an announcement to the participant
- announce_method (unicode) – The HTTP method we should use to call announce_url
- wait_url (unicode) – The URL we call using the wait_method for the music to play while participants are waiting for the conference to start
- wait_method (unicode) – The HTTP method we should use to call wait_url
- beep_on_exit (bool) – Whether to play a notification beep to the conference when the participant exit
- end_conference_on_exit (bool) – Whether to end the conference when the participant leaves
- coaching (bool) – Indicates if the participant changed to coach
- call_sid_to_coach (unicode) – The SID of the participant who is being coached
Returns: The updated ParticipantInstance
Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance
-
-
class
twilio.rest.api.v2010.account.conference.participant.
ParticipantInstance
(version, payload, account_sid, conference_sid, call_sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Status
[source]¶ Bases:
object
-
COMPLETE
= 'complete'¶
-
CONNECTED
= 'connected'¶
-
CONNECTING
= 'connecting'¶
-
FAILED
= 'failed'¶
-
QUEUED
= 'queued'¶
-
RINGING
= 'ringing'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
call_sid
¶ Returns: The SID of the Call the resource is associated with Return type: unicode
-
call_sid_to_coach
¶ Returns: The SID of the participant who is being coached Return type: unicode
-
conference_sid
¶ Returns: The SID of the conference the participant is in Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the ParticipantInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
end_conference_on_exit
¶ Returns: Whether the conference ends when the participant leaves Return type: bool
-
fetch
()[source]¶ Fetch the ParticipantInstance
Returns: The fetched ParticipantInstance Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance
-
label
¶ Returns: The label of this participant Return type: unicode
-
start_conference_on_enter
¶ Returns: Whether the conference starts when the participant joins the conference Return type: bool
-
status
¶ Returns: The status of the participant’s call in a session Return type: ParticipantInstance.Status
-
update
(muted=<object object>, hold=<object object>, hold_url=<object object>, hold_method=<object object>, announce_url=<object object>, announce_method=<object object>, wait_url=<object object>, wait_method=<object object>, beep_on_exit=<object object>, end_conference_on_exit=<object object>, coaching=<object object>, call_sid_to_coach=<object object>)[source]¶ Update the ParticipantInstance
Parameters: - muted (bool) – Whether the participant should be muted
- hold (bool) – Whether the participant should be on hold
- hold_url (unicode) – The URL we call using the hold_method for music that plays when the participant is on hold
- hold_method (unicode) – The HTTP method we should use to call hold_url
- announce_url (unicode) – The URL we call using the announce_method for an announcement to the participant
- announce_method (unicode) – The HTTP method we should use to call announce_url
- wait_url (unicode) – The URL we call using the wait_method for the music to play while participants are waiting for the conference to start
- wait_method (unicode) – The HTTP method we should use to call wait_url
- beep_on_exit (bool) – Whether to play a notification beep to the conference when the participant exit
- end_conference_on_exit (bool) – Whether to end the conference when the participant leaves
- coaching (bool) – Indicates if the participant changed to coach
- call_sid_to_coach (unicode) – The SID of the participant who is being coached
Returns: The updated ParticipantInstance
Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance
-
uri
¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.conference.participant.
ParticipantList
(version, account_sid, conference_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(from_, to, status_callback=<object object>, status_callback_method=<object object>, status_callback_event=<object object>, label=<object object>, timeout=<object object>, record=<object object>, muted=<object object>, beep=<object object>, start_conference_on_enter=<object object>, end_conference_on_exit=<object object>, wait_url=<object object>, wait_method=<object object>, early_media=<object object>, max_participants=<object object>, conference_record=<object object>, conference_trim=<object object>, conference_status_callback=<object object>, conference_status_callback_method=<object object>, conference_status_callback_event=<object object>, recording_channels=<object object>, recording_status_callback=<object object>, recording_status_callback_method=<object object>, sip_auth_username=<object object>, sip_auth_password=<object object>, region=<object object>, conference_recording_status_callback=<object object>, conference_recording_status_callback_method=<object object>, recording_status_callback_event=<object object>, conference_recording_status_callback_event=<object object>, coaching=<object object>, call_sid_to_coach=<object object>, jitter_buffer_size=<object object>, byoc=<object object>, caller_id=<object object>, call_reason=<object object>, recording_track=<object object>, time_limit=<object object>, machine_detection=<object object>, machine_detection_timeout=<object object>, machine_detection_speech_threshold=<object object>, machine_detection_speech_end_threshold=<object object>, machine_detection_silence_timeout=<object object>, amd_status_callback=<object object>, amd_status_callback_method=<object object>)[source]¶ Create the ParticipantInstance
Parameters: - from (unicode) – The phone number, Client identifier, or username portion of SIP address that made this call.
- to (unicode) – The phone number, SIP address or Client identifier that received this call.
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- status_callback_event (list[unicode]) – Set state change events that will trigger a callback
- label (unicode) – The label of this participant
- timeout (unicode) – he number of seconds that we should wait for an answer
- record (bool) – Whether to record the participant and their conferences
- muted (bool) – Whether to mute the agent
- beep (unicode) – Whether to play a notification beep to the conference when the participant joins
- start_conference_on_enter (bool) – Whether the conference starts when the participant joins the conference
- end_conference_on_exit (bool) – Whether to end the conference when the participant leaves
- wait_url (unicode) – URL that hosts pre-conference hold music
- wait_method (unicode) – The HTTP method we should use to call wait_url
- early_media (bool) – Whether agents can hear the state of the outbound call
- max_participants (unicode) – The maximum number of agent conference participants
- conference_record (unicode) – Whether to record the conference the participant is joining
- conference_trim (unicode) – Whether to trim leading and trailing silence from your recorded conference audio files
- conference_status_callback (unicode) – The callback URL for conference events
- conference_status_callback_method (unicode) – HTTP method for requesting conference_status_callback URL
- conference_status_callback_event (list[unicode]) – The conference state changes that should generate a call to conference_status_callback
- recording_channels (unicode) – Specify mono or dual recording channels
- recording_status_callback (unicode) – The URL that we should call using the recording_status_callback_method when the recording status changes
- recording_status_callback_method (unicode) – The HTTP method we should use when we call recording_status_callback
- sip_auth_username (unicode) – The SIP username used for authentication
- sip_auth_password (unicode) – The SIP password for authentication
- region (unicode) – The region where we should mix the conference audio
- conference_recording_status_callback (unicode) – The URL we should call using the conference_recording_status_callback_method when the conference recording is available
- conference_recording_status_callback_method (unicode) – The HTTP method we should use to call conference_recording_status_callback
- recording_status_callback_event (list[unicode]) – The recording state changes that should generate a call to recording_status_callback
- conference_recording_status_callback_event (list[unicode]) – The conference recording state changes that should generate a call to conference_recording_status_callback
- coaching (bool) – Indicates if the participant changed to coach
- call_sid_to_coach (unicode) – The SID of the participant who is being coached
- jitter_buffer_size (unicode) – Jitter Buffer size for the connecting participant
- byoc (unicode) – BYOC trunk SID (Beta)
- caller_id (unicode) – The phone number, Client identifier, or username portion of SIP address that made this call.
- call_reason (unicode) – Reason for the call (Branded Calls Beta)
- recording_track (unicode) – The track(s) to record
- time_limit (unicode) – The maximum duration of the call in seconds.
- machine_detection (unicode) – Enable machine detection or end of greeting detection
- machine_detection_timeout (unicode) – Number of seconds to wait for machine detection
- machine_detection_speech_threshold (unicode) – Number of milliseconds for measuring stick for the length of the speech activity
- machine_detection_speech_end_threshold (unicode) – Number of milliseconds of silence after speech activity
- machine_detection_silence_timeout (unicode) – Number of milliseconds of initial silence
- amd_status_callback (unicode) – The URL we should call to send amd status information to your application
- amd_status_callback_method (unicode) – HTTP Method to use with amd_status_callback
Returns: The created ParticipantInstance
Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance
-
get
(call_sid)[source]¶ Constructs a ParticipantContext
Parameters: call_sid – The Call SID or URL encoded label of the participant to fetch Returns: twilio.rest.api.v2010.account.conference.participant.ParticipantContext Return type: twilio.rest.api.v2010.account.conference.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.api.v2010.account.conference.participant.ParticipantPage
-
list
(muted=<object object>, hold=<object object>, coaching=<object object>, 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: - muted (bool) – Whether to return only participants that are muted
- hold (bool) – Whether to return only participants that are on hold
- coaching (bool) – Whether to return only participants who are coaching another call
- 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.api.v2010.account.conference.participant.ParticipantInstance]
-
page
(muted=<object object>, hold=<object object>, coaching=<object object>, 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: - muted (bool) – Whether to return only participants that are muted
- hold (bool) – Whether to return only participants that are on hold
- coaching (bool) – Whether to return only participants who are coaching another call
- 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 ParticipantInstance
Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantPage
-
stream
(muted=<object object>, hold=<object object>, coaching=<object object>, 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: - muted (bool) – Whether to return only participants that are muted
- hold (bool) – Whether to return only participants that are on hold
- coaching (bool) – Whether to return only participants who are coaching another call
- 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.api.v2010.account.conference.participant.ParticipantInstance]
-
-
class
twilio.rest.api.v2010.account.conference.participant.
ParticipantPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of ParticipantInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantInstance
-
twilio.rest.api.v2010.account.conference.recording module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.conference.recording.
RecordingContext
(version, account_sid, conference_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the RecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RecordingInstance
Returns: The fetched RecordingInstance Return type: twilio.rest.api.v2010.account.conference.recording.RecordingInstance
-
update
(status, pause_behavior=<object object>)[source]¶ Update the RecordingInstance
Parameters: - status (RecordingInstance.Status) – The new status of the recording
- pause_behavior (unicode) – Whether to record during a pause
Returns: The updated RecordingInstance
Return type: twilio.rest.api.v2010.account.conference.recording.RecordingInstance
-
-
class
twilio.rest.api.v2010.account.conference.recording.
RecordingInstance
(version, payload, account_sid, conference_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Source
[source]¶ Bases:
object
-
CONFERENCE
= 'Conference'¶
-
DIALVERB
= 'DialVerb'¶
-
OUTBOUNDAPI
= 'OutboundAPI'¶
-
RECORDVERB
= 'RecordVerb'¶
-
STARTCALLRECORDINGAPI
= 'StartCallRecordingAPI'¶
-
STARTCONFERENCERECORDINGAPI
= 'StartConferenceRecordingAPI'¶
-
TRUNKING
= 'Trunking'¶
-
-
class
Status
[source]¶ Bases:
object
-
ABSENT
= 'absent'¶
-
COMPLETED
= 'completed'¶
-
IN_PROGRESS
= 'in-progress'¶
-
PAUSED
= 'paused'¶
-
PROCESSING
= 'processing'¶
-
STOPPED
= 'stopped'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
api_version
¶ Returns: The API version used to create the recording Return type: unicode
-
call_sid
¶ Returns: The SID of the Call the resource is associated with Return type: unicode
-
channels
¶ Returns: The number of channels in the final recording file as an integer Return type: unicode
-
conference_sid
¶ Returns: The Conference SID that identifies the conference associated with the recording Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT that the resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT that the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the RecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
duration
¶ Returns: The length of the recording in seconds Return type: unicode
-
error_code
¶ Returns: More information about why the recording is missing, if status is absent. Return type: unicode
-
fetch
()[source]¶ Fetch the RecordingInstance
Returns: The fetched RecordingInstance Return type: twilio.rest.api.v2010.account.conference.recording.RecordingInstance
-
price
¶ Returns: The one-time cost of creating the recording. Return type: unicode
-
price_unit
¶ Returns: The currency used in the price property. Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
source
¶ Returns: How the recording was created Return type: RecordingInstance.Source
-
start_time
¶ Returns: The start time of the recording, given in RFC 2822 format Return type: datetime
-
status
¶ Returns: The status of the recording Return type: RecordingInstance.Status
-
update
(status, pause_behavior=<object object>)[source]¶ Update the RecordingInstance
Parameters: - status (RecordingInstance.Status) – The new status of the recording
- pause_behavior (unicode) – Whether to record during a pause
Returns: The updated RecordingInstance
Return type: twilio.rest.api.v2010.account.conference.recording.RecordingInstance
-
uri
¶ Returns: The URI of the resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.conference.recording.
RecordingList
(version, account_sid, conference_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(sid)[source]¶ Constructs a RecordingContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.api.v2010.account.conference.recording.RecordingContext Return type: twilio.rest.api.v2010.account.conference.recording.RecordingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of RecordingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of RecordingInstance Return type: twilio.rest.api.v2010.account.conference.recording.RecordingPage
-
list
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, limit=None, page_size=None)[source]¶ Lists RecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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.api.v2010.account.conference.recording.RecordingInstance]
-
page
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of RecordingInstance records from the API. Request is executed immediately
Parameters: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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 RecordingInstance
Return type: twilio.rest.api.v2010.account.conference.recording.RecordingPage
-
stream
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, limit=None, page_size=None)[source]¶ Streams RecordingInstance 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: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- 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.api.v2010.account.conference.recording.RecordingInstance]
-
-
class
twilio.rest.api.v2010.account.conference.recording.
RecordingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of RecordingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.api.v2010.account.conference.recording.RecordingInstance Return type: twilio.rest.api.v2010.account.conference.recording.RecordingInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.api.v2010.account.conference.
ConferenceContext
(version, account_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
()[source]¶ Fetch the ConferenceInstance
Returns: The fetched ConferenceInstance Return type: twilio.rest.api.v2010.account.conference.ConferenceInstance
-
participants
¶ Access the participants
Returns: twilio.rest.api.v2010.account.conference.participant.ParticipantList Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantList
-
recordings
¶ Access the recordings
Returns: twilio.rest.api.v2010.account.conference.recording.RecordingList Return type: twilio.rest.api.v2010.account.conference.recording.RecordingList
-
update
(status=<object object>, announce_url=<object object>, announce_method=<object object>)[source]¶ Update the ConferenceInstance
Parameters: - status (ConferenceInstance.UpdateStatus) – The new status of the resource
- announce_url (unicode) – The URL we should call to announce something into the conference
- announce_method (unicode) – he HTTP method used to call announce_url
Returns: The updated ConferenceInstance
Return type:
-
-
class
twilio.rest.api.v2010.account.conference.
ConferenceInstance
(version, payload, account_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
ReasonConferenceEnded
[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
Status
[source]¶ Bases:
object
-
COMPLETED
= 'completed'¶
-
INIT
= 'init'¶
-
IN_PROGRESS
= 'in-progress'¶
-
-
account_sid
¶ Returns: The SID of the Account that created this resource Return type: unicode
-
api_version
¶ Returns: The API version used to create this conference Return type: unicode
-
call_sid_ending_conference
¶ Returns: The call SID that caused the conference to end Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT that this resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT that this resource was last updated Return type: datetime
-
fetch
()[source]¶ Fetch the ConferenceInstance
Returns: The fetched ConferenceInstance Return type: twilio.rest.api.v2010.account.conference.ConferenceInstance
-
friendly_name
¶ Returns: A string that you assigned to describe this conference room Return type: unicode
-
participants
¶ Access the participants
Returns: twilio.rest.api.v2010.account.conference.participant.ParticipantList Return type: twilio.rest.api.v2010.account.conference.participant.ParticipantList
-
reason_conference_ended
¶ Returns: The reason why a conference ended. Return type: ConferenceInstance.ReasonConferenceEnded
-
recordings
¶ Access the recordings
Returns: twilio.rest.api.v2010.account.conference.recording.RecordingList Return type: twilio.rest.api.v2010.account.conference.recording.RecordingList
-
region
¶ Returns: A string that represents the Twilio Region where the conference was mixed Return type: unicode
-
sid
¶ Returns: The unique string that identifies this resource Return type: unicode
-
status
¶ Returns: The status of this conference Return type: ConferenceInstance.Status
-
subresource_uris
¶ Returns: A list of related resources identified by their relative URIs Return type: unicode
-
update
(status=<object object>, announce_url=<object object>, announce_method=<object object>)[source]¶ Update the ConferenceInstance
Parameters: - status (ConferenceInstance.UpdateStatus) – The new status of the resource
- announce_url (unicode) – The URL we should call to announce something into the conference
- announce_method (unicode) – he HTTP method used to call announce_url
Returns: The updated ConferenceInstance
Return type:
-
uri
¶ Returns: The URI of this resource, relative to https://api.twilio.com Return type: unicode
-
class
-
class
twilio.rest.api.v2010.account.conference.
ConferenceList
(version, account_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(sid)[source]¶ Constructs a ConferenceContext
Parameters: sid – The unique string that identifies this resource Returns: twilio.rest.api.v2010.account.conference.ConferenceContext Return type: twilio.rest.api.v2010.account.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.api.v2010.account.conference.ConferencePage
-
list
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, date_updated_before=<object object>, date_updated=<object object>, date_updated_after=<object object>, friendly_name=<object object>, status=<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: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- date_updated_before (date) – The YYYY-MM-DD value of the resources to read
- date_updated (date) – The YYYY-MM-DD value of the resources to read
- date_updated_after (date) – The YYYY-MM-DD value of the resources to read
- friendly_name (unicode) – The string that identifies the Conference resources to read
- status (ConferenceInstance.Status) – The status of the resources to read
- 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.api.v2010.account.conference.ConferenceInstance]
-
page
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, date_updated_before=<object object>, date_updated=<object object>, date_updated_after=<object object>, friendly_name=<object object>, status=<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: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- date_updated_before (date) – The YYYY-MM-DD value of the resources to read
- date_updated (date) – The YYYY-MM-DD value of the resources to read
- date_updated_after (date) – The YYYY-MM-DD value of the resources to read
- friendly_name (unicode) – The string that identifies the Conference resources to read
- status (ConferenceInstance.Status) – The status of the resources to read
- 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:
-
stream
(date_created_before=<object object>, date_created=<object object>, date_created_after=<object object>, date_updated_before=<object object>, date_updated=<object object>, date_updated_after=<object object>, friendly_name=<object object>, status=<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: - date_created_before (date) – The YYYY-MM-DD value of the resources to read
- date_created (date) – The YYYY-MM-DD value of the resources to read
- date_created_after (date) – The YYYY-MM-DD value of the resources to read
- date_updated_before (date) – The YYYY-MM-DD value of the resources to read
- date_updated (date) – The YYYY-MM-DD value of the resources to read
- date_updated_after (date) – The YYYY-MM-DD value of the resources to read
- friendly_name (unicode) – The string that identifies the Conference resources to read
- status (ConferenceInstance.Status) – The status of the resources to read
- 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.api.v2010.account.conference.ConferenceInstance]
-
-
class
twilio.rest.api.v2010.account.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.api.v2010.account.conference.ConferenceInstance Return type: twilio.rest.api.v2010.account.conference.ConferenceInstance
-