Register a Callback Listener URL

`POST /callbacks/{accountName}`

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 registered URL. The user is responsible for creating and running a listening process on a server at that URL to receive and parse the messages. 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

POST 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 Name	Data Type	Description
Authorization (required)	string	HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token (required)	string	A valid session token returned by a Connectivity Management `POST /session/login` request.
Content-Type (required)	string	Must be `application/json`.

Request Parameters

The accountName must be included in the path.

Parameter Name	Data Type	Description
accountName (required)	string	The name of the billing account to receive callback messages for. An `accountName` is numeric, and must include any leading zeros.
url (required)	string	The 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 body specifies the URL where the listening FOTA callback service is running. Example Request:

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

Success Response

Status 200 Example Response:

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

Success Parameters

Parameter Name	Data Type	Description
url	string	The secure address on a server where a 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.

# Register a Callback Listener URL ### `POST /callbacks/{accountName}` 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 registered URL. The user is responsible for creating and running a listening process on a server at that URL to receive and parse the messages. The callback messages will conform to the JSON callback schema shown on the [About Callback Services](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/working-with-verizon-wireless/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 [POST https://thingspace.verizon.com/api/fota/v3/callbacks/{accountName}](/docs/standard-apis/connectivity-management/api-endpoints/connectivity-callbacks/register-callback/registercallback) ## 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 Name|Data Type|Description| |-----|-----|-----| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## Request Parameters The `accountName` must be included in the path. |Parameter Name|Data Type|Description| |-----|-----|-----| | **accountName** *(required)* | string | The name of the billing account to receive callback messages for. An `accountName` is numeric, and must include any leading zeros. | | **url** *(required)* | string | The 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 body specifies the URL where the listening FOTA callback service is running. Example Request: ```json { "url": "https://10.120.102.183:50559/CallbackListener/FirmwareServiceMessages.asmx" } ``` ## Success Response **Status 200** Example Response: ```json { "url": "https://10.120.102.183:50559/CallbackListener/FirmwareServiceMessages.asmx" } ``` ## Success Parameters |Parameter Name|Data Type|Description| |-----|-----|-----| | **url** | string | The secure address on a server where a listening service for Software Management Services callback messages has been enabled. | ## Failure Responses All error messages are returned in this format: ```json { "errorCode": "error code string", "errorMessage": "error message string" } ``` Error codes and messages are listed on the [Error Messages page](https://thingspace.verizon.com/documentation/api-documentation.html#/http/software-management/guides/error-messages), along with explanations and suggestions for corrective actions.

Verizon 5G Edge API Portal

Register a Callback Listener URL