Premium APIsDevice DiagnosticsAPI EndpointsDiagnostics Callbacks
API Reference
Get the Callback Information of Diagnostics Subscription
GET /callbacks?accountName={account}
Receive the registered callback information of an existing Diagnostics subscription.
Uses and Requirements
The user will be provided with the following callback information for their existing Diagnostics subscriptions:
- Account name
- Service name
- Endpoint (the URL of the user’s server)
- The user’s HTTP headers
- Date the request was created
Request Components
HTTP Request
GET https://thingspace.verizon.com/api/diagnostics/v1/callbacks?accountName={account}
Resource Path and Query Parameters
The account name must be included in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName required | string | The name of the billing account from which you want to delete callback messages. An account name is usually numeric, and must include any leading zeros. |
Header Parameters
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required | string | HTTP Authorization bearer token. |
| VZ-M2M-Token required | string | A valid session token returned by POST /session/login. |
| Content-Type required | string | Must be application/json. |
Request Body
None.
Success Responses
Status 200
| 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. |
| endpoint | string | The URL for your web server. |
| httpHeaders | string | Your http headers. |
| createdOn | string($date-time) | The date and time of when this request was created. |
Example Success Response
{
"accountName": "TestQAAccount",
"serviceName": "string",
"endpoint": "https://yourwebsite.com",
"httpHeaders": {},
"createdOn": "2019-09-07T23:57:53.292Z"
}Failure Responses
Status 400 All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}