Devices

Devices

REST

The Devices API enables comprehensive management and interaction with SIM/Device-related data and operations.

Description

The Devices API provides functionality to access and manage SIM/Device information within the Vodafone IoT Platform. It allows client applications to retrieve SIM/Device data, manage configuration and credentials, monitor connectivity status, and support SIM/Device communication and lifecycle management. The API also enables efficient discovery and filtering of SIM/Device, supporting clearer operational visibility and easier integration with IoT management workflows.

Use Cases

The Devices API may be used by client applications wishing to:

Retrieve comprehensive device and SIM details, such as current SIM state, associated Customer Service Profile (CSP), data session information, registration status on the network, and eCall configuration details, helping applications understand the operational status of a device.

Search for and identify devices using unique identifiers (e.g. SIM or device identifiers), enabling efficient lookup and management of individual devices across large fleets.

Use retrieved device information to determine and perform subsequent management actions on SIMs or devices, such as lifecycle changes, configuration updates, messaging, or troubleshooting activities.

View the history and details of changes applied to a specific device, supporting auditability, transparency, and operational troubleshooting.

View details of device registration (SIM) on network, this in turn can help in diagnosing any issues related to device connectivity.

List and filter devices based on one or more device attributes, allowing customer applications to manage, monitor, and segment devices according to business‑relevant criteria.

Update and manage key device and SIM attributes, including state transitions, identifiers, customer profiles, base country assignment, static IP configuration, custom attributes, and eUICC profile information, ensuring device configurations remain accurate and aligned with business needs.

Manage and maintain eCall‑related parameters associated with devices, and support over‑the‑air updates with clear visibility of configuration status and progress.

Set and update device credentials securely, allowing devices to authenticate and interact correctly with network and application services.

Monitor SMS communication activity related to devices, providing visibility into messaging usage, delivery status, and communication behaviour across the fleet.

Send transactional or operational SMS messages to devices, enabling remote notifications, commands, or triggers as part of device management workflows.

Trigger device‑initiated data sessions, commonly used in scenarios such as smart metering or telemetry, to prompt devices to transmit data to backend systems with clear feedback on success or failure.

Resources

Key features

  • Search and identify devices using unique device or SIM identifiers.

  • List and filter devices based on configurable device attributes.

  • Update and manage device and SIM configuration parameters.

  • Track and view the history of changes applied to a device.

  • Monitor device registration and connectivity status on the network.

  • Manage eUICC and eCall configuration associated with devices.

  • Set and update device credentials securely.

  • View SMS communication overview for devices.

  • Send transactional and operational SMS messages to devices.

  • Trigger device‑initiated data sessions for telemetry and reporting use cases.