JavaScript

import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun({
  apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.esims.import();

console.log(response.data);

import os
from mobilerun_sdk import Mobilerun

client = Mobilerun(
    api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.esims.import_()
print(response.data)

curl --request POST \
  --url https://api.mobilerun.ai/v1/numbers/esims/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "autoInstall": true,
  "carrierName": "<string>",
  "confirmationCode": "<string>",
  "countryCode": "<string>",
  "deviceId": "physedge-dev-8f3a2c",
  "idempotencyKey": "<string>",
  "lpaCode": "LPA:1$smdp.example.com$QR-MATCH-1",
  "matchingId": "<string>",
  "msisdn": "+33612345678",
  "name": "Mom's phone",
  "notes": "<string>",
  "smdpAddress": "smdp.example.com"
}
EOF

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'autoInstall' => true,
    'carrierName' => '<string>',
    'confirmationCode' => '<string>',
    'countryCode' => '<string>',
    'deviceId' => 'physedge-dev-8f3a2c',
    'idempotencyKey' => '<string>',
    'lpaCode' => 'LPA:1$smdp.example.com$QR-MATCH-1',
    'matchingId' => '<string>',
    'msisdn' => '+33612345678',
    'name' => 'Mom\'s phone',
    'notes' => '<string>',
    'smdpAddress' => 'smdp.example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mobilerun.ai/v1/numbers/esims/import"

	payload := strings.NewReader("{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/v1/numbers/esims/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mobilerun.ai/v1/numbers/esims/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "carrierName": "<string>",
    "countryCode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deviceUuid": "<string>",
    "iccid": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "msisdn": "<string>",
    "name": "<string>",
    "networkStatus": "degraded",
    "source": "stocked",
    "status": "in_stock",
    "subscriptionId": 123,
    "updatedAt": "2023-11-07T05:31:56Z",
    "cancellationScheduled": true,
    "checkoutUrl": "<string>",
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "exempt": true,
    "rentStatus": "not_applicable"
  }
}

{
  "data": {
    "checkoutUrl": "<string>",
    "esim": {
      "carrierName": "<string>",
      "countryCode": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deviceUuid": "<string>",
      "iccid": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "msisdn": "<string>",
      "name": "<string>",
      "networkStatus": "degraded",
      "source": "stocked",
      "status": "in_stock",
      "subscriptionId": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "cancellationScheduled": true,
      "checkoutUrl": "<string>",
      "currentPeriodEnd": "2023-11-07T05:31:56Z",
      "exempt": true,
      "rentStatus": "not_applicable"
    },
    "rentStatus": "awaiting_payment"
  }
}

{
  "message": "<string>",
  "reason": "out_of_stock",
  "success": false
}

{
  "message": "<string>",
  "reason": "out_of_stock",
  "success": false
}

Esims

Import a BYO (tenant-supplied) physical eSIM activation code

Registers a bring-your-own (BYO) eSIM activation code as owned inventory. Provide either { smdpAddress, matchingId?, confirmationCode? } or { lpaCode } — supplying both, or neither, returns 400. An optional name sets a display label on the created eSIM (up to 15 characters).

Subject to per-owner and daily import limits, and disabled entirely unless BYO imports are enabled for this deployment (409 byo_disabled). Idempotent via idempotencyKey: replaying the same key with an identical request returns the original response; the same key with a different request returns 409 idempotency_conflict.

When rent-first billing is off (default), the import is free — 201 with the eSIM. Setting autoInstall: true additionally dispatches an install immediately after import (deviceId may only be set together with autoInstall): this returns 202 with {esim, operationId, statusUrl} when the install claim succeeds (poll GET /esims/{id}/install-status), or 201 with the eSIM plus installDispatch: {ok: false, reason} when the install could not be dispatched — the import itself still succeeds either way.

When rent-first billing is on, import additionally requires available device capacity (409 device_pool_empty) and is subject to a per-owner awaiting-payment cap (409 byo_awaiting_payment_cap). On success the eSIM is created awaiting_payment and a checkout is started: 201 with {esim, rentStatus, checkoutUrl} when the checkout URL is ready immediately, or 202 with checkoutUrl: null otherwise — poll GET /esims/{id} until it’s populated. Once payment is confirmed, install is triggered automatically.

POST

numbers

esims

import

JavaScript

import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun({
  apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.esims.import();

console.log(response.data);

import os
from mobilerun_sdk import Mobilerun

client = Mobilerun(
    api_key=os.environ.get("MOBILERUN_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.esims.import_()
print(response.data)

curl --request POST \
  --url https://api.mobilerun.ai/v1/numbers/esims/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "autoInstall": true,
  "carrierName": "<string>",
  "confirmationCode": "<string>",
  "countryCode": "<string>",
  "deviceId": "physedge-dev-8f3a2c",
  "idempotencyKey": "<string>",
  "lpaCode": "LPA:1$smdp.example.com$QR-MATCH-1",
  "matchingId": "<string>",
  "msisdn": "+33612345678",
  "name": "Mom's phone",
  "notes": "<string>",
  "smdpAddress": "smdp.example.com"
}
EOF

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mobilerun.ai/v1/numbers/esims/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'autoInstall' => true,
    'carrierName' => '<string>',
    'confirmationCode' => '<string>',
    'countryCode' => '<string>',
    'deviceId' => 'physedge-dev-8f3a2c',
    'idempotencyKey' => '<string>',
    'lpaCode' => 'LPA:1$smdp.example.com$QR-MATCH-1',
    'matchingId' => '<string>',
    'msisdn' => '+33612345678',
    'name' => 'Mom\'s phone',
    'notes' => '<string>',
    'smdpAddress' => 'smdp.example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mobilerun.ai/v1/numbers/esims/import"

	payload := strings.NewReader("{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mobilerun.ai/v1/numbers/esims/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mobilerun.ai/v1/numbers/esims/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"autoInstall\": true,\n  \"carrierName\": \"<string>\",\n  \"confirmationCode\": \"<string>\",\n  \"countryCode\": \"<string>\",\n  \"deviceId\": \"physedge-dev-8f3a2c\",\n  \"idempotencyKey\": \"<string>\",\n  \"lpaCode\": \"LPA:1$smdp.example.com$QR-MATCH-1\",\n  \"matchingId\": \"<string>\",\n  \"msisdn\": \"+33612345678\",\n  \"name\": \"Mom's phone\",\n  \"notes\": \"<string>\",\n  \"smdpAddress\": \"smdp.example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "carrierName": "<string>",
    "countryCode": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deviceUuid": "<string>",
    "iccid": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "msisdn": "<string>",
    "name": "<string>",
    "networkStatus": "degraded",
    "source": "stocked",
    "status": "in_stock",
    "subscriptionId": 123,
    "updatedAt": "2023-11-07T05:31:56Z",
    "cancellationScheduled": true,
    "checkoutUrl": "<string>",
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "exempt": true,
    "rentStatus": "not_applicable"
  }
}

{
  "data": {
    "checkoutUrl": "<string>",
    "esim": {
      "carrierName": "<string>",
      "countryCode": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deviceUuid": "<string>",
      "iccid": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "msisdn": "<string>",
      "name": "<string>",
      "networkStatus": "degraded",
      "source": "stocked",
      "status": "in_stock",
      "subscriptionId": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "cancellationScheduled": true,
      "checkoutUrl": "<string>",
      "currentPeriodEnd": "2023-11-07T05:31:56Z",
      "exempt": true,
      "rentStatus": "not_applicable"
    },
    "rentStatus": "awaiting_payment"
  }
}

{
  "message": "<string>",
  "reason": "out_of_stock",
  "success": false
}

{
  "message": "<string>",
  "reason": "out_of_stock",
  "success": false
}

Authorizations

Authorization

string

header

required

Bearer token via Authorization header

Body

application/json

autoInstall

boolean

Rent OFF only: dispatch install-on-device immediately after a successful import. No-op when ESIM_BYO_RENT_ENABLED=true.

carrierName

string

Maximum string length: 100

confirmationCode

string

Maximum string length: 128

countryCode

string

Maximum string length: 8

deviceId

string

physedge device id to auto-install onto; requires autoInstall:true and rent OFF. Omit for a random pool device.

Minimum string length: 1

Example:

"physedge-dev-8f3a2c"

idempotencyKey

string

Client-supplied key; replaying the same key+request returns the original import instead of importing again

Required string length: 1 - 128

lpaCode

string

Full LPA activation code

Maximum string length: 512

Example:

"LPA:1$smdp.example.com$QR-MATCH-1"

matchingId

string

Maximum string length: 128

msisdn

string

Self-reported E.164 MSISDN for this eSIM's line — an unverified label, never used for routing

Required string length: 1 - 20

Example:

"+33612345678"

name

string | null

User-defined display label — NFC-normalized, up to 15 GRAPHEMES (not UTF-16 code units; an emoji/flag may span several). Omit/null/empty/whitespace-only leaves it unset.

Example:

"Mom's phone"

notes

string

Maximum string length: 500

smdpAddress

string

SM-DP+ activation host — bare hostname ONLY, no port/scheme/path.

Maximum string length: 255

Example:

"smdp.example.com"

Response

eSIM imported — plain eSIM, an inline-resolved rent checkout, or an eSIM with a failed autoInstall dispatch

data

object

required

Option 1
Option 2
Option 3

Show child attributes

⌘I

Phones

Mobilerun Proxy

Mobilerun Numbers

Mobilerun Mailbox

Mobilerun VA Chat

Tasks

Workflows

Webhooks

Import a BYO (tenant-supplied) physical eSIM activation code

Authorizations

Body

Response