Network overview
Discover our set of APIs to supervise and consume network resources
Attach
This API gives you access to the history of location updates and the possibility to trigger a network detach.
By simplification, last attach corresponds to last location update for one specific SIM. Location updates information includes the following information:
- MCC: Mobile Country Code
- MNC: Mobile Network Code
- RAT: Radio Access Technology
- IMEI: International Mobile Equipment Identity
An update is usually triggered:
- When the device is switched on (but not always in reboots though)
- When the device moves to a new area (and connects to a new cell)
- When the device connects to another bearer type (ex: from LTE to 3G)
- At regular intervals to keep the connection active, as each operator requires devices to do so to stay connected (the duration of these intervals varies from operator to operator)
For more information, please refer to network attach procedure definition.
Location update history
Operation used to access location updates of the past 3 months for one specific SIM, even if there is no traffic.
Detach
Operation used to launch a network detach procedure by performing an HSS initiated cancel location. A new location update will be issued when the device triggers a new attach procedure.
⚠️ Launch of a new attach procedure may depend on device / modem own network behavior.
Data session
This API offers operations to access low level technical information on current active data session for a given MSISDN or IMSI.
Its purpose is to provide the current state of a subscriber data session if it exists. This service is dedicated to support teams for troubleshooting purposes.
SMS
This API offers the possibility of sending A2P SMS messages both on your fleet of subscribers (On-net) or outside it (Off-net).
Depending on your account settings, Off-net messaging may be restricted. Please contact your account manager to know more about this feature.
Message types
Both text and binary messages are supported.
- For text message, the content is expected in UTF-8 and as such non latin characters are supported as well
- For binary message, the content is expected as a Hexadecimal string
Originator
When sending your SMS message, you have the ability to specify the originator of the message. This originator could be:
- a number (MSISDN international format without +)
- a short number
- or a text
For network security reasons and to prevent abuses, any originator value must first be whitelisted and allowed for your account.
Please contact your account manager for any request regarding this configuration.
Message encoding
Our API supports automatic encoding based on your message content.
For latin characters, the standard GSM 7-bits encoding will be used automatically allowing to have up to 160 characters in a single SMS.
When non latin characters are included, the encoding will switch automatically to UCS-2 encoding in order to supports other languages, reducing the max number of characters to 70.
The encoding used to process your SMS, will be returned in our API response.
See Wikipedia for more information about SMS messages encodings.
Message segmentation
As a standard text SMS only supports up to 160 characters (when using standard GSM encoding), our API supports automatic segmentation which will allow you to send long SMS messages easily.
The number of segments generated by your SMS, will be returned in our API response.
Message retention
All your SMS messages will be stored for a period of 3 months during which you can consult their details. Past this delay, they will be automatically deleted.
Delivery report (DLR)
If you need to have a feedback on the delivery status of your SMS, you can request a delivery report (DLR). Doing so, you will have access to:
- The date of the report
- More importantly the status of the delivery:
delivered
: The SMS message was successfully delivered to the recipient's deviceexpired
: The SMS message was held and could not be delivered within the SMS validity perioddeleted
: The SMS message was deleted from the queue before being deliverederror
: The SMS message was not delivered
Send a SMS message
Operation used to send SMS message.
This operation supports text and binary SMS, On-net
and Off-net
(for text SMS only).
Optionally, delivery reports can be requested when sending SMS messages (by default no DLR will be provided).
If a DLR was requested, the DLR information (date and status) can either be:
- retrieved using our consultations operations (see below)
- received directly on your platform by subscribing to delivery report received event
Retrieve SMS messages
Operation used to search for SMS messages. This operation supports filtering, sorting and pagination.
Retrieve a given SMS message
Operation used to consult a given SMS message.
OTA
This API offers the possibility of sending OTA commands to SIM cards. Today we support one OTA command which triggers the switch from a public network to a private network.