Skip to main content
POST
/
vehicle
/
{vehicle_id}
/
command
Send command to vehicle
curl --request POST \
  --url https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}/command \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "priority": "HIGH",
  "command": "<string>",
  "timestamp_planned_execution": "2023-11-07T05:31:56Z"
}
'
{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "via": "me",
        "organization_id": "<string>"
      }
    ]
  },
  "data": {
    "priority": "HIGH",
    "command": "<string>",
    "vehicle_id": "<string>",
    "timestamp_created": "2023-11-07T05:31:56Z",
    "timestamp_planned_execution": "2023-11-07T05:31:56Z",
    "timestamp_execution": "2023-11-07T05:31:56Z",
    "response": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Path Parameters

vehicle_id
string
required

ID of vehicle to send command to.

Body

application/json

Experimental: Will change in upcoming versions. A command that is sent to a vehicle, e.g., to turn on / off an actuator.

priority
enum<string>
required

Priority with which to send the command. LOW does not guarantee immediate delivery (might take until the IoT device next connects to the c.technology cloud). HIGH guarantees immediate delivery (within several seconds; as long as the IoT device has GSM/internet connectivity), but is not available by default. Please contact us if you require this.

Available options:
HIGH,
LOW
command
string
required

Command to send to the vehicle. UNLOCK, ON set the output state of the indicated pin to one (floating), LOCK, OFF to zero (0V).

Possible choices are:

  • UNLOCK
  • LOCK
  • DOUT1:ON
  • DOUT1:OFF
  • DOUT2:ON
  • DOUT2:OFF
  • DOUT3:ON
  • DOUT3:OFF
  • DOUT4:ON
  • DOUT4:OFF
  • setparam XZY
  • getparam XZY
  • getrecord
timestamp_planned_execution
string<date-time>

An execution date that might be at some point in the future, after which this command is sent to the vehicle.

Response

Successfully queued command.

header
API Header Single · object
required

Default header sent along with single-resource responses.

data
Vehicle Command · object
required

Experimental: Will change in upcoming versions. A command that is sent to a vehicle, e.g., to turn on / off an actuator.