- Chat Widget API
- Hooks
- Methods
- create
- destroy
- isInitialized
- resetSession
deprecatedopenChat- openChatWindow
deprecatedcloseChat- closeChatWindow
- hideChatWindow
- isChatWindowOpened
- isChatWindowClosed
- isChatWindowHidden
- sendMessage
- sendTrigger
deprecatedsetUserParameters- setUserAttributes
deprecatedsetCustomParameters- setSessionAttributes
Callback function invoked when widget code is loaded but chat window is not rendered yet.
You can return false to stop the widget initialization.
window.BE_API = window.BE_API || {};
window.BE_API.onBeforeLoad = function () {
// return false
};Callback function invoked when widget code is loaded and chat window is rendered.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
// ...
};Callback function invoked after create() API method call.
window.BE_API = window.BE_API || {};
window.BE_API.onCreate = function () {
// ...
};Callback function invoked after destroy() API method call.
window.BE_API = window.BE_API || {};
window.BE_API.onDestroy = function () {
// ...
};Callback function invoked when the chat window is opened.
window.BE_API = window.BE_API || {};
window.BE_API.onChatWindowOpen = function () {
// ...
};Callback function invoked when the chat window is closed.
window.BE_API = window.BE_API || {};
window.BE_API.onChatWindowClose = function () {
// ...
};Callback function invoked when the chat window is hidden.
window.BE_API = window.BE_API || {};
window.BE_API.onChatWindowHide = function () {
// ...
};Callback function invoked after query result.
window.BE_API = window.BE_API || {};
window.BE_API.onMessage = function (result) {
console.log(result)
};Callback function invoked after the conversation starts.
window.BE_API = window.BE_API || {};
window.BE_API.onStartConversation = function () {
// ...
};Create chat widget if does not exist
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.create();
};Destroy chat widget if exist
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.destroy();
};Returns true if the chat is initialized.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.isInitialized();
};Reset current session and recreate widget.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.resetSession();
};Deprecated, use: openChatWindow
Open the chat window, should be used only inside window.BE_API.onLoad callback
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.openChatWindow();
};Deprecated, use: closeChatWindow
Close the chat window, should be used only inside window.BE_API.onLoad callback
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.closeChatWindow();
};Hide the chat window, should be used only inside window.BE_API.onLoad callback
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.hideChatWindow();
};Should be used only inside window.BE_API.onLoad callback.
Returns true if the chat window is open.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.isChatWindowOpened();
};Should be used only inside window.BE_API.onLoad callback.
Returns true if the chat window is closed.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.isChatWindowClosed();
};isChatWindowHidden
Should be used only inside window.BE_API.onLoad callback.
Returns true if the chat window is hidden.
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = function () {
window.BE_API.isChatWindowHidden();
};Deprecated, use: setUserAttributes
Set user attributes. Read more about user attributes here:
https://www.chatbot.com/docs/users#update-user
| parameter | type | description |
|---|---|---|
Object |
Object( Entry Object(1, 99) ) required |
Object with entries |
| parameter | type | description |
|---|---|---|
key |
String(1, 128) | Attribute name |
value |
String(1, 1024) | Attribute value |
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = () => {
window.BE_API.setUserAttributes({
email: '[email protected]',
name: 'Botengine Support'
})
}Deprecated, use: setSessionAttributes
Set your custom attributes that will be sent to the query. Each method call will overwrite existing parameters. Read more about attributes here: https://www.botengine.ai/docs/talk-with-bot#parameters
| parameter | type | description |
|---|---|---|
Object |
Object( Entry Object(1, 99) ) required |
Object with entries |
| parameter | type | description |
|---|---|---|
key |
String(1, 128) | Attribute name |
value |
String(1, 1024) | Attribute value |
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = () => {
window.BE_API.setSessionAttributes({
email: '[email protected]',
name: 'Botengine Support'
})
}Send a message as visitor.
| parameter | type | description |
|---|---|---|
payload.message |
String(1, 256) required |
Message |
payload.postback |
String(1, 256) | Postback |
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = () => {
window.BE_API.sendMessage({
message: 'message',
postback: 'postback'
})
}Trigger the specific interaction.
| parameter | type | description |
|---|---|---|
payload |
String(1, 50) required |
Trigger name |
window.BE_API = window.BE_API || {};
window.BE_API.onLoad = () => {
window.BE_API.sendTrigger('custom_trigger')
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent