Перейти к основному содержимому
Версия: 4.11-refactoring

Интеграция с iQTeams

Документация по API для отправки сообщений в корпоративное пространство iQTeams из внешних источников​

Общая логика работы клиента:

  1. Авторизация и подключение: Пользователь проходит авторизацию с помощью метода /users/login и аутентификацию с помощью метода /users/auth на iQChannels. После успешного входа клиент может взаимодействовать с корпоративным чатом.
  2. Отправка сообщений: Для отправки сообщения в систему IQChannels используется соответствующий метод /corporate_chats/create_message

Методы API​

Авторизация пользователя​

Метод: /users/login
HTTP-метод: POST
Краткое описание: Метод для авторизации пользователя.

Описание: Позволяет пользователю получить токен для работы с API.

Параметры:

  • email (string, required) — Имя пользователя или email.
  • password (string, required) — Пароль пользователя.

image-2024-12-12_14-55-47.png

Авторизация пользователя (проверка токена)​

Метод: /users/auth
HTTP-метод: POST
Краткое описание: Метод для проверки токена текущей сессии.

Описание: Используется для проверки валидности токена, чтобы подтвердить активность пользовательской сессии.

Параметры:

  • token (string, required) — Токен доступа.

image-2024-12-12_14-55-47-1.png

Создание сообщения в корпоративном чате​

Метод: /corporate_chats/create_message
HTTP-метод: POST
Краткое описание: Метод для отправки сообщения в корпоративном чате.

Описание: Создает новое сообщение в указанном корпоративном чате.

Параметры:

  • corporateChatId (integer) — Идентификатор корпоративного чата, в который отправляется сообщение.
  • corporateChatMessage (object):
  • localId (integer) — Локальный идентификатор сообщения.
  • text (string) — Текст сообщения.

Авторизация: как в Internal API — cookie user-session или заголовок Authorization: Bearer для сервисных аккаунтов; отдельный параметр token в теле запроса не используется.

Деавторизация текущего пользователя​

Метод: /users/logout
HTTP-метод: POST
Краткое описание: Метод для выхода пользователя из текущей сессии.

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

Параметры: отсутствуют.

image-2024-12-12_14-55-47-3.png

Детальное описание API​

Подробнее об API iQChannels — Описание Internal API