{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens SIM Cards API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "SIM Cards",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Purchase eSIMs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/actions/purchase/esims",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Purchases and registers the specified amount of eSIMs to the current user's account.<br/><br/>\nIf <code>sim_card_group_id</code> is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/>\n"
        },
        {
          "info": {
            "name": "Register SIM cards",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/actions/register/sim_cards",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Register the SIM cards associated with the provided registration codes to the current user's account.<br/><br/>\nIf <code>sim_card_group_id</code> is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/>\n"
        },
        {
          "info": {
            "name": "List SIM card data usage notifications",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications",
            "params": [
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "The page number to load."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The size of the page."
              },
              {
                "name": "filter[sim_card_id]",
                "value": "",
                "type": "query",
                "description": "A valid SIM card ID."
              }
            ]
          },
          "docs": "Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters."
        },
        {
          "info": {
            "name": "Create a new SIM card data usage notification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new SIM card data usage notification."
        },
        {
          "info": {
            "name": "Get a single SIM card data usage notification",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Get a single SIM Card Data Usage Notification."
        },
        {
          "info": {
            "name": "Updates information for a SIM Card Data Usage Notification",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates information for a SIM Card Data Usage Notification."
        },
        {
          "info": {
            "name": "Delete SIM card data usage notifications",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the resource."
              }
            ]
          },
          "docs": "Delete the SIM Card Data Usage Notification."
        },
        {
          "info": {
            "name": "Get all SIM cards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter for SIM cards (deepObject style). Originally: filter[iccid], filter[msisdn], filter[status], filter[tags]"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]"
              },
              {
                "name": "include_sim_card_group",
                "value": "",
                "type": "query",
                "description": "It includes the associated SIM card group object in the response when present."
              },
              {
                "name": "filter[sim_card_group_id]",
                "value": "",
                "type": "query",
                "description": "A valid SIM card group ID."
              },
              {
                "name": "sort",
                "value": "-current_billing_period_consumed_data.amount",
                "type": "query",
                "description": "Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign."
              }
            ]
          },
          "docs": "Get all SIM cards belonging to the user that match the given filters."
        },
        {
          "info": {
            "name": "Request bulk disabling voice on SIM cards.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_disable_voice",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group.<br/>\nFor each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n\nThe overall status of the Bulk SIM Card Action can be followed through the [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/si"
        },
        {
          "info": {
            "name": "Request bulk enabling voice on SIM cards.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_enable_voice",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group.<br/>\nFor each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n\nThe overall status of the Bulk SIM Card Action can be followed through the [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim"
        },
        {
          "info": {
            "name": "Request bulk setting SIM card public IPs.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_set_public_ips",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.<br/>\nFor each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n"
        },
        {
          "info": {
            "name": "Validate SIM cards registration codes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/actions/validate_registration_codes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "It validates whether SIM card registration codes are valid or not."
        },
        {
          "info": {
            "name": "Get SIM card",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              },
              {
                "name": "include_sim_card_group",
                "value": "",
                "type": "query",
                "description": "It includes the associated SIM card group object in the response when present."
              },
              {
                "name": "include_pin_puk_codes",
                "value": "",
                "type": "query",
                "description": "When set to true, includes the PIN and PUK codes in the response. These codes are used for SIM card security and unlocking purposes. Available for both physical SIM cards and eSIMs."
              }
            ]
          },
          "docs": "Returns the details regarding a specific SIM card."
        },
        {
          "info": {
            "name": "Update a SIM card",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.telnyx.com/v2/sim_cards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates SIM card data"
        },
        {
          "info": {
            "name": "Deletes a SIM card",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/sim_cards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              },
              {
                "name": "report_lost",
                "value": "",
                "type": "query",
                "description": "Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and the eSIM cannot be re-registered."
              }
            ]
          },
          "docs": "The SIM card will be decommissioned, removed from your account and you will stop being charged.<br />The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.<br/>\nTransitioning to the disabled state may take a period of time.\nUntil the transition is completed, the SIM card status will be disabling <code>disabling</code>.<br />In order to re-enable the SIM card, you will need to re-register it."
        },
        {
          "info": {
            "name": "Request a SIM card disable",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/disable",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.<br/>\nThe API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the disabled state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n"
        },
        {
          "info": {
            "name": "Request a SIM card enable",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/enable",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "This API enables a SIM card, connecting it to the network and making it possible to consume data.<br/>\nTo enable a SIM card, it must be associated with a SIM card group.<br/>\nThe API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the enabled state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n"
        },
        {
          "info": {
            "name": "Request removing a SIM card public IP",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/remove_public_ip",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "This API removes an existing public IP from a SIM card. <br/><br/>\n The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API."
        },
        {
          "info": {
            "name": "Request setting a SIM card public IP",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/set_public_ip",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              },
              {
                "name": "region_code",
                "value": "",
                "type": "query",
                "description": "The code of the region where the public IP should be assigned. A list of available regions can be found at the regions endpoint"
              }
            ]
          },
          "docs": "This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. <br/><br/>\n The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API. <br/><br/>\n Setting a Public IP to a SIM Card incurs a charge and will only succeed if the account has sufficient funds."
        },
        {
          "info": {
            "name": "Request setting a SIM card to standby",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/set_standby",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.<br/>\nTo set a SIM card to standby, it must be associated with SIM card group.<br/>\nThe API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the standby state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/si"
        },
        {
          "info": {
            "name": "Get activation code for an eSIM",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/activation_code",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "It returns the activation code for an eSIM.<br/><br/>\n This API is only available for eSIMs. If the given SIM is a physical SIM card, or has already been installed, an error will be returned.\n"
        },
        {
          "info": {
            "name": "Get SIM card device details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/device_details",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "It returns the device details where a SIM card is currently being used.\n"
        },
        {
          "info": {
            "name": "Get SIM card public IP definition",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/public_ip",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "It returns the public IP requested for a SIM card.\n"
        },
        {
          "info": {
            "name": "List wireless connectivity logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/sim_cards/:id/wireless_connectivity_logs",
            "params": [
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "The page number to load."
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The size of the page."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Identifies the SIM."
              }
            ]
          },
          "docs": "This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes."
        }
      ]
    }
  ],
  "bundled": true
}