whatsapp

type: meya.whatsapp.integration
class: WhatsAppIntegration
path: /meya/whatsapp/integration/integration.py
signature: -

Fields

field

signature

required

type

default

description               

spec

ForwardRef('Spec')

null

Override the original spec for this element

enabled

bool

true

Enables the integration, allowing it to process events and HTTP entries

filter

IntegrationFilter

rx_sub: true
rx: true
tx: true
tx_pub: true

verify_token

str

null

max_attachment_size

int

null

Controls maximum attachment size supported by the integration in bytes

account_sid

str

Twilio project Account SID

auth_token

str

null

Twilio project auth token. This field is being deprecated, switch to api_key_sid and api_key_secret as soon as possible. For more information, see https://www.twilio.com/console/project/api-keys

api_key_sid

str

null

Twilio API Key SID. Access https://www.twilio.com/console/project/api-keys to manage API Keys.

api_key_secret

str

null

Twilio API Key secret. Access https://www.twilio.com/console/project/api-keys to manage API Keys.

phone_number

str

null

Twilio active number for use with Meya

markdown

list
bool

false

typing

bool

true

When set to 'False', all typing indicators received by the integration will be ignored.

extra_sms_status_events

list

[]

List of SMS events that you want to process. This is useful in case you need specific behaviours depending on the status of the message. For WhatsApp Integration the TwilioSmsSentEvent is changed to WhatsAppSentEvent for standard messages and WhatsAppSentTemplateEvent for template messages. For more information on WhatsApp template access: https://www.twilio.com/docs/whatsapp/tutorial/send-whatsapp-notification-messages-templates

Examples

Basic

type: meya.whatsapp.integration
account_sid: STRING

Full

type: meya.whatsapp.integration
spec: '?'
enabled: false
filter:
  rx_sub: STRING
  rx: STRING
  tx: STRING
  tx_pub: STRING
verify_token: STRING
max_attachment_size: 123
account_sid: STRING
auth_token: STRING
api_key_sid: STRING
api_key_secret: STRING
phone_number: STRING
markdown:
  - format|linkify|breaks|typographer
typing: false
extra_sms_status_events:
  - accepted|queued|sending|sent|failed|delivered|undelivered|receiving|received|read