Chat with bot

This endpoint allows you to communicate with your bot and integrate the scenario with your website and application or even with your coffee machine.

Create user

Creates new user.

Properties

Note: userId is not required when attributes.default_email is provided

Request URL

curl --request POST \
	--url https://api.chatbot.com/users \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Response example

[
    {
      "id": "ID",
      "timestamp": "2018-01-19T11:55:07.552Z",
      "status": {
        "code": 200,
        "type": "success"
      }
    }
]

List users

Returns list of Users.

Properties

Request URL

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

Response example

{
    "data": [
        {
            "id": "5b7ff8476fcccc33c9249a8",
            "userId": "0735887f-6ba5-cccc-908e-6c84d093f317",
            "banned": false,
            "attributes": {
                "default_email": "joe@doe.com",
                "default_name": "Joe",
                "default_url": null,
                "default_avatar": null,
                "default_language": null,
                "default_timezone": null,
                "default_gender": null,
                "default_ip": null,
                "default_city": null,
                "default_region": null,
                "default_country": null,
                "default_referrer": null,
                "default_username": null
            },
            "conversations": 0,
            "createdAt": "2019-01-23 13:32:30.163Z",
            "lastSeen": "2019-01-23 13:32:30.163Z"
        }
    ],
    "count": 1
}

User object

List single user

Lists single user details.

URL Params

Required: id=[alphanumeric]

Request URL

curl --request GET \
	--url https://api.chatbot.com/users/:id \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}'

Response example

    {
        "id": "5b7ff847cc3c3fb33c9249a8",
        "userId": "0735887f-6ba5-cccc-908e-6c84d093f317",
        "banned": false,
        "attributes": {
          "default_email": "joe@doe.com",
          "default_name": "Joe",
          "default_url": null,
          "default_avatar": null,
          "default_language": null,
          "default_timezone": null,
          "default_gender": null,
          "default_ip": null,
          "default_city": null,
          "default_region": null,
          "default_country": null,
          "default_referrer": null,
          "default_username": null
        },
      "sessionAttributes": {
        "group-selected": "14"
      },
      "conversations": [
        {
          "id": "5c486e62bda7873576a379e4",
          "date": "2019-01-23 13:32:30.163Z",
          "firstMessage": "hello"
        }
      ],
      "segments": [
        {
          "id": "5c46d514bda7873576a30c48",
          "name": "Leads"
        }
      ],
      "createdAt": "2019-01-23 13:32:30.163Z",
      "lastSeen": "2019-01-23 13:32:30.163Z"
    }

User details object

Conversation object

Segments object

Update user

Update user basic data.

Data Params

Note: attributes properties are allowed with /^[\w-]{1,128}$/ pattern

Request URL

curl --request PUT \
	--url https://api.chatbot.com/chat/me \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
    attributes.default_email="support@chatbot.com"
    attributes.default_name="ChatBot Support"
'

Response example

    {
      "timestamp": "2018-01-19T11:55:07.552Z",
      "status": {
        "code": 200,
        "type": "success"
      }
    }

Update session attributes

Update active session attributes.

Data Params

Request URL

curl --request PATCH \
	--url https://api.chatbot.com/chat/me \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json' \
	--data '
    attributes.default_email="support@chatbot.com"
    attributes.default_name="ChatBot Support"
'

Response example

    {
      "timestamp": "2018-01-19T11:55:07.552Z",
      "status": {
        "code": 200,
        "type": "success"
      }
    }

Chat with bot

Data Params

Note:

• at least one of query, trigger, goto is required
• parameters properties are allowed with /^[\w-]{1,128}$/ pattern

Request URL

curl --request POST \
	--url https://api.chatbot.com/chat \
	--header 'authorization: Bearer ${DEVELOPER_ACCESS_TOKEN}' \
	--header 'content-type: application/json'

Response example

    {
      "result": {
        "source": "custom",
        "resolvedQuery": "text",
        "confidence": 0.7,
        "score": 1,
        "lifespan": 2,
        "incomplete": false,
        "storyId": "5b07fd67c2376e30306d9b0d",
        "interaction": {
          "id": "5b07ffafc2376e30306d9b16",
          "name": "text response",
          "action": ""
        },
        "parameters": {},
        "sessionParameters": {
          "default_email": "alexis.mcglynn77@hotmail.com",
          "default_name": "Alexis",
          "default_url": null,
          "default_id": null,
          "default_avatar": null,
          "default_language": null,
          "default_timezone": null,
          "default_gender": null,
          "default_ip": null,
          "default_city": null,
          "default_country": null,
          "default_referrer": null,
          "default_real_name": null
        },
        "contexts": [
          {
            "id": "5b07ffafc2376e30306d9b16",
            "name": "text response",
            "action": "",
            "parameters": {}
          }
        ],
        "fulfillment": [
          {
            "type": "text",
            "delay": 2000,
            "message": "text response"
          }
        ]
      },
      "sessionId": "c6d4bc58-4947-4f82-9e0b-67b87c6dc2de",
      "timestamp": "2019-03-12T13:27:15.513Z",
      "status": {
        "code": 200,
        "type": "success"
      }
    }