Build your bot using ChatBot API

Default interactions

Get Welcome Interaction

Returns Welcome Interaction object.

GET https://api.chatbot.com/stories/:storyID/interactions/welcome

Request URL

curl --request GET \
	--url https://api.chatbot.com/stories/:storyID/interactions/welcome \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response example

{
    "name": "Welcome Interaction",
    "responses": [
        {
            "type": "text",
            "filters": [],
            "elements": [
                "Hi",
                "Hello",
                "What can I do for you?",
                "Have a great day!"
            ]
        }
    ],
    "enabled": true
}

Properties

Property Type Description
name String Interaction name.
responses Array.<Object> An array of response objects.
enabled Boolean Indicates whether the welcome interaction is enabled or not.

Update Welcome Interaction

Updates the specified Welcome Interaction.

PUT https://api.chatbot.com/stories/:storyID/interactions/welcome

Request URL

curl --request PUT \
	--url https://api.chatbot.com/stories/:storyID/interactions/welcome \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Properties

Property Type Description
responses Array.<Object> An array of response objects.
enabled Boolean Required. Indicates whether the welcome interaction is enabled or not.

Response example

{
    "timestamp": "2018-01-24T10:58:31.612Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Get Fallback Interaction

Returns Fallback Interaction object.

GET https://api.chatbot.com/stories/:storyID/interactions/fallback

Request URL

curl --request GET \
	--url https://api.chatbot.com/stories/:storyID/interactions/fallback \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response example

{
    "name": "Fallback Interaction",
    "responses": [
        {
            "type": "text",
            "filters": [],
            "elements": [
                "One more time?",
                "What was that?",
                "I missed what you said. Say it again?",
                "I don't understand, can you repeat?"
            ]
        }
    ],
    "enabled": true
}

Properties

Property Type Description
name String Interaction name.
responses Array.<Object> An array of response objects.
enabled Boolean Indicates whether the Fallback Interaction is enabled or not.

Update Fallback Interaction

Updates the specified Fallback Interaction.

PUT https://api.chatbot.com/stories/:storyID/interactions/fallback

Request URL

curl --request PUT \
	--url https://api.chatbot.com/stories/:storyID/interactions/fallback \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Properties

Property Type Description
responses Array.<Object> An array of response objects.
enabled Boolean Required. Indicates whether the Fallback Interaction is enabled or not.

Response example

{
    "timestamp": "2018-01-24T10:58:31.612Z",
    "status": {
        "code": 200,
        "type": "success"
    }
}

Object definitions

responses

Go to object definition.

Possible response definitions:

Start a free ChatBot trial
and build your first chatbot today!

Free 14-day trial No credit card required