Kore.ai SDK libraries use the web socket channel to communicate with Kore.ai XO Platform. To initialize a web socket session, the Kore.ai SDKs use the following XO Platform endpoints. 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 web socket session and is for reference only.
Prerequisites
The client app is registered and Client ID and Secret Key are generated in the Kore.ai XO Platform tool.
Step1
The JWT is generated at 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. 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. POST
https://{{APIHost}}/api/1.1/oAuth/token/jwtgrant
{
"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 follow sample JSON response shows the accessToken and 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 web socket URL using the following endpoint. 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.
POST
https://{{APIHost}}/api/1.1/rtm/start
{
"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 web socket URL.
{"url":"wss://xxx.yyy.com:443/rtm/bot?sid=GhKrtrEC61g7hAnmvKAVnJIHG0DS1Lzv"}
RTM Events Reference
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 web socket. 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 web socket. Event Type: ack Description: An acknowledgment 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 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"
}
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
accessTokento 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": [
]
}
}
]
}
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.