Register a Callback for the ThingSpace Quality of Service API

POST /api/m2m/v1/callbacks/{accountName}

Use this endpoint to register QoS service and establish a callback server. There are also Callback Best Practices. For more detail and information, you can visit Register Callback Listener. The API endpoint can be tried here.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/callbacks/{accountName}

Resource Path and Query Parameters

Parameter Name Data Type Description
accountName
required		 string The name of a billing account. This value is numeric and must include any leading zeroes.

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

Request body parameters. All parameters listed are required unless marked "optional".

Parameter Name Data Type Description
name string

The name of the callback service that you want to subscribe to:

  • QoS
url string

The address on Enterprise server where you have enabled a listening service for the QoS callback messages/events

Specify a URL that is reachable from the Verizon data centers.

If Enterprise service is running on HTTPS, Enterprise should use a one-way authentication certificate with a white-listed IP address.

Example Request

{
  "name": "QoS",
  "url": "http://10.0.0.183:1234/CallbackListener/QosServiceMessages.asmx"
}

Success Responses

Status 200

{
  "accountName": "0000123456-00001",
  "serviceName": "QoS"
}

Response Parameters

Parameter Name Data Type Description
accountName
 string The name of a billing account. This value is numeric and must include any leading zeroes.
serviceName string The name of the callback service, which identifies the type and format of messages that will be sent to the registered URL.

Failure Responses

Status 400

All error messages are returned in this format:

    {
      "errorCode": "error code string",
      "errorMessage": "error message string"
    }