greenshootlabs.comin the message text will be turned to links.
urlproperty is included.
externalproperty to true results in the message buttons appearing outside of the button message (this defaults to false if not set).
clear_after_interactionproperty to false means that the buttons will remain visible to the user after being interacted with
textelement to specify the text that should be shown to the user.
callback_id(and optionally a
value) when interacted with by the user that will move the conversation forward. Make sure that any
callback_idyou use in a button response is mapped to an intent in the interpreter engine config.
attribute_nameshould be the ID of an attribute that has already been defined in the system.
new_tabproperty can be set to true to force the links to open in a new tab. If not set, links default to opening in the same tab
tel:link that depending on the user's current device and platform will start a phone call to the number given
typethat can affect how they are displayed as a button on screen. Types are added as properties of the button like this:
skip- If a button in an
externalbutton message has type of
skip, it will appear below the other buttons with a different appearance. This can be used in conjunction with other messages to allow a user to skip past an intent
inline- If a button in a standard button message (not
external) has a type of
inline, it will appear along with the button message text, inside the chat bubble.
callback. All form messages must contain the following elements:
textvalue is shown at the top of the form message and the
submit_textvalue is shown on the form submit button. When
auto_submitis set to true, the form will automatically be submitted when the user selects a value. This works best when just 1 element is added to the form
display, and can optionally define
default_value. If required is set to true, the form cannot be submitted unless the field has a value.
selectelements, you must define an
optionsblock giving the options to be presented in the checkbox list or select element:
textelement, but on submission, is validated to ensure it is formatted like an email address
intent.core.welcometo only send a message if the user was seen more than once.
view-type. This can either be
max_datefields restrict the dates that are shown to the user so that what they submit is always within that range. The dates provided should be ISO date format containing at least the year, or just the word
options-endpoint.url- The URL of the API to hit. This can be relative or absolute. It is often a good idea to create a local API proxy route in your OD application to be able to format responses from external sources.
options-endpoint.params- Each param in here will be added to the API url as query parameters in the format
options-endpoint.query-param-name- This field specifies the name to be used for the
queryquery param. The value of the query param will be all characters that the user has started typing in the auto-complete box.
textwhich will appear when the message starts showing and
placeholderwhich shows in the message input box before a user starts typing
cancel_callbackis sent. The cancel button can be added to a form message with the following mark up:
incoming/webchatendpoint, but are handled by an external system.
Documentation for handling hand-to-human messages is being developed.
dataelements that have a unique name specifying what they are for. This way, any custom data payload can be sent with hand to system messages
dataattributes defined as below: