This documentation provides detailed information about the available API endpoints.
For authentication,The Bearer token should be sent as a bearer tokens in the Authorization header of the request. Create account.
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 create an eSIM.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/esim/{plan_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"description": "",
"auto_renewal": true
}'
| Parameter | Type | Description |
| plan_id | Required string | The Data Plan ID is linked to a specific mobile data plan, which could include voice, text, and data services |
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/plans/{esim_id}' \
--header 'Authorization: Bearer {token}'
| Parameter | Type | Description |
| esim_iccid | Required string | Unique ID of eSIM |
API endpoint:
Description:
Use this endpoint to create an eSIM plan.
Request example:
curl --location --request POST 'https://api.simvox.com/v1/esim/plans/{esim_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"description": "",
"auto_renewal": true
}'
| Parameter | Type | Description |
| package_id | Required string | The Data Plan ID is linked to a specific mobile data plan, which could include voice, text, and data services |
| esim_id | Required string | Unique ID of eSIM |
| auto_renewal | Optional string | Auto Renewal Value (available values is true or false, if you don't set it,default value is false.) |
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 |