POST /callbacks/{acc}
Registers a secure URL (HTTPS) at which an account receives messages from the Software Management Service FOTA callback service when new software versions are available and when upgrades start and finish. The messages are REST messages POSTed to the URL. You are responsible for creating and running a listening process on your server at that URL to receive and parse the messages.
This request replaces the previously registered FOTA callback listener if there is one.
The callback messages will conform to the JSON callback schema shown on the About Callback Services page. You can follow these instructions to create a simple callback listener that will report the callback type and display any received callbacks on the console.
POST https://thingspace.verizon.com/api/fota/v2/callbacks/{acc}
The account name must be included in the path.
Parameter Name | Data Type | Description |
---|---|---|
acc required |
string | The name of the billing account for which you want to receive callback messages. An account name is usually numeric, and must include any leading zeros. |
The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token, and must set the Content-Type to JSON.
Parameter Name | Data Type | Description |
---|---|---|
Authorization required |
string | HTTP Authorization request header containing a valid Bearer token. |
VZ-M2M-Token required |
string | A valid session token returned by a Connectivity Management POST /session/login request. |
The body specifies the URL where the listening FOTA callback service is running.
Parameter Name | Data Type | Description |
---|---|---|
url required |
string | The address on your server where you have enabled a listening service for Software Management Services callback messages. Specify a secure URL (HTTPS) that is reachable from the Verizon data centers. |
{
"url": "https://10.120.102.183:50559/CallbackListener/FirmwareServiceMessages.asmx"
}
Status 200
Parameter Name | Data Type | Description |
---|---|---|
url required |
string | The secure address on your server where you have enabled a listening service for Software Management Services callback messages. |
{
"url": "https://10.120.102.183:50559/CallbackListener/FirmwareServiceMessages.asmx"
}
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}