With this API call the device or software service requests the MQTT URL for the location that it needs to connect. To determine the proper URL the device or software service needs to provide its ID (the one that was provided in the registration request), location (GPS coordinates), and whether it is on the Verizon cellular network or not.
Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.
thingspace_oauth sessionToken Access/Bearer token needed to authorize the user. The Bearer/Access Token should be acquired by using the ThingSpace Portal (thingspace.verizon.com). For details on how to obtain the token please refer to the
In: header
This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the
In: header
The VendorID set during the Vendor registration call.
^[a-zA-Z0-9]+$length <= 64Optional transaction identifier for tracing requests. If not provided, the application will generate one.
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$uuid36 <= length <= 36application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request for /clients/connection. It requires the device ID acquired in the registration request call; the geolocation of the device at the time of the request; and the network type (Verizon or non-Verizon). The system uses this information to determine with MQTT endpoint the device should use to connect the ETX Message Exchange.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/clients/connection" \ -H "VendorID: VerizonETX" \ -H "Content-Type: application/json" \ -d '{ "DeviceID": "976c4bad-03d3-4dcb-9688-ee57db7890e4", "Geolocation": { "Latitude": 42.36, "Longitude": -71.06 }, "NetworkType": "non-VZ" }'{ "MqttURL": "mqtt://imp-nyc-1.prod-us-east-1.thingspace.verizon.com:8883", "Host": "imp-nyc-1.prod-us-east-1.thingspace.verizon.com", "Port": 8883}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}{ "error": "Error Summary", "description": "Error Description"}The generated ID (UUID v4) for the device. It can be used as:
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$uuid36 <= length <= 36Geolocation of the device at the time of the connection request in GPS coordinates.
The type of the device's network connection at the time of the request. If the device is on the Verizon cellular network it should use the "VZ" value otherwise the "non-VZ" value.
Devices on the Verizon network can directly access the ETX Message Exchange on the MEC (Mobile Edge Compute server)
Value in