API

JAICP предоставляет ряд API для обращения к функциям платформы по протоколу HTTP и интеграции ее возможностей в сторонние приложения.

Доступ к API

Чтобы пользоваться API, получите токен в JAICP. Процесс получения токена может отличаться в зависимости от API:

API	Как получить токен
Project API	Выпустите единый токен в разделе Доступ к API.
Channel API	Выпустите единый токен в разделе Доступ к API.
NLP Direct API	Скопируйте токен в настройках проекта.
Reporter API	Скопируйте токен в настройках проекта.
Chat API	Скопируйте токен в настройках канала Chat API.
Prompter API	Скопируйте токен в настройках канала Prompter API.
Calls API	Скопируйте токен на вкладке Обзвоны.
Imputer API	Скопируйте токен на странице Гибридный синтез речи.
Operator API	Токен не требуется.
Model API	Токен не требуется.
Pushgate API	Токен не требуется.

Список API

Диалоговые API

• Chat API — API для ведения диалога с ботом или оператором.
  Поддерживаемые методы:

  • Отправка запроса клиента в чат.
  • Получение асинхронных событий в чате.
  • Получение истории переписки.
  • Сохранение и загрузка состояния чат-приложения.

• Operator API — API для интеграции JAICP с любыми операторскими каналами.
  Поддерживаемые методы:

  • Отправка оператору сообщения, файла или других дополнительных данных.
  • Выбор группы операторов для обработки обращения.
  • Подписка на уведомления о событиях в операторском канале.

• Prompter API — API для подключения суфлеров в Aimychat или их интеграции в сторонний сервис.
  Поддерживаемый метод:

  • Отправка оператору ответов на вопросы пользователя.

NLU API

• NLP Direct API — API для работы с NLU-ядром, которое используется для понимания естественного языка.
  Поддерживаемые методы:

  • Импорт и экспорт данных NLU в существующем проекте на JAICP.
  • Добавление, изменение, удаление интентов и сущностей.
  • Обучение классификатора.
  • Работа с сервисом исправления опечаток.

• Model API — API для подключения к JAICP внешнего сервиса для понимания естественного языка.

Прочие API

• Calls API — API для работы с исходящей телефонией.
  Поддерживаемые методы:

  • Добавление телефонных номеров с параметрами в обзвон.
  • Отмена созданных заданий на обзвон.
  • Получение отчетов по обзвону.
  • Запуск, приостановление, возобновление и остановка обзвона.

• Channel API — API для управления каналами и публикации бота в каналы.

• Imputer API — API для работы с репликами, сгенерированными при помощи гибридного синтеза речи.
  Поддерживаемые методы:

  • Получение реплики, синтезированной из готового шаблона.
  • Кэширование реплики с заданными параметрами.

• Project API — API для управления проектами.

• Pushgate API — API для отправки событий в бота через пушбэк.

• Reporter API — API для работы с аналитикой проекта.
  Поддерживаемые методы:

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