Call Lift

The CALL_LIFT command submits a request for the lift to service a specific floor. The timing and prioritization of when the lift responds to this request depend on the lift system's internal logic and current passenger usage. It does not mean that the elevator will not stop at other floors.

info

When the lift arrives at a floor, it will be broadcasted over the websocket connection

---

WebSocket API

Command

• Command: CALL_LIFT

Parameters

Parameter	Type	Required	Description
command	String	Yes	CALL_LIFT
requestId	String	Yes	Unique identifier for the request.
parameters.targetFloor	Integer	Yes	The floor to which the lift is requested.

Response

Field	Type	Description
requestId	String	Unique identifier for the request.
status	String	Status of the request (success or error).
code	String	Expect CALL_LIFT_OK if success, otherwise expect error code

Broadcast Response

Field	Type	Description
requestId	String	BROADCAST- appended by unique id
code	String	CURRENT_FLOOR
info.currentFloor	Integer	Current floor of lift.

Example Request

{
  "requestId": "a1b2c3d5",
  "command": "CALL_LIFT",
  "parameters": {
    "targetFloor": 5
  }
}

Expected Response

• On Success:

{
  "requestId": "a1b2c3d5",
  "code": "CALL_LIFT_OK",
  "status": "success"
}

• Follow-Up Updates:

As the lift progresses, broadcasts will be sent whenever lift arrives at a new floor:

{
  "requestId": "BROADCAST-XXXXX",
  "code": "CURRENT_FLOOR",
  "info": {
    "currentFloor": 1
  }
}