Agent Console API

Introduction

The extension area provided by the agent console is called widget here. You can extend the agent console through the widgets as below:

• Top Bar
• Nav Bar
• Live Chat Side Tab
• Live Chat Toolbar
• Live Chat Visitor Badge
• Ticketing & Messaging Side Tab
• Background

In order to enhance the extensibility of agent console, we also provide the following public objects.

• Notification
• Widgets
• Dialog

How to Use API

You must invoke api through SDK, which provides different methods, such as listening to events using the on method. Which method is used to call the api? It it desided by the providor.

Learn more for SDK view here.

Notification

1. Send a notification to Agent Console

Params:

Return: No.

Example:

client.do("agentconsole.notification.notify", {
  title: "new-message",
  message: "new message",
});

Widgets

Actions

1. Get all widgets that configured by current app when executing this API.

Params: No.

Return: Wedget list there you configured in the manifest.

Example:

const client = APPClient.init();
client.get("agentconsole.widgets").then(function (widgets) {
  // do stuff
});

2. Send the message to others widget

Params:

Return: No.

Example:

const client = APPClient.init();
client
  .do("agentconsole.widget.sendMessage", {
    to: "0593aae4-bc24-4420-8bf4-6e4ffa63bd1a", 
    data: "test",
  })

Events

1. It will be fired when others widget send message to it throught call agentconsole.widget.sendMessage api.

Params:

Callback params:

Return: No.

Example:

const client = APPClient.init();
client.on("agentconsole.widget.messageReceived", function (data) {
  // do stuff
});

Dialog

This API can open a dialog dynamically, and others widget under this app can subscribe the event of a dialog have be opened.

Actions

1. Open a dialog
   This API can open a dialog dynamically, and return promise result, you can get the opened dialog Id from result. The dialog Id is used when you want to close the dialog.

Params:

Return:

Example:

const client = APPClient.init();
const dialogId = await client
  .do("agentconsole.dialog.open", {
    url: "./dialog.html",
    width: 600,
    height: 480,
  })

2. Close a dialog
   You need to pass in the Dialog Id when closing the dialog.

Params:

Return: No.

Example:

/**
 * @param {string} id - the app id
 */
const client = APPClient.init();
client
  .do("agentconsole.dialog.close", "0593aae4-bc24-4420-8bf4-6e4ffa63bd1a");

Events

1. You can listen to the following event to track the others dialog opened.

Params:

Return: No.

Example:

const client = APPClient.init();
client.on("agentconsole.dialog.opened", function (dialog) {
  //do stuff
});

2. You can listen to the following event to track the others dialog closed.

Params:

Return: No.

Example:

const client = APPClient.init();
client.on("agentconsole.dialog.closed", function (dialog) {
  //do stuff
});