Object definitions

Available responses

• Text response
• Image response
• Quick replies
• Card response
• Carousel (cards) response
• Button response
• End response
• Reset response
• Webhook response
• Go to response
• Ask a question (attributes) response
• Set Attributes response
• Backtracking response

Text response

Returns a normal text response

Example JSON

{
    "responses": [
        {
            "type": "text",
            "elements": ["Hi, how are you", "Hello!"],
            "filters": []
        }
    ]
}

Image response

Returns an image response

Example JSON

{
    "responses": [
        {
            "type": "image",
            "imageUrl": "your-image-url",
            "filters": []
        }
    ]
}

Quick replies

Returns a quick replies response

Example JSON

{
    "responses": [
        {
            "type": "quickReplies",
            "title": "Lorem ipsum dolor sit amet.",
            "filters": [],
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

Card response

Returns single card response

Example JSON

{
    "responses": [
        {
            "type": "card",
            "filters": [],
            "title": "Lorem ipsum dolor sit amet.",
            "subtitle": "qui dolorem ipsum quia dolor sit amet,",
            "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

Carousel (cards) response

Returns multiple cards response

Card

Example JSON

{
    "responses": [
        {
            "type": "cards",
            "filters": [],
            "elements": [
                {
                    "title": "Lorem ipsum dolor sit amet.",
                    "subtitle": "qui dolorem ipsum quia dolor sit amet,",
                    "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
                    "buttons": [
                        {
                            "type": "postback",
                            "title": "Lorem ipsum dolor sit.",
                            "value": "first_message"
                        }
                    ]
                },
                {
                    "title": "Qui dolorem ipsum quia dolor sit amet.",
                    "subtitle": "lorem ipsum dolor sit amet.",
                    "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
                    "buttons": [
                        {
                            "type": "postback",
                            "title": "Ipsum quia dolor.",
                            "value": "second_message"
                        }
                    ]
                }
            ]
        }
    ]
}

Button response

Returns button response

Example JSON

{
    "responses": [
        {
            "type": "button",
            "title": "Lorem ipsum dolor sit amet.",
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

End response

This response is visible only in debug mode

Example JSON

{
    "responses": [
        {
            "type": "end",
            "filters": []
        }
    ]
}

Reset response

Triggers the “reset context” action as a response

Example JSON

{
  "responses": [
    {
      "type": "reset",
      "filters": []
    }
  ]
}

Webhook response

Triggers a webhook as a response

Example JSON

{
    "responses": [
        {
            "type": "webhook",
            "webhookId": "507f1f77bcf86cd799439011",
            "filters": []
        }
    ]
}

Go to response

Redirects the customer to the target interaction

Example JSON

{
    "responses": [
        {
            "type": "goto",
            "interactionId": "507f191e810c19729de860ea",
            "filters": []
        }
    ]
}

Ask a question (attributes) response

Triggers “Ask a question” action

Example JSON

{
  "responses": [
    {
      "type": "attributes",
      "filters": [],
      "delay": 2000,
      "elements": [
        {
          "entity": "foo",
          "alias": "bar",
          "lifespan": 2,
          "required": true,
          "actionOnFailure": "fallback",
          "askWhenFilled": true,
          "prompts": [
            "what is foo?"
          ]
        }
      ]
    }
  ]
}

Set Attributes response

Set a new value to the attribute

Example JSON

{
  "responses": [
    {
      "type": "setAttributes",
      "filters": [],
      "elements": [
        {
          "name": "foo",
          "action": "set",
          "value": "bar"
        },
        {
          "name": "empty",
          "action": "set",
          "value": ""
        },
        {
          "name": "name-with-dash",
          "action": "set",
          "value": "value"
        },
        {
          "name": "bar",
          "action": "remove"
        }
      ]
    }
  ]
}

Backtracking response

Enables/disables backtracking as a response

Example JSON

{
  "responses": [
    {
      "type": "backtracking",
      "filters": []
    }
  ]
}

Buttons

Postback button

Returns a postback when clicked

Hint: If you want all buttons to have the same name, use the postback field to give each of them a unique name. It will help ChatBot to distinguish which button has been clicked.

GoTo button

Triggers “Go to…” interaction when clicked

URL button

Opens up the URL when clicked

Phone button

Dials a number when clicked

Fulfillment

• Text fulfillment
• Image fulfillment
• Quick replies fulfillment
• Card fulfillment
• Carousel (cards) fulfillment
• Button fulfillment
• End fulfillment
• Reset fulfillment
• Webhook fulfillment
• Go to fulfillment
• Set attributes fulfillment
• Backtracking fulfillment

Text fulfillment

Returns text fulfillment

Example JSON

{
    "fulfillment": [
        {
            "type": "text",
            "message": "Hi, how are you"
        }
    ]
}

Image fulfillment

Returns image fulfillment

Example JSON

{
    "fulfillment": [
        {
            "type": "image",
            "imageUrl": "https://i.imgur.com/3yPwOLC.jpg"
        }
    ]
}

Quick replies fulfillment

Returns Quick Replies fulfillment

Example JSON

{
    "fulfillment": [
        {
            "type": "quickReplies",
            "title": "Lorem ipsum dolor sit amet.",
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

Card fulfillment

Returns a single card fulfillment

Example JSON

{
    "fulfillment": [
        {
            "type": "card",
            "title": "Lorem ipsum dolor sit amet.",
            "subtitle": "qui dolorem ipsum quia dolor sit amet,",
            "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

Carousel (cards) fulfillment

Returns multiple cards fulfillment

Card

Example JSON

{
    "fulfillment": [
        {
            "type": "cards",
            "filters": [],
            "elements": [
                {
                    "title": "Lorem ipsum dolor sit amet.",
                    "subtitle": "qui dolorem ipsum quia dolor sit amet,",
                    "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
                    "buttons": [
                        {
                            "type": "postback",
                            "title": "Lorem ipsum dolor sit.",
                            "value": "first_message"
                        }
                    ]
                },
                {
                    "title": "Qui dolorem ipsum quia dolor sit amet.",
                    "subtitle": "lorem ipsum dolor sit amet.",
                    "imageUrl": "https://i.imgur.com/3yPwOLC.jpg",
                    "buttons": [
                        {
                            "type": "postback",
                            "title": "Ipsum quia dolor.",
                            "value": "second_message"
                        }
                    ]
                }
            ]
        }
    ]
}

Button fulfillment

Returns a single button fulfillment

Example JSON

{
    "fulfillment": [
        {
            "type": "button",
            "title": "Lorem ipsum dolor sit amet.",
            "buttons": [
                {
                    "type": "postback",
                    "title": "Lorem ipsum dolor sit.",
                    "value": "developer_message"
                }
            ]
        }
    ]
}

End fulfillment

This response is visible only in debug mode

Example JSON

{
    "fulfillment": [
        {
            "type": "end",
            "used": true
        }
    ]
}

Reset fulfillment

This response is visible only in debug mode

Example JSON

{
    "fulfillment": [
        {
        "reset": "end",
        "used": true,
        "debug": true
        }
    ]
}

Webhook fulfillment

This response is visible only in debug mode

Example JSON

{
    "fulfillment": [
        {
            "type": "webhook",
            "webhookId": "507f1f77bcf86cd799439011",
            "used": false,
            "error": "foo.example.com’s server DNS address could not be found."
        }
    ]
}

Go to fulfillment

This response is visible only in debug mode

Example JSON

{
  "fulfillment": [
    {
      "type": "goto",
      "interactionId": "507f191e810c19729de860ea",
      "used": true,
      "debug": true
    }
  ]
}

Set Attributes fulfillment

This response is visible only in debug mode

Example JSON

{
  "fulfillment": [
    {
      "type": "setAttributes",
      "debug": true,
      "elements": [
        {
          "name": "foo",
          "action": "set",
          "value": "bar"
        },
        {
          "name": "empty",
          "action": "set",
          "value": ""
        },
        {
          "name": "name-with-dash",
          "action": "set",
          "value": "value"
        },
        {
          "name": "bar",
          "action": "remove"
        }
      ]
    }
  ]
}

Backtracking fulfillment

This response is visible only in debug mode

Example JSON

{
  "fulfillment": [
    {
      "type": "backtracking",
      "debug": true
    }
  ]
}

Filters

• Attribute
• Lifespan
• Score
• Incomplete
• ResolvedQuery
• Trigger

Attribute filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "is",
          "value": "my-value"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Lifespan filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "lifespan",
          "rule": "is",
          "value": 0
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Score filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "score",
          "rule": "is",
          "value": 0.2
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Incomplete filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "incomplete",
          "rule": "is",
          "value": false
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Resolved Query filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "resolvedQuery",
          "rule": "is",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Trigger filter

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "is",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Rules

Numeric rules

• is
• isNot
• greater
• less
• greaterOrEqual
• lessOrEqual

String rules

• is
• isNot
• empty
• contains
• notContains
• longer
• shorter

Is rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "is",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Is not rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "isNot",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Empty rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "empty",
          "value": false
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Contains rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "contains",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Not contains rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "trigger",
          "rule": "notContains",
          "value": "welcome"
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Greater rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "greater",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Less rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "less",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Greater or equal rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "greaterOrEqual",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Less or equal rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "lessOrEqual",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Longer rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "longer",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Shorter rule

Example JSON

{
  "responses": [
    {
      "type": "text",
      "filters": [
        {
          "type": "attribute",
          "alias": "my-param",
          "rule": "shorter",
          "value": 1337
        }
      ],
      "elements": ["hi", "hello"]
    }
  ]
}

Result