High Mobility Push API 1.0.0

This document specifies the JSON format for each vehicle property that is made available through High Mobility's streaming and push interfaces.

Servers

  • sandbox.mqtt.high-mobility.com:{port}mqttsandbox

    Sandbox broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:sandbox

  • mqtt.high-mobility.com:{port}mqttproduction

    Production broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:live

Operations

  • SUB {instance}/{auto_api_level}/{app_id}/{vin}/mobile/{action}/{property}

    Operation IDlive
    instance
    required
    string
    uid: instance

    live/sandbox

      Allowed values:
    • "live"
    • "sandbox"
    auto_api_level
    required
    string
    uid: auto_api_level

    AutoAPI level

    Const:"level13"
    app_id
    required
    string
    uid: app_id

    Application id

    vin
    required
    string
    uid: vin

    VIN

    capability
    required
    string
    uid: capability

    Capability

    Const:"mobile"
    action
    required
    string
    uid: action

    Action

    Const:"get"
    property
    required
    string
    uid: property

    Property

    qos
    1

    Accepts the following message:

    Mobile Connection
    object
    uid: mobile_get_connection
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"mobile"
    property
    required
    string
    Const:"connection"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Connection

    data
    required
    string

    Connection state

      Allowed values:
    • "disconnected"
    • "connected"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Examples

    {
  "version": 1,
  "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
  "vin": "VFXXXXXXXXXXXXXXX",
  "capability": "mobile",
  "property": "connection",
  "data": {
    "mobile": {
      "connection": {
        "data": "disconnected",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    }
  }
}
    This example has been generated automatically.

Messages

  • #1Mobile Connection
    object
    uid: mobile_get_connection
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"mobile"
    property
    required
    string
    Const:"connection"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Connection

    data
    required
    string

    Connection state

      Allowed values:
    • "disconnected"
    • "connected"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

Schemas

  • version
    number
    uid: version
  • message_id
    string
    uid: message_id
  • vin
    string
    uid: vin
  • timestamp
    string
    format: date-timeuid: timestamp
  • object
    uid: mobile_get_connection
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"mobile"
    property
    required
    string
    Const:"connection"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Connection

    data
    required
    string

    Connection state

      Allowed values:
    • "disconnected"
    • "connected"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.