Перейти к основному содержанию
GET
/
v2
/
b2b
/
fulfilment
/
esims
/
{iccid}
Получение данных eSIM
curl --request GET \
  --url https://api.phoenixpass.space/v2/b2b/fulfilment/esims/{iccid}
{
  "iccid": "8948010000000000000",
  "msisdn": "79991234567",
  "activation_code": "K2-1JL8YT-14S7I6K",
  "qr": "LPA:1$smdp.io$K1-1JL898-DKUTDC",
  "smdp": "smdp.io",
  "packages": [
    {
      "package_template_id": 30,
      "active": true,
      "data": {
        "total": 1073741824,
        "used": 1073741824
      },
      "voice": {
        "mo": {
          "total": 123,
          "used": 123
        },
        "mt": {
          "total": 123,
          "used": 123
        }
      },
      "sms": {
        "mo": {
          "total": 123,
          "used": 123
        },
        "mt": {
          "total": 123,
          "used": 123
        }
      },
      "package_template_name": "PDEL - Italy 20Gb",
      "location_zone": {
        "id": 27,
        "name": "PDEL - Italy"
      },
      "assigned_at": "2023-11-07T05:31:56Z",
      "active_from": "2023-11-07T05:31:56Z",
      "active_until": "2023-11-07T05:31:56Z",
      "period_days": 30
    }
  ],
  "activated_at": "2023-11-07T05:31:56Z"
}
Возвращает данные выпущенной eSIM по её iccid вместе с прикреплёнными пакетами трафика. Поле msisdn используется для отправки SMS абоненту.

Заголовки

​
X-Request-ID
string

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Параметры пути

​
iccid
string
обязательно

ICCID eSIM, полученный при создании ICCID — серийный номер eSIM-профиля (19–20 цифр)

Required string length: 19 - 20
Pattern: ^[0-9]+$
Пример:

"8948010000000000000"

Ответ

Данные eSIM с прикреплёнными пакетами

Данные eSIM с прикреплёнными пакетами трафика.

​
iccid
string
обязательно

ICCID — серийный номер eSIM-профиля (19–20 цифр)

Required string length: 19 - 20
Pattern: ^[0-9]+$
Пример:

"8948010000000000000"

​
msisdn
string
обязательно

MSISDN — телефонный номер абонента eSIM в международном формате E.164 (только цифры, без префикса +).

Pattern: ^[0-9]+$
Пример:

"79991234567"

​
status
enum<string>
обязательно

Статус eSIM (как в OCS):

  • free — eSIM свободна, не привязана к абоненту;
  • affected — eSIM привязана к абоненту.
Доступные опции:
free,
affected
​
activation_code
string
обязательно

Уникальный идентификатор конкретного профиля на SM-DP+ сервере

Пример:

"K2-1JL8YT-14S7I6K"

​
qr
string
обязательно

Строка активации eSIM в нотации LPA: LPA:version$smdp_address$activation_code.

  • LPA: — префикс, указывающий, что строка предназначена для Local Profile Assistant (компонент eSIM на устройстве).
  • version — версия формата кода активации.
  • smdp_address — адрес SM-DP+ сервера (Subscription Manager Data Preparation).
  • activation_code — уникальный идентификатор конкретного профиля на SM-DP+ сервере.
Пример:

"LPA:1$smdp.io$K1-1JL898-DKUTDC"

​
smdp
string<hostname>
обязательно

Адрес SM-DP+ сервера, на котором размещён профиль eSIM

Пример:

"smdp.io"

​
packages
object[]
обязательно
​
activated_at
string<date-time>

Дата и время активации eSIM на устройстве пользователя