ProviderApplication.provider_settings are used by ratatoskr.providers.AbstractProviders to communicate with the Provider API. This field is not exposed to frontend. This is where we store secret credentials.
Provider settings for Bot MD Hospital. This is a special provider that provides a PhoneBasedProviderMixin interface to Bot MD Hospital users.
The list of hospitals (organization_key or uid) to find profiles from. If not set, will look for profiles in all hospitals.
Must contain a minimum of 1 items
Must be at least 1 characters long
What to do when we encounter multiple possible profiles: deliver to all matching profiles, first matching profile (by hospital primary key), or raise an exception.
Delivers to native devices only. Defaults to delivery to both native and web devices.
Provider settings for Line.
No Additional PropertiesBot user ID which can be obtained by querying Line API: curl -H 'Authorization: Bearer <token>' https://api.line.me/v2/bot/info.
^U[0-9a-f]{32}$
Bot basic ID starting with @.
^\@.+$
Token for accessing Line API. Found under Channel > Messaging API.
Must be at least 1 characters long
Secret for validating incoming webhooks. Found under Channel > Basic Settings.
Must be at least 1 characters long
When generating invitation URLs via Line login API, these settings are required.
No Additional PropertiesClient ID for Login API.
Must be at least 1 characters long
Client secret for Login API.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for Messagebird.
No Additional PropertiesThe Messagebird API key.
Must be at least 1 characters long
The Messagebird Channel Id.
Must be at least 1 characters long
The Messagebird Signing Key.
Must be at least 1 characters long
The business number registered on Messagebird.
Must match regular expression:^\+\d{5,}$
The Messagebird namespace. This is required for sending WhatsApp template messages.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for Messenger.
No Additional PropertiesPage access token for interacting with Messenger API. Found in Meta for Developers under Messenger > Settings > Access Tokens.
Must be at least 1 characters long
App ID for use with the Facebook Javascript SDK. This is needed for the /ratatoskr/login view. Found in Meta for Developers on the Dashboard.
Must be at least 1 characters long
Token for verifying webhook challenge. You choose this and set this in Meta for Developers under Messenger > Settings > Callback URLs or via the upsert webhook feature.
Must be at least 1 characters long
Page ID where the user will be able to send messages. Found in the page's URL or Meta for Developers under Messenger > Settings > Pages.
Must be at least 1 characters long
Username alias of page. Used for generating invite links. If not set, we will get this from the API.
Must be at least 1 characters long
App secret for verifying payload signature and various other uses. Found in Meta for Developers under Settings > Basic.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for NoopProvider.
Returns SKIP_CREATE_DELIVERY for all incoming payloads. Defaults to false.
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for PinpointProvider.
The OriginationIdentity or phone number we are sending SMSes from.
^\+\d{5,}$
The keyword associated with the phone number.
Must be at least 1 characters long
The SNS topic ARN associated with this provider. This field is required to receive inbound messages.
Must match regular expression:^arn\:aws\:sns\:[\w\-]+:\d+\:[\w\-]+$
Provider settings for PromoTexter.
No Additional PropertiesThe PromoTexter apiKey.
Must be at least 1 characters long
The PromoTexter apiSecret.
Must be at least 1 characters long
Viber ID associated with this account. Also known as channel_id in PromoTexter.
Must be at least 1 characters long
Number to send SMS from.
Must match regular expression:^\+\d{5,}$
This would appear as the sender of the message. Value must be whitelisted to your account.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Number of seconds to wait before giving up on sending a message.
Value must be greater or equal to 5
Number of seconds to wait before giving up on connecting to Promotexter API.
Value must be greater or equal to 3
Provider settings for Pusher.
No Additional PropertiesThe Pusher app_id.
Must be at least 1 characters long
The Pusher App key.
Must be at least 1 characters long
The Pusher app secret.
Must be at least 1 characters long
Provider settings for Qiscus.
No Additional PropertiesThe Qiscus App ID which can be found in the Settings -> App Information page.
Must be at least 1 characters long
The Qiscus apiSecret.
Must be at least 1 characters long
This is the Qiscus agent ID from Integration -> Bot Integration page. This is used to verify the webhook request. Defaults to <app_id>_admin@qismo.com.
Additional settings for WhatsApp channel.
No Additional PropertiesThe Qiscus WhatsApp channel ID. See https://documentation.qiscus.com/multichannel-customer-service/whatsapp-business-api#glossary on how to find it. Note that channel ID for Qiscus is an integer. Required for WhatsApp.
The number we are sending WhatsApp messages from. Use E.164 format.
Must match regular expression:^\+\d{5,}$
The WhatsApp namespace. This is required for sending WhatsApp template messages. See https://documentation.qiscus.com/multichannel-customer-service/whatsapp-business-api#glossary on how to find it. Preferred to have for WhatsApp.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Number of seconds to wait before giving up on sending a message.
Value must be greater or equal to 5
Number of seconds to wait before giving up on connecting to Qiscus API.
Value must be greater or equal to 3
Provider settings for Qontak.
No Additional PropertiesThis is Omnichannel API Access Token which can use for omnichannel related API.
This is BOT API Access Token which can use for bot related API.
This is qontak's whatsapp account phone number identifier.
This is channel integration id of a Qontak's account. Used for sending a direct broadcast messages
Client ID is used for logging in to get non-bot token.
Client Secret is used for logging in to get non-bot token.
Agent division to fallback when the desire division has no agent.
Send agent handover message through incoming message flow.
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for AWS Simple Email Service.
No Additional PropertiesThe From email when sending emails through this provider. Defaults to Bot MD <noreply@botmd.io>.
Must be at least 1 characters long
The SNS topic ARN associated with this provider. This field is required to receive inbound emails. Currently used in us-east-1 (N. Virginia) region and ap-southeast-1 (Singapore) region.
^arn\:aws\:sns\:(us\-east\-1|ap\-southeast\-1):\d+\:[\w\-]+$
The Region of the SNS webhook associated with this provider. Default value is us-east-1.
Delete email immediately after successfully reading it (in iter_messages_from_payload). Inbound emails are stored in the temporary buckets so they will be automatically deleted after a day. Defaults to true.
The list of sender email addresses this provider will allow.
Must contain a minimum of 1 items
The list of email addresses this provider will deliver to.
Must contain a minimum of 1 items
Array of emails that are denied for incoming messages. If set, any emails not in this list will be allowed.
Must contain a minimum of 1 items
Array of emails that are denied for outgoing messages. If set, any emails not in this list will be allowed.
Must contain a minimum of 1 items
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
true if this provider will skip the usual SNS payload validation. Use only if you trust the webhook caller.
Provider settings for Smooch. This is deprecated.
No Additional PropertiesThe Smooch App ID.
Must be at least 1 characters long
The key_id for authenticating against the Smooch API.
Must be at least 1 characters long
The secret for authenticating against the Smooch API.
Must be at least 1 characters long
The Smooch Integration ID.
Must be at least 1 characters long
A shared webhook secret to authenticate that the incoming webhook is from Smooch and not bogus.
Must be at least 1 characters long
The Smooch namespace. This is required for sending WhatsApp template messages.
Must be at least 1 characters long
The "from" phone number where WhatsApp messages are sent from.
Must match regular expression:^\+\d{5,}$
Provider settings for sending emails using SMTP. TLS is always assumed.
No Additional PropertiesSMTP server URI of the form smtp://username:password@hostname:[port]. Port defaults to 465.
Must be at least 1 characters long
The From email when sending emails through this provider. Defaults to Bot MD <noreply@botmd.io>.
Must be at least 1 characters long
The list of sender email addressmtp this provider will allow.
Must contain a minimum of 1 items
The list of email addresses this provider will deliver to.
Must contain a minimum of 1 items
Array of emails that are denied for incoming messages. If set, any emails not in this list will be allowed.
Must contain a minimum of 1 items
Array of emails that are denied for outgoing messages. If set, any emails not in this list will be allowed.
Must contain a minimum of 1 items
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for Telegram.
No Additional PropertiesThe Telegram bot's username.
Must be at least 1 characters long
The API token for accessing Telegram API.
Must be at least 1 characters long
The list of usernames this provider will allow.
Must contain a minimum of 1 items
Must be at least 1 characters long
The list of usernames this provider will deliver to.
Must contain a minimum of 1 items
Must be at least 1 characters long
Array of usernames that are denied for incoming messages. If set, any usernames not in this list will be allowed.
Must contain a minimum of 1 items
Must be at least 1 characters long
Array of usernames that are denied for outgoing messages. If set, any usernames not in this list will be allowed.
Must contain a minimum of 1 items
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for Twilio.
No Additional PropertiesThe Twilio account_sid.
Must be at least 1 characters long
The phone number Twilio will use to send SMS/WhatsApp messages .
Must match regular expression:^\+\d{5,}$
The Twilio API key.
Must be at least 1 characters long
The Twilio API secret.
Must be at least 1 characters long
The auth_token is used for validation of incoming webhook requests.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for viber.
No Additional PropertiesThe sender’s avatar URL. Avatar size should be no more than 100 kb. Recommended 720x720
Must be at least 1 characters long
The sender’s name to display
Must be at least 1 characters long
The viber token.
Must be at least 1 characters long
bot's URI generated by viber. It can be found in the your bot’s Admin Panel or in the response to the get-account-info API request.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Provider settings for WhatsApp by Meta.
No Additional PropertiesThe WhatsApp business account ID associated with this provider. Get it from Meta for Developers under App -> WhatsApp -> Getting Started.
Must match regular expression:^\d{5,}$
App secret for verifying payload signature and various other uses. Found in Meta for Developers under Settings > Basic.
Must be at least 1 characters long
Access token for use with the Graph API. Access tokens should be assigned to System Users and be permanent. See instructions at here to create one.
Must be at least 1 characters long
WhatsApp namespace associated with this WABA.
Must be at least 1 characters long
The ID associated with the WhatsApp Business phone number. Get it from Meta for Developers under App -> WhatsApp -> Getting Started.
Must match regular expression:^\d{5,}$
The phone number where we will send WhatsApp messages from. Get it from Meta for Developers under App -> WhatsApp -> Getting Started.
Must match regular expression:^\+\d{5,}$
Token for verifying webhook challenge. You choose this and set this in Meta for Developers under App > WhatsApp > Configure Webhook.
Must be at least 1 characters long
Number of times to retry sending a message before giving up.
Value must be greater or equal to 1
Number of seconds to wait before retrying sending a message.
Value must be greater or equal to 30
Number of seconds to wait before giving up on sending a message.
Value must be greater or equal to 5
Number of seconds to wait before giving up on connecting to WhatsApp API.
Value must be greater or equal to 3
Provider settings for ActionState support.
Whether action state handling is enabled on this provider. Defaults to value of provider class variable use_action_state.
Number of seconds for action state IDs before they are invalid. Defaults to 3600 seconds.
Settings related to billing.
No Additional PropertiesDevices to ignore for billing purposes. Can be either UID or device identifier.
Must contain a minimum of 1 items
Must be at least 1 characters long
Provider settings for Firebase Cloud Messaging.
No Additional PropertiesThe FCM server API key for authenticating against FCM.
Must be at least 1 characters long
GCP service account credentials
Credential type. Must be service_account
"service_account"
Project ID this credential corresponds to
Must be at least 1 characters long
Private key unique ID associated with this credential
Must be at least 1 characters long
Private key associated with the credential
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectProvider settings for providers inheriting from PhoneBasedProviderMixin.
Whether to allow incoming/outgoing deliveries to short codes (usually SMS). Defaults to false.
Array of numbers that are allowed for incoming messages. If set, any numbers not in this list will be denied.
Must contain a minimum of 1 items
^\+\d{5,}$
Array of numbers that are allowed for outgoing messages. If set, any numbers not in this list will be denied.
Must contain a minimum of 1 items
^\+\d{5,}$
Array of numbers that are denied for incoming messages. If set, any numbers not in this list will be allowed.
Must contain a minimum of 1 items
^\+\d{5,}$
Array of numbers that are denied for outgoing messages. If set, any numbers not in this list will be allowed.
Must contain a minimum of 1 items
^\+\d{5,}$
Settings related to Ratatoskr.
No Additional PropertiesSend a technical error message whenever we encounter an unhandled provider/application level exception. Defaults to true.
The content of the technical error message to send. Defaults to: Sorry! I am currently experiencing technical issues. Don't worry, our team is on it! if not set.
No message will be sent.
Simple text message to send.
Must be at least 1 characters long
A text message will be uniformly selected from this array.
Must contain a minimum of 1 items
Must be at least 1 characters long
Ratatoskr Message.schema that will be sent to the user.
No Additional PropertiesThe type of this element.
Specific value:"message"
Message element metadata.
Title primitive element.
No Additional PropertiesThe type of this element.
Specific value:"title"
Title content.
Must be at least 1 characters long
Subtitle primitive element.
No Additional PropertiesThe type of this element.
Specific value:"subtitle"
Subtitle content.
Must be at least 1 characters long
Text primitive element.
No Additional PropertiesThe type of this element.
Specific value:"text"
Text content.
Must be at least 1 characters long
Image primitive element.
No Additional PropertiesThe type of this element.
Specific value:"image"
Image element metadata.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAudio primitive element.
No Additional PropertiesThe type of this element.
Specific value:"audio"
Audio element metadata.
URL to the audio file.
Preview image of audio. Defaults to a generic audio icon.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectVideo primitive element.
No Additional PropertiesThe type of this element.
Specific value:"video"
Video element metadata.
URL to the video file.
Preview image of video. Defaults to first frame of video.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectWhether to auto play video in preview view. Defaults to false.
Additional Properties of any type are allowed.
Type: objectAttachment primitive element.
No Additional PropertiesThe type of this element.
Specific value:"attachment"
Attachment element metadata.
No Additional PropertiesURL to the attachment file.
Must match regular expression:^((https|s3|gs|file)\:\/\/|\$)
Filename for attachment. This is useful when the filename cannot be inferred from the URL.
Must be at least 1 characters long
The MIME type of the attachment. This is guessed from the extension of the filename followed by the url. See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Preview image of attachment. Defaults to first frame of attachment.
URL to the image file.
Overrides frontend's default image scaling algorithm.
Action to take when clicking on the image (or preview image). Defaults to opening the image in viewer.
URL to the link file. Could be application internal links too. Currently supported internal links are: botmd://hospital/postMessage, botmd://hospital/emobot, botmd://hospital/gql, and `botmd://hospital/jarvisQuery.
Must be at least 1 characters long
Whether to open the url in an external browser instead of our own webview. Defaults to false.
The MIME type of the content at URL. This is guessed from the extension of the url. If it is a http/https URL and there are no file extensions, text/html is assumed.
This is useful to override the default app responsible for opening it.
See scalpel.messages.url.ContentTypeMixin for content type guessing logic.
Must be at least 1 characters long
Metadata to describe an event that can be posted to Shadowfax. This is usually part of an Actionable.
Event type that will be posted to Shadowfax (i.e., event_type) when this action is taken.
Must be at least 1 characters long
Optional event properties that will be posted to Shadowfax (i.e., event_properties) when this action is taken.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectEinstein-specific metadata for this attachment
Einstein Document UID for attachment.
Must be at least 1 characters long
Button action primitive element.
No Additional PropertiesThe type of this element.
Specific value:"button"
Quick reply primitive element.
No Additional PropertiesThe type of this element.
Specific value:"quick_reply"
Quick reply element metadata.
Metadata to describe the visual aspect of a quick reply.
Display text.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMetadata to describe actions that are taken when a UI element is triggered (e.g., tapped, clicked, etc).
Same definition as actionableLocation request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_request"
Location request element metadata.
No Additional PropertiesPrompt for the user when requesting for location.
Must be at least 1 characters long
Location request primitive element.
No Additional PropertiesThe type of this element.
Specific value:"location_response"
Location response element metadata.
No Additional PropertiesLocation latitude.
Location longitude.
Name of the location.
Must be at least 1 characters long
Human-readable address of the location.
Must be at least 1 characters long
Container types wrap around other primitive types.
Quick replies container element.
No Additional PropertiesThe type of this element.
Specific value:"quick_replies"
Array of quick replys.
Must contain a minimum of 1 items
Must contain a maximum of 16 items
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
No Additional PropertiesThe type of this element.
Specific value:"sections"
An array of section elements.
Must contain a minimum of 1 items
Must contain a maximum of 5 items
Paragraphs container element.
No Additional PropertiesThe type of this element.
Specific value:"paragraphs"
An array of paragraph elements.
Must contain a minimum of 1 items
Must contain a maximum of 3 items
When specified, the message / carousel item can be favorited on the frontend.
No Additional PropertiesTitle to show in the favorites menu.
Must be at least 1 characters long
URL to favorite item. This could be an internal botmd:// link or an external link.
Must be at least 1 characters long
This is used with botmd://hospital/jarvisQuery links using uids. If frontend decides to cache the content of this favorite message, it should be refreshed against the backend after the expiry.
Actions container element.
No Additional PropertiesThe type of this element.
Specific value:"actions"
An array of action elements.
Must contain a minimum of 1 items
Must contain a maximum of 8 items
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteWhen specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteCarousel container element.
No Additional PropertiesThe type of this element.
Specific value:"carousel"
Carousel element metadata.
Must contain a minimum of 1 items
Must contain a maximum of 10 items
Container types wrap around other primitive types. These types are used in carousels.
Sections are container types for up to at most 3 elements. These are most likely to be used for rich messages that include media, paragraphs, and actions.
Same definition as SectionsApplication payload message.
No Additional PropertiesThe type of this element.
Specific value:"application_payload"
Application payload element metadata.
No Additional PropertiesApplication origin of the data payload
Must be at least 1 characters long
Arbitrary payload to be used by application. Can be any JSON object.
Additional Properties of any type are allowed.
Type: objectThis is a high level representation of MIME emails.
No Additional PropertiesThe type of this element.
Specific value:"email"
Email element metadata.
A short string identifying the topic of the message (RFC 2822).
Must be at least 1 characters long
The main body of the email in plain text.
The main body of the email in HTML.
Must be at least 1 characters long
Attachments to the email.
Must contain a minimum of 1 items
A message type encapsulating the WhatsApp template syntax. It is currently used by MessageBird.
No Additional PropertiesThe type of this element.
Specific value:"whatsapp_template"
WhatsApp template element metadata.
No Additional PropertiesWhatsApp template name to use for this message.
Must be at least 1 characters long
WhatsApp namespace associated with the WABA. Defaults to the provider settings namespace.
Must be at least 1 characters long
For non-WhatsApp capable providers, it will be sent as a text message containing this string.
Must be at least 1 characters long
Language code of the template. Note that language policy of the template message will always be deterministic. Defaults to en.
Must be at least 1 characters long
Array of parameters in header component of the template message. Applies to media templates only.
No Additional ItemsType of header
Image header.
URL to the image.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Video header.
URL to the videos.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Document attachment in media template.
URL to the document.
Must match regular expression:^((https|s3|gs)\:\/\/|\$)
Caption to accompany the document attachment.
Must be at least 1 characters long
Filename of document attachment. If caption is not specified, filename will be used instead.
Must be at least 1 characters long
Array of parameters in body component of the template message. Applies to both text and media templates.
No Additional ItemsType of body.
Text to use in body parameter.
Text to use in body parameter.
An empty message with no content whatsoever.
No Additional PropertiesThe type of this element.
Specific value:"empty"
When specified, the message / carousel item can be favorited on the frontend.
Same definition as favoriteMessage.provider_metadata is used on Messages to provide additional context to the provider for delivery.
Delivery metadata for MessengerProvider.
Use MESSAGE_TAG when sending this message. This is useful when sending messages outside of the 24 hour window. Do make sure that the tag corresponds to the actual content of the message. See Message Tags documentation for more details on what content is allowed by each tag.
This is the schema for the ReplyTo metadata representing replyee message information
No Additional PropertiesThe UID of the replyee delivery object. Used when replyee edits/deletes their message.
Replied On datetime to track when we "copied" the replyee message (may be used to check if original message was edited post-reply)
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageSeries of Ratatoskr Message.schemas will be sent to the user.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageChoose from one of the arrays of Ratatoskr Message.schemas randomly.
No Additional PropertiesArray of choices of messages to choose from.
Must contain a minimum of 1 items
An array of messages that form this random message choice.
Must contain a minimum of 1 items
This is the schema for messages as described and proposed in the Ratatoskr: Data Models for Messages RFC.
Same definition as MessageThe relative weight of this message used to perform weighted choice. Defaults to 1.
Value must be strictly greater than 0