Главная » Webhooks » Звонок

Звонок

Этот раздел расскажет вам о настройке работы со звонками через Webhook.

В этой группе можно выделить следующие события:

  • success — успешный звонок
  • invalid_client — клиент не ответил на звонок
  • invalid_manager — менеджер не ответил на звонок
  • deferred — отложенный звонок
  • initial — мгновенный созвон

Название события указывается в поле status. Например:

[
    'event'     => 'call',
    'status'    => 'invalid_client',
    'data'      => '{}',
    'signature' => md5('Ваш ключ' . '{}')
]

При мгновенном созвоне (событие initial) создается предварительный вебхук, содержащий следующие данные:

[
    'site'                   => 'yoursite.com', //Сайт клиента, на котором установлен виджет
    'user_id'                => '123', //ID владельца виджета
    'user_language'          => 'ru', //Язык владельца виджета
    'widget_id'              => '456', //ID виджета
    'widget_timezone_offset' => '7200', //Сдвиг часового пояса в найстроках виджета относительно UTC в секундах
    'call_id'                => '1234567', // Идентификатор звонка
    'call_client_name'       => 'Артем Виляев', //Имя клиента, заказавшего звонок
    'call_client_phone'      => '+79111111111', //Номер клиента, заказавшего звонок'
    'manager_phones'         => ['+7922222222', '+79222222223'], //Массив с номерами менеджеров, одному из которых и будет направлен звонок
    'referer'                => 'yoursite.com/referer', // Страница, с которой инициирован звонок
    'referer_original'       => 'yandex.ru/click/jsredir....', //Первоисточник, по которому пользователь пришел на сайт
    'entrance_page'          => 'yoursite.com/somepage?somequery', //Страница, с которой пользователь попал на страницу с виджетом
    'call_date'              => '2016-01-11 23:41:16', //Время инициации звонка
    'custom_cookie'          => '{}', //Кастомная кука с данными в JSON-формате. Устанавливается в разделе индвидуальных настроек виджета
    'sess_ip'                => '194.186.207.1', //IP пользователя, заказавшего звонок
    'geo_location'           => 'Россия, Москва', //Местоположение пользователя
    'utm_source'             => 'yandex',
    'utm_medium'             => '',
    'utm_term'               => '',
    'utm_content'            => '',
    'utm_campaign'           => '',
    /**
     * Что послужило предпосылкой созвона:
     *      1 - сам нажал на кнопку;
     *      2 - поймали на входе;
     *      3 - поймали на выходе;
     *      4 - auto callback;
     *      5 - из верхней панели;
     *      6 - из JS API;
     *      7 - из wild;
     *      8 - из autowild
     */
    'widget_show_reason'     => '1'
]

При событии deferred массив будет иметь следующий вид(данные имеют иную структуру, так как звонок еще не совершен телефонией)^

[
    'site'                   => 'yoursite.com', //Сайт клиента, на котором установлен виджет
    'user_id'                => '123', //ID владельца виджета
    'user_language'          => 'ru', //Язык владельца виджета
    'widget_id'              => '456', //ID владельца виджета
    'widget_timezone_offset' => '7200', //Сдвиг часового пояса в найстроках виджета относительно UTC в секундах
    'call_client_name'       => 'Артем Виляев', //Имя клиента, заказавшего звонок
    'call_client_phone'      => '+79111111111', //Номер клиента, заказавшего звонок
    'manager_phone'          => '+79222222222', //Номер менеджера, которому будет осуществлен звонок
    'referer'                => 'yoursite.com/somepage.html', //Страница, с которой пользователь пришел на сайт
    'referer_original'       => 'yandex.ru/click/jsredir....', //Первоисточник, по которому пользователь пришел на сайт
    'entrance_page'          => 'yoursite.com/somepage?somequery', //Страница, с которой пользователь попал на страницу с виджетом
    'planned_call_date'      => '2016-01-12 12:00:00', //Планируемое время звонка
    'call_request_date'      => '2016-01-11 23:41:16', //Время заказа звонка
    'office_name'            => 'Варшавский-Офис', //Название офиса, если оно есть
    'custom_cookie'          => '{}', //Кастомная кука с данными в JSON-формате. Устанавливается в разделе индивидуальных настроек виджета
    'sess_ip'                => '194.186.207.1', //IP пользователя, заказавшего звонок
    'geo_location'           => 'Россия, Москва', //Местоположение пользователя
    'utm_source'             => 'yandex',
    'utm_medium'             => '',
    'utm_term'               => '',
    'utm_content'            => '',
    'utm_campaign'           => '',
    /**
     * Что послужило предпосылкой созвона
     *      1 - сам нажал на кнопку;
     *      2 - поймали на входе;
     *      3 - поймали на выходе;
     *      4 - auto callback;
     *      5 - из верхней панели;
     *      6 - из JS API;
     *      7 - из wild;
     *      8 - из autowild
     */
    'widget_show_reason'     => '1'
]

При событиях success, invalid_client и invalid_manager в поле data будет храниться следующий массив значений, переведенный в JSON-строку.

Обратите внимание, что эти события создаются после завершения звонка. Перед ними создаются события initial  или deferred.

[
    'site'                   => 'yoursite.com', //Сайт клиента, на котором установлен виджет
    'user_id'                => '123', //ID владельца виджета
    'user_language'          => 'ru', //Язык владельца виджета
    'widget_id'              => '456', //ID виджета
    'widget_timezone_offset' => '7200', //Сдвиг часового пояса в найстроках виджета относительно UTC в секундах
    'call_id'                => '1234567', // Идентификатор звонка
    'call_client_name'       => 'Артем Виляев', //Имя клиента, заказавшего звонок
    'call_client_phone'      => '+79111111111', //Номер клиента, заказавшего звонок
    'call_manager_phone'     => '+79222222222', //Номер менеджера, который принял звонок
    'entrance_page'          => 'yoursite.com/somepage?somequery', //Страница, с которой пользователь попал на страницу с виджетом
    'referer'                => 'yoursite.com/somepage.html', //Страница, с которой пользователь пришел на сайт
    'referer_original'       => 'yandex.ru/click/jsredir....', //Первоисточник, по которому пользователь пришел на сайт
    'call_date'              => '2016-01-12 18:09:45', //Время, когда состоялся звонок
    'call_record'            => '', //Ссылка на запись со звонком
    'call_duration'          => '3', //Длительность звонка в минутах
    'call_source'            => 'яндекс', //Откуда клиент попал на сайт (яндекс, google или прямая ссылка)
    'office_name'            => 'Варшавский', //Название офиса, с которым происходил созвон
    'custom_cookie'          => '{}', //Кастомная кука с данными в JSON-формате. Устанавливается в разделе индвидуальных настроек виджета
    'sess_ip'                => '194.186.207.1', //IP пользователя, заказавшего звонок
    'geo_location'           => 'Россия, Москва', //Местоположение пользователя
    'utm_source'             => 'yandex',
    'utm_medium'             => '',
    'utm_term'               => '',
    'utm_content'            => '',
    'utm_campaign'           => '',
    /**
     * то, что послужило предпосылкой созвона
     *      1 - сам нажал на кнопку;
     *      2 - поймали на входе;
     *      3 - поймали на выходе;
     *      4 - auto callback;
     *      5 - из верхней панели;
     *      6 - из JS API;
     *      7 - из wild;
     *      8 - из autowild
     */
    'widget_show_reason'     => '1'
]

Полезные статьи