Binotel

Для использования API Binotel нужно получить ключ и пароль через отдел технической поддержки support@binotel.ua

REST API Binotel работает в закрытом режиме, поэтому необходимо предоставить технической поддержке IP-адрес, с которого будут осуществляться запросы.

Здесь представлены процессы для инициирования звонков в Binotel CRM и получения информации из разделов личного кабинета:

• звонки
• мои клиенты
• настройки.

Процессы расположены в папках согласно категориям:

• Stats - получение данных по статистики звонков;
• Customers - работа с mini-CRM "Мои клиенты";
• Calls - инициирование звонков;
• Settings - получение настроек виртуальной АТС.

Перед финальным узлом каждого процесса добавлена логика Reply to Process. Это дает возможность использовать их в качестве универсальных процессов - делать вызов из множества других процессов и получать результат выполнения с помощью логики Call Process.

Тестирование процессов

Рассмотрим тестирование процесса Search из папки Customers.

1. Перейдите в режим View процесса Search.
2. Нажмите New task.
3. Укажите значения входящих параметров:
4. key - ключ Вашей компании Binotel;
5. secret - пароль Вашей компании в Binotel;
6. subject - часть имени или номера телефона для поиска пользователя.
7. Нажмите Add task. В результате заявка пройдет по узлам процесса и перейдет в один из конечных узлов.

Если параметры указаны верно, заявка пройдет по узлам процесса и попадает в End: Success "Successful response". В случае ошибки заявка попадает в один из узлов End: Error "Code error", "API error" или "Bad answer".

В Task archive узла "Successful response" заявка уже содержит параметр customerData (информация о найденных пользователях), который пришел в ответе от API.

Описание процессов

Stats

Outgoing calls for period

Получение исходящих звонков за период времени. Входящие параметры:

• key - ключ;
• secret - пароль;
• startTime - время начала выбора звонков (в формате unix timestamp);
• stopTime - время окончания выбора звонков (в формате unix timestamp).

Исходящие параметры:

• callDetails - исходящие звонки.

Incoming calls for period

Получение входящих звонков за период времени. Входящие параметры:

• key - ключ;
• secret - пароль;
• startTime - время начала выбора звонков (в формате unix timestamp);
• stopTime - время окончания выбора звонков (в формате unix timestamp).

Исходящие параметры:

• callDetails - входящие звонки.

Calltracking calls for period

CallTracking звонков за период времени. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• startTime - время начала выбора звонков (в формате unix timestamp);
• stopTime - время окончания выбора звонков (в формате unix timestamp).

Исходящие параметры:

• callDetails - звонки.

All outgoing calls since

Получение исходящих звонков с указанного момента по настоящее время. Входящие параметры процесса:

• key - ключ;
• secret - пароль;

• timestamp - время начала выбора звонков (в формате unix timestamp). Исходящие параметры:

• callDetails - исходящие звонки с указанного времени.

All incoming calls since

Получение входящих звонков с указанного момента по настоящее время. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• timestamp - время начала выбора звонков (в формате unix timestamp).

Исходящие параметры:

• callDetails - входящие звонки с указанного времени.

List of calls for period

Получение входящих и исходящих звонков за период времени (не более чем за 24 часа). Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• startTime - время начала выбора звонков (в формате unix timestamp);
• stopTime - время окончания выбора звонков (в формате unix timestamp).

Исходящие параметры:

• callDetails - входящие и исходящие звонки за период.

List of calls by internal number for period

Получение входящих и исходящих звонков по внутреннему номеру сотрудника за период времени (не более 7 дней). Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• startTime - время начала выбора звонков (в формате unix timestamp);
• stopTime - время окончания выбора звонков (в формате unix timestamp);
• internalNumber - внутренний номер сотрудника.

Исходящие параметры:

• callDetails - звонки по внутреннему номеру за период.

Recent calls by internal number

Получение недавних входящих и исходящих звонков по внутреннему номеру сотрудника (за последние 2 недели, не более 50 звонков) Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• internalNumber - внутренний номер сотрудника.

Исходящие параметры:

• callDetails - недавние звонки по внутреннему.

List of calls per day

Получение входящих и исходящих звонков за день. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• dayInTimestamp - день в формате unix timestamp.

Исходящие параметры:

• callDetails - звонки за день.

Online calls

Получение звонков, которые в онлайне. Входящие параметры процесса:

• key - ключ;
• secret - пароль.

Исходящие параметры:

• callDetails - звонки в онлайне.

List of lost calls for today

Получение потерянных звонков за сегодня. Входящие параметры процесса:

• key - ключ;
• secret - пароль.

Исходящие параметры:

• callDetails - потерянные звонки.

History by customer id

Получение входящих и исходящих звонков по идентификатору клиента. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• customerID - идентификатор клиента.

Исходящие параметры:

• callDetails - звонки клиента.

History by number

Получение входящих и исходящих звонков по номеру телефона. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• number - номер телефона.

Исходящие параметры:

callDetails - звонки по номеру телефона.

Call details

Получение данных о звонке по идентификатору звонка. Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• generalCallID - идентификатор звонка.

Исходящие параметры:

• callDetails - звонок с указанным идентификатором.

Сall record

Получение ссылки на запись разговора Входящие параметры процесса:

• key - ключ;
• secret - пароль;
• callID - идентификатор записи разговора.

Исходящие параметры:

• url - ссылка на запись разговора.

Важно! Время жизни ссылки на запись разговора 15 минут. Запись разговора может быть только в звонках с состоянием (disposition): ANSWER, VM-SUCCESS, SUCCESS..

Customers

List

Выбор всех клиентов с мини-CRM "Мои клиенты". Входящие параметры процесса:

• key - ключ;
• secret - пароль.

Исходящие параметры:

• customerData - информация о клиентах.

Take by id

Выбор всех клиентов с мини-CRM "Мои клиенты" по идентификатору клиента. Входящие параметры:

• key - ключ;
• secret - пароль;
• customerID - идентификатор клиента

Исходящие параметры:

customerData - информация о клиентах.

Take by label

Выбор всех клиентов с мини-CRM "Мои клиенты" по метке. Входящие параметры:

• key - ключ;
• secret - пароль;
• labelID - идентификатор метки.

Исходящие параметры:

customerData - информация о клиентах.

Search

Поиск клиентов с мини-CRM "Мои клиенты" по имени или номеру телефона. Входящие параметры:

• key - ключ;
• secret - пароль;
• subject - часть имени или номера телефона.

Исходящие параметры:

• customerData - информация о клиентах.

Create

Создание клиента в мини-CRM "Мои клиенты" . Входящие параметры:

• key - ключ;
• secret - пароль;
• name - имя клиента, имя должно быть уникальным;
• numbers - массив номеров, все номера должны быть уникальными.

Важно! Для создания пользователя можно изменить процесс и внести дополнительные поля (в логиках Code и API Call):

• description - информация о клиенте;
• labels - массив меток в виде {" id": " name"};
• email - email клиента;
• assignedToEmployee - имя ответственного сотрудника;
• assignedToEmployeeID - идентификатор ответственного сотрудника;
• assignedToEmployeeNumber - внутренний номер сотрудника в Binotel. Добавить их необходимо согласно документации REST API Binotel.

Исходящие параметры:

• customerID - идентификатор созданного клиента.

Update

Редактирование клиента в мини-CRM "Мои клиенты" . Входящие параметры:

• key - ключ;
• secret - пароль;
• id - идентификатор клиента;
• name - имя клиента, имя должно быть уникальным;
• email - email клиента;
• numbers - массив номеров, все номера должны быть уникальными;
• labels - массив клиента с идентификаторами меток (список меток с идентификаторами можно получить с помощью процесса "List of labels").

Исходящие параметры:

• update = success - в случае успешного обновления.

Важно! Изменяются все данные, которые передаются в запросе. Можно изменить процесс и внести дополнительные поля для редактирования клиентаassignedToEmployee, assignedToEmployeeID, assignedToEmployeeNumber (в логиках Code и API Call) согласно документации REST API Binotel.

Delete

Удаление клиента в мини-CRM "Мои клиенты" . Входящие параметры:

• key - ключ;
• secret - пароль;
• customerID - идентификатор клиента.

Исходящие параметры:

• delete = success - в случае успешного удаления.

Calls

Ext to phone

Инициирование двустороннего звонка (внутреннюю линию с внешним номером). Входящие параметры:

• key - ключ;
• secret - пароль;
• ext_number - внутренний номер сотрудника (первый участник разговора);
• phone_number - телефонный номер куда нужно позвонить (второй участник разговора).

Исходящие параметры:

• generalCallID - идентификатор звонка.

Phone to phone

Инициирование двустороннего звонка (внешний номер с внешним номером). Входящие параметры:

• key - ключ;
• secret - пароль;
• phoneNumber1 - первый внешний номер;
• phoneNumber2 - второй внешний номер;
• trunkNumber - номер через который будут совершаться оба звонка;
• limitCallTime - ограничение длительности звонка в секундах.

Исходящие параметры:

• generalCallID - идентификатор первого звонка (на первый внешний номер).

Attended call transfer

Перевод звонка с участием.

• key - ключ;
• secret - пароль;
• generalCallID - идентификатор звонка;
• phone_number - номер на который переводится звонок.

Исходящие параметры:

• transfer = success - в случае успешного перевода.

Hangup call

Завершение звонка. Входящие параметры:

• key - ключ;
• secret - пароль;
• generalCallID - идентификатор звонка.

Исходящие параметры:

• hangup = success - в случае успешного завершения.

Call with announcement

Звонок с оповещением голосового файла. Входящие параметры:

• key - ключ;
• secret - пароль;
• phone_number - номер телефона, кому будет проигрываться оповещение;
• voiceFileID - идентификатор голосового файла (получать в Settings/List of voice files).

Исходящие параметры:

• generalCallID - идентификатор звонка.

Settings

List of employees

Выбор всех сотрудников. Входящие параметры:

• key - ключ;
• secret - пароль.

Исходящие параметры:

• listOfEmployees - информация о сотрудниках.

List of routes

Выбор всех сценариев для входящих звонков. Входящие параметры:

• key - ключ;
• secret - пароль;

Исходящие параметры:

• listOfRoutes - информация о сценариях.

List of voice files

Выбор всех голосовых файлов (приветствий). Входящие параметры:

• key - ключ;
• secret - пароль;

Исходящие параметры:

• listOfVoiceFiles - информация о голосовых файлах.