Skip to content

TelliSIM API v3 (1.0.0)

API explanation

API explanation diagram

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Languages
Servers
Production server
https://api.tellisim.com/

Subscriptions

Operations related to subscriptions.

Operations

Plans

Operations related to plans.

Operations

Coverage

Operations related to coverage.

Operations

List coverage profiles

Request

Returns the list of coverage profiles available to your account.

Security
ApiKeyAuth
Query
region_codestring
Example: region_code=US
labelstring
Example: label=Green
curl -i -X GET \
  'https://api.tellisim.com/v3/coverage-profiles?region_code=US&label=Green&key=YOUR_API_KEY_HERE'

Responses

Successful response containing coverage profiles

Bodyapplication/json
errorbooleanrequired
Example: false
dataArray of objects(CoverageProfile)required
data[].​coverage_idstringrequired

The unique identifier for the coverage profile

Example: "24648a7f-8281-4af7-8fc0-19b2371b2d1d"
data[].​labelstringrequired

The label for the coverage profile

Example: "Green"
data[].​region_namestringrequired

The name of the region for which the coverage is applicable

Example: "United States"
data[].​region_codestringrequired

The ISO code of the region for which the coverage is applicable

Example: "US"
data[].​countriesArray of objects

Optional list of countries included in this coverage profile

Response
application/json
{
  "error": false,
  "data": [
    { … }
  ]
}

Get the coverage profile

Request

Retrieves the coverage profile

Security
ApiKeyAuth
Path
coverageIdstringrequired
curl -i -X GET \
  'https://api.tellisim.com/v3/coverage-profiles/{coverageId}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing coverage profile details

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example: false
dataobject(CoverageProfile)required
data.​coverage_idstringrequired

The unique identifier for the coverage profile

Example: "24648a7f-8281-4af7-8fc0-19b2371b2d1d"
data.​labelstringrequired

The label for the coverage profile

Example: "Green"
data.​region_namestringrequired

The name of the region for which the coverage is applicable

Example: "United States"
data.​region_codestringrequired

The ISO code of the region for which the coverage is applicable

Example: "US"
data.​countriesArray of objects

Optional list of countries included in this coverage profile

Response
application/json
{
  "error": false,
  "data": {
    "coverage_id": "24648a7f-8281-4af7-8fc0-19b2371b2d1d",
    "label": "Green",
    "region_name": "United States",
    "region_code": "US",
    "countries": [ … ]
  }
}

Create custom region coverage profile

Request

Creates a custom region coverage profile using a list of ISO 2-letter country codes.

Validation checks:

The system performs the following validations before creating the profile:

  • Duplicate name check: If a region with the same name already exists for this organization, returns 400 Bad Request
  • Duplicate coverage check: If a coverage profile with the exact same set of countries already exists, returns 409 Conflict with the existing profile details

Note: Coverage profiles are immutable and cannot be deleted. You can only create new profiles.

Security
ApiKeyAuth
Bodyapplication/json
region_namestringrequired

The name of the custom region.

Example: "Usa and Mexico Regional Plan"
labelstring(Label)required
Enum"Green""Aqua""Blue""Voilet""Red""Grey""Orange"
iso2_listArray of stringsrequired

List of ISO 2-letter country codes included in the custom region.

Example: ["US","MX"]
curl -i -X POST \
  'https://api.tellisim.com/v3/coverage-profiles/custom-region?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "region_name": "Usa and Mexico Regional Plan",
    "label": "Green",
    "iso2_list": [
      "US",
      "MX"
    ]
  }'

Responses

Successful response containing the created custom region coverage profile.

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example: false
dataobjectrequired
data.​coverage_idstringrequired

The unique identifier for the coverage profile

Example: "85089a51-801c-4737-bd8b-f542705712bf"
data.​region_codestringrequired

The generated region code for the custom region

Example: "R33BHT"
data.​region_namestringrequired

The name of the custom region

Example: "Usa and Mexico Regional Plan"
data.​iso2_listArray of stringsrequired

List of ISO 2-letter country codes included in the custom region

Example: ["US","MX"]
Response
application/json
{
  "error": false,
  "data": {
    "coverage_id": "85089a51-801c-4737-bd8b-f542705712bf",
    "region_code": "R33BHT",
    "region_name": "Usa and Mexico Regional Plan",
    "iso2_list": [ … ]
  }
}

SIM

Operations related to SIM management.

Operations

Operators

Operations related to operators.

Operations

Webhook Events

Operations related to webhook events.

Webhooks