POST /v1/devices/profile/actions/profile_resume
This API allows the customer to resume the suspended Verizon US eSIM profile or Global eSIM profile based on ICCID and contracted service plan. The previously suspended eSIM profile will be resumed.
Bulk operation: Supported (The callback would be one for each profile). Bulk operations have a limit of 10,000 requests.
eSIM profiles: Both Verizon US and Global.
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 |
---|---|---|
Parameter NameAuthorization required |
Data Typestring | Description HTTP Authorization bearer token: |
Parameter NameVZ-M2M-Token required |
Data Typestring | Description A valid session token: |
Parameter NameContent-Type required |
Data Typestring | Description Must be application/json: |
POST https://thingspace.verizon.com/api/m2m/v1//devices/profile/actions/profile_resume
Parameter | Data Type | Description |
---|---|---|
Parameter devices |
Data Typearray | Description An array of deviceIds. Each deviceId will contain:
|
Parameter id |
Data Typestring | DescriptionThe numeric value of the device ID type. |
Parameter kind |
Data Typestring | Description 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:
|
ParameteraccountName required |
Data Typestring | DescriptionThe name of the account. |
ParameterservicePlan | Data Typestring | DescriptionUse the Verizon ServicePlan when performing an action on the Verizon network and use the Global servicePlan when performing action for Global. |
Example request:
{
"devices": [
{
"deviceIds": [
{
"kind": "iccid",
"id": "20-digit ICCID"
}
]
}
],
"accountName": "0000123456-00001",
"servicePlan": "service plan name"
}
Status 200
A successful response shows a system generated request ID to track the request.
Example Response:
{
"requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}
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":"15-digit IMEI",
"kind":"Imei"
},
{
"id":"1+ 10-digit phone number",
"kind":"msisdn"
},
{
"id":"20-digit ICCID",
"kind":"Iccid"
}
],
"deviceResponse":{
"deviceProfileResponse":{
"deviceIdentifierCollection":[
{
"id":"32-digit EID",
"kind":"Eid"
},
{
"id":"15-digit IMEI",
"kind":"Imei"
},
{
"id":"1+ 10-digit phone number",
"kind":"msisdn"
},
{
"id":"20-digit ICCID",
"kind":"Iccid"
}
],
"state":"ACTIVE",
"profileStatus":"ENABLE",
"profileRole":"LOCAL"
}
},
"status":"SUCCESS",
"callbackCount":1,
"maxCallbackThreshold":4
}
Parameter | Data Type | Description |
---|---|---|
ParameterrequestId | Data Typestring | DescriptionThe requestId being viewed. This is a system generated value from the request above. |
ParameterdeviceIds |
Data Typearray | Description An array of devices ID values associated with the ICCID being queried. Each deviceId will contain:
|
Parameter id |
Data Typestring | DescriptionThe numeric value of the device ID. |
Parameter kind |
Data Typestring | Description The the type of device ID represented by the ID value. This could include:
|
ParameterdeviceResponse | Data Typearray | DescriptionContains the deviceProfileResponse, status and number of callback records returned. |
ParameterdeviceProfileResponse | Data Typearray | Description Contains the details and status of the device and the request. |
Parameter deviceIdentifierCollection | Data Typearray | DescriptionSimilar to deviceIds above. |
Parameter state | Data Typestring | DescriptionThe state of the device(s) responding. |
Parameter profileStatus | Data Typestring | Description Indicates the profile state. |
Parameter profileRole | Data Typestring | DescriptionThis indicates if the profile is LEAD, LOCAL or DEFAULT. |
Parameterstatus | Data Typestring | DescriptionThe status of the deviceResponse. |
ParametercallbackCount | Data Typestring | DescriptionThe number of responses for deviceResponse found. |
ParametermaxCallbackThreshold | Data Typestring | DescriptionThe maximum number of responses for deviceResponse allowed. |
All error responses will be in the following format
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}