[Webhook] HandleDownloadProgressInfo Event

post https://{CLIENT_HOST}/dest_url_esim_status_change

This webhook event is also called the "HandleDownloadProgressInfo" function in the GSMA RSP Technical Specs. The function SHALL be used by the SM-DP+ to notify the Operator of the progress of a
pending Profile download order request. This function MAY be used at several points of the
Profile Download and Installation procedure. It is assumed that the ICCID and the EID are
enough to identify the pending Profile download order request at the SM-DP+ and the
Operator sides. It is also assumed that the ICCID is enough for the SM-DP+ to retrieve the
Operator to notify. For more technical details, please refer to the GSM Association Official Document SGP.22 – RSP Technical Specification v2.4 (SGP.22-2.4)

📘
This endpoint requires special permission. Please reach out to bd@telna.com for more information.

Body Params

header

object

eid

string

Identifies the targeted eUICC.
This information SHALL be set if available to the
SM-DP+.
EID as described in [SGP.22-2.4 section 4.3.1]

iccid

string

required

Identifies the Profile to download and install in
the eUICC. ICCID as described in [SGP.22-2.4 section 5.2.1]

profileType

string

required

Identifies the Profile Type to download and
install in the eUICC. Content free information defined by the Operator

timestamp

string

required

Indicates the date/time when the operation has
been performed. String format as specified by W3C: YYYY-MM-DDThh:mm:ssTZD
(E.g. 2001-12-17T09:30:47Z)"

notificationPointId

string

required

Indicates the step reached within the Profile
Download and Installation procedure.
Defined check points are:
'1' -> Returned in case of failure due to insufficient download retries.
'2' -> Returned when the maximum number of retries for the Confirmation Code has been exceeded.
'3' -> BPP Downloaded (This notification indicates that the Binary Profile Package (BPP) has been successfully downloaded to the device. The BPP contains the eSIM profile data, including keys and configuration required for the proper functionality of the profile. At this point, the profile has been received, but installation has not yet occurred).
'4' -> BPP Installation (This checkpoint confirms that the Binary Profile Package has been successfully installed on the eUICC (embedded Universal Integrated Circuit Card). Installation involves configuring the eSIM profile on the card so it can be used for network access. Any issues during installation will prevent the profile from being activated for use).
'6' -> Local Enable (After the profile has been installed, this notification indicates that the profile has been locally enabled on the device. The profile is now active and can be used to connect to the network. Local enabling ensures that the profile is the one being used by the device, as there may be multiple profiles stored on the eUICC).
'7' -> Local Disable (This notification shows that the profile has been locally disabled on the device. Disabling a profile prevents it from being used to connect to the network, though the profile still remains installed on the device. This could be useful in scenarios where multiple profiles exist, and only one should be active at a time).
'8' -> Local Delete (This notification indicates that the profile has been locally deleted from the eUICC. Once deleted, the profile is no longer available on the device, and it cannot be used for network access. This step is typically irreversible, meaning the profile would need to be re-downloaded if required again in the future).

notificationPointStatus

object

required

Indicates the status after the execution of the
notification point.
The ExecutionStatus type is re-used to specify
the result of processing of the operation related
to the notification point (Executed-Success,
Executed-WithWarning, Failed), and optionally
to provide information on any encountered
problem (status code, data/object that causes
the status code, and message to provide textual
and human readable explanation of the status
code).

resultData

string

base64 encoded binary data containing the Result data contained in the ProfileInstallationResult". The finalResult data object as contained in the
ProfileInstallationResult, when received from the
eUICC.

Response

200

OK. The client endpoint must respond with an HTTP status code of 200 OK to acknowledge the successful delivery of the event. This response code indicates that the client has received and processed the webhook payload successfully.

📘This endpoint requires special permission. Please reach out to bd@telna.com for more information.

📘
This endpoint requires special permission. Please reach out to bd@telna.com for more information.