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.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package kontur-talk-sdk

PHP SDK для работы с API Kontur Talk

Tests Latest Stable Version Total Downloads License

PHP Version

Неофициальный 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 ещё до отправки запроса.

Требования


All versions of kontur-talk-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
guzzlehttp/guzzle Version ^7.0
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bigperson/kontur-talk-sdk contains the following files

Loading the files please wait ...