Premium APIsDevice LocationAPI Reference

List Callback Listeners

Get a List of Registered Callback Listeners

GET /callbacks/{accountName}

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

HTTP Request

GET https://thingspace.verizon.com/api/loc/v1/callbacks/{accountName}

Resource and Query Parameters

The account name must be included in the path.

Parameter NameData TypeDescription
accountName (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

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter NameData TypeDescription
Authorization (required)stringHTTP Authorization bearer token:
Authorization: Bearer {token}.
VZ-M2M-Token (required)stringA valid session token returned by POST /api/m2m/v1/session/login.
Content-Type (required)stringMust be application/json Content-Type: application/json

Request Body

None.

Success Responses

Status 200

Parameter NameData TypeDescription
accountNamestringThe name of the billing account for which callback messages will be sent.
serviceNamestringThe 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 Location for the Device Location Service callback.
urlstringThe address of the callback listening service where the ThingSpace Platform will send callback messages for the service type.
usernamestringThe username defined when a URL was registered for the callback service, or an empty string if no username was defined.
passwordstringThe password defined when a URL was registered for the callback service, or an empty string if no password was defined.

**Note:**The response body will be empty if there are no callback services registered with the account.

Example Success Response

[
    {
        "accountName": "0000123456-00001",
        "serviceName": "Location",
        "url": "http://10.120.102.147:50569/CallbackListener/Location.asmx"
    },
    {
        "accountName": "0000123456-00002",
        "serviceName": "DeviceLocation",
        "url": "http://10.120.102.147:50569/CallbackListener/DeviceLocation.asmx"
    }
]

Failure Responses

All error messages are returned in this format:

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}

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

On this page