API Reference
Resume an eUICC Device
POST /v1/devices/profile/actions/device_resume
This API allows the customer to resume the entire device with all active eSIM profiles. All previously suspended profiles on the device would remain in the suspended state.
Bulk operation: Supported (There will be a set of callbacks per device: one for every profile and one final callback at the device level). For profiles that are already resumed, there would be an error callback "Profile is already resumed". Bulk operations have a limit of 10,000 requests. eSIM profiles: Both Verizon US and Global since this is a device level suspension.
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
HTTP Request
POST https://thingspace.verizon.com/api/m2m/v1//devices/profile/actions/device_resume
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| devices (required) | array | An array of deviceIds. Each deviceId will contain: id, kind. |
| id | string | The numeric value of the device ID type. |
| kind | string | The the type of device ID represented by the ID value. Only the following are supported by the request and both values must be present: eid - The Electronic ID of a device |
| accountName (required) | string | The name of the account. |
Request Body
Example request:
{
"devices": [
{
"deviceIds": [
{
"kind": "eid",
"id": "32-digit EID"
}
]
}
],
"accountName": "0000123456-00001"
}Success Response
Status 200
A successful response shows a system generated request ID to track the request.
Example Response:
{
"requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}Callback Response
These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services.
Example callback response:
{
"requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
"deviceIds":[
{
"id":"32-digit EID",
"kind":"Eid"
},
{
"id":"20-digit ICCID",
"kind":"Iccid"
}
],
"deviceResponse":{
"deviceProfileResponse":{
"deviceIdentifierCollection":[
{
"id":"32-digit EID",
"kind":"Eid"
},
{
"id":"20-digit ICCID",
"kind":"Iccid"
}
],
"state":"ACTIVE",
"servicePlan":"service plan name",
"profileStatus":"DISABLE",
"profileRole":"LEAD"
}
},
"status":"SUCCESS",
"callbackCount":1,
"maxCallbackThreshold":4
}Callback Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| requestId | string | The requestId being viewed. This is a system generated value from the request above. |
| deviceIds | array | An array of devices ID values associated with the ICCID being queried. Each deviceId will contain: id, kind. |
| id | string | The numeric value of the device ID. |
| kind | string | The the type of device ID represented by the ID value. This could include: iccid, eid. Note: because this is at the device level, EID and ICCID will be the only values used. |
| deviceResponse | array | Contains the deviceProfileResponse, status and number of callback records returned. |
| deviceProfileResponse | array | Contains the details and status of the device and the request. |
| deviceIdentifierCollection | array | Similar to deviceIds above. |
| state | string | The state of the device(s) responding. |
| servicePlan | string | The name of the service plan associated. |
| profileStatus | string | Indicates the profile state. |
| profileRole | string | This indicates if the profile is LEAD, LOCAL or DEFAULT. Note: If the device has multiple profiles associated, there will be a deviceProfileResponse for each profile. |
| status | string | The status of the deviceResponse. |
| callbackCount | string | The number of responses for deviceResponse found. |
| maxCallbackThreshold | string | The maximum number of responses for deviceResponse allowed. |
Failure Responses
All error responses will be in the following format
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}