m90 / go-chatbase Goto Github PK

HTTP Method: POST
Request Body (JSON):
{
  api_key:           string, <required> the Chatbase ID of the bot
  type:              string, <required> valid values "user" or "agent" (aka
                     your bot) message
  user_id:           string, <required> the ID of the end-user
  time_stamp:        int,    <required> milliseconds since the UNIX epoch, used to sequence
                     messages. (must be within previous 30 days)
  platform:          string, <required> valid values "Facebook", "SMS", "Web", "Android",
                     "iOS", "Actions", "Alexa", "Cortana", "Kik", "Skype", "Twitter", "Viber",
                     "Telegram", "Slack", "WhatsApp", "WeChat", "Line", "Kakao" or a custom name
                     like "Workplace" or "OurPlatform"
  message:           string, <optional> the raw message body regardless of type for example
                     a typed-in or a tapped button or tapped image; 1,200 characters max
  intent:            string, <optional> set for user messages only; if not set usage metrics
                     will not be shown per intent; do not set if it is a generic catch all intent,
                     like default fallback, so that clusters of similar messages can be reported
  not_handled:       bool,   <optional> set for user messages only;
                     indicates that the bot was not able to handle the message because it was
                     not understood (e.g. no intent for "Start over"), or it was understood (e.g.
                     has intent for "Order drink") but not supported; if not set then these high
                     churn issues are not shown across reports; set for generic catch all intents,
                     like default fallback
  version:           string, <optional> set for user and bot messages; used to track
                     versions of your code or to track A/B tests
  session_id:        string, <optional> set for user and bot messages; used to define your own
                     custom sessions for Session Flow report and daily session metrics
}

Response:
{
  message_id:  <string>,
  status:      <int> 200 || 400
}`