Про API

Сopied

Для работы Вам понадобится ключ (токен) доступа к API.
Ключ позволяет идентифицировать Ваш проект и получать к нему доступ с максимальными привилегиями без необходимости предварительной авторизации каждый раз.
На странице личного кабинета «API» необходимо создать ключ:

Этот ключ необходимо указывать при каждом запросе в header: «Authorization:*Ваш ключ*»

Любой метод из описанного API может вернуть ошибку:

{"status": "Error", "message": "Internal error"}

О таких ошибках сообщайте, пожалуйста, в техническую поддержку.
Все пути всех методов, описанных в этой документации, имеют пути относительно https://cstat.nextel.com.ua:8443/tracking/api
Все запросы к методам API выполняются в режиме POST.
Примеры результатов использования методов API в данной статье показаны с использованием Postman. В Postman режим, необходимый заголовок авторизации и адрес метода указываются следующим образом:

Также можно отправлять ключ в формате «Authorization: Bearer *Ваш ключ*»

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

{"status": "Error", "message": "Authorization invalid"}

Обзвон номеров

Сopied

Общие сведения

Сopied

Все действия с обзвонами выполняются только одним методом:
/autodial/action
В теле запроса всегда должен быть JSON с обязательным полем действия, которое Вы хотите выполнить.
Минимальный JSON выглядит так:

{
  "action": "GET_WITH_DATA"
}

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

Ниже приведены словари ключевых полей, необходимых для работы с обзвонами:
state:

callState:

Действия

Сopied

Поле action определяет какое действие будет выполнено с обзвоном и перечень необходимых параметров. Ниже приведен перечень возможных значений поля.
action:

Каждое действие может вернуть определённую ошибку. Ошибки выглядят как:

{
    "status": "Error",
    "message": "*Текст ошибки*",
    "rus": "*Внутреннее обозначение текста ошибки*",
    "data": "*Дополнительная информация*"
}

Далее в этой инструкции будет рассматриваться только поле message.
Например, если в запросе не указано действие, ответ будет содержать message — Action is null.

Управление звонками

Сopied

Прямой вызов SIP -> GSM

Сopied

Этот метод позволяет интегрироваться с Вашим ПО и нажатием одной кнопки сразу звонить на номер клиента без необходимости ввода номера вручную на SIP телефоне.
Это используется обычно в CRM системах.
Как это работает: вызываете этот метод — звонит сип клиент как входящий. После ответа сразу идёт звонок на указанный номер. Основная суть — не нужно вводить номер руками.
/phones/directCall
Режим: POST
Content-Type: application/x-www-form-urlencoded
Отправлять форму с двумя параметрами:
String sip — это номер внутренней линии.
String number — gsm номер, присылаемый в международном формате. Например: 380504443322.
String meta — String на 1000 символов. Это любая информация, которая должна отображаться в вэбхуках. Может быть null.

В случае успеха пример ответа:

{"status": "Success","message": "Called"}

Возможные ошибки:

Создание нового звонка

Сopied

Метод используется в случае если необходимо позвонить абоненту с целью информирования его о чём-то.
После того как абонент дослушает аудиозапись — звонок завершиться.
Аудиозапись необходимо предварительно добавить в категорию «API звонки» здесь: https://my.unitalk.cloud/new/index.html#audio. После загрузки Вы увидите её ID
/calls/originateNew
Режим: POST
Content-Type: application/json
Пример JSON запроса:

{  
  "phone": "380503332211", // номер абонента на который необходимо звонить. Не null.  
  "outerLine": null, // внешняя линия для звонка абоненту. Если null - то линия будет выбрана автоматически, согласно правилам исходящих сценариев.  
  "meta": "238", // String на 1000 символов. Это любая информация, которая должна отображаться в вэбхуках. Может быть null.  
  "ivrId": 211, // id голосового меню, которое будет воспроизведено абоненту ответившему на звонок. Если указаны audios - будет воспроизведено после них. Может быть null - если указан параметр audios или voiceSecretaryId. В голосовом меню разрешаются только действия: "Перевод звонка на внутреннюю линию", "Перевод звонка на группу номеров" и разрешена только группа внутренних линий (SIP), "Воспроизведение голосового сообщения".
  "voiceSecretaryId": 321, // id голосового секретаря, который будет вызван при ответе абонента на звонок. Если указаны audios - будет воспроизведено после них. Может быть null - если указан параметр audios иди ivrId. В голосовом секретаре не разрешаются действия "Перевод звонка на GSM номер", "Активация сценария", "Активация голосового меню" и "Перевод звонка на отдел" с операторами на GSM.
  "audios": [ //массив аудиозаписей и текста для озвучивания из которого будут синтезированы аудио, которые будут воспроизведены абоненту как только он ответит на звонок. В каком порядке аудио находятся в массиве, в таком будут воспроизводиться. Максимум 5 элементов, из них максимум озвучиваний - 2. Озвученные из текста аудиозаписи в списке аудиозаписей проекта не отображаются. Может быть null.
    {
      "id": 4953, //id заранее загруженного аудио для API звонков. Может быть null, в таком случае tts не должно быть null. Если и id и tts не null, использоваться будет id.
      "tts": null //данные для озвучивания текста, могут быть null, если указано id
    },
    {
      "id": null,
      "tts": { //данные для озвучивания текста, могут быть null, если указано id
        "text": "текст для озвучивания", //текст который будет озвучен, не может превышать 4960 символов. Можем быть null, если указано ssml. Если указаны оба поля text и ssml - использоваться будет ssml
        "ssml": "текст для озвучивания",  //альтернатива полю text - текст в формате ssml. Не может превышать 5000 символов. Должен начинаться и заканчиваться тегом speak. Может быть null, если указано поле text. Если указаны оба поля text и ssml - использоваться будет ssml
        "settingsId": 18 //настройки синтеза речи, которые будут использоваться при озвучивании. Не может быть null
      }
    }
  ]
}

В случае успеха:

{"status": "Success"}

Возможные ошибки:

Независимый click to call звонок

Сopied

Как это работает: точно также как и обычный с2с, только независимость заключается в том, что Вам не требуется предварительно создавать сайт, добавлять на него кнопку обратного звонка
Метод позволяет создать немедленный с2с звонок.
Этот звонок не будет виден в заявках и CRM системах, но будет в истории звонков и вэбхуках.
Для его работы не нужно предварительно создавать сайт и подключать к нему кнопку обратного звонка
POST /calls/originateC2c

{
  "clientNumber": "380935553322",
  "meta": "client-5472",
  "steps": [
    {
      "type": "GSM",
      "to": "380931111111",
      "awaitingTime": 5
    }
  ]
}

clientNumber — номер клиента которому надо звонить

meta— String на 1000 символов. Это любая информация, которая должна отображаться в вэбхуках. Может быть null.

steps — массив шагов переадресаций. Можно указывать несколько.
steps.type — GSM, SIP, GROUP
steps.to — номер оператора
steps.awaitingTime — время вызова от 5 до 300 секунд

в поле steps.to необходимо указывать:
GSM -> номер клиента в международном формате (например 380501112233)
SIP -> внутренний номер линии (например 5455)
GROUP -> id группы (отдела). Id отображается вверху справа на каждом отделе в личном кабинете

Возможные ошибки:

Сброс звонка

Сopied

Этот метод позволяет сбросить активный звонок по его id, который вы получаете в вебхуках, либо по номеру внутренней/внешней линии

/calls/hangup
Режим: POST
Content-Type: application/json
Отправлять Json:

{
  "number": null,
  "id": 1474427802
}

В случае успеха пример ответа:

{"status": "Success","message": "Found: 1"}

Возможные ошибки:

Аудио

Сopied

Добавление аудио файлов в проект

Сopied

/audio/upload
Режим: POST
Content-Type: multipart/form-data
Отправлять multipart с тремя параметрами:

В случае успеха, в message вернётся id загруженного аудиофайла:

{"status": "Success","message": "432"}

Синтез аудио из текста

Сopied

Метод синтезирует аудио из текста и добавляет аудиозаписи в проект, с указанным именем и в указанный раздел. За раз можно озвучить до 5 аудио.
/audio/tts
Режим: POST
Content-Type: application/json
Пример JSON запроса:

{
 "data": [ //массив данных для синтеза аудио. Максимум 5 элементов
    { //первый элемент для озвучивания
      "name": "аудио для обзвона", //название с которым аудио будет добавлено в проект
      "type": "AUTODIAL", //раздел аудио в который будет добавлена аудиозапись. Возможные значения: GENERAL (Сценарии), IVR (Голосовые меню), MELODY (Мелодии ожидания на линии и очередей), AUTODIAL (Автообзвоны), API (API звонки)
      "tts": { //данные для озвучивания текста
        "text": "текст для озвучивания", //текст который будет озвучен, не может превышать 4960 символов. Можем быть null, если указано поле ssml. Если указаны оба поля text и ssml - использоваться будет ssml
        "ssml": null, //альтернатива полю text - текст в формате ssml. Не может превышать 5000 символов. Должен начинаться и заканчиваться тегом speak. Может быть null, если указано поле text. Если указаны оба поля text и ssml - использоваться будет ssml
        "settingsId": 18 //настройки синтеза речи, которые будут использоваться при озвучивании. Не может быть null
      }
    },
    { //второй элемент для озвучивания
      "name": "аудио для апи звонка",
      "type": "API",
      "tts": {
        "text": null,
        "ssml": "текст для озвучивания",
        "settingsId": 16
      }
    }
  ]
}

В случае успеха:

{
    "status": "Success",
    "message": "Success",
    "data": [ //массив с результатом синтеза, по каждому аудио. Если аудио синтезировано успешно - будет указан id с которым оно сохранилось в проект. В случае ошибки - id будет null, а в поле error будет текст ошибки
        { //успешно синтезированное аудио (присутствует id)
            "name": "аудио для обзвона", //название аудио
            "id": 4962,  //id нового аудио (в случае успеха)
            "error": null //текст ошибки (в случае неудачи)
        },
        { //синтез неудачен или не выполнен (id нет, есть error)
            "name": "аудио для апи звонка",
            "id": null,
            "error": "Same name already present"
        }
    ]
}

Возможные значения поля error для каждого из элементов озвучивания при Success:

Возможные ошибки:

Списки

Сopied

BLOCKED_PHONES

Сopied

POST /lists

BLOCKED_PHONES — список номеров в международном формате, входящие звонки от них блокируются, а запрос click2call отклоняется. Размер — 200 элементов. При добавлении 201го номера — первый (самый старый) удаляется.

GET (получение списка)

{  
  "list": "BLOCKED_PHONES", 
  "operation": "GET",  
  "items": [] 
}

Ответ:

["380934007171"]

ADD (Добавление нескольких элементов в список)

{ 
  "list": "BLOCKED_PHONES",
  "operation": "ADD", 
  "items": ["380556667788", "380445556677"]
}

Ответ:

{"status": "Success"}

REMOVE (удаление нескольких элементов из списка)

{ 
  "list": "BLOCKED_PHONES",
  "operation": "REMOVE", 
  "items": ["380556667788", "380445556677"]
}

Ответ:

{"status": "Success"}

Пользователи

Сopied

Список

Сopied

POST  /users/list

Возвращает список пользователей.

[
    {
        "email": "example@gmail.com",
        "firstName": "Александр",
        "lastName": "Александрович",
        "middleName": "Александров",
        "phone": "380501234567",
        "role": "ADMIN",
        "id": 12579,
        "workStatus": "WORK"
    },
    {
        "email": "example@unitalk.cloud",
        "firstName": "Владимир",
        "lastName": "Владимирович",
        "middleName": "null",
        "phone": "380935551133",
        "role": "OWNER",
        "id": 5701,
        "workStatus": "WORK"
    }
]

Данные о пользователях

Сopied

/users/getStatus
Выдаёт список всех пользователей с указанием их внутренней или мобильной линии и состоянием работы.

[
    {
        "firstName": "Василий",
        "middleName": "Александрович",
        "lastName": "Иванов",
        "phone": "4035",
        "workStatus": "WORK"
    }
]

workStatus  может быть:
WORK (работает),
PAUS (на паузе),
STOP (работа окончена/еще не начал работать)

у пользователей без расширенного функционала, workStatus всегда WORK

Изменение состояния работы

Сopied

/phones/inner/setStatus
Режим: POST
Передавать параметры
number — номер линии оператора
status — новое состояние (WORK, PAUS, STOP)
Пример: /phones/inner/setStatus?number=9999&status=WORK

В случае успеха ответ:

{"status": "Success", "message": "Success"}

Внутренние линии

Сopied

Список внутренних линий

Сopied

/phones/inner
Режим: POST
Пустой запрос.
В случае успеха ответ:

{  
  "2239": "offline",  
  "2238": "offline",  
  "2006": "offline",  
  "2237": "offline",  
  "2005": "offline",  
  "2004": "offline",  
  "2003": "online",  
  "2002": "busy", // занят. Разговор или звонок  
  "2241": "offline",  
  "2240": "offline"  
}

Отделы

Сopied

Получение групп

Сopied

POST /groups/action
Пример body JSON запроса:

{
  "action": "GET"
}

Ответ:

{ 
  "status": "Success", 
  "data": [ 
    { 
      "id": 455, // id группы 
      "name": "Отдел продаж", // имя группы 
      "phones": [ // массив номеров которые содержит группа      
        { 
          "number": "4030",  // номер   
          "firstName": "Александр", // имя пользователя, если он есть 
          "lastName": "Максимов"  // фамилия пользователя, если он есть 
        } 
      ] 
    } 
  ] 
}

Удаление номера из группы

Сopied

POST /groups/action
Пример body JSON запроса:

{ 
  "action": "REMOVE_NUMBER", 
  "groupId": 141, // id группы
  "number": "2561" // номер, который необходимо удалить
}

Успех:

{"status": "Success"}

Возможные ошибки:

История звонков

Сopied

Получение истории

Сopied

/history/get
Режим: POST
Content-Type: application/json
Отправлять JSON:

{  
  "dateFrom": "2018-06-25 00:00:00",  
  "dateTo": "2018-07-09 00:00:00",  
  "limit": 246,  
  "offset": 0,  
  "filter": {  
    // Все параметры фильтров опциональные. То есть могут быть null, в случае если фильтрация не требуется.
    // Ниже пример 2х параметров. Остальные фильтры указаны в таблице ниже, что бы не усложнять этот образец
    "direction": "OUT",
    "exactPhone": [  
      "5008"  
    ]  
  }  
}

Пример ответа:

{ 
  "count": 8, // количество записей в базе данных по указанным критериям. Конечно же не зависит от параметра limit.
  "calls": [ 
    { 
      "event": "CALL_END", 
      "call": { 
        "id": 1091944, 
        "dbid": 275, 
        "from": "380505557182", 
        "to": [ 
          "2000" 
        ], 
        "direction": "IN", 
        "secondsFullTime": 19, 
        "secondsTalk": 9, 
        "utmSource": "google", 
        "utmMedium": "search", 
        "utmCampaign": "web", 
        "utmTerm": "ковры", 
        "utmContent": "content", 
        "outerNumber": "site.ua", 
        "callback": true, 
        "googleId": "1182768620.1530916891", 
        "facebookClientId": "fb.1.1234567890", 
        "referer": "google.com", 
        "comment": "комментарий к звонку", 
        "date": "2018-07-09 16:58:52", 
        "state": "ANSWER", 
        "source": "REGULAR", 
        "link": "https://cstat.nextel.com.ua:8443/tracking/rec/1531144732.920/2018-07-09", 
        "meta": "some info", 
        "cause": 16 
      } 
    } 
  ] 
}

Вебхуки

Сopied

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

Движение по балансу

Сopied

Вебхук «Движение по балансу» предоставляет информацию по каждой операции изменения баланса проекта и не может быть конфигурирован, поскольку события данной категории обрабатываются системой автоматически. Для работы с этим вебхуком Ваше веб-приложение должно принимать JSON методом POST по указанному на странице личного кабинета «API» URL.

Есть всего 5 типов операций:

Пример отправляемого JSON:

{
  "date": "2022-11-12 19:12:50", // Время проведения операции
  "type": "MAIN_REFILL", // Тип операции
  "sum": 500000, // Сумма операции. 1000 соответствует единице валюты проекта
  "sumV2": 500000000, // Сумма операции. 1000,000 соответствует единице валюты проекта
  "mainBalance": 15500000, // Основной баланс по завершению операции. 1000 соответствует единице валюты проекта
  "mainBalanceV2": 15500000000, // Основной баланс по завершению операции. 1000,000 соответствует единице валюты проекта
  "bonusBalance": 350000, // Бонусный баланс по завершению операции. 1000 соответствует единице валюты проекта
  "description": "Пополнение баланса на 500.00 UAH через LiqPay" // Описание операции
}

Обработка событий

Сopied

Отправка вебхука может быть выбрана в качестве типа действия при создании или редактировании действий на странице личного кабинета «Обработка событий». При конфигурации действия данного типа можно указать:
1) URL на который будет отправлен вебхук;
2) HTTP метод, который будет использован;
3) Заголовки HTTP;
4) URL параметры;
5) Тип тела запроса (Для POST, PUT, PATCH);
6) Содержимое тела запроса (Для типов «Указанный JSON» и «Форма (urlencoded)»).
События, за которыми можно закрепить действия, существуют 4 типов:
Типы событий

Более подробно с процессом обработки событий можно ознакомиться в инструкции по обработке событий.
Отправка вебхука с типом тела «Стандартный JSON» подразумевает формирование тела запроса на основании типа события, по которому был отправлен вебхук:
Стандартный JSON для событий звонков:

{
  "event": "CALL_END", // Событие, по которому был отправлен вебхук
  "call": { // Массив данных о звонке
    "id": 1091944, // Случайно генерируемый id звонка для связи его с другими событиями звонков
    "dbid": 275, // id под которым этот звонок был сохранён в базу данных. Впоследствии звонок обладает именно эти id
    "from": "380505557182", // Номер с которого был совершен звонок
    "to": [ // Массив номеров, на которые был переадресован звонок
      "2000"
    ],
    "outerNumber": "site.ua", // Внешняя линия, которая была использована для совершения или получения звонка. Содержит название сайта в случае обратного звонка
    "direction": "IN", // Направление звонка: "IN" - входящий, "OUT" - исходящий, "INNER" - внутренний
    "date": "2018-07-09 16:58:52", // Дата и время принятия звонка
    "secondsFullTime": 19, // Полное время звонка. Известно только в событии CALL_END
    "secondsTalk": 9, // Время общения. Известно только в событии CALL_END
    "utmSource": "google", // Метка аналитики. Может быть null
    "utmMedium": "search", // Метка аналитики. Может быть null
    "utmCampaign": "web", // Метка аналитики. Может быть null
    "utmTerm": "ковры", // Метка аналитики. Может быть null
    "utmContent": "content", // Метка аналитики. Может быть null
    "googleId": "1182768620.1530916891", // Метка аналитики. Может быть null
    "facebookClientId": "fb.1.1234567890", // Метка аналитики. Может быть null
    "referer": "google.com", // Метка аналитики. Может быть null
    "callback": true, // Указывает является ли этот звонок обратным. Устарело. Используйте поле "source"
    "comment": "комментарий к звонку",
    "state": "ANSWER", // Состояние звонка. Для событий CALL_NEW и CALL_REDIRECT - null
    "source": "REGULAR", // Источник звонка
    "link": "https://cstat.nextel.com.ua:8443/tracking/rec/1531144732.920/2018-07-09", // Ссылка на запись звонка. Присутствует только в случае поле state - "ANSWER"
    "meta": "some info", // Дополнительная информация, которая может быть задана при инициации звонка через API
    "cause": 16 // Код завершения звонка
  }
}

Массив «to»

Поле «state»

Поле «source»

Стандартный JSON для событий голосовых меню:

{ 
    "ivrName":"Распределение по отделам", // Название голосового меню
    "from":"380971234567", // Номер телефона абонента
    "outerNumber":"380441234567", // Внешняя линия, которая была использована для совершения или получения звонка. Содержит название сайта в случае обратного звонка
    "pressedDigit":2, // Цифра на которую нажал абонент. Может быть null 
    "actionType": "MAIN", // Тип действия. "MAIN" - основное действие, "NO_CHOICE" - действие отсутствия выбора, "WRONG_DIGIT" - действие неправильного выбора
    "projectName": "myproject", // Название проекта
    "utmCampaign": "sale2021", // Метка аналитики. Может быть null
    "utmSource": "google", // Метка аналитики. Может быть null
    "utmMedium": "email", // Метка аналитики. Может быть null
    "utmTerm": "term", // Метка аналитики. Может быть null
    "utmContent": "content", // Метка аналитики. Может быть null
    "googleId": "11111.11111", // Метка аналитики. Может быть null
    "facebookClientId": "fb.1.1234567890" // Метка аналитики. Может быть null
}

Стандартный JSON для событий завершения звонков обзвонов номеров:

{
    "from": "380971234567", // Номер телефона абонента
    "operatorNumber": "2040", // Внутренняя линия оператора. Может быть null
    "callName": "Владимир", // Имя закрепленное за номером обзвона
    "callNote": "покупал окна", // Заметка к номеру обзвона
    "calledCount": 1, // Количество звонков на данный номер в обзвоне
    "callState": "ANSWER", // Статус завершения звонка. Детальнее в разделе "Обзвон номеров" - "Общие сведенья"
    "dialName": "обзвон-окна", // Название обзвона
    "totalCount": 2000, // Количество номеров в обзвоне
    "doneCount": 537, // Количество обработанных номеров обзвона
    "projectName": "myproject" // Название проекта
}

Стандартный JSON для событий обзвона, не связанных со звонками

{}

Стандартный JSON для события очереди с голосовым сопровождением

{ 
    "from":"380971234567", // Номер телефона абонента
    "projectName":"my-project", // Название проекта
    "utmCampaign": "sale2021", // Метка аналитики. Может быть null
    "utmSource": "google", // Метка аналитики. Может быть null
    "utmMedium": "email", // Метка аналитики. Может быть null
    "utmTerm": "term", // Метка аналитики. Может быть null
    "utmContent": "content", // Метка аналитики. Может быть null
    "googleId": "11111.11111", // Метка аналитики. Может быть null
    "facebookClientId": "fb.1.1234567890", // Метка аналитики. Может быть null
    "gclid": "gclid..." // Метка аналитики. Может быть null
    "cdid": "cdid...", // Метка аналитики. Может быть null
    "referer": "https://unitalk.cloud", // Метка аналитики. Может быть null
    "ip": "111.111.111.111" // !
}

Входящие вебхуки

Сopied

UniTalk может принимать вебхуки с определенной структурой и выполнять по ним действия.
Доступные на данный момент действия:
1) «AUTODIAL_ADD» — Добавление номера телефона в обзвон номеров;
2) «AUTODIAL_REMOVE» — Удаление номера телефона из обзвона номеров.
Для использования входящих вебхуков на странице личного кабинета «API« необходимо:
1) Сгенерировать токен:

2) Нажать кнопку «Сгенерировать ссылку«:

3) Выбрать действие, обзвон к которому оно применится, указать дополнительные опции и нажать кнопку «Сгенерировать«:

4) Заполнить параметры ссылки и отправить на неё POST запрос.
Параметры, которые заполняются при генерации автоматически:

Перевод звонка на ответственного оператора

Сopied

Вебхук «Перевод звонка на ответственного оператора» позволяет получить информацию о звонке для последующего выбора ответственного оператора Вашей системой. Для работы с этим вебхуком Ваше веб-приложение должно принимать JSON методом POST по указанному при создании или редактировании входящего сценария на странице личного кабинета «Входящие сценарии», при выборе перенаправления на «На ответственного менеджера» и активации опции «Запрос в Ваш API» URL.

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

{  
  "event": "ROUTE",  
  "call": {  
    "from": "380505557182" // Номер звонящего абонента  
  }  
}

В ответ Ваше приложение должно отправить JSON следующей структуры:

{  
  "operatorNumber": "2048", // Номер телефона ответственного оператора. Можно указать SIP или GSM. Может быть null
  "callerName": "Александр",  // Имя абонента, которое будет отображено в SIP клиенте
  "ivrId": 487 // id голосового меню, которое необходимо воспроизвести абоненту. Может быть null
}

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

Управление очередью с голосовым сопровождением

Сopied

Вебхук «Управление очередью с голосовым сопровождением» позволяет получить информацию о звонке для последующей приоритезации обработки клиентов Вашей системой. Для работы с этим вебхуком Ваше веб-приложение должно принимать JSON методом POST по указанному при создании или редактировании входящего сценария на странице личного кабинета «Входящие сценарии», при выборе перенаправления на «Очередь с сопровождением» и активации опции «Вебхук для управления» URL.

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

{
  "outerNumber": "380440000001", // Внешняя линия, на которую поступил звонок
  "from": "380501234567", // Номер абонента
  "utmSource": null, // Метка аналитики. Может быть null
  "utmMedium": null, // Метка аналитики. Может быть null
  "utmCampaign": null, // Метка аналитики. Может быть null
  "utmTerm": null, // Метка аналитики. Может быть null
  "utmContent": null, // Метка аналитики. Может быть null
  "googleId": null, // Метка аналитики. Может быть null
  "facebookClientId": null, // Метка аналитики. Может быть null
  "gclid": null, // Метка аналитики. Может быть null
  "cdid": null, // Метка аналитики. Может быть null
  "referer": null // Метка аналитики. Может быть null
}

Очередь с приоритетом состоит из 10 очередей, которые обрабатываются в порядке уменьшения номера. По умолчанию, UniTalk определяет все звонки в очередь с номером 5.
Ваше приложение может изменить номер очереди, отправив в ответ JSON следующей структуры:

{
  "setPriority": 7 // Номер очереди от 1 до 10
}

Уведомления

Сopied

Отправка уведомлений в Chrome виджет

Сopied

POST  /widget/sendNotification

Отправляет уведомление указанным пользователям.

Пример body JSON запроса:

Как минимум одно из полей объекта data должно быть заполнено.

{
    "userIds": [ 
        5701, 5800, 4560
    ],
    "data": {
        "contactName": "Александр",
        "contactLink": "https://example.com",
        "entityName": "Продажа автомобиля",
        "entityLink": "https://example.com",
        "responsible": "Владимир"
    }
}

Ответ:

{
    "status":"Success",
    "data": {
        "notificationId": 1985837794
    }
}

Скрытие уведомлений в Chrome виджете

Сopied

POST  /widget/hideNotification

Скрывает уведомления указанным пользователям.

Пример body JSON запроса

{     
    "userIds": [
        5701, 5800, 4560
    ],
    "notificationId": 1551593033
}

{
   "status": "Success"
}