Modify a Callback Listener URL

Modify a Callback Listener URL

PUT /callbacks/{acc}

Modifies the secure URL (HTTPS) at which an account receives messages from the Software Management FOTA callback service when new software versions are available and when upgrades start and finish.

This request replaces the previously registered FOTA callback listener if there is one.

Usage and Requirements

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.

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/fota/v2/callbacks/{acc}

Resource Path and Query Parameters

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.

Header Parameters

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.

Request Body

The body specifies the URL where the listening service is running.

Parameter Name Data Type Description
callback
required
string The secure 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.

Example Request Body

{
  "url": "https://255.255.11.135:50559/CallbackListener/FirmwareServiceMessages.asmx"
}

Success Responses

Status 200

Parameter Name Data Type Description
URL string The secure address on your server where you have enabled the listening service for Software Management Services callback messages.

Example Success Response

{
  "url": "https://255.255.11.135:50559/CallbackListener/FirmwareServiceMessages.asmx"
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.