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

List plans

Request

This endpoint retrieves a list of available plans. It allows users to specify pagination and filter out archived plans.

Security
ApiKeyAuth
Query
archivedboolean

When true, only archived plans are returned. When false, only non archived plans are returned. When absent all are returned.

page_sizestring[ 1 .. 25 ]

Number of items to be returned in a single page

Default 10
pagestring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call.

labelstring(Label)

Filter plans by label. Allowed values are Green, Aqua, Blue, Voilet, Red, Grey, Orange

Enum"Green""Aqua""Blue""Voilet""Red""Grey""Orange"
search_querystring

Query to search the plans by name

country_iso_2string

Comma separated list of countryIso2 e.g. countryIso2=FR,IN

curl -i -X GET \
  'https://api.tellisim.com/v3/plans?archived=true&page_size=10&page=string&label=Green&search_query=string&country_iso_2=string&key=YOUR_API_KEY_HERE'

Responses

Successful response containing a list of plans. The optional fields are returned for labels on which throttling or recurring is enabled.

Bodyapplication/json
errorbooleanrequired

Indicates if there was an error in the request

Example: false
dataArray of objects(Plan)required

An array of plan objects returned by the request

data[].​plan_namestringrequired

Name of the plan

Example: "USA Plan"
data[].​plan_idstringrequired

Unique identifier for the plan

Example: "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"
data[].​coverage_idstringrequired

Identifier for the coverage area of the plan

Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"
data[].​archived_atstring or nullrequired

Timestamp of when the plan was archived (if applicable)

Example: null
data[].​region_codestringrequired

Code representing the region for the plan

Example: "US"
data[].​labelstringrequired

Label for the plan

Example: "blue"
data[].​created_atstringrequired

Timestamp of when the plan was created

Example: "2025-01-01T00:00:00Z"
data[].​throttlingbooleanrequired

Indicates if the plan has throttling enabled

Example: true
data[].​recurringbooleanrequired

Indicates if the plan is recurring

Example: true
data[].​data_mega_bytesintegerrequired

Amount of data in megabytes included in the plan

Example: 1024
data[].​period_daysintegerrequired

Duration of the plan in days

Example: 30
data[].​archivebooleanrequired

Indicates if the plan is archived

Example: false
data[].​period_iterationsinteger

Number of iterations for the plan period

Example: 12
data[].​throttling_threshold1_percinteger[ 0 .. 100 ]

The percentage threshold for first throttling

Example: 50
data[].​throttling_threshold1_limitstring

The limit associated with the first throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "3072"
data[].​throttling_threshold2_percinteger[ 0 .. 100 ]

The percentage threshold for second throttling

Example: 80
data[].​throttling_threshold2_limitstring

The limit associated with the second throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "384"
data[].​throttling_threshold3_percinteger[ 0 .. 100 ]

The percentage threshold for third throttling

Example: 90
data[].​throttling_threshold3_limitstring

The limit associated with the third throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "128"
data[].​nb_occurrenceinteger

The number of occurrences for the plan

Example: 12
data[].​recurring_periodicity_typestring

The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly.

Enum"0""1""2"
Example: "0"
data[].​recurring_periodicity_frequencyinteger

The frequency of the recurring billing cycle

Example: 1
next_pagestring or nullrequired

Token for the next page of results, if available

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

Create Plans

Request

Creates a plan with the given configuration.

Security
ApiKeyAuth
Bodyapplication/json
coverage_idstringrequired

coverage id of the region.

Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"
data_MBsnumber>= 1required

The amount of MBs you want in the plan

Example: 1024
namestringrequired

Name of the plan which can be any thing you like.

Example: "test1 recurring and throttling package"
period_daysnumber[ 1 .. 1825 ]required

plan validity in days

Example: 1
recurringbooleanrequired

Set to true if you want the plan to be recurring

Example: true
throttlingbooleanrequired

Set to true if you want the plan to be throttled

Example: true
nb_occurrencenumber[ 2 .. 550 ]

The number of occurrences for the plan. Required if recurring is true.

Example: 2
recurring_periodicity_typestring

Recurring periodicity type. Possible values are 0=Daily, 1=Weekly, 2=Monthly. Required if recurring is true.

Enum"0""1""2"
Example: "0"
recurring_periodicity_frequencynumber

Along with recurring_periodicity_type will determine the frequency at which the subscriber will receive its packages. For example recurring_periodicity_frequency=0 and recurring_periodicity_frequency=2, the subscriber is going to receive a package every 2 days. Required if recurring is true.

Example: 2
throttling_threshold1_percnumber[ 0 .. 100 ]

First threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example: 50
throttling_threshold1_limitstring(ThrottlingThresholdLimit)

Limit to apply when the subscriber is crossing the first threshold. It's units is Kbit/sec. Required if throttling is true.

Enum"128""256""384""512""1024""3072""5120""7680""10240""20480"
throttling_threshold2_percnumber[ 0 .. 100 ]

Second threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example: 90
throttling_threshold2_limitstring(ThrottlingThresholdSecondLimit)

Limit to apply when the subscriber is crossing the second threshold. It's units is Kbit/sec. Required if throttling_threshold2_perc is present in request.

Enum"128""256""384""512""1024""3072""5120""7680""10240""20480"
throttling_threshold3_percnumber[ 0 .. 100 ]

Third threshold for throttling, in percentage of the total volume of the package. Required if throttling is true.

Example: 100
throttling_threshold3_limitstring(ThrottlingThresholdThirdLimit)

Limit to apply when the subscriber is crossing the third threshold. It's units is Kbit/sec. Required if throttling_threshold3_perc is present in request.

Enum"128""256""384""512""1024""3072""5120""7680""10240""20480"
curl -i -X POST \
  'https://api.tellisim.com/v3/plans?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "coverage_id": "819b05c4-f154-4df9-8fd1-16be3e82f5c6",
    "data_MBs": 1024,
    "name": "test1 recurring and throttling package",
    "period_days": 1,
    "recurring": true,
    "throttling": true,
    "nb_occurrence": 2,
    "recurring_periodicity_type": "0",
    "recurring_periodicity_frequency": 2,
    "throttling_threshold1_perc": 50,
    "throttling_threshold1_limit": "1024",
    "throttling_threshold2_perc": 90,
    "throttling_threshold2_limit": "1024",
    "throttling_threshold3_perc": 100,
    "throttling_threshold3_limit": "1024"
  }'

Responses

Plan created successfully

Bodyapplication/json
errorbooleanrequired

Indicates if there was an error processing the request

Example: false
messagestringrequired

A message providing additional information about the error (if any)

Example: "plan created successfully"
plan_idstringrequired

The unique identifier for the newly created plan (if successful)

Example: "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"
Response
application/json
{
  "error": false,
  "message": "plan created successfully",
  "plan_id": "39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"
}

Get a Plan

Request

Retrieves the details of an existing plan by its ID.

Security
ApiKeyAuth
Path
planIdstringrequired
curl -i -X GET \
  'https://api.tellisim.com/v3/plans/{planId}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing plan details

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example: false
dataobjectrequired

Contains the details of the requested plan

data.​plan_namestringrequired

Name of the plan

Example: "USA Plan"
data.​plan_idstringrequired

The unique identifier of the plan

Example: "0a3ee1d6-fe5e-4561-91a0-d4649aaf0754"
data.​coverage_idstringrequired

The ID associated with the plan's coverage

Example: "819b05c4-f154-4df9-8fd1-16be3e82f5c6"
data.​archived_atstring or nullrequired

Timestamp indicating when the plan was archived, if applicable

Example: "2025-01-01T00:00:00Z"
data.​region_codestringrequired

The code representing the region for the plan

Example: "US"
data.​labelstringrequired

A human-readable label for the plan

Example: "blue"
data.​throttlingbooleanrequired

Indicates if throttling is applied to the plan

Example: true
data.​recurringbooleanrequired

Indicates if the plan has a recurring billing cycle

Example: true
data.​archivebooleanrequired

Indicates if the plan is archived

Example: true
data.​data_mega_bytesintegerrequired

The amount of data in megabytes included in the plan

Example: 1024
data.​period_daysintegerrequired

The duration of the plan in days

Example: 1
data.​throttling_threshold1_percinteger[ 0 .. 100 ]

The percentage threshold for first throttling

Example: 10
data.​throttling_threshold1_limitstring

The limit associated with the first throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "3072"
data.​throttling_threshold2_percinteger[ 0 .. 100 ]

The percentage threshold for second throttling

Example: 10
data.​throttling_threshold2_limitstring

The limit associated with the second throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "3072"
data.​throttling_threshold3_percinteger[ 0 .. 100 ]

The percentage threshold for third throttling

Example: 10
data.​throttling_threshold3_limitstring

The limit associated with the third throttling threshold

Enum"32""64""128""256""384""512""1024""3072""5120""7680"
Example: "3072"
data.​nb_occurrenceinteger

The number of occurrences for the plan

Example: 2
data.​recurring_periodicity_typestring

The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly.

Example: "2"
data.​recurring_periodicity_frequencyinteger

The frequency of the recurring billing cycle

Example: 0
Response
application/json
{
  "error": false,
  "data": {
    "plan_name": "USA Plan",
    "plan_id": "0a3ee1d6-fe5e-4561-91a0-d4649aaf0754",
    "coverage_id": "819b05c4-f154-4df9-8fd1-16be3e82f5c6",
    "archived_at": "2025-01-01T00:00:00Z",
    "region_code": "US",
    "label": "blue",
    "throttling": true,
    "recurring": true,
    "archive": true,
    "data_mega_bytes": 1024,
    "period_days": 1,
    "throttling_threshold1_perc": 10,
    "throttling_threshold1_limit": "3072",
    "throttling_threshold2_perc": 10,
    "throttling_threshold2_limit": "3072",
    "throttling_threshold3_perc": 10,
    "throttling_threshold3_limit": "3072",
    "nb_occurrence": 2,
    "recurring_periodicity_type": "2",
    "recurring_periodicity_frequency": 0
  }
}

Delete a Plan

Request

Deletes plan with the given id. Deleting a plan won't impact the existing and historic attachments for this plan. They will continue to work as expected.

Security
ApiKeyAuth
Path
planIdstring(uuid)required
curl -i -X DELETE \
  'https://api.tellisim.com/v3/plans/{planId}?key=YOUR_API_KEY_HERE'

Responses

The plan was deleted successfully.

Bodyapplication/json
errorboolean

Indicates if an error occurred.

Example: false
messagestring

A message indicating the result of the operation.

Example: "Plan deleted successfully"
Response
application/json
{
  "error": false,
  "message": "Plan deleted successfully"
}

Archive a plan

Request

This endpoint allows you to archive a specific plan identified by its planId. Archiving a plan may be necessary for managing your plans effectively, especially when they are no longer active or needed.

Security
ApiKeyAuth
Path
planIdstringrequired
curl -i -X POST \
  'https://api.tellisim.com/v3/plans/{planId}/archive?key=YOUR_API_KEY_HERE'

Responses

Plan archived successfully

Bodyapplication/json
errorbooleanrequired

Indicates whether there was an error processing the request

Example: false
messagestringrequired

A message providing additional information about the request status

Example: "Plan archived successfully"
Response
application/json
{
  "error": false,
  "message": "Plan archived successfully"
}

Unarchive a plan

Request

This endpoint allows you to unarchive a specific plan identified by its planId. When a plan is unarchived, it is restored to an active state, making it available for use again.

Security
ApiKeyAuth
Path
planIdstringrequired
curl -i -X POST \
  'https://api.tellisim.com/v3/plans/{planId}/unarchive?key=YOUR_API_KEY_HERE'

Responses

Plan unarchived successfully

Bodyapplication/json
errorbooleanrequired

Indicates whether there was an error processing the request

Example: false
messagestringrequired

A message providing additional information about the request status

Example: "Plan unarchived successfully"
Response
application/json
{
  "error": false,
  "message": "Plan unarchived successfully"
}

Coverage

Operations related to coverage.

Operations

SIM

Operations related to SIM management.

Operations

Operators

Operations related to operators.

Operations

Webhook Events

Operations related to webhook events.

Webhooks