twilio.rest.taskrouter.v1.workspace.worker package

Submodules

twilio.rest.taskrouter.v1.workspace.worker.reservation module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationContext(version, workspace_sid, worker_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the ReservationInstance

Returns:The fetched ReservationInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance
update(reservation_status=<object object>, worker_activity_sid=<object object>, instruction=<object object>, dequeue_post_work_activity_sid=<object object>, dequeue_from=<object object>, dequeue_record=<object object>, dequeue_timeout=<object object>, dequeue_to=<object object>, dequeue_status_callback_url=<object object>, call_from=<object object>, call_record=<object object>, call_timeout=<object object>, call_to=<object object>, call_url=<object object>, call_status_callback_url=<object object>, call_accept=<object object>, redirect_call_sid=<object object>, redirect_accept=<object object>, redirect_url=<object object>, to=<object object>, from_=<object object>, status_callback=<object object>, status_callback_method=<object object>, status_callback_event=<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_status_callback=<object object>, conference_status_callback_method=<object object>, conference_status_callback_event=<object object>, conference_record=<object object>, conference_trim=<object object>, recording_channels=<object object>, recording_status_callback=<object object>, recording_status_callback_method=<object object>, conference_recording_status_callback=<object object>, conference_recording_status_callback_method=<object object>, region=<object object>, sip_auth_username=<object object>, sip_auth_password=<object object>, dequeue_status_callback_event=<object object>, post_work_activity_sid=<object object>, end_conference_on_customer_exit=<object object>, beep_on_customer_entrance=<object object>, if_match=<object object>)[source]

Update the ReservationInstance

Parameters:
  • reservation_status (ReservationInstance.Status) – The new status of the reservation
  • worker_activity_sid (unicode) – The new worker activity SID if rejecting a reservation
  • instruction (unicode) – The assignment instruction for the reservation
  • dequeue_post_work_activity_sid (unicode) – The SID of the Activity resource to start after executing a Dequeue instruction
  • dequeue_from (unicode) – The caller ID of the call to the worker when executing a Dequeue instruction
  • dequeue_record (unicode) – Whether to record both legs of a call when executing a Dequeue instruction
  • dequeue_timeout (unicode) – The timeout for call when executing a Dequeue instruction
  • dequeue_to (unicode) – The contact URI of the worker when executing a Dequeue instruction
  • dequeue_status_callback_url (unicode) – The callback URL for completed call event when executing a Dequeue instruction
  • call_from (unicode) – The Caller ID of the outbound call when executing a Call instruction
  • call_record (unicode) – Whether to record both legs of a call when executing a Call instruction
  • call_timeout (unicode) – The timeout for a call when executing a Call instruction
  • call_to (unicode) – The contact URI of the worker when executing a Call instruction
  • call_url (unicode) – TwiML URI executed on answering the worker’s leg as a result of the Call instruction
  • call_status_callback_url (unicode) – The URL to call for the completed call event when executing a Call instruction
  • call_accept (bool) – Whether to accept a reservation when executing a Call instruction
  • redirect_call_sid (unicode) – The Call SID of the call parked in the queue when executing a Redirect instruction
  • redirect_accept (bool) – Whether the reservation should be accepted when executing a Redirect instruction
  • redirect_url (unicode) – TwiML URI to redirect the call to when executing the Redirect instruction
  • to (unicode) – The Contact URI of the worker when executing a Conference instruction
  • from (unicode) – The caller ID of the call to the worker when executing a Conference instruction
  • 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[ReservationInstance.CallStatus]) – The call progress events that we will send to status_callback
  • timeout (unicode) – The timeout for a call when executing a Conference instruction
  • 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 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 agent 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_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[ReservationInstance.ConferenceEvent]) – The conference status events that we will send to conference_status_callback
  • 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
  • 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
  • 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
  • region (unicode) – The region where we should mix the conference audio
  • sip_auth_username (unicode) – The SIP username used for authentication
  • sip_auth_password (unicode) – The SIP password for authentication
  • dequeue_status_callback_event (list[unicode]) – The call progress events sent via webhooks as a result of a Dequeue instruction
  • post_work_activity_sid (unicode) – The new worker activity SID after executing a Conference instruction
  • end_conference_on_customer_exit (bool) – Whether to end the conference when the customer leaves
  • beep_on_customer_entrance (bool) – Whether to play a notification beep when the customer joins
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated ReservationInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance

class twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance(version, payload, workspace_sid, worker_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class CallStatus[source]

Bases: object

ANSWERED = 'answered'
COMPLETED = 'completed'
INITIATED = 'initiated'
RINGING = 'ringing'
class ConferenceEvent[source]

Bases: object

END = 'end'
HOLD = 'hold'
JOIN = 'join'
LEAVE = 'leave'
MUTE = 'mute'
SPEAKER = 'speaker'
START = 'start'
class Status[source]

Bases: object

ACCEPTED = 'accepted'
CANCELED = 'canceled'
COMPLETED = 'completed'
PENDING = 'pending'
REJECTED = 'rejected'
RESCINDED = 'rescinded'
TIMEOUT = 'timeout'
WRAPPING = 'wrapping'
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_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
fetch()[source]

Fetch the ReservationInstance

Returns:The fetched ReservationInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance
Returns:The URLs of related resources
Return type:unicode
reservation_status
Returns:The current status of the reservation
Return type:ReservationInstance.Status
sid
Returns:The unique string that identifies the resource
Return type:unicode
task_sid
Returns:The SID of the reserved Task resource
Return type:unicode
update(reservation_status=<object object>, worker_activity_sid=<object object>, instruction=<object object>, dequeue_post_work_activity_sid=<object object>, dequeue_from=<object object>, dequeue_record=<object object>, dequeue_timeout=<object object>, dequeue_to=<object object>, dequeue_status_callback_url=<object object>, call_from=<object object>, call_record=<object object>, call_timeout=<object object>, call_to=<object object>, call_url=<object object>, call_status_callback_url=<object object>, call_accept=<object object>, redirect_call_sid=<object object>, redirect_accept=<object object>, redirect_url=<object object>, to=<object object>, from_=<object object>, status_callback=<object object>, status_callback_method=<object object>, status_callback_event=<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_status_callback=<object object>, conference_status_callback_method=<object object>, conference_status_callback_event=<object object>, conference_record=<object object>, conference_trim=<object object>, recording_channels=<object object>, recording_status_callback=<object object>, recording_status_callback_method=<object object>, conference_recording_status_callback=<object object>, conference_recording_status_callback_method=<object object>, region=<object object>, sip_auth_username=<object object>, sip_auth_password=<object object>, dequeue_status_callback_event=<object object>, post_work_activity_sid=<object object>, end_conference_on_customer_exit=<object object>, beep_on_customer_entrance=<object object>, if_match=<object object>)[source]

Update the ReservationInstance

Parameters:
  • reservation_status (ReservationInstance.Status) – The new status of the reservation
  • worker_activity_sid (unicode) – The new worker activity SID if rejecting a reservation
  • instruction (unicode) – The assignment instruction for the reservation
  • dequeue_post_work_activity_sid (unicode) – The SID of the Activity resource to start after executing a Dequeue instruction
  • dequeue_from (unicode) – The caller ID of the call to the worker when executing a Dequeue instruction
  • dequeue_record (unicode) – Whether to record both legs of a call when executing a Dequeue instruction
  • dequeue_timeout (unicode) – The timeout for call when executing a Dequeue instruction
  • dequeue_to (unicode) – The contact URI of the worker when executing a Dequeue instruction
  • dequeue_status_callback_url (unicode) – The callback URL for completed call event when executing a Dequeue instruction
  • call_from (unicode) – The Caller ID of the outbound call when executing a Call instruction
  • call_record (unicode) – Whether to record both legs of a call when executing a Call instruction
  • call_timeout (unicode) – The timeout for a call when executing a Call instruction
  • call_to (unicode) – The contact URI of the worker when executing a Call instruction
  • call_url (unicode) – TwiML URI executed on answering the worker’s leg as a result of the Call instruction
  • call_status_callback_url (unicode) – The URL to call for the completed call event when executing a Call instruction
  • call_accept (bool) – Whether to accept a reservation when executing a Call instruction
  • redirect_call_sid (unicode) – The Call SID of the call parked in the queue when executing a Redirect instruction
  • redirect_accept (bool) – Whether the reservation should be accepted when executing a Redirect instruction
  • redirect_url (unicode) – TwiML URI to redirect the call to when executing the Redirect instruction
  • to (unicode) – The Contact URI of the worker when executing a Conference instruction
  • from (unicode) – The caller ID of the call to the worker when executing a Conference instruction
  • 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[ReservationInstance.CallStatus]) – The call progress events that we will send to status_callback
  • timeout (unicode) – The timeout for a call when executing a Conference instruction
  • 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 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 agent 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_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[ReservationInstance.ConferenceEvent]) – The conference status events that we will send to conference_status_callback
  • 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
  • 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
  • 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
  • region (unicode) – The region where we should mix the conference audio
  • sip_auth_username (unicode) – The SIP username used for authentication
  • sip_auth_password (unicode) – The SIP password for authentication
  • dequeue_status_callback_event (list[unicode]) – The call progress events sent via webhooks as a result of a Dequeue instruction
  • post_work_activity_sid (unicode) – The new worker activity SID after executing a Conference instruction
  • end_conference_on_customer_exit (bool) – Whether to end the conference when the customer leaves
  • beep_on_customer_entrance (bool) – Whether to play a notification beep when the customer joins
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated ReservationInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance

url
Returns:The absolute URL of the WorkerReservation resource
Return type:unicode
worker_name
Returns:The friendly_name of the Worker that is reserved
Return type:unicode
worker_sid
Returns:The SID of the reserved Worker resource
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that this worker is contained within.
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationList(version, workspace_sid, worker_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a ReservationContext

Parameters:sid – The SID of the WorkerReservation resource to fetch
Returns:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ReservationInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationPage
list(reservation_status=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • reservation_status (ReservationInstance.Status) – Returns the list of reservations for a worker with a specified ReservationStatus
  • 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.taskrouter.v1.workspace.worker.reservation.ReservationInstance]

page(reservation_status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • reservation_status (ReservationInstance.Status) – Returns the list of reservations for a worker with a specified ReservationStatus
  • 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 ReservationInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationPage

stream(reservation_status=<object object>, limit=None, page_size=None)[source]

Streams ReservationInstance 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:
  • reservation_status (ReservationInstance.Status) – Returns the list of reservations for a worker with a specified ReservationStatus
  • 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.taskrouter.v1.workspace.worker.reservation.ReservationInstance]

class twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ReservationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationInstance

twilio.rest.taskrouter.v1.workspace.worker.worker_channel module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelContext(version, workspace_sid, worker_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the WorkerChannelInstance

Returns:The fetched WorkerChannelInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance
update(capacity=<object object>, available=<object object>)[source]

Update the WorkerChannelInstance

Parameters:
  • capacity (unicode) – The total number of Tasks that the Worker should handle for the TaskChannel type
  • available (bool) – Whether the WorkerChannel is available
Returns:

The updated WorkerChannelInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance

class twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance(version, payload, workspace_sid, worker_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
assigned_tasks
Returns:The total number of Tasks assigned to Worker for the TaskChannel type
Return type:unicode
available
Returns:Whether the Worker should receive Tasks of the TaskChannel type
Return type:bool
available_capacity_percentage
Returns:The current available capacity between 0 to 100 for the TaskChannel
Return type:unicode
configured_capacity
Returns:The current configured capacity for the WorkerChannel
Return type:unicode
date_created
Returns:The RFC 2822 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The RFC 2822 date and time in GMT when the resource was last updated
Return type:datetime
fetch()[source]

Fetch the WorkerChannelInstance

Returns:The fetched WorkerChannelInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance
sid
Returns:The unique string that identifies the resource
Return type:unicode
task_channel_sid
Returns:The SID of the TaskChannel
Return type:unicode
task_channel_unique_name
Returns:The unique name of the TaskChannel, such as ‘voice’ or ‘sms’
Return type:unicode
update(capacity=<object object>, available=<object object>)[source]

Update the WorkerChannelInstance

Parameters:
  • capacity (unicode) – The total number of Tasks that the Worker should handle for the TaskChannel type
  • available (bool) – Whether the WorkerChannel is available
Returns:

The updated WorkerChannelInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance

url
Returns:The absolute URL of the WorkerChannel resource
Return type:unicode
worker_sid
Returns:The SID of the Worker that contains the WorkerChannel
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that contains the WorkerChannel
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelList(version, workspace_sid, worker_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a WorkerChannelContext

Parameters:sid – The SID of the to fetch
Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of WorkerChannelInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelPage
list(limit=None, page_size=None)[source]

Lists WorkerChannelInstance 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.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance]

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

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

Parameters:
  • 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 WorkerChannelInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelPage

stream(limit=None, page_size=None)[source]

Streams WorkerChannelInstance 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.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance]

class twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkerChannelInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelInstance

twilio.rest.taskrouter.v1.workspace.worker.worker_statistics module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext(version, workspace_sid, worker_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch(minutes=<object object>, start_date=<object object>, end_date=<object object>, task_channel=<object object>)[source]

Fetch the WorkerStatisticsInstance

Parameters:
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • end_date (datetime) – Only include usage that occurred on or before this date
  • task_channel (unicode) – Only calculate statistics on this TaskChannel
Returns:

The fetched WorkerStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance

class twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance(version, payload, workspace_sid, worker_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
cumulative
Returns:An object that contains the cumulative statistics for the Worker
Return type:dict
fetch(minutes=<object object>, start_date=<object object>, end_date=<object object>, task_channel=<object object>)[source]

Fetch the WorkerStatisticsInstance

Parameters:
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • end_date (datetime) – Only include usage that occurred on or before this date
  • task_channel (unicode) – Only calculate statistics on this TaskChannel
Returns:

The fetched WorkerStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance

url
Returns:The absolute URL of the WorkerChannel statistics resource
Return type:unicode
worker_sid
Returns:The SID of the Worker that contains the WorkerChannel
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that contains the WorkerChannel
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList(version, workspace_sid, worker_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WorkerStatisticsContext

Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsContext
class twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkerStatisticsInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsInstance

twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsContext(version, workspace_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch(end_date=<object object>, minutes=<object object>, start_date=<object object>, task_channel=<object object>)[source]

Fetch the WorkersCumulativeStatisticsInstance

Parameters:
  • end_date (datetime) – Only calculate statistics from on or before this date
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • task_channel (unicode) – Only calculate cumulative statistics on this TaskChannel
Returns:

The fetched WorkersCumulativeStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsInstance

class twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsInstance(version, payload, workspace_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
activity_durations
Returns:The minimum, average, maximum, and total time that Workers spent in each Activity
Return type:list[dict]
end_time
Returns:The end of the interval during which these statistics were calculated
Return type:datetime
fetch(end_date=<object object>, minutes=<object object>, start_date=<object object>, task_channel=<object object>)[source]

Fetch the WorkersCumulativeStatisticsInstance

Parameters:
  • end_date (datetime) – Only calculate statistics from on or before this date
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • task_channel (unicode) – Only calculate cumulative statistics on this TaskChannel
Returns:

The fetched WorkersCumulativeStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsInstance

reservations_accepted
Returns:The total number of Reservations that were accepted
Return type:unicode
reservations_canceled
Returns:The total number of Reservations that were canceled
Return type:unicode
reservations_created
Returns:The total number of Reservations that were created
Return type:unicode
reservations_rejected
Returns:The total number of Reservations that were rejected
Return type:unicode
reservations_rescinded
Returns:The total number of Reservations that were rescinded
Return type:unicode
reservations_timed_out
Returns:The total number of Reservations that were timed out
Return type:unicode
start_time
Returns:The beginning of the interval during which these statistics were calculated
Return type:datetime
url
Returns:The absolute URL of the Workers statistics resource
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that contains the Workers
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsList(version, workspace_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WorkersCumulativeStatisticsContext

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsContext
class twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkersCumulativeStatisticsInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsInstance

twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsContext(version, workspace_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch(task_channel=<object object>)[source]

Fetch the WorkersRealTimeStatisticsInstance

Parameters:task_channel (unicode) – Only calculate real-time statistics on this TaskChannel
Returns:The fetched WorkersRealTimeStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsInstance
class twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsInstance(version, payload, workspace_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
activity_statistics
Returns:The number of current Workers by Activity
Return type:list[dict]
fetch(task_channel=<object object>)[source]

Fetch the WorkersRealTimeStatisticsInstance

Parameters:task_channel (unicode) – Only calculate real-time statistics on this TaskChannel
Returns:The fetched WorkersRealTimeStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsInstance
total_workers
Returns:The total number of Workers
Return type:unicode
url
Returns:The absolute URL of the Workers statistics resource
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that contains the Workers
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsList(version, workspace_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WorkersRealTimeStatisticsContext

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsContext
class twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkersRealTimeStatisticsInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsInstance

twilio.rest.taskrouter.v1.workspace.worker.workers_statistics module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsContext(version, workspace_sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch(minutes=<object object>, start_date=<object object>, end_date=<object object>, task_queue_sid=<object object>, task_queue_name=<object object>, friendly_name=<object object>, task_channel=<object object>)[source]

Fetch the WorkersStatisticsInstance

Parameters:
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • end_date (datetime) – Only calculate statistics from this date and time and earlier
  • task_queue_sid (unicode) – The SID of the TaskQueue for which to fetch Worker statistics
  • task_queue_name (unicode) – The friendly_name of the TaskQueue for which to fetch Worker statistics
  • friendly_name (unicode) – Only include Workers with friendly_name values that match this parameter
  • task_channel (unicode) – Only calculate statistics on this TaskChannel
Returns:

The fetched WorkersStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsInstance

class twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsInstance(version, payload, workspace_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
cumulative
Returns:An object that contains the cumulative statistics for the Worker
Return type:dict
fetch(minutes=<object object>, start_date=<object object>, end_date=<object object>, task_queue_sid=<object object>, task_queue_name=<object object>, friendly_name=<object object>, task_channel=<object object>)[source]

Fetch the WorkersStatisticsInstance

Parameters:
  • minutes (unicode) – Only calculate statistics since this many minutes in the past
  • start_date (datetime) – Only calculate statistics from on or after this date
  • end_date (datetime) – Only calculate statistics from this date and time and earlier
  • task_queue_sid (unicode) – The SID of the TaskQueue for which to fetch Worker statistics
  • task_queue_name (unicode) – The friendly_name of the TaskQueue for which to fetch Worker statistics
  • friendly_name (unicode) – Only include Workers with friendly_name values that match this parameter
  • task_channel (unicode) – Only calculate statistics on this TaskChannel
Returns:

The fetched WorkersStatisticsInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsInstance

realtime
Returns:An object that contains the real-time statistics for the Worker
Return type:dict
url
Returns:The absolute URL of the Worker statistics resource
Return type:unicode
workspace_sid
Returns:The SID of the Workspace that contains the Worker
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsList(version, workspace_sid)[source]

Bases: twilio.base.list_resource.ListResource

get()[source]

Constructs a WorkersStatisticsContext

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsContext
class twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkersStatisticsInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.taskrouter.v1.workspace.worker.WorkerContext(version, workspace_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

cumulative_statistics

Access the cumulative_statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsList
delete(if_match=<object object>)[source]

Deletes the WorkerInstance

Parameters:if_match (unicode) – The If-Match HTTP request header
Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the WorkerInstance

Returns:The fetched WorkerInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance
real_time_statistics

Access the real_time_statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsList
reservations

Access the reservations

Returns:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationList
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationList
statistics

Access the statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList
update(activity_sid=<object object>, attributes=<object object>, friendly_name=<object object>, reject_pending_reservations=<object object>, if_match=<object object>)[source]

Update the WorkerInstance

Parameters:
  • activity_sid (unicode) – The SID of the Activity that describes the Worker’s initial state
  • attributes (unicode) – The JSON string that describes the Worker
  • friendly_name (unicode) – A string to describe the Worker
  • reject_pending_reservations (bool) – Whether to reject the Worker’s pending reservations
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated WorkerInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance

worker_channels

Access the worker_channels

Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelList
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelList
class twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance(version, payload, workspace_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
activity_name
Returns:The friendly_name of the Worker’s current Activity
Return type:unicode
activity_sid
Returns:The SID of the Worker’s current Activity
Return type:unicode
attributes
Returns:The JSON string that describes the Worker
Return type:unicode
available
Returns:Whether the Worker is available to perform tasks
Return type:bool
cumulative_statistics

Access the cumulative_statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_cumulative_statistics.WorkersCumulativeStatisticsList
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_status_changed
Returns:The date and time in GMT of the last change to the Worker’s activity
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
delete(if_match=<object object>)[source]

Deletes the WorkerInstance

Parameters:if_match (unicode) – The If-Match HTTP request header
Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the WorkerInstance

Returns:The fetched WorkerInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance
friendly_name
Returns:The string that you assigned to describe the resource
Return type:unicode
Returns:The URLs of related resources
Return type:unicode
real_time_statistics

Access the real_time_statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_real_time_statistics.WorkersRealTimeStatisticsList
reservations

Access the reservations

Returns:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationList
Return type:twilio.rest.taskrouter.v1.workspace.worker.reservation.ReservationList
sid
Returns:The unique string that identifies the resource
Return type:unicode
statistics

Access the statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_statistics.WorkerStatisticsList
update(activity_sid=<object object>, attributes=<object object>, friendly_name=<object object>, reject_pending_reservations=<object object>, if_match=<object object>)[source]

Update the WorkerInstance

Parameters:
  • activity_sid (unicode) – The SID of the Activity that describes the Worker’s initial state
  • attributes (unicode) – The JSON string that describes the Worker
  • friendly_name (unicode) – A string to describe the Worker
  • reject_pending_reservations (bool) – Whether to reject the Worker’s pending reservations
  • if_match (unicode) – The If-Match HTTP request header
Returns:

The updated WorkerInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance

url
Returns:The absolute URL of the Worker resource
Return type:unicode
worker_channels

Access the worker_channels

Returns:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelList
Return type:twilio.rest.taskrouter.v1.workspace.worker.worker_channel.WorkerChannelList
workspace_sid
Returns:The SID of the Workspace that contains the Worker
Return type:unicode
class twilio.rest.taskrouter.v1.workspace.worker.WorkerList(version, workspace_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(friendly_name, activity_sid=<object object>, attributes=<object object>)[source]

Create the WorkerInstance

Parameters:
  • friendly_name (unicode) – A string to describe the resource
  • activity_sid (unicode) – The SID of a valid Activity that describes the new Worker’s initial state
  • attributes (unicode) – A valid JSON string that describes the new Worker
Returns:

The created WorkerInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance

get(sid)[source]

Constructs a WorkerContext

Parameters:sid – The SID of the resource to fetch
Returns:twilio.rest.taskrouter.v1.workspace.worker.WorkerContext
Return type:twilio.rest.taskrouter.v1.workspace.worker.WorkerContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of WorkerInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.WorkerPage
list(activity_name=<object object>, activity_sid=<object object>, available=<object object>, friendly_name=<object object>, target_workers_expression=<object object>, task_queue_name=<object object>, task_queue_sid=<object object>, ordering=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • activity_name (unicode) – The activity_name of the Worker resources to read
  • activity_sid (unicode) – The activity_sid of the Worker resources to read
  • available (unicode) – Whether to return Worker resources that are available or unavailable
  • friendly_name (unicode) – The friendly_name of the Worker resources to read
  • target_workers_expression (unicode) – Filter by Workers that would match an expression on a TaskQueue
  • task_queue_name (unicode) – The friendly_name of the TaskQueue that the Workers to read are eligible for
  • task_queue_sid (unicode) – The SID of the TaskQueue that the Workers to read are eligible for
  • ordering (unicode) – Sorting parameter for Workers
  • 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.taskrouter.v1.workspace.worker.WorkerInstance]

page(activity_name=<object object>, activity_sid=<object object>, available=<object object>, friendly_name=<object object>, target_workers_expression=<object object>, task_queue_name=<object object>, task_queue_sid=<object object>, ordering=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • activity_name (unicode) – The activity_name of the Worker resources to read
  • activity_sid (unicode) – The activity_sid of the Worker resources to read
  • available (unicode) – Whether to return Worker resources that are available or unavailable
  • friendly_name (unicode) – The friendly_name of the Worker resources to read
  • target_workers_expression (unicode) – Filter by Workers that would match an expression on a TaskQueue
  • task_queue_name (unicode) – The friendly_name of the TaskQueue that the Workers to read are eligible for
  • task_queue_sid (unicode) – The SID of the TaskQueue that the Workers to read are eligible for
  • ordering (unicode) – Sorting parameter for Workers
  • 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 WorkerInstance

Return type:

twilio.rest.taskrouter.v1.workspace.worker.WorkerPage

statistics

Access the statistics

Returns:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsList
Return type:twilio.rest.taskrouter.v1.workspace.worker.workers_statistics.WorkersStatisticsList
stream(activity_name=<object object>, activity_sid=<object object>, available=<object object>, friendly_name=<object object>, target_workers_expression=<object object>, task_queue_name=<object object>, task_queue_sid=<object object>, ordering=<object object>, limit=None, page_size=None)[source]

Streams WorkerInstance 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:
  • activity_name (unicode) – The activity_name of the Worker resources to read
  • activity_sid (unicode) – The activity_sid of the Worker resources to read
  • available (unicode) – Whether to return Worker resources that are available or unavailable
  • friendly_name (unicode) – The friendly_name of the Worker resources to read
  • target_workers_expression (unicode) – Filter by Workers that would match an expression on a TaskQueue
  • task_queue_name (unicode) – The friendly_name of the TaskQueue that the Workers to read are eligible for
  • task_queue_sid (unicode) – The SID of the TaskQueue that the Workers to read are eligible for
  • ordering (unicode) – Sorting parameter for Workers
  • 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.taskrouter.v1.workspace.worker.WorkerInstance]

class twilio.rest.taskrouter.v1.workspace.worker.WorkerPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of WorkerInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance
Return type:twilio.rest.taskrouter.v1.workspace.worker.WorkerInstance