Skip to content

Messaging API⚓︎

Use the Messaging API to receive messages using AMQP. The INVERS OneAPI can push messages to you when specific events happen, e.g. when a new vehicle state is received or when the vehicle’s master data changes. This allows you to react instantly and to keep your data up to date.

Basics⚓︎

The Messaging API serves as an asynchronous messaging mechanism and not as long-term storage. Messages are saved for 7 days. If you have not consumed and acknowledged a message during this time, the message is deleted and will not be delivered to you anymore.

Message⚓︎

Each message has a message_type which uniquely identifies what kind of message it is. In an “object-oriented” perspective, the message_type can be seen as the class of the message. Each message contains information, but that information is different depending on the message_type.

Topic⚓︎

A topic is a collection of one or more message types. You can subscribe to a message topic, and by doing so you can consume all messages which are published to that topic. You can subscribe to multiple topics.

Queue⚓︎

When you subscribe to a topic, an AMQP queue is created for the topic. You can access the queue to consume the topic’s messages.
Message topics may contain messages of different message types.

Message source⚓︎

All messages that are pushed to you via Messaging API of the INVERS OneAPI have one of the following sources:

Message from OneAPI
The origin of these messages is the INVERS OneAPI and not a vehicle. An example is the message VehicleDataChanged which, for example, informs you that the license plate of the vehicle was changed.
Message from a vehicle
These messages are sent regularly or when something happens at the vehicle. This requires the vehicle or, to be precise, the built-in telematics unit to be online. An example is the message VehicleStateReceived which, for example, informs you that the central lock status of the vehicle has changed (this message contains the vehicle state).

Further reading⚓︎

Consume Learn how to consume messages

Format Learn more about how messages look

Versioning Learn how versioning helps to keep your integration intact

Message List See a list of all messages that can be pushed to you

Back to top