Chatbot API

• End conversation and move it to All conversations.

• Unassign conversation and move it to the Inbox, where any operator in your group can see and answer it.

• Forward conversation to an available human operator from the same group.

• as a direct response to a chat event that has been sent to your Webhook URL.

• as a self-initiated message to your Userlike API URL.

• Removing, renaming, or moving API entities.

• Changing or removing functionality.

• Making optional parameters or properties mandatory.

javascript
{
    "info": {
        "approach_mode": "proactive",
        "cid": "chatbot::258:a56785fb6fb84edd890905913b0c0821",
        "contact": {},
        "context": {},
        "conversation": {},
        "widget": {}
    },
    "packet": {
        "name": "start",
        "payload": {}
    }
}

javascript
{
    "info": {
        "cid": "chatbot::258:a56785fb6fb84edd890905913b0c0821"
    },
    "packet": {
        "name": "message",
        "payload": {
            "body": "Welcome!"
        }
    }
}

• You can include a list of event objects as JSON in your response to our webhook call.

• You can also send the same JSON as a new request to our API endpoint. Example

javascript
import threading
import json
import socketserver
from http.server import SimpleHTTPRequestHandler


HOST = "localhost"
PORT = 8000
OUTBOUND_AUTH_TOKEN = "d8facdb0-7510-495c-9d6e-8c22b9260e7a"


def create_event(cid, context, packet_name, payload):
    return {
        "info": {"cid": cid, "context": context},
        "packet": {"name": packet_name, "payload": payload},
    }


def create_message(cid, context, body):
    return create_event(cid, context, "message", {"body": body})


def create_contact_update(cid, context, **kwargs):
    return create_event(cid, context, "contact_update", kwargs)


def create_forward_any(cid, context):
    return create_event(cid, context, "forward_any", {})


class InboundSimpleHTTPRequestHandler(SimpleHTTPRequestHandler):
    def handle_start(self, message):
        """Welcome contact and ask for name"""
        body = "Welcome! I am a Bot. What is your name?"
        self.wfile.write(
            json.dumps(create_message(message["info"]["cid"], {"state": "name"}, body))
        )

    def handle_name(self, message):
        """Save the name and ask for email"""
        contact_name = message["packet"]["payload"]["body"]
        contact_update = create_contact_update(
            message["info"]["cid"], {}, name=contact_name
        )
        body = "Hello %s! Could you tell me your email as well?" % contact_name
        chat_message = create_message(message["info"]["cid"], {"state": "email"}, body)
        self.wfile.write(json.dumps([contact_update, chat_message]))

    def handle_email(self, message):
        """Save email, thank contact and forward to human"""
        contact_email = message["packet"]["payload"]["body"]
        contact_update = create_contact_update(
            message["info"]["cid"], {}, email=contact_email
        )
        body = "Thanks! I'll forward you to a human now..."
        chat_message = create_message(message["info"]["cid"], {}, body)
        forward = create_forward_any(message["info"]["cid"], {})
        self.wfile.write(json.dumps([contact_update, chat_message, forward]))

    def do_POST(self):
        content_length = int(self.headers["Content-Length"])
        token = self.headers.get("API-SECURITY-TOKEN")
        if token != OUTBOUND_AUTH_TOKEN:
            self.send_response(401)
            self.end_headers()
            self.wfile.write("Unauthorized")
            return
        self.send_response(200)
        self.send_header("Content-type", "application/json")
        self.end_headers()

        body = self.rfile.read(content_length)
        message = json.loads(body)
        packet_name = message["packet"]["name"]
        contact_name = message["info"]["contact"]["name"]
        contact_email = message["info"]["contact"]["email"]

        # If the name or email is set already, the contact is returning.
        # In that case we don't want any bot behaviour:
        if packet_name == "start" and (contact_name or contact_email):
            self.wfile.write(json.dumps(create_forward_any(message["info"]["cid"], {})))
        elif packet_name == "start":
            self.handle_start(message)
        elif packet_name == "message" and message["info"]["context"]["state"] == "name":
            self.handle_name(message)
        elif (
            packet_name == "message" and message["info"]["context"]["state"] == "email"
        ):
            self.handle_email(message)


class ThreadedHTTPServer(object):
    def __init__(self, host, port, request_handler=SimpleHTTPRequestHandler):
        socketserver.TCPServer.allow_reuse_address = True
        self.server = socketserver.TCPServer((host, port), request_handler)
        self.server_thread = threading.Thread(target=self.server.serve_forever)
        self.server_thread.daemon = True

    def start(self):
        self.server_thread.start()

    def stop(self):
        self.server.shutdown()
        self.server.server_close()

    def serve_forever(self):
        self.server.serve_forever()


if __name__ == "__main__":
    handler = InboundSimpleHTTPRequestHandler
    server = ThreadedHTTPServer(HOST, PORT, request_handler=handler)
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        server.stop()