Chat Status Message

A Chat status message is generated when the driver receives or reads a message from the planner.

The data field of a Chat message consists of the properties described below.

Property	Nullable	Type	Description
id	false	string	The ID of the message whose status is updated
status	false	string	The status of the message. Possible values are: `received` for a messages that has been received by the driver `read` for a messages that has been read by the driver
time	false	string	ISO 8601 formatted timestamp of when the message status was updated
timeMillis	false	Long	Unix timestamp (milliseconds) of when the message status was updated

Example

The examples below contain different types of ChatStatus messages. Each example contains a JSON snippet together with a brief explanation.

This example will be sent when the driver has received the message

{
  "type": "ChatStatus",
  "data": {
    "id": "1234",
    "status": "received",
    "time": "2024-01-17T12:35:33.326Z",
    "timeMillis": 1705494933326
  },
  "location": {
    "latitude": 52.128572,
    "longitude": 5.5662831,
    "speedMs": 0.0,
    "bearing": 75.0
  },
  "origin": {
    "appId": 60000153,
    "deviceId": "358240051111110",
    "driverNumber": "2",
    "coDriverNumber": null
  },
  "vehicle": {
    "licensePlate": "TE-ST-12",
    "odometer": 250000
  },
  "messageTime": "2024-09-11T06:01:43.162Z"
}

This example will be sent when the driver has read the message

{
  "type": "ChatStatus",
  "data": {
    "id": "1234",
    "status": "read",
    "time": "2024-01-17T12:35:33.326Z",
    "timeMillis": 1705494933326
  },
  "location": {
    "latitude": 52.128572,
    "longitude": 5.5662831,
    "speedMs": 0.0,
    "bearing": 75.0
  },
  "origin": {
    "appId": 60000153,
    "deviceId": "358240051111110",
    "driverNumber": "2",
    "coDriverNumber": null
  },
  "vehicle": {
    "licensePlate": "TE-ST-12",
    "odometer": 250000
  },
  "messageTime": "2024-09-11T06:01:43.162Z"
}

Last modified: 05 February 2026