Standard APIsConnectivity ManagementAPI EndpointsConnectivity CallbacksList Registered Callbacks
API Reference
Get a List of Registered Callback Listeners
Uses and Requirements
Returns the name and endpoint URL of the callback listening services registered for a given account.
Request
HTTP Request
GET https://thingspace.verizon.com/api/m2m/v1/callbacks/{accountname}
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 for which you want to start the SMS callback service. 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
Note: The response to this request only includes callback listeners that were registered through the Connectivity Management API.
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. |
| url | string | The address of the callback listening service where the ThingSpace Platform will send callback messages for the service type. |
| username | string | The username defined when a URL was registered for the callback service, or an empty string if no username was defined. |
| password | string | The password defined when a URL was registered for the callback service, or an empty string if no password was defined. |
The response body will be empty if there are no callback services registered with the account.
Example Success Response
[
{
"accountName": "0252012345-00001",
"serviceName": "CarrierService",
"url": "http://10.120.102.147:50569/CallbackListener/Carrier.asmx",
},
{
"accountName": "0252012345-00001",
"password": "drowssap",
"serviceName": "DeviceUsage",
"url": "http://10.120.102.147:50569/CallbackListener/Usage.asmx",
"username": "zaffod"
}
]Failure Responses
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}