twilio.flex.start_chat

type: meya.twilio.flex.component.start_chat
class: TwilioFlexStartChatComponent
path: /meya/twilio/flex/component/start_chat.py
signature: -

Learn more: https://www.twilio.com/docs/flex/developer/messaging/api/chat-channel

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

send_transcript

bool

true

Send the conversation transcript to flex agent when chat is accepted

chat_friendly_name

str

Chat title. This is the only information the flex agent will see before chat is accepted, should be very informative e.g. "James - +55112222222222 - computer problem"

task_attributes

dict

null

Used for routing purposes. Check twilio docs https://www.twilio.com/taskrouter

integration

TwilioBaseIntegrationRef

Examples

Basic

triggers:
  - keyword: meya.twilio.flex.component.start_chat
steps:
  - type: meya.twilio.flex.component.start_chat
    chat_friendly_name: STRING
    integration: integration.generic

Full

triggers:
  - keyword: meya.twilio.flex.component.start_chat
steps:
  - type: meya.twilio.flex.component.start_chat
    spec: '?'
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    send_transcript: false
    chat_friendly_name: STRING
    task_attributes:
      foo: bar
    integration: integration.generic