Unconfirmed commands

The SMS commands still queued for a tracker, and a way to clear the queue.

A command sent to a device by SMS waits in a queue until the device confirms it. These two operations work on that queue: one counts what is still waiting, the other clears it.

Clearing discards the commands rather than sending them, so anything the device was waiting for never arrives.

API actions

API base path: /tracker/command/unconfirmed.

---

Count queued SMS commands

post

/tracker/command/unconfirmed/count

Get how many SMS commands are still waiting in a tracker's queue. Available to demo accounts.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body

tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456

Responses

200

The queue length

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

countintegerOptional

Unconfirmed commands waiting in the queue.

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

403

Error 204: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended.

application/json

default

Error response object

application/json

post/tracker/command/unconfirmed/count

POST /v2/tracker/command/unconfirmed/count HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "tracker_id": 123456
}

{
  "success": true,
  "count": 0
}

Errors

These errors come in addition to the general error codes:

• 204 - No tracker with this ID belongs to the account.

• 208 - The tracker exists but is blocked, normally because its tariff ended.

---

Required sub-user rights: tracker_update.

Clear the SMS command queue

post

/tracker/command/unconfirmed/reset

Discard every pending SMS command for a tracker. The commands are dropped, not sent, so anything the device was waiting for will never arrive.

Requires the tracker_update right.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body

tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456

Responses

200

The queue was cleared

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

403

Error 204: no tracker with this ID belongs to the account. Error 208: the tracker exists but is blocked, normally because its tariff ended.

application/json

default

Error response object

application/json

post/tracker/command/unconfirmed/reset

POST /v2/tracker/command/unconfirmed/reset HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "tracker_id": 123456
}

{
  "success": true
}

Errors

These errors come in addition to the general error codes:

• 204 - No tracker with this ID belongs to the account.

• 208 - The tracker exists but is blocked, normally because its tariff ended.