front.message.send

type: meya.front.component.message.send
class: FrontMessageSendComponent
path: /meya/front/component/message/send.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

integration

FrontIntegrationRef

A string identifier for the Front integration (e.g. integration.front)

attachments_url

list

[]

A list of file URLs to attach to the conversation

text

str

null

The plain text version of the message

html

str

null

The HTML version of the message

context

dict

{}

Send context data with this component's event

sensitive

bool

true

triggers

list

[]

Activate these dynamic triggers when the component runs

thread_ref

str

null

A way of uniquely identifying the Meya thread the conversation is associated with. Defaults to meya_thread/

conversation_id

str

null

The Front conversation ID. Conversation IDs have the format cnv_xxxxxxxx

contact_handle

str

null

An alias for the Front Contact. The format is alt:: (e.g. alt:phone:+12345678900). Defaults to meya_user/

contact_id

str

null

The Front Contact ID

subject

str

null

The subject of the message

send_transcript

bool

false

Send the chat transcript to be included in the conversation. Useful for providing context for agents.

Examples

Basic

triggers:
  - keyword: meya.front.component.message.send
steps:
  - type: meya.front.component.message.send
    integration: integration.front

Full

triggers:
  - keyword: meya.front.component.message.send
steps:
  - type: meya.front.component.message.send
    spec: '?'
    integration: integration.front
    attachments_url:
      - STRING
    text: STRING
    html: STRING
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    thread_ref: STRING
    conversation_id: STRING
    contact_handle: STRING
    contact_id: STRING
    subject: STRING
    send_transcript: false