Skip to main content

Django webhook for ChatBotAI

Project description

A Django wrapper with webhook for ChatbotAI

Example code

Installation

pip install django-chatbot

Usage

For Web Bot

in settings.py add the following:

 INSTALLED_APPS = [
  ...
  'django.chatbot',
  ...
]

CHATBOT_TEMPLATE = <ChatBotAI template file path>
START_MESSAGE = "Welcome to ChatBotAI"

in urls.py add the following:

 from django.chatbot.views import web_hook


 urlpatterns = [
   ...
   path("webhook/", web_hook, name="webhook"),
   ...
]

Web Hook API (should authenticate before API request)

URL: /webhook/
Method: POST
Data: {
        last_message_id: 5,
        message: "what is dosa"
      }
Response: {
      "status": "Success",
      "messages": [
           {
             "id": 6, "text": "what is dosa",
             "created": "2020-03-22 19:42:59",
             "by": "user"
            }, {
              "id": 7,
              "text": "A dosa is a cooked flat thin layered rice batter, originating from South India, made from a fermented batter....",
              "created": "2020-03-22 19:42:59",
              "by": "bot"
            }
      ]
}

For Microsoft Bot Framework Webhook

pip install django-background-task

in settings.py add the following:

 INSTALLED_APPS = [
  ...
  'background_task',
  'django.chatbot',
  ...
]

CHATBOT_TEMPLATE = <ChatBotAI template file path>
START_MESSAGE = "Welcome to ChatBotAI"
APP_CLIENT_ID = "<Microsoft App ID>"
APP_CLIENT_SECRET = "<Microsoft App Secret>"

in urls.py add the following:

 from django.chatbot.views import botframework

 urlpatterns = [
   ...
   path("webhook/",
        botframework.web_hook,
        name="botframework-webhook"),
   ...
]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-chatbot, version 0.0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size django_chatbot-0.0.2.2-py3-none-any.whl (8.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size django-chatbot-0.0.2.2.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page