Premium APIsSoftware ManagementSoftware Management V3API Reference Pages V3

Modify a Callback Listener URL

PUT /callbacks/{accountName}

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. The callback messages will conform to the JSON callback schema shown on the About Callback Services page. These instructions can be followed to create a simple callback listener that will report the callback type and display any received callbacks on the console. Note: This request replaces the previously registered FOTA callback listener, if there is one.

HTTP Request

PUT https://thingspace.verizon.com/api/fota/v3/callbacks/{accountName}

Header Parameters

The request header must contain a current ThingSpace authorization token, set the content to "JSON" and a current VZ-M2M-session token.

Parameter NameData TypeDescription
Authorization (required)stringHTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token returned by a Connectivity Management POST /session/login request.
Content-Type (required)stringMust be application/json.

Request Parameters

The accountName must be included in the path.

Parameter NameData TypeDescription
accountName (required)stringThe name of the billing account to receive callback messages for. An account name is numeric, and must include any leading zeros.
url (required)stringThe secure address on a server where a listening service for Software Management Services callback messages has been enabled. This is a secure URL (HTTPS) that is reachable from the Verizon data centers.

Request Body

The request body specifies the URL where the listening service is running. Example Request Body:

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

Success Responses

Status 200 Example Response:

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

Success Parameters

Parameter NameData TypeDescription
URLstringThe secure address on a server where the listening service for Software Management Services callback messages has been enabled.

Failure Responses

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.

On this page