Adapter - OBI4wan
This page describes version 2.0.7 of the adapter.
Overview
This page describes the usage of the OBI4wan adapter. This adapter can be used to send chat messages to the OBIwan chatbot platform.
Adapter Configuration
Before the adapter can be used, first it needs some configuration-data. To start a session and send messages to OBIwan, an OBIwan chatbot ID must be configured.
These settings must be configured using the next parameters:
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| chatbotId | Chatbot ID | True | Chatbot ID obtained from OBIwan chatbot platform | password | 24 |
Commands
Start Chatbot Session (StartSession)
Starts a chatbot session
Response Properties
| Name | Description | Type |
|---|---|---|
| sessionId | Session ID to be used for subsequent chat messages to chatbot | string |
Send Chat Message (SendChatMessage)
Send a chat message to the chatbot
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| chatMessage | Chat Message | The chat message that will be send to the chatbot | True | string |
| sessionId | Chatbot Session ID | The chatbot session ID (obtained via 'Start Chatbot Session') | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| sessionId | Session ID to be used for subsequent chat messages to chatbot | string |
| containsChoice | Indicates the response contains a web chat choice | boolean |
| containsHandover | Indicates the response contains a web chat handover | boolean |
| reply | An array of chatbot reply messages | array |
| reply.count | Number of reply message lines that are sent by chatbot | string |
| reply.message | A reply message that was sent by chatbot | string |
| choice | An array of choice options replied by chatbot | array |
| choice.count | Number of choice options that are sent by chatbot | string |
| choice.option | The quick reply choice value that was sent by chatbot | string |
| handoverContext | Handover context ('NoResponse' or 'Completed') | string |
Send Choice Answer (SendChoiceAnswer)
Send a choice answer to the chatbot
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| choiceAnswer | Choice Answer | The replied answer (from one of offered choice options) | True | string |
| sessionId | Chatbot Session ID | The chatbot session ID (obtained via 'Start Chatbot Session') | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| sessionId | Session ID to be used for subsequent chat messages to chatbot | string |
| containsChoice | Indicates the response contains a web chat choice | boolean |
| containsHandover | Indicates the response contains a web chat handover | boolean |
| reply | An array of chatbot reply messages | array |
| reply.message | A reply message that was sent by chatbot | string |
| choice | An array of choice options replied by chatbot | array |
| choice.option | The quick reply choice value that was sent by chatbot | string |
| handoverContext | Handover context ('NoResponse' or 'Completed') | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-30 |