📚
База знаний | Qolio.io
  • Обзор Qolio
  • Видеоинструкции
    • Интеграция с Битрикс24
    • Права доступа и уровни сотрудников
    • Дополнительные отделы
    • Структура компании
    • Страница "Сотрудники"
    • Настройки организации
    • Управление аккаунтом
    • Страница "Формы оценки"
    • Настройка критериев
    • Настройка формы оценки
    • Cтраница "Список коммуникаций"
    • Конфигурации фильтров
    • Фильтры на "Списке коммуникаций"
    • Как оценить звонок?
    • Как оценить текстовую коммуникацию?
    • Быстрая проверка
    • Где найти мою проверку?
    • Статусы контакта
    • Теги
    • Библиотека звонков
    • Как загрузить звонки
    • Распределение нагрузки
    • Как отслеживать прогресс сотрудников
    • Калибровочные сессии
    • Апелляции: настройка
    • Как подать апелляцию
    • Обработка апелляции
    • Страница "Отчеты": Динамика оценок по отделам
    • Страница "Отчеты": Аналитика по апелляциям
    • Страница "Отчеты": Команда
    • Страница "Аналитика"
    • Личный кабинет Оператора
    • Распределение нагрузки: видео-обзор функции
  • Быстрые клавиши
  • Как написать сообщение в поддержку?
  • Последние обновления
    • Возможность менять оператора, ответственного за звонок
    • Улучшения в настройках аналитики и интеграции
    • Перезагрузка плеера во время проверки
    • Дополнительные отделы, больше информации по сделкам из AmoCRM и другие возможности
    • Отображение результатов по дате оценки и другие новые возможности
    • Апелляции на любые типы коммуникаций
    • Отображение аналитики по дате оценки в разделах “Личный кабинет” и “Команда” уже доступно
    • Простая интеграция с HelpDeskEddy
  • Возможности платформы
    • Список коммуникаций
    • Формы оценки
      • Настройка форм оценки
      • Критерии формы оценки
      • Зоны оценки
      • Подсчет результатов по формам оценки
        • Процентное/Простая/Сумма
        • Процентное/Простая/Средний балл
        • Процентное/Взвешенная/Средний балл
        • Числовое/Простая/Сумма
        • Числовое/Простая/Средний балл
        • Числовое/Взвешенная/Средний балл
    • Проверка коммуникаций
      • Как оценить звонок
      • Быстрая проверка
    • Браузерное расширение
    • Теги
    • Библиотека звонков
    • Статусы контакта
    • Апелляции
      • Как подать апелляцию?
      • Как обработать апелляцию
    • Аналитика
      • Как настроить аналитику
      • Как посмотреть аналитику по дате оценки
      • Отчёт "Динамика оценок по отделам"
      • Команда
      • XL-виджеты
        • Результаты проверок по сотрудникам
        • Результаты сотрудников по критериям
        • Результаты проверок по критериям
        • Количество проверок по проверяющим
        • Результаты сотрудников по формам оценки
        • Результаты сотрудников по форме оценки
        • Флаги и комментарии
      • L-виджеты
        • Динамика среднего балла по отделам
        • Динамика балла по группам вопросов формы оценки
        • Динамика балла по вопросам формы оценки
        • Динамика количества проверенных звонков
        • Динамика количества звонков по сотрудникам
        • Динамика средней продолжительности звонка по сотрудникам
        • Динамика количества звонков по отделам
        • Динамика средней продолжительности звонка по отделам
        • Динамика среднего балла по сотрудникам
      • M-виджеты
        • Сравнение среднего балла по сотрудникам
        • Количество флагов и комментариев
        • Сравнение количества флагов по сотрудникам
        • Сравнение среднего балла по отделам
        • Сравнение количества тегов по отделам
        • Сравнение среднего балла по формам оценки
        • Сравнение среднего балла по вопросам в форме оценки
        • Сравнение количества тегов по сотрудникам
        • Сравнение среднего балла в группах формы оценки
        • Сравнение среднего балла вопросов в группах
        • Сравнение количества звонков по отделам
        • Сравнение количества звонков по сотрудникам
        • Сравнение количества проверок супервизоров
        • Сравнение средней продолжительности звонков по сотрудникам
        • Сравнение количества флагов по отделам
        • Сравнение средней продолжительности звонков по отделам
      • S-виджеты
        • Количество звонков
        • Общая продолжительность звонков
        • Процент проверок
        • Средняя продолжительность звонка
        • Средний балл по форме оценки
    • Калибровочные сессии
    • Личный кабинет Оператора
    • Распределение нагрузки: общий обзор функции
      • Распределение нагрузки: как отслеживать процесс проверок
      • Распределение нагрузки: как оценивать коммуникации
    • Настройки пользователей и отделов
      • Как пригласить сотрудников в Qolio
      • Настройки прав доступа и уровней сотрудников
      • Дополнительные отделы
      • Добавление новых сотрудников и смена пароля
      • Как добавить нового сотрудника из вашей системы
      • Настройка уведомлений и статусов
      • Страница "Подключения"
  • Интеграции
    • Битрикс 24
      • Bitrix (Коробочная Версия): Разрешение Доступа
    • AmoCRM
      • Как просмотреть все коммуникации из сделки AmoCRM
      • Если не получается оценить звонок из AmoCRM
      • Авторизация в amoCRM
    • Что делать после установки Qolio в AmoCRM/Битрикс24?
    • Usedesk
    • Binotel
    • Sipuni
    • Zendesk
    • HelpDeskEddy
    • UIS/Comagic
    • Edna
    • MANGO OFFICE
    • Подключение по API
      • Интеграция по API для IP-телефонии и чатов
        • API запрос для добавления звонков
          • API запрос для добавления звонка с транскрибцией
        • API запрос для добавления звонков с хранением данных на S3
        • HTTPS интеграция с текстовыми каналами (через API Qolio)
      • Создание csv файла для добавления пользователей при интеграции по API
      • Создание и управление пользовательскими полями при интеграции по API
      • Синхронизация аккаунтов пользователя в системе Qolio и интегрируемой системы
      • Доступ через API
      • Добавление и настройка пользователей через API
      • Custom Fields API - Настройка пользовательских полей
      • Возможные ошибки API
      • Получение оценок операторов по API
      • Приложение (информация о полях в объектах JSON:API)
    • Установка коробочной версии на одной машине (single-node deployment)
    • Oktell: Общие сведения для подключения
    • Asterisk: Общие сведения о настройке интеграции
  • Вопросы
    • Что делать, если по сотрудникам нет коммуникаций
    • Доступ к Qolio через VPN
    • Если в браузере не проигрывается звонок с http-ссылкой
    • "Установленные настройки недоступны" - что делать?
  • Безопасность
    • Облачная версия
Powered by GitBook
On this page

Was this helpful?

  1. Интеграции
  2. Подключение по API
  3. Интеграция по API для IP-телефонии и чатов

HTTPS интеграция с текстовыми каналами (через API Qolio)

PreviousAPI запрос для добавления звонков с хранением данных на S3NextСоздание csv файла для добавления пользователей при интеграции по API

Last updated 10 months ago

Was this helpful?

Создание интеграции

Вы можете посмотреть на предварительную настройку организации и создании чата по API в этом видео:

Запрос для создания текстовой коммуникации

После добавления интеграции для текстового канала, вам будет предоставлен:

  1. URL путь для создании текстовых коммуникаций. URL путь имеет следующий вид: https://{DEALAPP_API_URL}/api/v1/integrations/{INTEGRATION_ID}/text , где DEALAPP_API_URL адрес установки сервера DealApp, а INTEGRATION_ID сгенерирован сервисом DealApp.

  2. Authorization Token, это токен, который должен передаваться в headerах запроса и использоваться для авторизации запроса на URL путь интеграции.

Для регистрации текстовой коммуникации нужно сделать POST запрос следующим образом:

// POST https://api.prod1.dealapp.io/api/v1/integrations/c34f637a-..../text

Зарос должен содержать следующие заголовки (headers): "Content-Type: application/json" и "Authorization: ...". В Authorization заголовке передается значение Authorization Token, которое можно найти на странице настройки интеграции в DealApp.

Вместе с запросом нужно передать JSON документ с данными о текстовой коммуникации. Пример JSON документа для запроса на добавление / обновление объекта текстового взаимодействия:

// {
  "client_id": "375299933332",        // Идентификатор клиента в системе клиента (номер телефона, id или хэш)
  "communication_id": "1911-1498-11",  // Идентификатор текстового взаимодействия
  "communication_type": "chat",        // Тип текстового взаимодействия. Возможные варианты: chat / ticket / email
  "title": "Добрый вечер. Я хочу приобрести холодильник", // Заглавие беседы, если нету - берется из conversation_parts.first.body
  "source": "chat",        // источник чата (telegram, viber и другие)
  "nps": 8,                // Net Promoter Score
  "client_feedback": 1,    // число, отображающее отзыв клиента
  "status": "closed",      // String обозначающий статус (accepted / rejected)
  "direction": "incoming", // incoming / outcoming / local
  "communication_parts": [
    {
      "communication_part_id": "2202737122",
      "author": {
        "type": "client"  // при отсутствии id клиента мы используем client_id из
      },        
      "body": "Добрый вечер. Я хочу приобрести холодильник",
      "created_at": "2020-01-17T08:15:30+03:00"
    },
    {
      "communication_part_id": "2202737122",
      "author": {
        "type": "client"
      },
      "body": "Интересует модель X этого года",
      "created_at": "2020-01-17T08:15:30+03:00",
      "updated_at": "2020-01-17T09:30:28+03:00"
    },
    {
       "communication_part_id": "2202737122",
       "author": {
          "id": "123",       // id оператора (внутренний номер)
          "type": "operator" // возможные значения operator / client
       },
       "body": "Здравствуйте! Спасибо за сообщение, наш отдел продаж обязательно свяжется с вами",
       "content_type": "text/plain",  // text/plain by default, возможные варианты text/html
       "created_at": "2020-01-17T08:15:30+03:00",
       "updated_at": "2020-01-17T08:15:30+03:00"
    }
  ],
  "custom_fields": {
    "reopens_count": 3
  }
}

Описание полей запроса

operator_id

(required) string

Идентификатор оператора, с которым проходил разговор (это могут быть email, SIP номер или ID из ActiveDirectory/LDAP)

uid

string

уникальный внешний идентификатор (который после будет храниться и возвращаться в поле integration_uid)

communication_id

string (chat / ticket / email)

Идентификатор текстового взаимодействия, должен быть уникальным для всех взаимодействий

communication_type

string

Тип текстового взаимодействия. Возможные варианты: chat / ticket / email

title

string

Заглавие беседы, если нету - берется из conversation_parts.first.body

source

string

Поле в котором может храниться название сервиса, через которое проходила текстовая коммуникация (telegram, viber и др.). Возможны любые значения

nps

string

Значение NPS

client_feedback

string

Число, которое ассоциируется с выбором, которое делает клиент для оценки коммуникации

status

string (accepted / rejected / opened / closed)

Статус диалога. String, значения: accepted, rejected, opened, closed

direction

string (incoming / outcoming / local)

Направление коммуникации: incoming / outcoming / local

communication_parts

array

Перечень сообщений в диалоге. Array

communication_parts[].author

string

Описывает с каким пользователем можно связать это сообщение

communication_parts[].author.type

string

Возможные значения client / operator

communication_parts[].author.id

string

id клиента или оператора в зависимости от conversation_parts.author.type. если не указан, используется client_id или operator_id соответственно

communication_parts[].conversation_part_id

string

трекинг ID сообщения в вашей системе

communication_parts[].body

string

Тело сообщения

communication_parts[].content_type

string

Тип содержимого в сообщении (text/plain или text/html), по умолчанию text/plain

communication_parts[].created_at

string

Время создания сообщения

custom_fields (metacontent)

hash (object)

Хэш, в который можно передавать поля, которые не входят в схему запроса

client_id

string

Устаревшая форма передавать id клиента по которому проходит коммуникация

client

hash (object)

Объект с информацией о клиенте, который совершает ком-цию

client.id

string

Идентификатор клиента в системе клиента (номер телефона, id или хэш)

client.company_name

string

Название компании клиента

client.first_name

string

Имя клиента

client.last_name

string

Фамилия клиента

client.email

string

email клиента

client.phone_number

string

номер телефона клиента

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

curl запрос с помощью, которого можно создать чат:

// export INTEGRATION_URL="https://api.prod1.dealapp.io/api/v1/integrations/9e5af994-9d16-4607-8964-86272a452299/text"
export AUTHORIZATION_TOKEN="289a2b91a681031fc576e3c66e155761cef58926a97d201363abd4c3196546318b597a9171aca4ae008be8e7fae5bec6f8de396adec24a"

curl --header "Content-Type: application/json" --request POST --header "Authorization: $AUTHORIZATION_TOKEN" --data @request.json $INTEGRATION_URL
23MB
dealapp-integration-with-chats.mp4