Send this phone a test push

POST

/push/test

curl --request POST \
  --url http://127.0.0.1:7700/api/push/test \
  --header 'Authorization: Bearer <token>'

• On the box itself (the default listen address)
• From another device, with a paired device token, when BOX_LISTEN allows it

A paired device only. One test every 10 seconds per device, so a phone cannot use up the box’s push allowance at the relay.

Authorizations

• deviceToken
• accessToken

Responses

200

Sent.

Media typeapplication/json

object

sent

integer

Allowed value: 1

Example

{
  "sent": 1
}

403

Not a paired phone.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}

409

Notifications are off on this phone, or remote access is off.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}

429

Another test within 10 seconds.

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}

502

The push was not sent, with the reason in a sentence, such as “The notification was not sent: the relay at box.example.com isn’t answering.”

Media typeapplication/json

object

error

required

What went wrong

string

Example ^generated

{
  "error": "example"
}