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

Element details

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

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
send_transcript	Send the conversation transcript to flex agent when chat is accepted	○	○	true	bool
chat_friendly_name	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"	◉	○		str
task_attributes	Used for routing purposes. Check twilio docs https://www.twilio.com/taskrouter	○	○	null	dict
integration		◉	○		TwilioBaseIntegrationRef

Usage reference

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:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    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