botium-connector-liveperson
v0.0.11
Published
Botium Connector for Live Person
Downloads
29
Readme
Botium Connector for Live Person
This is a Botium connector for testing your Live Person chatbot.
Did you read the Botium in a Nutshell articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!
How it works
Botium connects to the API of your Live person chatbot.
It can be used as any other Botium connector with all Botium Stack components:
Requirements
- Node.js and NPM
- a Live Person bot
- a project directory on your workstation to hold test cases and Botium configuration
Install Botium and Live Person Connector
When using Botium CLI:
> npm install -g botium-cli
> npm install -g botium-connector-liveperson
> botium-cli init
> botium-cli run
When using Botium Bindings:
> npm install -g botium-bindings
> npm install -g botium-connector-liveperson
> botium-bindings init mocha
> npm install && npm run mocha
When using Botium Box:
Already integrated into Botium Box, no setup required
Connecting Live Person chatbot to Botium
First of all you have to login and install a new application on Live Person Connector App Hub. During the installation please set up the webhook endpoint field according to your server endpoint (from localhost you can use ngrok, see later)
After the installation you will see a new row in the application installations list.
Create a botium.json
file and copy the following values in:
You have to copy the id value from the Application Name & id
column into the LIVEPERSON_CLIENT_ID
.
You have to copy the secret
column value into the
{
"botium": {
"Capabilities": {
"PROJECTNAME": "<whatever>",
"CONTAINERMODE": "liveperson",
"LIVEPERSON_CLIENT_ID": "018908a5-aa8f-4f2a-bae4-1efe1f092e27",
"LIVEPERSON_CLIENT_SECRET": "s8r6ttaar0m5ev2qaqhkbs9m5",
"LIVEPERSON_ACCOUNT_ID": "72165163"
}
}
}
To check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:
> botium-cli emulator
Botium setup is ready, you can begin to write your BotiumScript files.
How to start samples
There is a small demo in samples with Botium Bindings. By changing the corresponding capabilities you can use it with the default Live Person chatbot.
Live Person chatbot sample
- Install the dependencies and botium-core as peerDependency:
> npm install && npm install --no-save botium-core
- Navigate into the samples/real directory
Install the dependencies
> cd ./samples/real > npm install
Adapt botium.json in the sample directory:
- Change
LIVEPERSON_CLIENT_ID
with your installed application id - Change
LIVEPERSON_CLIENT_SECRET
with your installed application secret - Change
LIVEPERSON_ACCOUNT_ID
with your accound id
- Change
Start
inbound-proxy
(it will listen onhttp://127.0.0.1:45100/
):> npm run inbound
In your installed application you need to set
Webhook endpoint
according to the previous step set up inbound-proxy url. (To make this localhost url public you can use e.g. ngrok)Finally run the test
> npm test
Supported Capabilities
Set the capability CONTAINERMODE to liveperson to activate this connector.
LIVEPERSON_CLIENT_ID*
Live Person installed application id
LIVEPERSON_CLIENT_SECRET*
Live Person installed application secret
LIVEPERSON_ACCOUNT_ID*
Your account id
LIVEPERSON_CAMPAIGN_ID
Filling campaignId
and engagementId
you can route your conversation to a specific bot.
LIVEPERSON_ENGAGEMENT_ID
Filling campaignId
and engagementId
you can route your conversation to a specific bot.
LIVEPERSON_CLIENT_PROPERTIES
You can define a client properties object, which is sent in the header of the request at open conversion. E.g.:
{
"type": "ClientProperties",
"features": [
"AUTO_MESSAGES"
]
}
LIVEPERSON_USER_PROFILE
You can define a user profile object. E.g.:
{
"firstName": "Botium",
"lastName": "",
"role": "consumer",
"description": ""
}