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.
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 replyee_message