Checks whether specified devices are registered by the manufacturer with the Verizon network and are available to be activated. The information is returned in a callback response, so you must register a URL endpoint to receive DeviceService callback messages using POST /callbacks.
See also:
Retrieve Device Information
Activate Devices
You can use this request to find out about the existence and status of these types of devices:
POST https://thingspace.verizon.com/api/m2m/v1/devices/availability/actions/list
None.
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. |
The request body identifies the device and reporting period that you want included in the report.
| Parameter Name | Data Type | Description |
|---|---|---|
| devices required |
array of deviceIds objects | A list of up to 2,000 deviceIds objects containing the devices and SIMS that you want to search for in the Verizon database. Each deviceIds object will have a corresponding element in the callback response.To search for a 4G device and SIM pairing, include both the IMEI and ICCID in the same deviceIds object. |
kind,
id required |
strings | The type and value of the device identifier.
|
| accountName required |
string | The name of the account that you want the callback response sent to. An account name is usually numeric, and must include any leading zeros. |
{
"accountName":"0212345678-00001",
"devices":[
{
"deviceIds":[
{
"kind":"meid",
"id":"A100008385E561"
}
]
},
{
"deviceIds":[
{
"kind":"iccid",
"id":"84258000000891490087"
}
]
},
{
"deviceIds":[
{
"kind":"imei",
"id":"990005350342573"
},
{
"kind":"iccid",
"id":"82458000000984190032"
}
]
}
]
}
Status 200
| Parameter Name | Data Type | Description |
|---|---|---|
| requestId | string | A unique string that associates the request with the results that are sent via a callback message. ThingSpace will send a separate callback message for each device that was in the request indicating whether the operation succeeded for that device. All of the callback messages will have the same requestId. |
{"requestId": "595f5c44-c31c-4552-8670-020a1545a84d"}
The callback contains an array of deviceInfo objects, one for each device in the request. Each deviceInfo object contains these values:
| Parameter Name | Data Type | Description |
|---|---|---|
| id | string | The value of the device identifier. |
| kind | string | The type of the device identifier: ESN, ICCID, IMEI, or MEID. |
| deviceSku | string | The SKU of the device. May not be present for ICCIDs. |
| productType | string | The general type of the device. May not be present for ICCIDs. |
| deviceFound | Boolean | True if the device has been registered with Verizon by the manufacturer. |
| deviceSimPair | Boolean | True for IMEIs or ICCIDs from 4G devices with embedded SIMs; false for other 4G devices. This parameter may not be included for 3G devices. |
| associatedWithMtn | Boolean | True for ICCIDs if the device is associated with a line of service. False for all other device identifiers. |
This response includes the four devices from the example request, each representing different scenarios:
{
"username":"",
"password":"",
"requestId":"595f5c44-c31c-4552-8670-020a1545a84d",
"deviceResponse":{
"checkDeviceAvailabilityResponse":{
"deviceInfo":[
{
"device":[
{
"id":"A100008385E561",
"kind":"MEID",
"deviceSku":"SMB311ZKA",
"productType":"BasicPhone",
"deviceFound":true
}
],
"associatedWithMTN":true
},
{
"device":[
{
"id":"990005325735034",
"kind":"IMEI",
"deviceSku":"VZW090000450004",
"productType":"Modem",
"deviceFound":true
},
{
"id":"89148000000842590078",
"kind":"ICCID",
"deviceFound":true
}
],
"associatedWithMTN":true,
"deviceSimPair":true
},
{
"device":[
{
"id":"84258000000891490087",
"kind":"ICCID",
"deviceFound":false
}
],
"associatedWithMTN":false,
"deviceSimPair":false
},
{
"device":[
{
"id":"990005350342573",
"kind":"IMEI",
"deviceSku":"VZW090000450004",
"productType":"Modem",
"deviceFound":true
},
{
"id":"82458000000984190032",
"kind":"ICCID",
"deviceFound":true
}
],
"associatedWithMTN":true,
"deviceSimPair":true
},
],
"accountName":"0212345678-00001"
}
},
"callbackCount":1,
"maxCallbackThreshold":4
}
Status 400
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}
Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.