Jifeline websocket service 1.0.0

Accepts one of the following messages:

• #0

  Message IDSubscribeToConnector

  Subscribes to updates from a specified connector, updates are received in a default interval of 5 seconds

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "subscribeToConnector"

  connector_id

  integer

  Connector ID to get updates for

  Additional properties are allowed.

  Extensions

  x-response

  Expand all

  object

  payload

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  connector_id

  integer

  ID of the connector

  voltage

  integer

  Voltage of the car

  voltage_is_measured

  boolean

  true if the voltage of the car the connector is connected to is measured

  vin_number

  string

  The Vehicle Identification number of the vehicle the connector is connected to.

  round_trip_time

  string

  The round trip time between the local en remote connector

  connection_quality_as_string

  string

  string representation of the connection quality, this is based on the round_trip_time

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToConnector",
    "connector_id": 940201043
  }
  

  This example has been generated automatically.

• #1

  Message IDSubscribeToTicket

  Subscribes to updates from a specified ticket, updates are received in a default interval of 5 seconds

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "subscribeToTicket"

  ticket_id

  integer

  Ticket ID to get updates for

  Additional properties are allowed.

  Extensions

  x-response

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  id

  integer

  Unique ID of the ticket

  ticket_id

  integer

  Unique ID of the ticket

  ticket_uuid

  string

  Unique UUID of the ticket

  state

  integer

  State of the ticket:

  • 0 - Initiated
  • 1 - Waiting for operator
  • 2 - Active
  • 3 - Outsourced
  • 5 - Job completed
  • 6 - Closed
  • 7 - Cancelled
  • 8 - Interrupted

  Allowed values:
  • 0
  • 1
  • 2
  • 3
  • 5
  • 6
  • 7
  • 8

  connection_id

  integer

  The unique ID of the current connection to the connector

  connection_uuid

  string

  The unique UUID of the current connection to the connector

  cancelled_reason

  integer

  Reason for cancelling:

  • 0 - Undefined
  • 1 - No communication with vehicle
  • 2 - Lost communication with customer
  • 3 - Unstable internet connection
  • 4 - Insufficient equipment
  • 5 - Regarded as stolen
  • 6 - Operation too risky
  • 7 - Customer fault
  • 8 - Double ticket
  • 9 - Demo ticket
  • 10 - Vehicle component defect
  • 11 - Return later
  • 12 - Outsourced ticket reclaimed
  • 13 - Account has insufficient funds
  • 14 - Wrong vehicle selected
  • 15 - Script execution failed
  • 16 - Attended provider unavailable
  • 17 - Client aborted automated service
  • 18 - Desired diagnostic routine not supported

  Allowed values:
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

  chat_state

  integer

  State of the chat session:

  • 0 - Un synced
  • 1 - Trying
  • 2 - Succeeded
  • 3 - Failed

  Allowed values:
  • 0
  • 1
  • 2
  • 3

  vehicle_model_id

  integer

  ID of the vehicle model the ticket is created for

  is_script_composition_running

  boolean

  Indicates if scripts for the tickets are running in composition

  vehicle_model_variant_id

  integer

  ID of the vehicle model variant the ticket is created for

  vin

  string

  The VIN of the vehicle the ticket is created for

  schedule

  Expand all

  object

  message

  string

  Message of the operator

  until

  string

  time the operator is back to process the ticket

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToTicket",
    "ticket_id": 32423
  }
  

  This example has been generated automatically.

• #2

  Message IDSubscribeToConnection

  Subscribes to updates from a specified connection, updates are received in a default interval of 5 seconds

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "subscribeToConnection"

  connection_uuid

  string

  Connection UUID to get updates for

  Additional properties are allowed.

  Extensions

  x-response

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  connection_uuid

  string

  uuid of the connection

  script_ui_wss_url

  string

  URL of the websocket script UI

  script_ui_available

  boolean

  indicates the availability of the script UI

  is_autonomous

  boolean

  indicates if the connection is handled autonomously

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToConnection",
    "connection_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a"
  }
  

  This example has been generated automatically.

• #3

  Message IDUnsubscribeFromConnector

  Unsubscribes from connector, updates are no longer received after sending this message

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "unsubscribeFromConnector"

  connector_id

  integer

  Connector ID to unsubscribe from

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "unsubscribeFromConnector",
    "connector_id": 940201043
  }
  

  This example has been generated automatically.

• #4

  Message IDUnsubscribeFromTicket

  Unsubscribes from ticket, updates are no longer received after sending this message

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "unsubscribeToTicket"

  ticket_id

  integer

  Ticket ID to unsubscribe from

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "unsubscribeToTicket",
    "ticket_id": 32423
  }
  

  This example has been generated automatically.

• #5

  Message IDUnsubscribeFromConnection

  Unsubscribes from connection, updates are no longer received after sending this message

  Payload

  Expand all

  object

  action

  string

  Websocket action, in this field the subscription action must be defined

  Allowed values:
  • "unsubscribeToConnection"

  connection_uuid

  string

  Connection uuid to unsubscribe from

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "unsubscribeToConnection",
    "connection_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0

  Message IDConnectionStatusResponse

  Payload

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  connection_uuid

  string

  uuid of the connection

  script_ui_wss_url

  string

  URL of the websocket script UI

  script_ui_available

  boolean

  indicates the availability of the script UI

  is_autonomous

  boolean

  indicates if the connection is handled autonomously

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToConnection",
    "message": {
      "connection_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a",
      "script_ui_wss_url": null,
      "script_ui_available": 1300,
      "is_autonomous": true
    }
  }
  

  This example has been generated automatically.

• #1

  Message IDTicketStatusResponse

  Payload

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  id

  integer

  Unique ID of the ticket

  ticket_id

  integer

  Unique ID of the ticket

  ticket_uuid

  string

  Unique UUID of the ticket

  state

  integer

  State of the ticket:

  • 0 - Initiated
  • 1 - Waiting for operator
  • 2 - Active
  • 3 - Outsourced
  • 5 - Job completed
  • 6 - Closed
  • 7 - Cancelled
  • 8 - Interrupted

  Allowed values:
  • 0
  • 1
  • 2
  • 3
  • 5
  • 6
  • 7
  • 8

  connection_id

  integer

  The unique ID of the current connection to the connector

  connection_uuid

  string

  The unique UUID of the current connection to the connector

  cancelled_reason

  integer

  Reason for cancelling:

  • 0 - Undefined
  • 1 - No communication with vehicle
  • 2 - Lost communication with customer
  • 3 - Unstable internet connection
  • 4 - Insufficient equipment
  • 5 - Regarded as stolen
  • 6 - Operation too risky
  • 7 - Customer fault
  • 8 - Double ticket
  • 9 - Demo ticket
  • 10 - Vehicle component defect
  • 11 - Return later
  • 12 - Outsourced ticket reclaimed
  • 13 - Account has insufficient funds
  • 14 - Wrong vehicle selected
  • 15 - Script execution failed
  • 16 - Attended provider unavailable
  • 17 - Client aborted automated service
  • 18 - Desired diagnostic routine not supported

  Allowed values:
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18

  chat_state

  integer

  State of the chat session:

  • 0 - Un synced
  • 1 - Trying
  • 2 - Succeeded
  • 3 - Failed

  Allowed values:
  • 0
  • 1
  • 2
  • 3

  vehicle_model_id

  integer

  ID of the vehicle model the ticket is created for

  is_script_composition_running

  boolean

  Indicates if scripts for the tickets are running in composition

  vehicle_model_variant_id

  integer

  ID of the vehicle model variant the ticket is created for

  vin

  string

  The VIN of the vehicle the ticket is created for

  schedule

  Expand all

  object

  message

  string

  Message of the operator

  until

  string

  time the operator is back to process the ticket

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToTicket",
    "message": {
      "id": 4723423,
      "ticket_id": 4723423,
      "ticket_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a",
      "state": 1,
      "connection_id": 1631171716525,
      "connection_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a",
      "cancelled_reason": 0,
      "chat_state": 0,
      "vehicle_model_id": 243021,
      "is_script_composition_running": false,
      "vehicle_model_variant_id": 243031,
      "vin": "JFL94020109394020",
      "schedule": {
        "message": "I'll be right back",
        "until": "string"
      }
    }
  }
  

  This example has been generated automatically.

• #2

  Message IDConnectionStatusResponse

  Payload

  Expand all

  object

  action

  string

  The action that is provided in the subscribe message

  message

  Expand all

  object

  connection_uuid

  string

  uuid of the connection

  script_ui_wss_url

  string

  URL of the websocket script UI

  script_ui_available

  boolean

  indicates the availability of the script UI

  is_autonomous

  boolean

  indicates if the connection is handled autonomously

  Additional properties are allowed.

  Additional properties are allowed.

  Examples

  Payload

  {
    "action": "subscribeToConnection",
    "message": {
      "connection_uuid": "97a0e81d-d0ac-42ae-9195-a11732ad322a",
      "script_ui_wss_url": null,
      "script_ui_available": 1300,
      "is_autonomous": true
    }
  }
  

  This example has been generated automatically.