POST /callbacks

Registers a URL at which an account receives asynchronous responses and other messages from a ThingSpace Platform callback service. The messages are REST messages. You are responsible for creating and running a listening process on your server at that URL to receive and parse the messages.

Contents

See also:

• GET /callbacks - Find registered listeners for an account
• DELETE /callbacks - Deregister (delete) listeners for an account

Request Components

A vz-m2m-token is required to use these APIs. To obtain a token, please visit Getting Started to get a token.

HTTP Request

POST https://thingspace.verizon.com/api/hyper-precise/v1/callbacks?accountNumber={accountNumber}

Request Parameters

td>string td>string

Request Body

Example request:

[
  {
    "aname": "string",
    "name": "string",
    "url": "string"
  }
]

Success Response

Status 200

A successful response will display the billing account number (aname), the name of the callback service (name) and the address of the callback listening service (url).

Example response:

[
  {
    "aname": "string",
    "name": "string",
    "url": "string"
  }
]

Failure Responses

{
  "errorCode": "INVALID_PARAMETER",
  "errorMessage": "Device Not Found, Request will be queued"
}

{
  "errorCode": "INVALID_ACCESS",
  "errorMessage": "The access policy denied the resource operation for this user"
}

{
  "errorCode": "INVALID_PARAMETER",
  "errorMessage": "Device Not Certified"
}

{
  "errorCode": "INVALID_PARAMETER",
  "errorMessage": "Device inactive"
}

{
  "errorCode": "INVALID_PARAMETER",
  "errorMessage": "Service Not Purchased"
}

{
  "errorCode": "INTERNAL_ERROR",
  "errorMessage": "Device is active in several accounts"
}