APIs/Connected Vehicle APIVersion 2
APIs/Connected Vehicle APIVersion 2

Commands

List commands

Used to list the commands which can be sent to the vehicle. Each command can then be used in the respective endpoint. See below example response with list of commands.

get

https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/commands

Scopes

  • openid

  • conve:commands

Headers

KeyDescription

Key

accept

Description

The mediatype of what should be returned. The valid values are: application/json

Key

authorization

Description

The access token issued by Volvo ID identity system.

Key

vcc-api-key

Description

Your application’s VCC API Key.

All these header values are mandatory. They must exist in every request.

Response body

The response’s data node provides the details for the queried request.

FieldDescription

Field

command

Description

Name of the commands available for a vehicle.

Field

href

Description

URL of the specific command for a vehicle.

Examples

curl -X GET 'https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/commands' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'

Get accessibility status

Check if vehicle is accessible for receiving invocation commands. If not available an unavailability reason is displayed.

get

https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/command-accessibility

Scopes

  • openid

  • conve:command_accessibility

Headers

KeyDescription

Key

accept

Description

The mediatype of what should be returned. The valid values are: application/json

Key

authorization

Description

The access token issued by Volvo ID identity system.

Key

vcc-api-key

Description

Your application’s VCC API Key.

All these header values are mandatory. They must exist in every request.

Response body

The response’s data node provides the details for the queried vehicle data.

FieldDescription

Field

availabilityStatus.value

Description

Status if the vehicle is available. Possible values: UNSPECIFIED, AVAILABLE, UNAVAILABLE

Field

availabilityStatus.unavailableReason

Description

The reason why the vehicle is not available. Possible values: UNSPECIFIED, NO_INTERNET, POWER_SAVING_MODE, CAR_IN_USE

Field

availabilityStatus.timestamp

Description

Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle.

Examples

curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/command-accessibility' \
-H 'accept: application/json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'

/