Download the PHP package bigperson/kontur-talk-sdk without Composer
On this page you can find all versions of the php package bigperson/kontur-talk-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bigperson/kontur-talk-sdk
More information about bigperson/kontur-talk-sdk
Files in bigperson/kontur-talk-sdk
Package kontur-talk-sdk
Short Description PHP SDK для работы с API Kontur.Talk
License MIT
Informations about the package kontur-talk-sdk
PHP SDK для работы с API Kontur Talk
Неофициальный PHP SDK для удобной интеграции с API сервиса Контур.Толк.
Важно: Данный SDK не является официальным продуктом компании СКБ Контур и разрабатывается независимо.
Начиная с версии 2.0.0 SDK выровнен по официальной OpenAPI-спецификации Kontur.Talk и покрывает
только те endpoint'ы, что нужны для сценария "комната → встреча в календаре → опрос истории
конференций за записями/транскриптом/саммари", плюс вебхуки и отчёт по комнате. Пути и регистр букв в них взяты из спецификации
дословно (например, Domain/recordings, Recordings/{key}/access, recordings/{key}/transcript —
это разные endpoint'ы, а не опечатки). Ответы возвращаются как декодированный JSON (array) без
DTO-слоя — так методы SDK не расходятся со спецификацией со временем.
Установка
Использование
Инициализация клиента
Комнаты ($client->rooms)
Календарь встреч ($client->calendar)
Встреча создаётся "от имени" организатора — на его почтовом ящике. Комнату (roomName) нужно
создать заранее через $client->rooms->createOrUpdate().
История конференций ($client->conferencesHistory)
Записи ($client->recordings)
Скачивание файла записи — методы транспортного уровня (GET /api/Recordings/{key}/file):
Спецификация объявляет качество как
{qualityName}в пути, но описывает его как query-параметр без соответствующего path-параметра. SDK следует объявлению параметра и передаёт качество как?qualityName=...— единственная трактовка, по которой вообще есть что подставлять в запрос.
Информация об API-ключе ($client->applications)
Пользователи ($client->users)
Вебхуки ($client->webhooks)
Требуют разрешения application.webhooks.read / application.webhooks.write у API-ключа.
Создание вебхука — асинхронное: Толк присылает на указанный url запрос с телом
{"activationKey": "..."}, и до вызова activate() с этим ключом события не приходят.
На создание действует лимит — 10 запросов в сутки на пространство (сверх лимита API отвечает
429, SDK бросает TalkRateLimitException).
Разбор входящих событий SDK на себя не берёт — это дело принимающей стороны. Контракт доставки:
тело события — JSON с обязательными eventId, eventType и time (ISO 8601); принимающий
сервер обязан ответить 200 в течение 5 секунд. Дополнительные поля зависят от типа события:
eventType в доставке |
Дополнительные поля |
|---|---|
ConferencesStarted |
conferenceKey, roomName |
ConferencesFinished |
conferenceKey |
RecordingCompleted |
recordingKey |
TranscriptionReady |
recordingKey |
UserConnectedToRoom |
roomName, isAnonymous, userKey, anonymousId |
UserDisconnectedFromRoom |
roomName, isAnonymous, userKey, anonymousId |
Осторожно с регистром: в подписке (
events[]) типы записаны в camelCase (recordingCompleted), а в доставленном событииeventTypeприходит в PascalCase (RecordingCompleted). ПередатьeventTypeиз вебхука напрямую вWebhookEventType::from()не получится — будет\ValueError.
Отчёты по комнатам ($client->roomReport)
Требуют разрешения application.reporting.read. Даты — ISO 8601 в UTC, максимальный период —
365 дней.
Отчёт по всему пространству (
GET /api/RoomReport/statistics) в SDK не вынесен: он отдаёт файл xlsx, а не JSON, — весь транспорт SDK построен на декодировании тела ответа в массив.
Документация
Подробная документация по API доступна в официальной документации Контур.Толк.
Обработка ошибок
SDK использует исключения для обработки ошибок:
Методы, принимающие значения перечислений (Kontur\Talk\Enum\*, например SummaryType в
recordings->summary(), LinkAccessScope в recordings->patchAccess() или WebhookEventType
в webhooks->create()), при недопустимом значении бросают стандартный \ValueError ещё до
отправки запроса.
Требования
- PHP 8.2 или выше
- Guzzle HTTP 7.0 или выше
- Расширение JSON