TWtwilio
SupersimV1EsimProfile

Order an eSIM Profile.

Changed on

Order an eSIM Profile.

post/v1/ESimProfiles

Request

  • Base URL
    https://supersim.twilio.com
  • URL
    https://supersim.twilio.com/v1/ESimProfiles
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

CallbackUrlstring

The URL we should call using the callback_method when the status of the eSIM Profile changes. At this stage of the eSIM Profile pilot, the a request to the URL will only be called when the ESimProfile resource changes from reserving to available.

CallbackMethod'GET' | 'POST' http-method

The HTTP method we should use to call callback_url. Can be: GET or POST and the default is POST.

GenerateMatchingIdboolean

When set to true, a value for Eid does not need to be provided. Instead, when the eSIM profile is reserved, a matching ID will be generated and returned via the matching_id property. This identifies the specific eSIM profile that can be used by any capable device to claim and download the profile.

Eidstring

Identifier of the eUICC that will claim the eSIM Profile.

Response

Created

sidstring nullable

The unique string that we created to identify the eSIM Profile resource.

account_sidstring nullable

The SID of the Account to which the eSIM Profile resource belongs.

iccidstring nullable

The ICCID associated with the Sim resource.

sim_sidstring nullable

The SID of the Sim resource that this eSIM Profile controls.

status'new' | 'reserving' | 'available' | 'downloaded' | 'installed' | 'failed'

The status of the eSIM Profile. Can be: new, reserving, available, downloaded, installed or failed. See the eSIM Profile Status Values for a description of each.

eidstring nullable

Identifier of the eUICC that can claim the eSIM Profile.

smdp_plus_addressstring uri nullable

Address of the SM-DP+ server from which the Profile will be downloaded. The URL will appear once the eSIM Profile reaches the status available.

matching_idstring nullable

Unique identifier of the eSIM profile that can be used to identify and download the eSIM profile from the SM-DP+ server. Populated if generate_matching_id is set to true when creating the eSIM profile reservation.

activation_codestring nullable

Combined machine-readable activation code for acquiring an eSIM Profile with the Activation Code download method. Can be used in a QR code to download an eSIM profile.

error_codestring nullable

Code indicating the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state.

error_messagestring nullable

Error message describing the failure if the download of the SIM Profile failed and the eSIM Profile is in failed state.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

The absolute URL of the eSIM Profile resource.

Changes

  • v1d0ddd613f56bRevision changes
    • breaking

      removed the enum value DELETE of the request property

    • breaking

      removed the enum value HEAD of the request property

    • breaking

      removed the enum value PATCH of the request property

    • breaking

      removed the enum value PUT of the request property

  • v14c8f6063ae9dRevision changes
    • info

      api tag SupersimV1EsimProfile added