Commands
Get accessibility status
Provides information if the vehicle is accessible to receive and process invocation commands together with a timestamp when it is or was accessible. If the accessible field is false, the vehicle needs to be started manually.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/command-accessibility
Scopes
openid
conve:command_accessibility
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.commands.accessibility.v1+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.
| Field | Description |
Field accessible | Description Status if the vehicle is accessible. Possible values: true, false. |
Field accessibleUntil | Description The timestamp in ISO-8601 format that the vehicle is accessible until it goes offline. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/command-accessibility' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.commands.accessibility.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'Get sent command details
Deprecated. This endpoint will be removed in the next version.
Used to get the details of an sent command referenced by the request id parameter.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/{id}
Scopes
openid
conve:commands
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.requestdetailresponse.v1+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.
| Field | Description |
Field status | Description Response status code. |
Field operationId | Description Id to log and track the request. |
Field data.created | Description Created date for the request. |
Field data.updated | Description The updated date when the request was able to be sent to the vehicle. |
Field data.command | Description The type of command. Possible values: CLIMATIZATION_START, CLIMATIZATION_STOP, ENGINE_START, ENGINE_STOP, FLASH, HONK_AND_FLASH, HONK, LOCK, UNLOCK. |
Field data.requestId | Description Request id of the request. |
Field data.invokeStatus | Description Status of the request sent to the vehicle. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, UNLOCK_TIME_FRAME_PASSED, UNABLE_TO_LOCK_DOOR_OPEN. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/5e62fd15-f92f-4d3a-91d2-e1432b4a52c1' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.requestdetailresponse.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'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/v1/vehicles/{vin}/commands
Scopes
openid
conve:commands
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.commandlist.v1+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.
| Field | Description |
Field command | Description Name of the commands available for a vehicle. |
Field href | Description URL of the specific command for a vehicle. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/commands' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.commandlist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'List sent commands
Deprecated. This endpoint will be removed in the next version.
Used to get a list of the active and past command-requests invoked against the vehicle.
get
https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests/
Scopes
openid
conve:commands
Headers
| Key | Description |
Key accept | Description The mediatype of what should be returned. The valid values are: application/vnd.volvocars.api.connected-vehicle.requestlist.v1+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.Query parameters
| Parameter | Description |
Parameter limit | Description The number of the items to display in each result set. Default is 50. |
Parameter after | Description An identifier to for the next page of the result. |
The query parameters are optional values to be added in the request URL.
Response body
The response’s data node provides the details for the queried request.
| Field | Description |
Field status | Description Response status code. |
Field operationId | Description Id to log and track the request. |
Field data.created | Description Created date for the request. |
Field data.updated | Description The updated date when the request was able to be sent to the vehicle. |
Field data.command | Description The type of command. Possible values: CLIMATIZATION_START, CLIMATIZATION_STOP, ENGINE_START, ENGINE_STOP, FLASH, HONK_AND_FLASH, HONK, LOCK, UNLOCK. |
Field data.requestId | Description Request id of the request. |
Field data.invokeStatus | Description Status of the request sent to the vehicle. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, UNLOCK_TIME_FRAME_PASSED, UNABLE_TO_LOCK_DOOR_OPEN. |
Field data.href | Description Direct URL of the request to see the details and status of the command. |
Field pagination.limit | Description Number of command results in the response. |
Field pagination.next | Description URL for the next page for the search result. |
Field cursor.after | Description Next cursor id for pagination. |
Examples
curl -v -X GET 'https://api.volvocars.com/connected-vehicle/v1/vehicles/{vin}/requests?limit=50&after=2537699f-e34e-4bef-9b78-0c56a52a2234' \
-H 'accept: application/vnd.volvocars.api.connected-vehicle.requestlist.v1+json' \
-H 'authorization: Bearer <your-access-token>' \
-H 'vcc-api-key: <your-vcc-api-key>'