はじめに
対話型AIプラットフォーム
チャットボットの概要
自然言語処理(NLP)
ボットの概念と用語
クイックスタートガイド
プラットフォームへのアクセス
ボットビルダーの操作
リリースノート
最新バージョン(英語)
以前のバージョン(英語)
廃止機能(英語)
コンセプト
設計
ストーリーボード
ダイアログタスク
ダイアログタスクとは
ダイアログビルダー
ノードタイプ
インテントノード
ダイアログノード
エンティティノード
フォームノード
確認ノード
ロジックノード
ボットアクションノード
サービスノード
Webhookノード
スクリプトノード
グループノード
エージェント転送ノード
ユーザープロンプト
音声通話プロパティ
イベント ハンドラー
ナレッジグラフ
ナレッジグラフの抽出
ナレッジグラフの構築
ボットにナレッジグラフを追加
グラフの作成
ナレッジグラフの構築
既存のソースからFAQを構築
通知タスク
スモールトーク
デジタルスキル
デジタルフォーム
デジタルビュー
デジタルビューとは
パネル
ウィジェット
トレーニング
トレーニングとは
機械学習
機械学習とは
モデル検証
ファンダメンタルミーニング
ナレッジグラフ
示唆
ランキングおよび解決
NLPの詳細設定
NLPのガイドライン
インテリジェンス
インテリジェンスとは
コンテキスト
コンテキストインテント
割り込み
複数インテントの検出
エンティティの変更
デフォルトの会話
センチメント管理
トーン分析
テストとデバッグ
ボットと会話
発話テスト
バッチテスト
会話テスト
デプロイ
チャネル
公開
分析
ボットの分析
NLPメトリクス
会話フロー
Usage Metrics
封じ込め測定
カスタムダッシュボード
カスタムダッシュボードとは
メタタグ
カスタムダッシュボードとウィジェット
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
ユニバーサルボット
ユニバーサルボットとは
ユニバーサルボットの定義
ユニバーサルボットの作成
ユニバーサルボットのトレーニング
ユニバーサルボットのカスタマイズ
他言語の有効化
ストア
プラントと使用
Overview
Usage Plans
Support Plans
Invoices
管理
ボット認証
複数言語対応ボット
個人を特定できる情報の編集
ボット変数の使用
IVRのシステム連携
一般設定
ボット管理
ハウツー
会話スキルの設計
バンキングボットを作成
バンキングボット – 資金の振り替え
バンキングボット – 残高を更新
ナレッジグラフを構築
スマートアラートの予約方法
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
デジタルスキルの設計
デジタルフォームの設定方法
デジタルビューの設定方法
データテーブルのデータの追加方法
データテーブルのデータの更新方法
Add Data from Digital Forms
ボットのトレーニング
示唆の使用方法
インテントとエンティティのパターンの使用方法
コンテキスト切り替えの管理方法
ボットのデプロイ
エージェント転送の設定方法
ボット関数の使用方法
コンテンツ変数の使用方法
グローバル変数の使用方法
ボットの分析
カスタムダッシュボードの作成方法
カスタムタグを使ってフィルタリング
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. ホーム
  2. Docs
  3. Virtual Assistants
  4. SDKs
  5. Web Socket Connect & RTM

Web Socket Connect & RTM

Kore.ai SDK libraries use the WebSocket channel to communicate with the Kore.ai XO Platform. When using the Kore.ai XO Platform SDKs, only the JWT token must be generated and passed to the client SDK.

Initializing

This section describes how the Kore.ai SDKs initialize a WebSocket session and is for reference only.

Prerequisites

  • Make sure to register the client app.
  • Generate the Client ID and Secret Key in the Kore.ai XO Platform.

Step1

The JWT is generated on the server side using client app credentials and user information. The JWT is passed to the client app.

Step 2

The client app exchanges the JWT token for the accessToken on the XO Platform using the following XO Platform endpoint.
POST
https://{{APIHost}}/api/1.1/oAuth/token/jwtgrant

This section describes how to format the request to post a message in a chat with the /api/1.1/oAuth/token/jwtgrant endpoint based on the following JSON syntax.

{
    "assertion": “{{JWT Token}}”,
    "botInfo": {
        "chatBot": "{{Bot Name}}",
        "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685"
    }
)

Sample cURL

curl 'https://{{APIHost}}/api/1.1/oAuth/token/jwtgrant' \
  -H 'content-type: application/json'  \
  --data-binary '{"assertion":"{JWT Token}}","botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}}

Response

The following sample JSON response shows the accessToken and the user associated with that token.

{
   "authorization": {
	"accessToken": "ZdV2OL_UZ_MvHog-rs8k9KJFNWBICvquSc3jpeaRDE_-",
                 // access token to user at /api/rtm
	"token_type": "bearer",
	"expiresDate": "2019-06-28T06:52:23.160Z",
                //expiry date for access token
	"issuedDate": "2019-02-28T06:52:23.160Z" 
               //access token issuedDate
	},
   "userInfo": {
	"userId": "u-4f6c68e0-551a-5dd9-a33a-1af3dc9cadcc", 
                 // user id which is unique for the user and can be used at bot messages api
	"accountId": "5c66514d09ab3565deb2e30a", 
                 // account id in which the user is present
	"orgId": "o-88aad7f1-0d32-5765-93d7-f40c80402114",
                // organization id of the user
	"identity": "cs-5b08ed1e-5fa7-5aaa-9c21-28bf8c90b739/admin1212@qakore.xyz", 
                //identity of user from the channel perspective
	"enrollType": "free", 
                //Enrollment type (Free/ Paid etc)
	"managedBy": "5c66514d09ab3565deb2e30a", 
                //(The account id)
	"fName": "", 
                //first name of the user
                // (fetched if the user is registered on the Platform)
	"lName": "" 
                //last name of the user
                // (fetched if the user is registered on the Platform)
	}
}

Step 3

The client app acquires the WebSocket URL using the following endpoint.

POST
https://{{APIHost}}/api/1.1/rtm/start

This section describes how to format the request to get the web socket URL with the /api/1.1/rtm/start endpoint based on the following JSON syntax.

Note: This URL is short-lived and expires in 30 seconds. You must ensure it is used to connect before expiration.

{
    "botInfo": {
        "chatBot": "Twitter",
        "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685"
    }
}

The accessToken is passed in the bearer parameter in the Authorization header.

Sample cURL

curl 'https://{{APIHost}}/api/1.1/rtm/start' \
  -H 'content-type: application/json' \
  -H 'Authorization: bearer {{accessToken}}' \
  --data-binary '{"botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}'

Response

The following sample JSON response shows the WebSocket URL.

{"url":"wss://xxx.yyy.com:443/rtm/bot?sid=GhKrtrEC61g7hAnmvKAVnJIHG0DS1Lzv"}

RTM Channel Events

The following real-time events can be exchanged between the client app and the Kore.ai XO Platform

RTM Client Events

This section describes the RTM Client Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /bot.message

Description: Triggered when a user posts a message. The following payload is used to send a user-typed message to the XO Platform.

{
    "clientMessageId": 1466692440896,
    "message": {
        "body": "Here is the message.",
        "attachments": [

      ]
    },
    "resourceid": "/bot.message",
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "id": 1466692440896
}

RTM Server Events

This section describes the RTM Server Event JSON responses sent to the client app over a WebSocket.

Event Type:ack

Description: An acknowledgment is sent whenever an event is received from the client app.

The following payload is used to acknowledge an event from the client app.

{
    "ok": true,
    "replyto": 1466692440896,
    "message": "delivered",
    "type": "ack"
}

Event Type: bot_response

Description: An acknowledgment is sent whenever a message is processed from the client app.

The following payload is sent when a message from the client app is processed.

{
    "type": "bot_response",
    "from": "bot",
    "message": [
        {
            "type": "text",
            "cInfo": {
                "body": " Hi.  "
            }
      }
   ],
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "createdOn": "2016-06-23T14:34:00.025Z",
    "icon": "https://devbots.kore.com/api/getMediaStream/market/f-683e82be-fc25-5921-bf41-4104780f71c2.png"
}

Event Type: user_message

Description: Sent to the client app when a user enters and sends a message to the server from another simultaneous session.

The following sample payload is sent to the client app.

{
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "from": "self",
    "message": {
        "body": "how are you doing ",
        "attachments": []
    },
    "id": 1466692871803,
    "type": "user_message"
}

Bot Status Event

The following bot user event is exchanged and triggered between the client app and the Kore.ai XO Platform when a bot is active.

This section describes the Bot Status Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /bot_active

Description:Triggered when a WebSocket connection is established with the bot.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "bot_active", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Event Type: /botKitUnreachable

Description: Send notification to the WebSDK channel as a WebSocket event when the BotKit is unreachable. 

By default, the notification says, “‘Sorry, there was an error in continuing the conversation. Please retry.” Developers can customize the message to make it more contextual or language specific for the end users.

The following payload is used to send a response message to the XO Platform.

{
  "type": "botKitUnreachable",
  "from": "bot",
  "botInfo": {
    "chatBot": "new bot hangouts",
    "taskBotId": "st-f3ad01a6-a034-519a-84ab-40043a4c368f",
    "botType": "default",
    "remoteAddress": "115.114.88.222",
    "hostDomain": "https://bots.kore.ai",
    "os": "Linux",
    "device": "Other",
    "userId": "u-f6b20c0b-c7bd-57e1-a762-d9a0590acefc"
  }
  "message": "Sorry, there was an error in continuing the conversation. Please retry.",
  "traceId": "c070f2b7de24920a",
  "timestamp": 1693394943443
} 

Form Events

The following form events are exchanged and triggered between the client app and the Kore.ai XO Platform when a form based dialog task is invoked.

This section describes the Form Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /form_delivered

Description:Triggered when a form is delivered to a user.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_delivered", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /form_submitted

Description:Triggered when a form is submitted by a user.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_submitted", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /form_failure

Description: Triggered when a form fails for any reason.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_failure", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Session Events

The following session events are exchanged and triggered between the client app and the Kore.ai XO Platform when a session is invoked.

This section describes the Session Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /session_start

Description:Triggered when a session starts using an On-Connect event or message.

The session starts in the following scenarios:

  • When the On-Connect is enabled to open, refresh and disable a chat window.
  • A message sent after 15 mins.
  • A message is sent after the idle timeout mentioned in Manage Sessions.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "session_start", 
  "from": "bot", 
  "botInfo": 
  { 
    "chatBot": "jarvis_new_import", 
    "taskBotId": "st-496bf3e4-63de-5635-8fcb-db1f9356def8", 
"hostDomain": "http://localhost", 
"os": "Linux", 
"device": "Other" 
}, 
"sessionId": "6426bf7e916562382331ba89", 
"traceId": "a33d81825f3b1a77" 
} 

Event Type: /session_end

Description:Triggered when a session ends using an On-Connect event.

The session ends in the following scenarios:

  • When the On-Connect is enabled to close, refresh and disable a chat window.
  • A session timeout after 15 mins.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "session_end", 
  "from": "bot", 
  "botInfo": 
  { 
    "chatBot": "jarvis_new_import", 
    "taskBotId": "st-496bf3e4-63de-5635-8fcb-db1f9356def8", 
"hostDomain": "http://localhost", 
"os": "Linux", 
"device": "Other" 
}, 
"sessionId": "6426bf7e916562382331ba89", 
"traceId": "a33d81825f3b1a77" 
} 

Agent Transfer Events

The following agent transfer events are exchanged and triggered between the client app and the Kore.ai XO Platform when an agent is invoked. For more information, see the Agent Transfer Overview article.

This section describes the Agent Transfer Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /agent_session_start

Description: Triggered when the chat is handed off to an agent.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "agent_session_start", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /agent_session_end

Description:Triggered when the conversation with the agent is ended.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "agent_session_end", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

User Input Event

The following user input event is exchanged and triggered between the client app and the Kore.ai XO Platform when the user input is required.

This section describes the User Input Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /waiting_for_user_input

Description:Triggered when the VA is waiting for user input. The input can come from an Entity, Confirmation, and Standard Responses.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "waiting_for_user_input", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Get Conversation History

The client app requests the XO Platform endpoint /api/botmessages/rtm?botId={{botId}} using the access token as generated in Step 2 above to get the previous messages exchanged between the user and the chatbot. The response from the mentioned endpoint can be used to display the conversation history in the chat window. This section describes how to format the request to get the web socket URL with the /api/botmessages/rtm endpoint based on the following JSON syntax.

GET
https://{{APIHost}}/api/botmessages/rtm?botId={{botId}}

Query Parameters:

  • botId(mandatory) : Bot ID, can be accessed from the bot’s General Settings page.
  • skip/offset (optional) : The number of messages to be skipped.
  • limit (optional) : The number of messages to be fetched.
  • The accessToken to be passed along with bearer as the Authorization parameter in the header

Sample cURL

curl 'https://{{APIHost}}/api/botmessages/rtm?botId={{botId}}&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: bearer -{{accessToken}}' \
  -H 'content-type: application/json'

Sample Response

{
  "total": 2,
  "moreAvailable": false,
  "messages": [
    {
      "_id": "ms-8a83d099-dd93-5b6b-836b-ac77bdfe9d4a",
      "channels": [
        {
          "type": "rtm"
        }
      ],
      "type": "incoming",
      "status": "sent to cs",
      "createdBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "lmodifiedBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "lmodifiedOn": "2019-12-03T05:07:44.008Z",
      "botId": "st-2f579dbf-9dc1-548c-972f-f19d33160a07",
      "orgId": "o-44741779-1971-5ab9-a0f7-aaf4e21dbe4e",
      "accountId": "5a675150ff600b3d7665d2a6",
      "isBB": 0,
      "ms": 1,
      "chnl": "rtm",
      "components": [
        {
          "_id": "cp-1edc5033-a9cb-5011-8b2b-5986b7fa45cc",
          "cT": "text",
          "data": {
            "text": "Hi"
          },
          "thumbnails": [
           
          ]
        }
      ],
      "createdOn": "2019-12-03T05:07:44.097Z",
      "timestampValue": 1575349664097,
      "__v": 0,
      "lang": "en",
      "sessionId": "5de5eda04cdcff145752dbf6",
      "nodeType": 0,
      "tr0_I": "dg-61e5609f-76e7-5c42-b66f-7bb8b3af2433:intent0",
      "tr0_O": "dg-61e5609f-76e7-5c42-b66f-7bb8b3af2433:entity1:4a04988ee640428d1847fc433081be0b",
      "tr0_T": "0",
      "tr_isSS": 1,
      "resourceid": "messagestore",
      "tags": {
        "messageTags": [
         
        ],
        "userTags": [
         
        ],
        "sessionTags": [
         
        ]
      }
    },
    {
      "_id": "ms-80e8dbf3-ca69-5ee2-a2c1-1c6a70100c08",
      "channels": [
        {
          "type": "rtm"
        }
      ],
      "type": "outgoing",
      "status": "pending",
      "lmodifiedOn": "2019-12-03T05:07:45.165Z",
      "createdBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "components": [
        {
          "_id": "cp-209a0641-130b-57ce-b0d3-d651691084bb",
          "cT": "text",
          "data": {
            "text": "Please enter the text to comment on the issue"
          },
          "thumbnails": [
           
          ]
        }
      ],
      "botId": "st-2f579dbf-9dc1-548c-972f-f19d33160a07",
      "orgId": "o-44741779-1971-5ab9-a0f7-aaf4e21dbe4e",
      "accountId": "5a675150ff600b3d7665d2a6",
      "tN": "Add Comment to Issue",
      "isBB": 0,
      "ms": 1,
      "chnl": "rtm",
      "lang": "en",
      "createdOn": "2019-12-03T05:07:45.171Z",
      "timestampValue": 1575349665171,
      "__v": 0,
      "sessionId": "5de5eda04cdcff145752dbf6",
      "resourceid": "messagestore",
      "tags": {
        "messageTags": [
         
        ],
        "userTags": [
         
        ],
        "sessionTags": [
         
        ]
      }
    }
  ]
}

WebSocket Error Scenarios

This section describes the various error code responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Error Code Reason
1002 When protocol error occurs.
1005 When a user closes the chat window or reconnects with the bot.
1006 When the server restarts.
1007 When VA finds non utf-8 kind of messages instead of text messages.
1008 When any of the following scenarios occurs:

  • Exceeds user rate limit
  • Bot suspended
  • User blocked
  • Channel user ID is blocked
1011 When any unhandled exceptions come up when the WebSocket connection is up and running.
1009 When the payload size is larger than the maximum limit.

Next Steps

The XO Platform API endpoints and RTM events can be used with your client app or Kore.ai Bot SDKs. For more information, see the Kore.ai Bots SDK.

Web Socket Connect & RTM

Kore.ai SDK libraries use the WebSocket channel to communicate with the Kore.ai XO Platform. When using the Kore.ai XO Platform SDKs, only the JWT token must be generated and passed to the client SDK.

Initializing

This section describes how the Kore.ai SDKs initialize a WebSocket session and is for reference only.

Prerequisites

  • Make sure to register the client app.
  • Generate the Client ID and Secret Key in the Kore.ai XO Platform.

Step1

The JWT is generated on the server side using client app credentials and user information. The JWT is passed to the client app.

Step 2

The client app exchanges the JWT token for the accessToken on the XO Platform using the following XO Platform endpoint.
POST
https://{{APIHost}}/api/1.1/oAuth/token/jwtgrant

This section describes how to format the request to post a message in a chat with the /api/1.1/oAuth/token/jwtgrant endpoint based on the following JSON syntax.

{
    "assertion": “{{JWT Token}}”,
    "botInfo": {
        "chatBot": "{{Bot Name}}",
        "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685"
    }
)

Sample cURL

curl 'https://{{APIHost}}/api/1.1/oAuth/token/jwtgrant' \
  -H 'content-type: application/json'  \
  --data-binary '{"assertion":"{JWT Token}}","botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}}

Response

The following sample JSON response shows the accessToken and the user associated with that token.

{
   "authorization": {
	"accessToken": "ZdV2OL_UZ_MvHog-rs8k9KJFNWBICvquSc3jpeaRDE_-",
                 // access token to user at /api/rtm
	"token_type": "bearer",
	"expiresDate": "2019-06-28T06:52:23.160Z",
                //expiry date for access token
	"issuedDate": "2019-02-28T06:52:23.160Z" 
               //access token issuedDate
	},
   "userInfo": {
	"userId": "u-4f6c68e0-551a-5dd9-a33a-1af3dc9cadcc", 
                 // user id which is unique for the user and can be used at bot messages api
	"accountId": "5c66514d09ab3565deb2e30a", 
                 // account id in which the user is present
	"orgId": "o-88aad7f1-0d32-5765-93d7-f40c80402114",
                // organization id of the user
	"identity": "cs-5b08ed1e-5fa7-5aaa-9c21-28bf8c90b739/admin1212@qakore.xyz", 
                //identity of user from the channel perspective
	"enrollType": "free", 
                //Enrollment type (Free/ Paid etc)
	"managedBy": "5c66514d09ab3565deb2e30a", 
                //(The account id)
	"fName": "", 
                //first name of the user
                // (fetched if the user is registered on the Platform)
	"lName": "" 
                //last name of the user
                // (fetched if the user is registered on the Platform)
	}
}

Step 3

The client app acquires the WebSocket URL using the following endpoint.

POST
https://{{APIHost}}/api/1.1/rtm/start

This section describes how to format the request to get the web socket URL with the /api/1.1/rtm/start endpoint based on the following JSON syntax.

Note: This URL is short-lived and expires in 30 seconds. You must ensure it is used to connect before expiration.

{
    "botInfo": {
        "chatBot": "Twitter",
        "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685"
    }
}

The accessToken is passed in the bearer parameter in the Authorization header.

Sample cURL

curl 'https://{{APIHost}}/api/1.1/rtm/start' \
  -H 'content-type: application/json' \
  -H 'Authorization: bearer {{accessToken}}' \
  --data-binary '{"botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}'

Response

The following sample JSON response shows the WebSocket URL.

{"url":"wss://xxx.yyy.com:443/rtm/bot?sid=GhKrtrEC61g7hAnmvKAVnJIHG0DS1Lzv"}

RTM Channel Events

The following real-time events can be exchanged between the client app and the Kore.ai XO Platform

RTM Client Events

This section describes the RTM Client Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /bot.message

Description: Triggered when a user posts a message. The following payload is used to send a user-typed message to the XO Platform.

{
    "clientMessageId": 1466692440896,
    "message": {
        "body": "Here is the message.",
        "attachments": [

      ]
    },
    "resourceid": "/bot.message",
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "id": 1466692440896
}

RTM Server Events

This section describes the RTM Server Event JSON responses sent to the client app over a WebSocket.

Event Type:ack

Description: An acknowledgment is sent whenever an event is received from the client app.

The following payload is used to acknowledge an event from the client app.

{
    "ok": true,
    "replyto": 1466692440896,
    "message": "delivered",
    "type": "ack"
}

Event Type: bot_response

Description: An acknowledgment is sent whenever a message is processed from the client app.

The following payload is sent when a message from the client app is processed.

{
    "type": "bot_response",
    "from": "bot",
    "message": [
        {
            "type": "text",
            "cInfo": {
                "body": " Hi.  "
            }
      }
   ],
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "createdOn": "2016-06-23T14:34:00.025Z",
    "icon": "https://devbots.kore.com/api/getMediaStream/market/f-683e82be-fc25-5921-bf41-4104780f71c2.png"
}

Event Type: user_message

Description: Sent to the client app when a user enters and sends a message to the server from another simultaneous session.

The following sample payload is sent to the client app.

{
    "botInfo": {
        "chatBot": "CNN",
        "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce"
    },
    "from": "self",
    "message": {
        "body": "how are you doing ",
        "attachments": []
    },
    "id": 1466692871803,
    "type": "user_message"
}

Bot Status Event

The following bot user event is exchanged and triggered between the client app and the Kore.ai XO Platform when a bot is active.

This section describes the Bot Status Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /bot_active

Description:Triggered when a WebSocket connection is established with the bot.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "bot_active", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Event Type: /botKitUnreachable

Description: Send notification to the WebSDK channel as a WebSocket event when the BotKit is unreachable. 

By default, the notification says, “‘Sorry, there was an error in continuing the conversation. Please retry.” Developers can customize the message to make it more contextual or language specific for the end users.

The following payload is used to send a response message to the XO Platform.

{
  "type": "botKitUnreachable",
  "from": "bot",
  "botInfo": {
    "chatBot": "new bot hangouts",
    "taskBotId": "st-f3ad01a6-a034-519a-84ab-40043a4c368f",
    "botType": "default",
    "remoteAddress": "115.114.88.222",
    "hostDomain": "https://bots.kore.ai",
    "os": "Linux",
    "device": "Other",
    "userId": "u-f6b20c0b-c7bd-57e1-a762-d9a0590acefc"
  }
  "message": "Sorry, there was an error in continuing the conversation. Please retry.",
  "traceId": "c070f2b7de24920a",
  "timestamp": 1693394943443
} 

Form Events

The following form events are exchanged and triggered between the client app and the Kore.ai XO Platform when a form based dialog task is invoked.

This section describes the Form Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /form_delivered

Description:Triggered when a form is delivered to a user.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_delivered", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /form_submitted

Description:Triggered when a form is submitted by a user.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_submitted", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /form_failure

Description: Triggered when a form fails for any reason.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "form_failure", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Session Events

The following session events are exchanged and triggered between the client app and the Kore.ai XO Platform when a session is invoked.

This section describes the Session Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /session_start

Description:Triggered when a session starts using an On-Connect event or message.

The session starts in the following scenarios:

  • When the On-Connect is enabled to open, refresh and disable a chat window.
  • A message sent after 15 mins.
  • A message is sent after the idle timeout mentioned in Manage Sessions.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "session_start", 
  "from": "bot", 
  "botInfo": 
  { 
    "chatBot": "jarvis_new_import", 
    "taskBotId": "st-496bf3e4-63de-5635-8fcb-db1f9356def8", 
"hostDomain": "http://localhost", 
"os": "Linux", 
"device": "Other" 
}, 
"sessionId": "6426bf7e916562382331ba89", 
"traceId": "a33d81825f3b1a77" 
} 

Event Type: /session_end

Description:Triggered when a session ends using an On-Connect event.

The session ends in the following scenarios:

  • When the On-Connect is enabled to close, refresh and disable a chat window.
  • A session timeout after 15 mins.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "session_end", 
  "from": "bot", 
  "botInfo": 
  { 
    "chatBot": "jarvis_new_import", 
    "taskBotId": "st-496bf3e4-63de-5635-8fcb-db1f9356def8", 
"hostDomain": "http://localhost", 
"os": "Linux", 
"device": "Other" 
}, 
"sessionId": "6426bf7e916562382331ba89", 
"traceId": "a33d81825f3b1a77" 
} 

Agent Transfer Events

The following agent transfer events are exchanged and triggered between the client app and the Kore.ai XO Platform when an agent is invoked. For more information, see the Agent Transfer Overview article.

This section describes the Agent Transfer Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /agent_session_start

Description: Triggered when the chat is handed off to an agent.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "agent_session_start", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

Event Type: /agent_session_end

Description:Triggered when the conversation with the agent is ended.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "agent_session_end", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
} 

User Input Event

The following user input event is exchanged and triggered between the client app and the Kore.ai XO Platform when the user input is required.

This section describes the User Input Event JSON responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Event Type: /waiting_for_user_input

Description:Triggered when the VA is waiting for user input. The input can come from an Entity, Confirmation, and Standard Responses.

The following payload is used to send a response message to the XO Platform.

{ 
  "type": "waiting_for_user_input", 
  "from": "bot", 
   "botInfo": { "chatBot": "Natasha", 
   "taskBotId": "st-2e2663f4-bc07-583a-b244-3d8e41d3d2ac" }, 
   "sessionId": "642d2f34f7eb45387a7be64e", "formMetaInfo": 
{ 
   "isSecured": true, 
    "formLinkExpiry": 300, 
     "submitExpiry": 600
}, 
"traceId": "4a663e27051cd294" 
}

Get Conversation History

The client app requests the XO Platform endpoint /api/botmessages/rtm?botId={{botId}} using the access token as generated in Step 2 above to get the previous messages exchanged between the user and the chatbot. The response from the mentioned endpoint can be used to display the conversation history in the chat window. This section describes how to format the request to get the web socket URL with the /api/botmessages/rtm endpoint based on the following JSON syntax.

GET
https://{{APIHost}}/api/botmessages/rtm?botId={{botId}}

Query Parameters:

  • botId(mandatory) : Bot ID, can be accessed from the bot’s General Settings page.
  • skip/offset (optional) : The number of messages to be skipped.
  • limit (optional) : The number of messages to be fetched.
  • The accessToken to be passed along with bearer as the Authorization parameter in the header

Sample cURL

curl 'https://{{APIHost}}/api/botmessages/rtm?botId={{botId}}&limit=10' \
  -H 'accept: application/json' \
  -H 'Authorization: bearer -{{accessToken}}' \
  -H 'content-type: application/json'

Sample Response

{
  "total": 2,
  "moreAvailable": false,
  "messages": [
    {
      "_id": "ms-8a83d099-dd93-5b6b-836b-ac77bdfe9d4a",
      "channels": [
        {
          "type": "rtm"
        }
      ],
      "type": "incoming",
      "status": "sent to cs",
      "createdBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "lmodifiedBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "lmodifiedOn": "2019-12-03T05:07:44.008Z",
      "botId": "st-2f579dbf-9dc1-548c-972f-f19d33160a07",
      "orgId": "o-44741779-1971-5ab9-a0f7-aaf4e21dbe4e",
      "accountId": "5a675150ff600b3d7665d2a6",
      "isBB": 0,
      "ms": 1,
      "chnl": "rtm",
      "components": [
        {
          "_id": "cp-1edc5033-a9cb-5011-8b2b-5986b7fa45cc",
          "cT": "text",
          "data": {
            "text": "Hi"
          },
          "thumbnails": [
           
          ]
        }
      ],
      "createdOn": "2019-12-03T05:07:44.097Z",
      "timestampValue": 1575349664097,
      "__v": 0,
      "lang": "en",
      "sessionId": "5de5eda04cdcff145752dbf6",
      "nodeType": 0,
      "tr0_I": "dg-61e5609f-76e7-5c42-b66f-7bb8b3af2433:intent0",
      "tr0_O": "dg-61e5609f-76e7-5c42-b66f-7bb8b3af2433:entity1:4a04988ee640428d1847fc433081be0b",
      "tr0_T": "0",
      "tr_isSS": 1,
      "resourceid": "messagestore",
      "tags": {
        "messageTags": [
         
        ],
        "userTags": [
         
        ],
        "sessionTags": [
         
        ]
      }
    },
    {
      "_id": "ms-80e8dbf3-ca69-5ee2-a2c1-1c6a70100c08",
      "channels": [
        {
          "type": "rtm"
        }
      ],
      "type": "outgoing",
      "status": "pending",
      "lmodifiedOn": "2019-12-03T05:07:45.165Z",
      "createdBy": "u-211f287f-17c8-51ac-b768-15c68e19afb2",
      "components": [
        {
          "_id": "cp-209a0641-130b-57ce-b0d3-d651691084bb",
          "cT": "text",
          "data": {
            "text": "Please enter the text to comment on the issue"
          },
          "thumbnails": [
           
          ]
        }
      ],
      "botId": "st-2f579dbf-9dc1-548c-972f-f19d33160a07",
      "orgId": "o-44741779-1971-5ab9-a0f7-aaf4e21dbe4e",
      "accountId": "5a675150ff600b3d7665d2a6",
      "tN": "Add Comment to Issue",
      "isBB": 0,
      "ms": 1,
      "chnl": "rtm",
      "lang": "en",
      "createdOn": "2019-12-03T05:07:45.171Z",
      "timestampValue": 1575349665171,
      "__v": 0,
      "sessionId": "5de5eda04cdcff145752dbf6",
      "resourceid": "messagestore",
      "tags": {
        "messageTags": [
         
        ],
        "userTags": [
         
        ],
        "sessionTags": [
         
        ]
      }
    }
  ]
}

WebSocket Error Scenarios

This section describes the various error code responses sent to the Kore.ai XO Platform from the client app over a WebSocket.

Error Code Reason
1002 When protocol error occurs.
1005 When a user closes the chat window or reconnects with the bot.
1006 When the server restarts.
1007 When VA finds non utf-8 kind of messages instead of text messages.
1008 When any of the following scenarios occurs:

  • Exceeds user rate limit
  • Bot suspended
  • User blocked
  • Channel user ID is blocked
1011 When any unhandled exceptions come up when the WebSocket connection is up and running.
1009 When the payload size is larger than the maximum limit.

Next Steps

The XO Platform API endpoints and RTM events can be used with your client app or Kore.ai Bot SDKs. For more information, see the Kore.ai Bots SDK.

メニュー