Get Registered Callback Listeners
GET /callbacks/{accountName}
Returns the name and endpoint URL of the callback listening services registered for a given account.
Header Parameters
The request header must set the content-type to JSON, 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 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. |
HTTP Request
GET https://thingspace.verizon.com/api/fota/v1/callbacks/{accountName}
Request Parameters
The account name must be included in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | The 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. |
Request Body
None.
Success Responses
Status 200 Example Success Response
[
{
"accountName":"0000123456-00001",
"serviceName":"DeviceProfileService",
"url":"undefined",
"username":"username",
"password":"password"
},
{
"accountName":"0000123456-00001",
"serviceName":"DeviceService",
"url":"http://webservice.location.azure.com:9001/callback/DeviceService/rest",
"username":"user",
"password":"password"
},
{
"accountName":"0000123456-00001",
"serviceName":"DiagnosticsService",
"url":"http://webservice.location.azure.com:9001/scef-monitoring/callback",
"username":"null",
"password":"null"
},
{
"accountName":"0000123456-00001",
"serviceName":"ExternalProvisioningChanges",
"url":"http://webservice.location.azure.com:9001/callback/StateService/rest"
},
{
"accountName":"0000123456-00001",
"serviceName":"NetworkEventService",
"url":"http://webservice.location.azure.com:9001/callback/StateService/rest"
},
{
"accountName":"0000123456-00001",
"serviceName":"StateService",
"url":"http://webservice.location.azure.com:9001/callback/StateService/rest"
}
] Success Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | string | The name of the billing account for which callback messages will be sent. |
| serviceName | string | The name of the callback service, which identifies the type and format of messages that will be sent to the registered URL. |
| url | string | The address of the callback listening service where ThingSpace will send callback messages for the service type. |
| username | string | The user name set for the listener. This may or may not be presented, based on how the listener is configured. |
| password | string | The password set for the listener. This may or may not be presented, based on how the listener is configured. |
Note: The response body will be empty if there are no callback services registered with the account. If a URL has not been set for the listener, the url will be "undefined".
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.