netresearch/sdk-api-universal-messenger

Implementation of the Universal Messenger API

3.0.0 2026-07-14 14:03 UTC

Requires

• php: ^8.2
• ext-json: *
• ext-simplexml: *
• ext-xmlwriter: *
• magicsunday/jsonmapper: ^2.4.0
• magicsunday/xmlmapper: ^2.0 || ^3.0
• php-http/client-common: ^2.7.0
• php-http/discovery: ^1.19.0
• php-http/httplug: ^2.4.0
• php-http/logger-plugin: ^1.3.0
• php-http/message: ^1.16.0
• phpdocumentor/reflection-docblock: ^6.0.0
• psr/http-client: ^1.0.0
• psr/http-client-implementation: *
• psr/http-factory: ^1.0.0
• psr/http-factory-implementation: *
• psr/http-message: ^2.0.0
• psr/http-message-implementation: *
• psr/log: ^3.0.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.65
• nyholm/psr7: ^1.8
• overtrue/phplint: ^9.5
• php-http/mock-client: ^1.6
• phpstan/phpstan: ^2.0
• phpstan/phpstan-deprecation-rules: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpstan/phpstan-strict-rules: ^2.0
• phpstan/phpstan-symfony: ^2.0
• phpunit/phpunit: ^11.0 || ^12.0 || ^13.0
• rector/rector: ^2.0
• symfony/http-client: ^7.0 || ^8.0

MIT

• Rico Sonntag

Published on Packagist.org on 2026-07-14 14:04 UTC

README

Universal Messenger API

The documentation for all requests can be found at Universal Messenger API Documentation.

The Universal Messenger API SDK package offers an interface to the Universal Messenger interface. The SDK currently implements only the endpoints and data structures that were required at the time of development.

Table of contents

• Requirements & Installation
• Basic usage & Limitations
• Endpoints
• Error handling

Compatibility

The Universal Messenger REST API is not versioned on the client side. The SDK addresses fixed endpoints, and the behaviour — most notably the authentication scheme — depends on the Universal Messenger server version that is deployed. Authentication is therefore what distinguishes the server generations, and the SDK major version reflects the supported era:

SDK	Authentication	Universal Messenger server
^2.0	API token via the umopen/open query parameter (cmsbs.open)	UM before 7.56
^3.0	API key (public key + secret) via HTTP basic authentication	UM 7.56.0 and later

Pin the SDK major version to match your Universal Messenger server. The umopen/open token is deprecated since UM 7.41 and, while it still works transitionally, will be removed; from UM 7.56.0 an API key is required. See section API-Schlüssel of the developer documentation.