- Сервис онлайн-консультирования Webim
- -
- База знаний
- -
- Для разработчиков
- -
- Webim API
- -
- Webim Partner API
- -
- Webim Partner API 1.0
-
-
-
- API сервиса Webim
- Webim Mobile SDK и мобильное приложение Webim для посетителя
- Встраивание чата Webim на сайт
- Идентификаторы посетителя
- Интеграция со сторонними сервисами
- Интерфейс виджета чата
- Логика обработки чатов
- Настройка сервиса Webim
- Операторы и РМО
- Отделы в сервисе Webim
- Панель приборов: ответы на вопросы
- Эксплуатация сервиса Webim
- Основные понятия и термины
- Сброс пароля
- Система управления ролями и правами доступа
- Шаг 1. Установка виджета Webim на сайт
- Шаг 2. Начальная настройка сервиса
- Шаг 3. Регистрация оператора
- Шаг 4. Подключение каналов общения
-
-
-
- 01. Обнаружение нового посетителя, ожидающего ответа
- 02. Выбор посетителя сайта из списка и начало диалога
- 03. Набор ответа посетителю, выбор шаблона
- 04. Запрос контактной информации у посетителя
- 05. Отправка файла посетителю
- 06. «Телепортация» пользователей
- 07. Переадресация диалога другому оператору
- 08. Отправка переписки на адрес электронной почты оператора
- 09. Назначение категории посетителю
- 10. Блокировка посетителя
- 11. Вставка гиперссылки в сообщение
- 12. Добавление cкрытых сообщений
- 13. Проверка орфографии
- Agent`s Handbook
- Горячие клавиши в РМО
- Загрузка файлов в диалог
- Исходящие диалоги
- Как включить оповещения в Google Chrome
- Очереди в РМО
- Работа с офлайн-обращениями в РМО
-
- Автоприглашения
- Активность сотрудников
- Алгоритмы назначения чатов
- Видимость диалогов
- Возможности и ограничения Webim в каналах общения
- Вход в систему
- Геолокация посетителей
- График работы
- Добавление кнопки Webim в E-mail
- Закрытие диалогов
- Логотип компании в заголовке чата
- Маршрутизация чатов между операторами и ботами
- Маска телефонного номера
- Настройка языков
- Общие настройки организации
- Ограничения по длине сообщений и полей
- Особенности функционала «Начать чат» в каналах общения
- Отделы
- Оценки
- Переназначение специализированных клавиш управления в РМО
- Приоритетные страницы
- Рассылки
- Регистрация операторов и назначение супервизоров
- Системные сообщения
- Список тайм-аутов
- Финансы
- Шаблоны ответов
-
-
- Встраивание административного интерфейса через iframe
- Горизонтальное масштабирование (кластеризация)
- Интеграция с почтовыми серверами
- Обработка файлов, загружаемых в чат
- Описание сервисных периодов Webim
- Параметры настроек сервера
- Редактор настроек аккаунта (account config)
- Редактор ресурсов
- Сетевые конфигурации сервиса Webim
-
-
-
- Webim Mobile SDK 3.0 для интеграции в мобильные приложения iOS
- Информация о выпусках (Release notes) – Webim Mobile SDK 3 для Android
- Информация о выпусках (Release notes) – Webim Mobile SDK 3 для iOS
- Справочник по Webim Mobile SDK – SDK для интеграции в мобильные приложения iOS (iPhone/iPad)
- Справочник по Webim Mobile SDK для интеграции в мобильные приложения Android
- Push-уведомления
- Webim Cordova Plugin
-
- Webim CRM postMessage Interface
- Как сделать ссылку кнопкой старта чата
- Маршрутизатор чатов
- Обработчики событий чата
- Процедура установки чата Webim на сайт в iframe
-
-
-
- Настройка интеграции с Facebook* (для версий до 10.0 включительно)
- Настройка интеграции с Facebook* с помощью приложения Webim
- Настройка интеграции с Instagram* с помощью приложения Webim
- Настройка приложения для интеграции с Facebook* (для версий до 10.0 включительно)
- Создание бизнес-аккаунта в Instagram*
- Создание страницы организации в Facebook*
- Skype
- Telegram
- Viber
- ВКонтакте
- Одноклассники
-
-
Webim Partner API 1.0
СОДЕРЖАНИЕ
Скачайте документ «Webim Partner API Documentation (English)» на английском языке в формате Adobe PDF
Доступ к API
Работа API осуществляется только по https.
Для доступа используется email и пароль администратора (admin_password).
Осуществляется basic авторизация таким образом:
curl -u adminemail@somedomain.com:admin_password https://{subdomain}.webim.ru/api/v1/partner/{request}
Где {subdomain} — имя вашего аккаунта.
Все данные принимаются и возвращаются в кодировке UTF-8.
Обработка ошибок
При ошибках авторизации возвращается HTTP код 401.Ошибки приходят в следующем виде:
{"error":"код-ошибки"}
Возможные типы ошибок представлены в таблице:
Код ошибки | Описание |
---|---|
no-tariff-option | Аккаунт не имеет доступа к API |
no-partner-option | Аккаунт не является партнерским |
argument-missing | Не хватает аргументов в запросе |
wrong-price | Сумма в запросе меньше рассчитанной |
wrong-period | Период в запросе отличается от расчетного |
unauthorized | Ошибка авторизации |
unknown | Неизвестная ошибка |
wrong-partner | При регистрации, когда попался существующий аккаунт, у которого существует партнер, отличный от nethouse |
Запрос на создание аккаунта
Данные посылаются POST запросом на следующий адрес:
https://{subdomain}.webim.ru/api/v1/partner/install
Описание данных:
- site — адрес сайта клиента
- full_name — имя администратора для создаваемого аккаунта
- email — e-mail администратора для создаваемого аккаунта (служит логином)
- password — пароль администратора для создаваемого аккаунта
- phone — контактный телефон для создаваемого аккаунта
- crc = md5(email + fullname + password + phone + site + private_key) — контрольная сумма из полей и Вашего private_key в заданном порядке
Ответ приходит в формате JSON:
{ "account_name": "имя созданного аккаунта", "private_key": "приватный ключ для созданного аккаунта", "status": "created" }
Если аккаунт с данным e-mail уже существует и данные авторизации совпадают, то возвращается существующий аккаунт и в поле 'status' передаётся значение 'exists'.
Оплата периода использования
Данные посылаются POST запросом на следующий адрес:
https://{subdomain}.webim.ru/api/v1/partner/order
Описание данных:
- account_name — название аккаунта
- month_count — длительность периода (количество месяцев)
- operators_count — заказанное количество операторов
- tariff_key — ключ тарифа
- partner_price — сумма, которая будет использована во взаиморасчетах партнера и Webim.Ru. Должна формироваться на основе partner_prices из описания тарифов.
Ответ приходит в формате JSON:
{"result": "ok", "from": "2013-01-01", "to": "2013-02-01"}
- from — '2018-01-01': начало периода
- to — '2018-02-01': окончание периода
Выдача тарифной сетки
GET запрос на адрес:
https://{subdomain}.webim.ru/api/v1/partner/tariffs
Ответ приходит в формате JSON.
Описание данных:
- tariffs — описание тарифов
- key — ключ тарифа
- name — название тарифа
- basic_prices — базовые цены webim.ru в рублях
- base_price — стоимость аккаунта с одним оператором
- per_operator_price — стоимость дополнительных операторов
- partner_prices — цены для партнера в рублях
- discounts — размер скидки в процентах по заказанному периоду в месяцах
{ "tariffs": [{ "key": "start", "name": "Начальный", "description": "Что Вы получаете: базовый функционал обслуживания посетителей +...", "public_prices": { "base_price": 490, "per_operator_price": 290 }, "partner_prices": { "base_price": 343, "per_operator_price": 203 } } ], "discounts": { "1": 0, "2": 0, "3": 10, "4": 10, "5": 10, "6": 15, "7": 15, "8": 15, "9": 15, "10": 15, "11": 15, "12": 20 } }
Выдача кода кнопки
Запрос:
https://{subdomain}.webim.ru/api/v1/button-code
Возможный ответ:
<a class="webim_button" href="#" rel="webim"><img src="https://company.webim.ru/button.php" border="0" /></a> <script type="text/javascript"> webim = { accountName: "company", domain: "company.webim.ru" }; (function () { var s = document.createElement("script"); s.type = "text/javascript"; s.src = "https://company.webim.ru/js/button.js"; document.getElementsByTagName("head")[0].appendChild(s); })(); </script>