- Mon - Sat: 8:00am - 6:00pm
- sandking19850512@gmail.com
Documentation
Explore our comprehensive documentation to get detailed insights on service usage and development.
eSIM Management encompasses the full suite of tools and processes needed to control and maintain eSIM profiles and their associated data plans. This includes essential features like creating, deleting, and updating eSIMs, as well as managing their data plans.
API endpoint:
Description:
Use this endpoint to get the eSIM list.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esims' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
API endpoint:
Description:
Use this endpoint to get the eSIM.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to delete the eSIM.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to update the eSIM.
Request example:
curl --location --request PATCH 'https://api.simvox.com/v1/esim/{esim_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"network_status": "active"
}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
| network_status | Required string | Network Status |
API endpoint:
Description:
Get the Data Plans currently attached to an eSIM, including data usage for each Data Plan.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}/plans' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to get the topup list for esim
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/topups/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_id | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to delete the eSIM plan.
Request example:
curl --location --request GET 'https://api.simvox.com/v1/esim/{esim_id}/plans/{plan_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
| plan_id | Required string | Unique ID of eSIM Plan |
API endpoint:
Description:
Use this endpoint to create new order for eSIM/Plan
Request example:
curl --location --request POST 'https://api.simvox.com/v1/esim' \
--header 'Authorization: Basic dXNlcmdAZ21haWwuY29tOiQyXRpWDFudIZlNPaG4xdVhrbllBemMyN0huVWVOM0lMSmZWbjNPR25TMg==' \
--header 'Content-Type: text/plain' \
--data-raw '{
"type":"esim",
"package_id": "3b9ea0a6299cea3e6f915e01c45a974e",
"auto_renewal": true
}'
| Parameter | Type | Description |
| type | Required string | available values is |
| package_id | Required string | Unique ID for Data Plan |
| auto_renewal | Required boolean | Determines whether the subscription will automatically renew at the end of the current billing period. |
| iccid | Optional string | Specifies whether to create a new eSIM with the given package (`true`) or add the package should be added to an existing eSIM (`false`). |