Раздел для разработчиков

Описание API для интеграции с платформой Webcall

Описание

Мы стараемся предоставить максимальные возможности для интеграции Webcall с другими сервисами и системами, чтобы вы, наши клиенты и партнеры, могли расширить возможности Webcall для себя и других наших и ваших пользователей.

Для того, чтобы еще больше облегчить жизнь разработчику, кроме инструкций, мы приводим примеры использования методов, их описание.

API (аббревиатура от Application Programming Interface) – интерфейс программирования приложений, позволяющий сервисам взаимодействовать, получать доступ и обмениваться данными.

По сути API выступает в роли посредника между платформой Webcall и приложением клиентов.

Знакомство с API

Общение между платформой Webcall и клиентом происходит с помощью GET метода. GET-метод осуществляет запрос к серверу, то есть все данные запроса передаются в строке запроса. Он принимает следующие параметры:

url: обязательный параметр, содержащий адрес ресурса, к которому будет обращаться запрос

data: обязательный параметр, содержащий простой объект javascript или строку, которые будут отправлены на сервер вместе с запросом

success: необязательный параметр - функция обратного вызова, которая будет выполняться при успешном выполнении запроса.

Добавление номеров в кампанию Автодозвона

WebCall предоставляет возможность добавления номеров телефонов в систему Автодозвона, используя API

Данная возможность реализуется методом campaign_insert.

Для использования данного метода, необходимо создать API ключ в настройках Кампании


Параметр Описание
method campaign_insert
key Секретный ключ (не передавайте данный ключ третим лицам). Сгенерировать ключ можно в настройках кампании
campaign_id id кампании. id кампании отображается в настройках самой кампании
phone Номер телефона в формате 380XXXXXXXXX
date Время, когда необходимо выполнить дозвон в формате YYYY-MM-DD HH:MM:SS
skill Навык агентов. Если указать номер телефона агента, система будет делать дозвон сразу на агента (агент должен быть в статусе "Доступен")

Как получить campaign_name и key:

Lights


Пример использования метода campaign_insert: используя AJAX

var data = {
    method: 'campaign_insert',
    key: 'KnktR2Y9n7zR76oSd8H7',
    campaign_id: '12',
    phone: '3806333XXXXX',
    date: '2019-08-07 23:59:36',
    skill: '81233',
};
$.get(
    "https://webcall.com.ua/webphone/api/",
    data,
    function(data, status){
        var obj = JSON.parse(data);
        console.log(obj);
    }
});

Пример использования метода campaign_insert: используя URL:

https://webcall.com.ua/webphone/api/?method=campaign_insert &key=KnktR2Y9n7zR76oSd8H7 &campaign_id=12 &phone=3806333XXXXX

При успешном запросе будет следующие ответ: {"status":"ok","result":[]}

Исходящий звонок

Используя этот метод, вы можете синтегрировать свою CRM систему и совершать исходящие звонки.

Например, агент при нажатие на номер телефона в CRM-системе, инициирует звонок с Webcall-платформы (агент должен находиться в сети).


Параметр Описание
method click_to_call
key Секретный ключ (не передавайте данный ключ третим лицам). Сгенерировать ключ можно в настройках групп
company Название компании (можно посмотреть точное название в настройках групп)
agent Внутренний номер телефона агента
phone Номер телефона клиента в формате 380XXXXXXXXX

Как получить company и key:

Lights


Пример использования метода click_to_call: используя AJAX

var data = {
    method: 'click_to_call',
    key: 'KnktR2Y9n7zR76oSd8H7',
    company: 'DEMO',
    phone: '3806333XXXXX',
    agent: '81923',
};
$.get(
    "https://webcall.com.ua/webphone/api/",
    data,
    function(data, status){
        var obj = JSON.parse(data);
        console.log(obj);
    }
});

Пример использования метода click_to_call: используя URL:

https://webcall.com.ua/webphone/api/?method=click_to_call &key=KnktR2Y9n7zR76oSd8H7 &company=DEMO &phone=3806333XXXXX &agent=81923

При успешном запросе будет следующие ответ: {"status":"ok","result":[]}

API входящего звонка

Используя этот метод, вы можете синтегрировать свою CRM систему.

Функционал позволяет открывать карту клиента при входящем звонке, а также использовать внешний API при входящем звонке.

Добавьте Javascript"Скрипт входящего звонка" в Панель управления > Группы > CRM.

Чтобы открыть карту клиента при входящем звонке, необходимо:

В поле "Скрипт входящего звонка" добавить функцию new_crm_url(new_url); - где new_url - карта клиента.

В скрипте доступны переменные:

Параметр Описание
url содержание поля "Ссылка на ресурс" (Панель управления > Группы > CRM)
username номер агента
client номер входящего звонка

Панель управления > Группы > CRM:

Lights


Пример использования метода (вставить в поле "Скрипт входящего звонка"):

1. Карта открывается по номеру телефона (https://webcall.com.ua/webphone/api/check_crm_card?card_id=3806312345678)

 new_url = url+'?card_id='+client;
 new_crm_url(new_url);

2. Нужно узнать id карточки через внешний API, зная номер клиента:

 $.get("https://webcall.com.ua/webphone/api/check_crm_card", {
  username: username,
  client: client,
  some_variable: 'find'
 },
 function(data){
  var obj = JSON.parse(data);
  new_url = url+'?card_id='+obj.card_id;
  new_crm_url(new_url);
 });