В некоторых случаях интеграция требует получает уведомлений в режиме реального времени о звонке. В качестве примера можно привести показ карточки звонка в CRM системе (для таких CRM систем как АМО и Bitrix24 у нас есть \ готовые системы интеграции). Для решения таких задач система Call-Tracking.BY может уведомлять ваши сервера специальными запросами при начале звонка, ответе оператора и завершения звонка. Список операторов, которые поддерживают такое решение необходимо уточнить у вашего менеджера.

Для того, чтобы настроить получение уведомлений вам необходима пара простых шагов:

ШАГ 1: зайти на страницу настроек и нажать на создание собственной интеграции.

Webhooks api step 1

ШАГ 2: Заполнить адреса ваших серверов для уведомления. Так же вы можете выбрать метод, который будет использоваться при запросе.

Webhooks api step 2

ШАГ 3 (опциональный): Возможно иногда вам потребуется пересылать дополнительные параметры необходимые вашей системе. Наиболее распространенный пример - некоторый ключ, чтобы никто больше не мог отправить вам запросы, или же указание того, что запросы приходят из системы Call-Tracking.BY. Для этого предусмотрены дополнительные настройки.

Webhooks api step 2

На указанные адреса вам будут отправлены следующие параметры:

    
      {
        "time" => "2019-05-10T15:24:49+03:00",
        "call_status" => "end",
        "pbx_id" => "1557491089.930439",
        "adv_campaign_id" => "777",
        "campaign_name" => "Контекст",
        "duration" => "102.0", 
        "caller_number" => "+375290000000",
        "ads_number" => "+375295555555",
        "answer_number" => "+375297777777",
        "audio_path" => "https://vrecords.call-tracking.by/monitor/04ec5d3b",
        "utm_keyword" => "купить минск",
        "utm_campaign" => "minsk-t",
        "utm_source" => "google", 
        "utm_medium" => "cpc", 
        "utm_content" => "content",
        "roistat_id" => "", 
        "google_analytics_id" => "", 
        "yandex_metrica_id" => "", 
        "custom_param" => "custom_value"
      }
    
  
  • time - время в формате iso8601.
  • call_status - Текущее событие (статус). Возможные значения: start, answer, end, busy, abandon.
  • pbx_id - Уникальный идентификатор звонка.
  • campaign_id - идентификатор кампании.
  • campaign_name - имя кампании.
  • duration - продолжительность звонка. Для события начала звонка и ответа продолжительность звонка нулевая
  • caller_number - номер звонившего
  • ads_number - номер который показывался и\или был размещен в рекламном объявлении
  • answer_number - номер который ответил на звонок. Пустая строка в случае если звонок не отвечен
  • audio_path - Ссылка на запись разговора. Присутствует, если запись включена. Запись хранится в соответствии с настройками пользователя.
  • utm_keyword - ключевое слов в случае если звонок был сделан по динамической рекламной кампании
  • utm_campaign - контекстная рекламная кампания в случае если звонок был сделан по динамической рекламной кампании<
  • utm_medium - тип источника трафика (cpc, баннер, рассылка) в случае если звонок был сделан по динамической рекламной кампании
  • utm_content - определяет разные версии рекламы (к примеру две разные ссылки в одном рекламном письме) в случае если звонок был сделан по динамической рекламной кампании
  • roistat_id - уникальный идентификатор RoiStat (доступно только для динамического колл трекинга, при наличии скрипта RoiStat)
  • google_analytics_id - уникальный идентификатор Google Analytics (доступно только для динамического колл трекинга, при наличии скрипта Google Analytics)
  • yandex_metrica_id - уникальный идентификатор Yandex Metrica (доступно только для динамического колл трекинга, при наличии скрипта Yandex Metrica)