Skip to navigation
ProxyCommands

Read the status of an OCPP command

Reads the lifecycle of a command sent with POST /proxy/ocpp/commands/{command}, by the tracking_id from its response: queued, sent, then completed, failed or timeout, with the charger’s response payload or error once it answers. Pass charge_point_id when two chargers reused the same OCPP message id. 404 if the tracking id is unknown for this organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

tracking_idstringRequired1-36 characters

tracking_id from the send response.

Query parameters

charge_point_idstring or nullOptional1-255 characters
Disambiguates when two chargers reused the same OCPP message id.

Response

Successful Response
tracking_idstring
statusstring
created_atdatetime
charge_point_idstring or nullOptional
actionstring or nullOptional
reasonstring or nullOptional
messagestring or nullOptional
final_resultstring or nullOptional
authorization_referencestring or nullOptional
client_correlation_idstring or nullOptional
transaction_idstring or nullOptional
sent_atdatetime or nullOptional
deliveryenumOptionalDefaults to unconfirmed
Allowed values:
delivered_atdatetime or nullOptional
completed_atdatetime or nullOptional
timeout_atdatetime or nullOptional
attempt_countintegerOptionalDefaults to 0
response_payloadmap from strings to any or nullOptional
error_codestring or nullOptional
error_descriptionstring or nullOptional

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error