Использование API виджета

Открывает окно чата (эквивалент клика по кнопке виджета). Если чат уже открыт — ничего не делает.

Возвращает: boolean — true, если чат открыт (или уже был открыт); false, если виджет ещё не загрузился.

window.smartbtn_widget_api.open();

Закрывает окно чата. Если чат уже закрыт — ничего не делает.

Возвращает: boolean

window.smartbtn_widget_api.close();

Отправляет сообщение text в чат от имени посетителя — так же, как если бы он сам напечатал и отправил его. Проходит все обычные проверки виджета (пустой текст, нет операторов онлайн — сообщение уйдёт в очередь и т.д.).

Возвращает: boolean

window.smartbtn_widget_api.sendMessage('Здравствуйте, у меня вопрос по заказу');

Передаёт оператору контактные данные посетителя — отображаются так, будто посетитель сам ввёл их в форме представления. Вызывает отправку немедленно (внутри уже вызывает makeRequest() — отдельно вызывать не нужно, в отличие от старого API ниже).

Возвращает: boolean — только подтверждает, что вызов принят (data — объект); не гарантирует, что запрос дошёл до сервера, см. «Ограничения» ниже.

window.smartbtn_widget_api.setContactInfo({
    name: 'Василий Васильев',
    email: 'client@example.com',
    phone: '+79991234567',
    description: 'Пришёл со страницы тарифов'
});

Передаёт произвольную дополнительную информацию о клиенте — отображается в информационной панели справа в приложении оператора, в том порядке, в котором перечислена в массиве. Можно вызывать любое число раз — если диалог уже открыт, данные у оператора обновятся в реальном времени. Как и setContactInfo, отправляет немедленно.

Возвращает: boolean

window.smartbtn_widget_api.setCustomData([
    { title: 'Actions', content: 'Add contact', link: 'https://crm.example.com/add' },
    { content: 'Open customer profile', link: 'https://crm.example.com/client/42' }
]);

Регистрирует callback, который вызывается каждый раз, когда чат открывается (в том числе если посетитель открыл его сам). Можно подписать сколько угодно обработчиков.

window.smartbtn_widget_api.onOpen(function () {
    console.log('чат открыт');
});

То же самое для закрытия чата.

window.smartbtn_widget_api.onClose(function () {
    console.log('чат закрыт');
});

Вызывается при отправке сообщения посетителем — как через обычную форму чата, так и через sendMessage(). Аналога для входящих сообщений оператора сейчас нет, см. «Ограничения».

window.smartbtn_widget_api.onMessageSent(function (payload) {
    console.log('отправлено:', payload.text);
});

Записывает контактные данные посетителя в память — сами по себе ничего не отправляют. Поля те же, что у setContactInfo выше (name, email, phone, description).

То же для произвольных полей — массив объектов {title, content, link}, как у setCustomData выше. Тоже только записывает данные в память.

Единственный вызов, который реально отправляет данные на сервер. Ни setClientInfo, ни setClientCustomData ничего не отправляют без него — только запоминают значения. Асинхронный, ничего не возвращает через промис; результат доступен через Smartbtn_api.status сразу после вызова (с учётом сетевой задержки — см. «Ограничения»).

Smartbtn_api.setClientInfo({
    name: 'Василий Васильев',
    email: 'client@example.com',
    phone: '+79991234567',
    description: 'Текст описания'
});
Smartbtn_api.makeRequest(); // без этого вызова ничего не будет отправлено

setTimeout(function () {
    console.log(Smartbtn_api.status); // { result: 'ok' } или { result: 'fail', reason: '...' }
}, 500);