CSML is able to handle many types of messages by default.
To send a message to the end user, simply use the keyword
say followed by the message type you want to send.
somestep:say "I'm a text message"say Wait(1500)say Text("I'm also a text message")say Typing(1500)say Url("https://clevy.io")say Image("https://media.giphy.com/media/ASd0Ukj0y3qMM/source.gif")say Video("https://www.youtube.com/watch?v=DLzxrzFCyOs")say Audio("https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/253508261")say Question(title = "What is love?",buttons = [Button("baby don't hurt me"),Button("don't hurt me"),Button("no more")])say Carousel(cards = [Card(title="title",subtitle="an optional description",image_url="https://images.unsplash.com/photo-1567322329435-28658f2958c4",buttons=[Button("click me!")])])
You can style text using Markdown. Some channels however only partially support Markdown (Messenger for example only allows bold, italic, strikethrough, but not tables), so don't get too fancy there.
# Title 1## Title 2**bold***italic*~strikethrough[link text](https://google.com)
Below is a list of default valid message components, which are automatically converted to nicely formatted messages for the channel in which the user is talking with the bot.
Output a simple string (with no styling attached). This is also the default type, alias of
Display a typing indicator for
Url(string, text="text", title="title")
Display the image available at URL
Display the video available at URL
Display the audio available at URL
Question(title = string(, buttons = [Button]))
Display a list of buttons with a header of
Text(string) + list of buttons
Card(title="string", buttons=[Button], image_url="string")
Display nicely formatted content in a
Question(title, buttons) or Text(title)
Display a list of
A conversation with a chatbot is not very different from a human-to-human dialogue: sometimes the user talks, sometimes the bot talks.
CSML provides a solution when you need the chatbot wait for the user's input: using the
hold keyword, the chatbot will remember its position in the conversation and simply wait until the user says something, then continue from there.
somestep:say Question("Do you like cheese?", buttons=[Button("yes"), Button("no")])holdif (event == "yes") say "I'm glad to know that you like cheese!"else say "Oh that's too bad!"
When receiving an event from an end-user, the CSML interpreter will try to match it with a new flow, or consume it in the existing conversation, or trigger the default flow as defined in the bot settings, by order of priority.
CSML Events are made available in the script when a step is triggered by a user's input. The
event object is a complex structure which contains a lot more than just the string that was typed by the user. It contains a lot of information that is used by the CSML interpreter, for example the custom button payload to match a list of choices offered to the user. This makes it easy to handle both a click on a "OK" button or the user typing the word "yes".
By default, events are only expected when:
the flow was just triggered, the current step being triggered is
the bot asked something to the user, and is waiting for the user's input at the same step
In those cases, a local variable,
event, is made available, with the content of the user request. When no event is available, event is set to