Skip to main content

Setup SIM Provisioning

info

You will be using the Alef Mobile Network API to carry out the tasks in this section. This is a basic config, Refer to the API reference documentation to learn more about the API and explore the full schema.

Upload your SIMs​

Required information

  • name: Name for the SIM, needs to be unique in the account.
  • iccid: The ICCID value for the SIM. Needs to be unique for each SIM.
  • imsi: The IMSI data per SIM. Currently one IMSI entry is supported.
    • imsi: The unique 15-digit number identifier for the SIM. Typically: mcc + mnc + MSIN (Mobile Subscriber Identity).
    • msisdn: The MSISDN is the 'phone' number for the SIM. MSISDNs are typically 14 or 15 digits long.
    • plmn: The mcc + mnc for the SIM. Should be the same as the Mobile Core PLMN.
    • apn: The APN name for the SIM. Needs to be the same as specified on the Mobile Core.
    • imsi-profile: The secret keys for the SIM to authenticate with. Typically two values k and opc.
      • use-opc: Set to false if the opc value in the key set should be interpreted as the op operator key.
      • key-set: The k and opc values as provided by the SIM supplier. Usually unique per IMSI.

You will use the following POST request body with the /connectivity/v2/sims/{coreId}/sim endpoint to add SIM.

You can use the following GET request body with the /connectivity/v2/sims/{coreId}/sim/{id} endpoint to retrieve your RAN information.

Expand here to see the SIM POST request body. 
{
   "name": "test-sim-1",
   "iccid": "8901260123456789011",
   "imsi": [
       {
           "imsi": "123456789012341",
           "msisdn": [
               "1234567890"
           ],
           "plmn": [
               "101002"
           ],
           "apn": [
               {
                   "apn": "internet",
               }
           ],
           "imsi-profile": {
               "use-opc": true,
               "key-set": [
                   {
                       "k": "123456789abcdef0123456789abcdef0",
                       "opc": "123456789abcdef0123456789abcdef0"
                   }
               ]
           }
       }
   ]
}

Examples​

info

All APIs require the user to be authenticated with their username/password. The JWT token needs to be added to the header as Bearer of each call.

Expand here to see examples for managing a SIM POST and GET requests and responses.

Request

curl -X 'POST' 'https://api.alefedge.com/connectivity/v2/sims/66c7553603ffb584d8338c4a/sim' \
  -H 'Authorization: Bearer <JWT TOKEN>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d ' {
      "name": "test-sim-1",
      "iccid": "8901260123456789011",
      "imsi": [
          {
              "imsi": "123456789012341",
              "msisdn": [
                  "1234567890"
              ],
              "plmn": [
                  "101002"
              ],
              "apn": [
                  {
                      "apn": "internet",
                  }
              ],
              "imsi-profile": 
              {
                  "use-opc": true,
                  "key-set": [
                      {
                          "k": "123456789abcdef0123456789abcdef0",
                          "opc": "123456789abcdef0123456789abcdef0"
                      }
                  ]
              }
          }
      ]
  }'

Response

{
    "account": "66992fb6310e8d77a42ed77a",
    "mobile-core-id": "66c7553603ffb584d8338c4a",
    "iccid": "8901260123456789011",
    "imsi": [
        {
            "imsi": "123456789012341",
            "msisdn": [
                "1234567890"
            ],
            "plmn": [
                "101002"
            ],
            "allowed-mme": null,
            "ue-ambr": null,
            "subscribed-periodic-rau-tau-timer": null,
            "extended-idle-mode-drx-cycle-length": null,
            "apn": [
                {
                    "apn": "internet",
                    "pdn-type": null,
                    "ue-apn-ip": null,
                    "apn-ambr": {
                        "downlink-ambr": null,
                        "uplink-ambr": null
                    }
                }
            ],
            "imsi-profile": {
                "algorithm": null,
                "use-opc": true,
                "use-sqn": null,
                "key-set": [
                    {
                        "k": "123456789abcdef0123456789abcdef0",
                        "opc": "123456789abcdef0123456789abcdef0",
                        "amf": null,
                        "sqn-start": null,
                        "sqn-end": null
                    }
                ]
            }
        }
    ],
    "_id": "66a2e8f79a60b7d523eb8cea",
    "__v": 0
}