twilio.rest.flex_api.v1.interaction.interaction_channel package

Submodules

twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance(version, payload, interaction_sid, channel_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Action[source]

Bases: object

ACCEPT = 'accept'
DECLINE = 'decline'
class Type[source]

Bases: object

TASKROUTER = 'taskrouter'
channel_sid
Returns:The Channel SID for this Invite
Return type:unicode
interaction_sid
Returns:The Interaction SID for this Channel
Return type:unicode
routing
Returns:A JSON object representing the routing rules for the Interaction Channel
Return type:dict
sid
Returns:The unique string that identifies the resource
Return type:unicode
url
Returns:The url
Return type:unicode
class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteList(version, interaction_sid, channel_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(routing)[source]

Create the InteractionChannelInviteInstance

Parameters:routing (dict) – The Interaction’s routing logic
Returns:The created InteractionChannelInviteInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of InteractionChannelInviteInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInvitePage
list(limit=None, page_size=None)[source]

Lists InteractionChannelInviteInstance 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.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance]

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

Retrieve a single page of InteractionChannelInviteInstance 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 InteractionChannelInviteInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInvitePage

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

Streams InteractionChannelInviteInstance 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.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance]

class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInvitePage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of InteractionChannelInviteInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteInstance

twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantContext(version, interaction_sid, channel_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

update(status)[source]

Update the InteractionChannelParticipantInstance

Parameters:status (InteractionChannelParticipantInstance.Status) – The Participant’s status.
Returns:The updated InteractionChannelParticipantInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance
class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance(version, payload, interaction_sid, channel_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

CLOSE = 'close'
CLOSED = 'closed'
WRAPUP = 'wrapup'
class Type[source]

Bases: object

AGENT = 'agent'
CUSTOMER = 'customer'
EXTERNAL = 'external'
SUPERVISOR = 'supervisor'
UNKNOWN = 'unknown'
channel_sid
Returns:The Channel Sid for this Participant.
Return type:unicode
interaction_sid
Returns:The Interaction Sid for this channel.
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
type
Returns:Participant type.
Return type:InteractionChannelParticipantInstance.Type
update(status)[source]

Update the InteractionChannelParticipantInstance

Parameters:status (InteractionChannelParticipantInstance.Status) – The Participant’s status.
Returns:The updated InteractionChannelParticipantInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance
url
Returns:The url
Return type:unicode
class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantList(version, interaction_sid, channel_sid)[source]

Bases: twilio.base.list_resource.ListResource

create(type, media_properties)[source]

Create the InteractionChannelParticipantInstance

Parameters:
Returns:

The created InteractionChannelParticipantInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance

get(sid)[source]

Constructs a InteractionChannelParticipantContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantContext
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of InteractionChannelParticipantInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantPage
list(limit=None, page_size=None)[source]

Lists InteractionChannelParticipantInstance 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.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance]

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

Retrieve a single page of InteractionChannelParticipantInstance 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 InteractionChannelParticipantInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantPage

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

Streams InteractionChannelParticipantInstance 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.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance]

class twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of InteractionChannelParticipantInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelContext(version, interaction_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the InteractionChannelInstance

Returns:The fetched InteractionChannelInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance
invites

Access the invites

Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteList
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteList
participants

Access the participants

Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantList
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantList
update(status, routing=<object object>)[source]

Update the InteractionChannelInstance

Parameters:
Returns:

The updated InteractionChannelInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance

class twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance(version, payload, interaction_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

CLOSE = 'close'
CLOSED = 'closed'
WRAPUP = 'wrapup'
class Type[source]

Bases: object

CHAT = 'chat'
EMAIL = 'email'
SMS = 'sms'
VOICE = 'voice'
WEB = 'web'
WHATSAPP = 'whatsapp'
fetch()[source]

Fetch the InteractionChannelInstance

Returns:The fetched InteractionChannelInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance
interaction_sid
Returns:The unique string that identifies the resource
Return type:unicode
invites

Access the invites

Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteList
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_invite.InteractionChannelInviteList
Returns:The links
Return type:unicode
participants

Access the participants

Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantList
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.interaction_channel_participant.InteractionChannelParticipantList
sid
Returns:The unique string that identifies the resource
Return type:unicode
type
Returns:The Interaction Channel’s type.
Return type:InteractionChannelInstance.Type
update(status, routing=<object object>)[source]

Update the InteractionChannelInstance

Parameters:
Returns:

The updated InteractionChannelInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance

url
Returns:The url
Return type:unicode
class twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelList(version, interaction_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a InteractionChannelContext

Parameters:sid – The unique string that identifies the resource
Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelContext
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of InteractionChannelInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelPage
list(limit=None, page_size=None)[source]

Lists InteractionChannelInstance 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.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance]

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

Retrieve a single page of InteractionChannelInstance 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 InteractionChannelInstance

Return type:

twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelPage

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

Streams InteractionChannelInstance 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.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance]

class twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of InteractionChannelInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance
Return type:twilio.rest.flex_api.v1.interaction.interaction_channel.InteractionChannelInstance