eSIM packs and roaming eSIM
An eSIM is a SIM that is installed on a phone by scanning a QR code, so nothing is posted and nothing is inserted. MonoPbx offers two kinds: eSIM packs for your own mobile network, which you buy from the console and which register against your PBX, and roaming eSIMs that keep an extension reachable by VoLTE calls and SMS while the phone travels. This page covers both, with most of the detail on buying and installing packs. The partner roaming eSIMs with a data allowance, which need no radio or core of your own, are sold as Global eSIM.
For the surrounding setup (network settings, subscribers, VoLTE and VoWiFi) see VoLTE / VoNR (IMS mode). For the licence account that pays for the packs see Licence account sign-in and payment methods.
Buying eSIM packs for your own network
Open Numbers and trunks, Private 4/5G, eSIM. The page is for administrators who may view or change system settings; buying and the list of eSIMs need the permission to change them. Each eSIM you buy carries the network identity from your initial settings (MCC, MNC, IMS domain, identity formats and SMS centre number) and is written into the built-in subscriber database of this PBX, so it can register as soon as it is installed.
Before you can buy:
- On Network, save your MCC, MNC, the IMSI range and the other initial settings. Until then the Buy buttons stay disabled and the page offers Open the initial settings.
IMSI range
Every eSIM you buy gets the next free IMSI of the IMSI range in the initial settings: a First IMSI and a Last IMSI, each a full IMSI of 15 digits (MCC + MNC + MSIN). The form fills in the default range of your MCC and MNC, from MSIN 0…01 to the highest MSIN (for MCC 001 and MNC 01: 001010000000001 to 001019999999999; with a 3-digit MNC such as 001 the MSIN has 9 digits: 001001000000001 to 001001999999999), and the first save stores it. Leading zeros are part of every value: MCC 001, MNC 01 or 001 and an MSIN such as 0000000001 are kept exactly as typed, in the settings, the order, the eSIM profile, the subscriber database and the order e-mail.
- Both IMSIs must start with the MCC and the MNC, and the first must not be after the last. If you change the MCC or MNC, the form offers Rewrite the range for …, which replaces the first digits and keeps the MSINs.
- The range must keep every IMSI already given to an eSIM of this MCC and MNC: you can widen it, but not narrow it below an IMSI that was issued. IMSIs are never given twice, even after a failed order.
- IMSIs used by subscribers you added or imported yourself are skipped.
- An order that needs more IMSIs than are free in the range is refused; widen the range and order again.
- Sign in to your licence account from the Licence page (the eSIM page offers Go to the Licence page when you are not signed in).
- Make sure the account has a payment method. The page shows the card that will be charged, for example "Paying with Visa •••• 4242 (exp 12/28)". If there is none, choose Add a payment method; the account opens in a new tab and the page checks again when you return. Manage card and Update payment method open the same place.
Optionally set the SIM profile and the ICCID prefix first (see SIM profile and ICCID prefix).
Placing an order
The eSIM packs section lists the pack sizes with their prices, the price per eSIM, and marks the best value. Choose Buy on a pack. The confirmation names the number of eSIMs, the total and the card, and Buy and pay charges that card at once. A declined or expired card, insufficient funds, or a busy licence server each show a clear message; fix the payment method and try again.
Following the order
The order appears in the Orders table with its Status and Progress. The steps shown are Paid, building the eSIMs ("Building SIMs and uploading them to the SM-DP+: 3 of 10"), Delivering to this PBX and Imported into the HSS, ending with "Done: the SIMs are in the list below". You can leave the page: the PBX keeps following the order and imports the eSIMs by itself.
Each order shows a short order number. Copy puts the full number on the clipboard; it is the number on your receipt and the one support asks for. If an order fails, the table shows the reason. When money goes back to the card the order says Refunded or Partly refunded with the amount, or Refund in progress until the refund has been made.
The confirmation e-mail
When the eSIMs are ready, MonoPbx sends an e-mail to the address of the licence account that paid. The subject is "Your MonoPbx eSIMs are ready" with the short order number. It contains:
- the order number, the pack, the number of eSIMs and the amount paid;
- for each eSIM its ICCID, IMSI and activation code, with the QR codes attached as images or, for larger packs, in one attached archive, plus a table of the eSIMs as a CSV file; for the largest packs only the table is attached and you enter the activation codes by hand;
- short instructions for installing on a phone;
- a link to the order in your account.
If some eSIMs could not be created, the e-mail says how many were delivered and that the rest is refunded to the card you paid with. A second e-mail confirms the refund. The e-mail is sent in English, Spanish or Russian. Treat the activation codes like passwords: anyone who has one can install that eSIM.
Delivering the eSIMs to people
In the eSIMs table you see each eSIM with its ICCID, IMSI, phone number, Activation code and its state in the HSS (Active, Suspended, Not in the HSS or Not known here).
- Open the row's ... menu, choose Show QR code and show the window to the person (or send them the QR image from the e-mail). Close the window when done.
- On the phone: Settings, Mobile (Cellular), Add eSIM, scan the QR code. Or choose to enter the details manually and type the activation code.
- Tie the eSIM to an extension, as for any SIM, under IMS subscribers (see Subscribers). The linked extension is the one that rings the handset.
Each eSIM can be installed on one device once. A lost or deleted eSIM cannot be issued again: buy a new one.
Self-service install from the app
Once an eSIM's subscriber is tied to a user's extension, that user sees it under My eSIMs in the MonoPhone app and can get its activation code there once (see My eSIMs). Each attempt is recorded in the company's audit log, and each eSIM accepts 5 install attempts per hour. If the person needs it again (a new phone), issue the install again: they then have 7 days to install it. Revoke stops the app from handing it out; a profile already on a phone stays there, so suspend the subscriber to stop the line. Whether the profile itself can be downloaded again depends on the eSIM provider. The user can also open My eSIMs in the web console and scan a QR code from there.
eSIM assignments
Open Numbers and trunks, eSIM assignments. The page lists every eSIM of this PBX, company eSIMs and sponsored ones, with:
- its number, its company and whether it is in the subscriber database yet;
- the extension and user it is assigned to;
- its install state: Ready to install, Handed out (with how many times and when), Revoked, Re-issue expired (issued again but not installed within 7 days) or No downloadable profile (install it for the user yourself);
- Last seen: when the eSIM last registered with this PBX, and for a sponsored eSIM also when the licence server last reported it on a mobile network (whichever is later, with where it was seen), or Never. It is the quickest way to tell whether an installed eSIM works. The licence server's time is stored when the user opens My eSIMs, so a sponsored eSIM that never registers here may show Never until then.
System administrators who may change system settings can, per eSIM:
- In the row's ... menu, Assign it (a window asks for the extension) to an extension of the company the console works in, or Unassign it. For a company eSIM this ties its subscriber to the extension: calls to the extension also ring the phone, and the extension's user sees the eSIM under My eSIMs. Moving an eSIM to another user lets that user install it. Unassigning keeps the subscriber and its keys; suspend the subscriber to stop the line. Sponsored eSIMs are attached the same way as on the Global eSIM SIMs page.
- Send install link: tells the assigned user that the eSIM is ready, in their language, by a chat message in their own read-only "My eSIMs" conversation, by a phone notification ("Your eSIM is ready to install"; a tap opens Settings, My eSIMs in MonoPhone directly; it replaces the chat notification of that message, so the person is notified once) and/or by e-mail through the company's mail provider. The notification has no text beyond its title and no number or code. The message links to the My eSIMs page of the web console (your company's preferred web address when one is verified) and explains where to find it in MonoPhone; it never contains the activation code. The answer says what each channel did (sent, not set up, failed); the phone notification counts as "not set up" when the user has no phone with notifications. The link can only be sent while the user can install the eSIM: after they got it, Issue again first.
- Issue again and Revoke, as described above.
Every change and every link sent is recorded in the company's audit log (esim.assigned, esim.unassigned, esim.install_link_sent; and esim.data_switched when a user switches mobile data of their sponsored eSIM, see My eSIMs). The same actions are in the API: GET /api/v1/system/esims, PUT and DELETE /api/v1/system/esims/{iccid}/assignee, POST /api/v1/system/esims/{iccid}/install/send, .../install/reissue and .../install/revoke.
The one-time key file
To load the same eSIMs into another core network, choose Download key file on an order. A confirmation ("Download the key file once") explains that the file holds the keys and PINs and that the PBX deletes its own copy after the download. Afterwards a second attempt answers that the file is gone, so store it safely. Only system administrators can download it, and the download is recorded in the audit log.
Roaming eSIM
Roaming eSIMs are plug-and-play eSIMs with data bundles that work in many countries. While the phone roams on partner networks (sponsored roaming, so you do not sign agreements network by network), the eSIM registers your MonoPbx extension for VoLTE calls and SMS. People keep reaching the person on the same number, and calls and messages come through the PBX as usual.
What you need:
- a phone that supports eSIM and VoLTE;
- the eSIM tied to an extension.
What the administrator does: tie the eSIM to the person's extension as a subscriber, under IMS subscribers, as for the packs above. The extension then rings the phone abroad, and the phone's own calls and SMS use the PBX.
Limits and notes
- Buying needs an account with a payment method on file, a saved MCC, MNC and IMSI range, and the permission to change system settings.
- Orders are charged to the card when you confirm. There is no way to buy without a card.
- The history of your orders and eSIMs is shown even if this PBX lost its own copy, but the keys are kept only in the built-in subscriber database or in the key file.