Optibot Live Station Chat Transfer Openwhisk Rule
API for chat initiation with respective Optibot Live Station instance. Following are the pre-requisites required for a successful Live Station-chat-transfer integration:
- Access needed for BigFix AEX Global Admin Portal.
- Global Admin URL: <BIGFIX AEX GLOBAL ADMIN URL>.
- Live Station Credentials needed
Base URL: <URL OF LIVESTATION WHICH NEEDS TO BE CONNECTED>
API Key: <API KEY FROM LIVESTATION>
API for Chat Initiation
{{
'url':`${baseurl}/api/BigFix AEXCommunicateWithLivestationBot?code=$apikey }`,
'method': 'POST',
'json': true,
'timeout': 50000,
'headers': {
'Content-Type': 'application/json',
},
'body': {
'ReturnContext': {
'CustomerCode': {customer_code},
'CustomerName': {customer name},
'ConversationReference': {conversationReference},
'ConversationId': {params.context.conversation_id}
'Source': {source},
'User': {username},
'lang': {language}
},
'UserId': {username},
'UserEmail': {username},
'Username': {displayName},
'ServiceURL': {customer},
'Source': `BIGFIX AEX_${ source }`,
'Subject': {subject},
'Language': {language},
'IsActive': true,
'CreatedDate': new Date().toISOString(),
'Transcript': chatHistory,
'LSDConversationCode': livestationResponse,
'ResponseMessage': enteredMessage
}
}
-
-
Response type: JSON {….}
Status Code: 200 OK in case of success and lsd code will be there in response
-
API for Chat Update
{
'url':`${baseurl}/api/BigFix AEXCommunicateWithLivestationBot?code=$apikey }`,
'method': 'POST',
'json': true,
'timeout': 50000,
'headers': {
'Content-Type': 'application/json',
},
'body': {
'ReturnContext': {
'CustomerCode': {customer_code},
'CustomerName': {customer name},
'ConversationReference': {conversationReference},
'ConversationId': {params.context.conversa]tion_id}
'Source': {source},
'User': {username},
'lang': {language}
},
'UserId': {username},
'UserEmail': {username},
'Username': {displayName},
'ServiceURL': {customer},
'Source': `BIGFIX AEX_${ source }`,
'Subject': {subject},
'Language': {language},
'IsActive': true,
'CreatedDate': new Date().toISOString(),
'Transcript': chatHistory,
'LSDConversationCode': livestationResponse,
'ResponseMessage': enteredMessage
}
}
-
- Response type: JSON {…}
- Status Code: 200 OK in case of success and status :”received will be there in response.
LiveStation Configuration Required for Connect Chat Live Transfer to Operate:
- Base URL – BigFix AEX Tenant URL which would be sending live transfer chat requests to LiveStation
- Published API Token – Token generated from the BigFix AEX tenant