API канал служит для подключения произвольных сервисов к AutoFAQ, к примеру:
корпоративные мессенджеры - для переписки пользователей в мессенджере с ботом и операторами
форма обратной связи - для заведения заявок с сайтов и отправки ответов пользователю на электронную почту
Service Desk - для классификации поступающих заявок и получения ответов на запросы
собственный чат на сайте или в личном кабинете - для переписки пользователей с ботом и операторами
Детали работы через API канал
Переписка через API канал ведется только в асинхронном режиме. Полное описание методов API доступно по ссылке в swagger.
Авторизация при отправке запросов ведется через отправку токена в заголовке запроса. Для получения токена авторизации необходима учетная запись пользователя в сервисе AutoFAQ, можно воспользоваться существующей учетной записью или создать новую, набор ролей для новой учетной записи значения не имеет. Получить токен можно отдельным запросом https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4#/Authentication/Authenticate. Время жизни токена 42 года.
Перед началом работы клиентский сервис должен указать адрес для получения ответов от AutoFAQ в настройках канала или отдельным запросом https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4#/Chat/set_webhook.
Отправка сообщений пользователя ведется в теле запроса https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4#/Chat/SendQuestionAsync. Ответные сообщения бота или оператора AutoFAQ придут в виде POST запроса на указанный ранее адрес WebHook. Формат ответного сообщения указан в описании запроса в разделе CallBacks.
Переписка через API канал поддерживает двухсторонюю передачу файлов. Для передачи файлов в сервис AutoFAQ следует сперва передать нужные файлы запросом https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4#/Chat/post_api_ext_v2_services__serviceId__channels__channelId__files, а потом указать полученные идентификаторы в теле запроса с сообщением пользователя. При получении в ответном сообщении от AutoFAQ идентификаторов файлов их можно получить запросом https://app.swaggerhub.com/apis-docs/AutoFAQ.ai/external-api/2.1.4#/Chat/get_api_ext_v2_services__serviceId__channels__channelId__files__fileId_.
Переписка через API канал поддерживает использование кнопок. Список кнопки передаются отдельным списком для каждой реплики AutoFAQ. Нажатия пользователей на кнопки можно возвращать как в виде текстового сообщения, так и в виде события нажатия на кнопку.
Подключение к API каналу
создать API канал в разделе Каналы настроек сервиса AutoFAQ
2. В настройках канала