Skip to content

Add Temp eSIM

Function: ADD_TEMP_ESIM

The ADD_TEMP_ESIM function is used to add a temporary eSIM to the test device. This function is essential for testing eSIM provisioning and activation.

The step downloads and installs the eSIM profile and can make it the preferred SIM for calls, messages or data. Wi-Fi is required for the download; the step turns it on.

On iOS 27, a travel eSIM asks three questions after it is installed. The step answers them: Voice and Data for the plan type, Travel eSIM and Current SIM so that the phone's own SIM stays on, and Not Now for Low Data Mode. TIMEOUT is the wait for the first of these questions.

The eSIM is temporary: it is removed automatically when the test case ends, or when the suite ends if CLEANUP_SCOPE is TEST_SUITE. You do not need a DELETE_TEMP_ESIM step for cleanup.

Supported on: Android and iOS.

Parameters

Parameter Name Description Example Values Required Default Value
ACTIVATION_CODE The activation code used to provision the eSIM. ABCD1234 Yes
SET_PRIMARY_FOR_CALLS Whether to set the eSIM as the primary SIM for calls. ON, OFF No ON
SET_PRIMARY_FOR_SMS Whether to set the eSIM as the primary SIM for SMS. On iOS this follows SET_PRIMARY_FOR_CALLS and cannot be set separately. ON, OFF No ON
SET_PRIMARY_FOR_DATA Whether to set the eSIM as the primary SIM for data. ON, OFF Yes ON
TIMEOUT Seconds to wait for the operator-side eSIM download and installation, 0-3700. If it is empty, a default of 60 to 180 seconds is used, depending on the device. 180, 300 No
CLEANUP_SCOPE When the eSIM is removed: TEST_CASE at the end of this test case, or TEST_SUITE at the end of the suite execution, so that later test cases on the same device can use it. TEST_CASE, TEST_SUITE No TEST_CASE

The step editor pre-selects ON for SET_PRIMARY_FOR_CALLS and SET_PRIMARY_FOR_SMS. When they are left out of an API payload, the platform uses OFF.