Standard APIsGlobal IoT Orchestration
Quick API Reference
Global IoT Orchestration Quick APIs Reference
You can find the Quick Reference for Global IoT Orchestration API Endpoints to help you manage Verizon US eSIM profiles and the global (local carrier) eSIM profiles here. You must first activate a Verizon US eSIM profile before downloading and enabling a global eSIM profile as outlined below:
See the table for a list of APIs for managing both Verizon US (lead carrier) eSIM profiles and global (local carrier) eSIM profiles. Please note that Verizon US eSIM profiles must be bootstrapped to the IoT devices and cannot be deleted from the IoT devices.
✔ = Supported N/A = Not applicable
Managing eSim Profiles
| Http Request | Description | Verizon US eSIM Profile | Global eSIM Profile | Bulk Operation Support |
|---|---|---|---|---|
| POST /m2m/v1/devices/profile/actions/activate | Activate/Reactivate a Global eSIM Profile | ✓ | ✓ | ✓ |
| POST /m2m/v1/devices/profile/actions/enable | Enable a Global eSIM Profile | ✓ | ✓ | ✓ |
| POST /m2m/v1/devices/profile/actions/deactivate | Deactivate a Global eSIM Profile | ✓ | ✓ | ✓ |
| POST /devices/profile/actions/setfallbackattribute | Set Fallback Attributes | ✓ | ✓ | N/A |
| POST /m2m/v1/devices/profile/actions/download_enable | Download_Enable a Global eSIM Profile | N/A | ✓ | ✓ |
| POST /m2m/v1/devices/profile/actions/download | Download a Global eSIM profile | N/A | ✓ | ✓ |
| POST /m2m/v1/devices/profile/actions/delete | Delete a Global eSIM Profile | N/A | ✓ | ✓ |
Device SMS Messaging
| Http Request | Description | Verizon US eSIM Profile | Global eSIM Profile | Bulk Operation Support |
|---|---|---|---|---|
| POST /m2m/v1/sms | Send an SMS Message to Devices | ✓ | ✓ | ✓ |
| GET /m2m/v1/sms/{accountName}/history | Get SMS Messages | ✓ | ✓ | ✓ |
| PUT /m2m/v1/sms/{accountName}/startCallbacks | Start an SMS Callback | ✓ | ✓ | ✓ |
| POST /m2m/v1/devices/sms/history/actions/list | Retrieve SMS Event History | ✓ | ✓ | N/A |
Device Actions
| Http Request | Description | Verizon US eSIM Profile | Global eSIM Profile | Bulk Operation Support |
|---|---|---|---|---|
| GET /accounts/{accountName} | Retrieve Account Information | ✓ | ✓ | ✓ |
| GET /plans/{accountName} | Retrieve the List of Service Plans | ✓ | ✓ | ✓ |
| POST /devices/usage/actions/list | Retrive Daily Usage | ✓ | ✓ | ✓ |
| POST /devices/usage/actions/list/aggregate | Retrieve Aggregate Usage | ✓ | ✓ | ✓ |
| POST /v2/devices/actions/list | Retrieve the Global Device List | ✓ | ✓ | ✓ |
| POST /v2/devices/history/actions/list | Retrieve Device Provisioning History | ✓ | ✓ | N/A |
| GET /v2/accounts/{accountName}/requests/{requestID}/status | Get the Status of an Asynchronous Request | ✓ | ✓ | N/A |