Bot Message API

Summary

• Chatbot Message API. Use this API to send messages to Comm100 Live Chat channel while bot chatting

- session

Authentication

API_key Authentication

For each method call, you must use your email and API_KEY.Authentication to the API is done via HTTP Basic Auth. Provide your email as the basic auth username and API_KEY as the password. You must authenticate for API requests.

Session

• POST /api/v3/bot/sessions/{sessionId}:sendMessage - Send Message

Related Object Json Format

ChatbotMessage

ChatbotMessage is represented as simple flat json objects with the following keys:

TextResponse

TextResponse is represented as simple flat JSON objects with the following keys:

Link

Link is represented as simple flat JSON objects with the following keys:

ImageResponse

ImageResponse is represented as simple flat JSON objects with the following keys:

VideoResponse

VideoResponse is represented as simple flat JSON objects with the following keys:

QuickReplyResponse

QuickReplyResponse is represented as simple flat JSON objects with the following keys:

QuickReplyItem

QuickReplyItem is represented as simple flat JSON objects with the following keys:

ButtonResponse

ButtonResponse is represented as simple flat JSON objects with the following keys:

ButtonItem

ButtonItem is represented as simple flat JSON objects with the following keys:

Endpoints

Send Message

POST /api/v3/bot/sessions/{sessionId}:sendMessage

Parameters

Path parameters

Query String

Request body

The request body contains data with the follow structure:

example:

  {
    "botId": "44f88d68-92e6-4487-a2e8-8234fc9d1f48",
    "visitorId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "messages": [
        {
            "type": "text",
            "content": {
                "message": "this is a plain message"
            },
            "disableChatInputArea": true
        },
    ]
  }

Response

HTTP/1.1 204 No Content

Example

Using curl

curl -H "Authorization: Basic test@comm100.com:e07cce30b1b145e99049bf201f302239"
-H "Content-Type: application/json" -d '{
    "botId": "44f88d68-92e6-4487-a2e8-8234fc9d1f48",
    "visitorId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "messages": [
        {
            "type": "text",
            "content": {
                "message": "this is a plain message"
            },
            "disableChatInputArea": true
        },
    ]
  }' -X POST https://api2.comm100.io/botapi/api/v3/bot/sessions/f9928d68-92e6-4487-a2e8-8234fc9d1f48:sendMessage?siteId=10000

Response

  HTTP/1.1 204 No Content
  Content-Type:  application/json
  

ChatbotMessage List Sample Json

 [
      {
          "type": "text",
          "content": {
              "message": "this is a plain message"
          },
          "disableChatInputArea": true
      },
      {
          "type": "text",
          "content": {
              "message": "this is a web link message",
              "link": [{
                  "type": "hypelink",// hypelink
                  "startPosition": 10,
                  "endPosition": 17,
                  "ifPushPage": true,
                  "url": "www.test.com",
                  "openIn": "sideWindow"// currentWindow, sideWindow or newWindow.
              }]
          },
          "disableChatInputArea": true
      },        
      {
          "type": "image",
          "content": {
              "description": "description of the image",
              "url": "www.test.com/test-image.jpg"
          },
          "disableChatInputArea": true
      },
      {
          "type": "video",
          "content": {
              "url": "www.test.com/test-video.jpg"
          },
          "disableChatInputArea": true
      },        
      {
          "type": "button",
          "content": {
              "message": "this is a button response",
              "items": [
                  {
                      "type": "goToIntent",// goToIntent, hyperlink or webview.
                      "text": "click to trigger test-intent-name",
                      "intentId": "00000000-0000-0000-0000-000000001111"
                  },
                  {
                      "type": "hyperlink",
                      "text": "click to open this url in web page",
                      "url": "www.test.com",
                      "openIn": "currentWindow"
                  },
                  {
                      "type": "webview",
                      "text": "click to open this url in web view",
                      "url": "www.test.com",
                      "webviewOpenStyle": "full"
                  }
              ]
          },
          "disableChatInputArea": true
      }, {
          "type": "quickreply",
          "content": {
              "message": "this is a quick reply response",
              "items": [
                  {
                      "type": "goToIntent",// goToIntent, contactAgent or text.
                      "text": "click to trigger test-intent-name",
                      "intentId": "00000000-0000-0000-0000-000000001111"
                  },
                  {
                      "type": "goToIntent",// goToIntent, contactAgent or text.
                      "text": "Go to main menu",
                      "intentName": "main menu"
                  },
                  {
                      "type": "contactAgent",
                      "text": "click to contact agent"
                  }
              ]
          },
          "disableChatInputArea": true
      },
  ]