Premium APIsSoftware ManagementSoftware Management V1API Reference V1

Get the callback listener

Get Registered Callback Listeners:

GET /callbacks/{account}

Returns the name and endpoint URL of the callback listening services registered for a given account.

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/fota/v1/callbacks/{account}

Resource and Query Parameters

The account name must be included in the path.

Parameter NameData TypeDescription
account (required)stringThe name of the account for which a list of registered callback services will be returned. An account name is usually numeric, and must include any leading zeros.

Header Parameters

Parameter NameData TypeDescription
Authorization (required)stringHTTP Authorization bearer token: Authorization: Bearer {token}
VZ-M2M-Token (required)stringA valid session token: VZ-M2M-Token: {M2Mtoken}
Content-Type (required)stringMust be application/json Content-Type: application/json

Request Body

None.

Success Responses

Status 200

Parameter NameData TypeDescription
anamestringThe name of the billing account for which callback messages will be sent.
namestringThe name of the callback service, which identifies the type and format of messages that will be sent to the registered URL. The value will be Fota for the Software Management Services callback.
urlstringThe address of the callback listening service where ThingSpace will send callback messages for the service type. The response body will be empty if there are no callback services registered with the account.

Example Success Response

[
  {
    "aname": "0252012345-00001",
    "name": "Fota",
    "url": "http://10.120.102.183: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.

On this page