Remote Command API¶
The Remote Command API allows you send commands to a remote charger and perform the following functions.
- Control charging activity
- Modify charger settings and configurations
API Usage¶
See Token Management API for more information on how to create and use the access token.
Remote Command¶
Prepare Request Body¶
Set the following path parameters to prepare the request body.
- Charger ID to
chargerId
. - Remote Command Type to
remoteCommandType
. - Additional body parameter for sending the payload. Refer the schema
RemoteCommandBody
for the additional body parameter details. For more information, see Remote Command API Reference.
Example Request¶
Note
Use the server URL applicable to your region. See API Reference for available server URLs applicable to your region.
export ACCESS_TOKEN = <YOUR_ACCESS_TOKEN>
export CHARGER_ID = <YOUR_CHARGER_ID>
export REMOTE_COMMAND_TYPE = <YOUR_REMOTE_COMMAND_TYPE>
export CONNECTOR_ID = <YOUR_CONNECTOR_ID>
export ID_TAG = <YOUR_ID_TAG>
curl --location --request POST 'https://api.eu.depot.emobility.io/v1/chargerControl/chargers/$CHARGER_ID/remoteCommands/$REMOTE_COMMAND_TYPE'
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $ACCESS_TOKEN' \
--data '{
"connectorId": $CONNECTOR_ID,
"idTag": $ID_TAG
}'
Response Body¶
Successful response returns 200 HTTP status code with response body as RemoteCommandResponse
schema. For more information, see Remote Command API Reference.
Example Response¶
{
"commandType": "startChargingSession",
"response": {
"status": "Accepted",
"message": "Operation successful: Start charging request has been accepted."
}
}
Example Responses¶
Http Code | Status | Message |
---|---|---|
200 | Accepted | Operation successful: Start charging request has been accepted. |
200 | Accepted | Operation successful: Stop charging request has been accepted. |
400 | Rejected | Operation denied: Rejected by the charger. |
400 | Operation denied: Invalid Payload. | |
404 | Operation denied: Charger is offline. | |
404 | Operation denied: Charger ID not found. | |
404 | Operation denied: Connector ID not found. | |
404 | Operation denied: No ongoing charging. | |
401 | Operation denied: Unauthorized IDTag. | |
500 | Operation failed: Internal server error. | |
408 | Operation failed: Timeout. |