Batch & Campaign Operations
The IoT.live platform supports asynchronous operational workflows for executing large-scale connection management and automation tasks.
These workflows are commonly referred to as:
- Batch operations
- Campaign operations
- Async operational workflows
Batch and campaign APIs are designed to support:
- Large operational updates
- High-volume provisioning
- Mass lifecycle changes
- Bulk tagging
- Large export generation
[IMAGE PLACEHOLDER: Batch and campaign architecture]
Why asynchronous operations are used
Some operational requests may:
- Affect thousands of subscriptions
- Require provider-side processing
- Execute across multiple systems
- Take significant time to complete
In these scenarios, the platform processes operations asynchronously rather than returning immediate results.
Typical async workflows include:
- Rate plan migrations
- Bulk status changes
- Customer tagging updates
- Large exports
- Communication plan updates
Async operations may continue processing after the initial API response has been returned.
Async workflow lifecycle
Typical asynchronous processing follows this sequence:
- Submit the operational request
- Receive a pending or accepted response
- Operation enters background processing
- Campaign progress is tracked
- Final results become available
[IMAGE PLACEHOLDER: Async operation lifecycle]
editConnectionsAsync API
The primary asynchronous operational API is:
editConnectionsAsync
This API allows bulk operational updates to be queued and processed in the background.
Typical use cases include:
- Large-scale status changes
- Bulk rate plan updates
- High-volume operational changes
- Multi-provider updates
Example async request
Async operation responses
Asynchronous operations commonly return result values such as:
Result | Meaning |
|---|---|
Pending | Operation accepted and queued |
Success | Operation completed successfully |
Partially_Successful | Some records succeeded while others failed |
Failed | Operation failed |
Rejected | Request rejected |
Example async response:
Campaign processing
Campaign workflows are used to coordinate large operational tasks.
Campaign processing may include:
- Provider-side execution
- Retry handling
- Record-level validation
- Progress tracking
- Partial failure handling
The platform documentation references campaign APIs including:
- initiateOpsCampaign
- pauseOpsCampaign
- resumePausedOpsCampaign
- getOpsCampaignCurrentStatusSnapshot
[IMAGE PLACEHOLDER: Campaign processing dashboard]
Partial successes
Large operational campaigns may return:
Partially_Successful
This means:
- Some records completed successfully
- Some records failed validation or processing
Typical causes include:
- Provider restrictions
- Invalid identifiers
- Unsupported operations
- Subscription eligibility issues
- Temporary provider failures
Async operations should always be monitored until processing fully completes.
Batch import APIs
The platform also supports multipart upload APIs for large operational imports.
Documented batch APIs include:
batchEditConnections
These workflows are commonly used for:
- CSV-driven operational updates
- Bulk provisioning
- Large migrations
- Enterprise onboarding
[IMAGE PLACEHOLDER: Batch CSV import workflow]
Multipart upload workflows
Batch upload APIs may support:
- CSV uploads
- Multipart form submissions
- Large operational datasets
- Background processing
Typical imported operations include:
- Status updates
- Rate plan assignments
- Tagging updates
- Attribute updates
Monitoring async operations
Operational monitoring may include:
- Campaign status tracking
- Audit API review
- Export result analysis
- Error handling workflows
- Retry analysis
Recommended monitoring approaches include:
- Reviewing failed records
- Tracking provider responses
- Exporting operational results
- Monitoring async status APIs
[IMAGE PLACEHOLDER: Async monitoring workflow]
Export workflows
Large export operations may also execute asynchronously.
Documented export workflows include:
- Synchronous export mode
- Asynchronous export mode
- Report download APIs
Related APIs include:
- download/report
- exportConnections
- exportConnectionStats
- Usage export APIs
- Audit export APIs
Best practices
Recommended async integration practices include:
- Use meaningful campaign names
- Track correlation IDs consistently
- Monitor operations until completion
- Export failed records for analysis
- Retry failures carefully
- Avoid overlapping bulk updates unnecessarily
Execute large operational changes in smaller phases where possible to simplify monitoring and rollback handling.
Security considerations
Batch operations may affect:
- Large subscription groups
- Customer connectivity
- Billing workflows
- Provider lifecycle states
Recommended controls include:
- Restricting async operational permissions
- Validating datasets carefully
- Testing workflows in smaller pilot groups
- Logging operational activity externally
Large-scale async operations can immediately impact live production services and should be executed carefully.