SIM Card Actions API

View SIM card actions, their progress and timestamps using the SIM Card Actions

List bulk SIM card actions

This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[action_type]
string

Filter by action type.

Value: "bulk_set_public_ips"
Example: filter[action_type]=bulk_set_public_ips
Responses
200

Successful response

Response Schema: application/json
Array of objects (BulkSIMCardActionDetailed)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/bulk_sim_card_actions
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const { data } = await telnyx.bulkSimCardActions.list({"page[number]":1,"page[size]":20});
Response samples
application/json
{
  • "data": [
    • {
      • "action_type": "bulk_set_public_ips",
      • "created_at": "2020-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "bulk_sim_card_action",
      • "settings": { },
      • "sim_card_actions_summary": [
        • {
          • "count": 0,
          • "status": "in-progress"
          }
        ],
      • "updated_at": "2020-02-03T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Get bulk SIM card action details

This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Identifies the resource.

Example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses
200

Successful Response

Response Schema: application/json
object (BulkSIMCardActionDetailed)
action_type
string

The operation type. It can be one of the following:

  • bulk_set_public_ips - set a public IP for each specified SIM card
Value: "bulk_set_public_ips"
created_at
string (CreatedAt)

ISO 8601 formatted date indicating when the resource was created.

id
string <uuid> (Id)

Identifies the resource.

record_type
string
settings
object

A JSON object representation of the bulk action payload.

Array of objects (SIMCardActionsSummary)
updated_at
string (UpdatedAt)

ISO 8601 formatted date indicating when the resource was updated.

default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/bulk_sim_card_actions/{id}
Request samples 
const telnyx = require('telnyx')('YOUR_API_KEY');

const { data } = await telnyx.bulkSimCardActions.retrieve('id');
Response samples
application/json
{
  • "data": {
    • "action_type": "bulk_set_public_ips",
    • "created_at": "2020-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "bulk_sim_card_action",
    • "settings": { },
    • "sim_card_actions_summary": [
      • {
        • "count": 0,
        • "status": "in-progress"
        }
      ],
    • "updated_at": "2020-02-03T22:25:27.521Z"
    }
}

List SIM card actions

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[sim_card_id]
string <uuid>

A valid SIM card ID.

Example: filter[sim_card_id]=47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
filter[status]
string

Filter by a specific status of the resource's lifecycle.

Enum: "in-progress" "completed" "failed"
Example: filter[status]=in-progress
filter[bulk_sim_card_action_id]
string <uuid>

Filter by a bulk SIM card action ID.

Example: filter[bulk_sim_card_action_id]=47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
filter[action_type]
string

Filter by action type.

Enum: "enable" "enable_standby_sim_card" "disable" "set_standby" "remove_public_ip" "set_public_ip"
Example: filter[action_type]=disable
Responses
200

Successful response

Response Schema: application/json
Array of objects (SIMCardAction)
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/sim_card_actions
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "action_type": "enable",
      • "created_at": "2020-02-02T22:25:27.521Z",
      • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "record_type": "sim_card_action",
      • "settings": { },
      • "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      • "status": {
        • "reason": "The data limit was exceeded.",
        • "value": "completed"
        },
      • "updated_at": "2020-02-03T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Get SIM card action details
This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.


SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Identifies the resource.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Successful Response


Response Schema: application/json
object (SIMCardAction) 
This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.


 
action_type
string
The operation type. It can be one of the following: 


    
 
  • enable - move the SIM card to the enabled status
    • 
 
  • enable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.
    • 
 
  • disable - move the SIM card to the disabled status
    • 
 
  • set_standby - move the SIM card to the standby status
    • 
 
 Enum: "enable" "enable_standby_sim_card" "disable" "set_standby"  
created_at
string (CreatedAt) 
ISO 8601 formatted date indicating when the resource was created.


 
id
string <uuid>  (Id) 
Identifies the resource.


 
record_type
string
 
settings
object
A JSON object representation of the action params.


 
sim_card_id
string <uuid> 
The related SIM card identifier.


 
object
 
updated_at
string (UpdatedAt) 
ISO 8601 formatted date indicating when the resource was updated.


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/sim_card_actions/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "action_type": "enable",
    • "created_at": "2020-02-02T22:25:27.521Z",
    • "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "record_type": "sim_card_action",
    • "settings": { },
    • "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    • "status": {
      • "reason": "The data limit was exceeded.",
      • "value": "completed"
      },
    • "updated_at": "2020-02-03T22:25:27.521Z"
    }
}