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

The CALL_LIFT_OK response is sent immediately to acknowledge the request. Wait for the CURRENT_FLOOR broadcast message indicating the lift has arrived at your target floor before proceeding with subsequent commands.

---

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.liftId	String	Yes	The ID of the lift to call.
parameters.targetFloor	Integer	Yes	The floor to which the lift is requested.
parameters.setOpenOnArrival	Boolean	Optional	Whether to open doors on arrival (default: false).

Response

Field	Type	Description
requestId	String	Unique identifier for the request.
status	String	Status of the request (success or error).
code	String	Response code (e.g., CALL_LIFT_OK)
message	String	Descriptive message about the response

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": {
    "liftId": "lift1",
    "targetFloor": 5,
    "setOpenOnArrival": false
  }
}

Expected Response

• On Success:

{
  "requestId": "a1b2c3d5",
  "status": "success",
  "code": "CALL_LIFT_OK",
  "message": "Lift called successfully"
}

• 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
  }
}