Telnyx

Telnyx SIM Cards API

SIM Cards operations

GitHub OpenAPI

Operations 24

POST /actions/purchase/esims Purchase eSIMs #
POST /actions/register/sim_cards Register SIM cards #
GET /sim_card_data_usage_notifications List SIM card data usage notifications #
POST /sim_card_data_usage_notifications Create a new SIM card data usage notification #
DELETE /sim_card_data_usage_notifications/{id} Delete SIM card data usage notifications #
GET /sim_card_data_usage_notifications/{id} Get a single SIM card data usage notification #
PATCH /sim_card_data_usage_notifications/{id} Updates information for a SIM Card Data Usage Notification #
GET /sim_cards Get all SIM cards #
POST /sim_cards/actions/bulk_disable_voice Request bulk disabling voice on SIM cards. #
POST /sim_cards/actions/bulk_enable_voice Request bulk enabling voice on SIM cards. #
POST /sim_cards/actions/bulk_set_public_ips Request bulk setting SIM card public IPs. #
POST /sim_cards/actions/validate_registration_codes Validate SIM cards registration codes #
DELETE /sim_cards/{id} Deletes a SIM card #
GET /sim_cards/{id} Get SIM card #
PATCH /sim_cards/{id} Update a SIM card #
POST /sim_cards/{id}/actions/disable Request a SIM card disable #
POST /sim_cards/{id}/actions/enable Request a SIM card enable #
POST /sim_cards/{id}/actions/remove_public_ip Request removing a SIM card public IP #
POST /sim_cards/{id}/actions/set_public_ip Request setting a SIM card public IP #
POST /sim_cards/{id}/actions/set_standby Request setting a SIM card to standby #
GET /sim_cards/{id}/activation_code Get activation code for an eSIM #
GET /sim_cards/{id}/device_details Get SIM card device details #
GET /sim_cards/{id}/public_ip Get SIM card public IP definition #
GET /sim_cards/{id}/wireless_connectivity_logs List wireless connectivity logs #

Documentation

📖
Documentation
https://developers.telnyx.com/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-sim-cards-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/telnyx-sim-cards-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-sim-cards-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@telnyx.com
  description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
  title: Telnyx SIM Cards API
  version: 2.0.0
  x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
  url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: SIM Cards operations
  name: SIM Cards
paths:
  /actions/purchase/esims:
    post:
      description: 'Purchases and registers the specified amount of eSIMs to the current user''s account.<br/><br/>

        If <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/>

        '
      operationId: PurchaseESim
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ESimPurchase'
        required: true
      responses:
        '202':
          $ref: '#/components/responses/RegisterSimCardsResponse'
        '401':
          description: Unauthorized
      summary: Purchase eSIMs
      tags:
      - SIM Cards
      x-latency-category: background
  /actions/register/sim_cards:
    post:
      description: 'Register the SIM cards associated with the provided registration codes to the current user''s account.<br/><br/>

        If <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/>

        '
      operationId: RegisterSimCards
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIMCardRegistration'
        required: true
      responses:
        '202':
          $ref: '#/components/responses/RegisterSimCardsResponse'
        '401':
          description: Unauthorized
      summary: Register SIM cards
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_card_data_usage_notifications:
    get:
      description: Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.
      operationId: ListDataUsageNotifications
      parameters:
      - $ref: '#/components/parameters/wireless_PageNumber'
      - $ref: '#/components/parameters/wireless_PageSize'
      - $ref: '#/components/parameters/FilterSIMCardId'
      responses:
        '200':
          $ref: '#/components/responses/SimCardDataUsageNotificationCollectionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: List SIM card data usage notifications
      tags:
      - SIM Cards
      x-latency-category: background
    post:
      description: Creates a new SIM card data usage notification.
      operationId: PostSimCardDataUsageNotification
      requestBody:
        content:
          application/json:
            schema:
              properties:
                sim_card_id:
                  description: The identification UUID of the related SIM card resource.
                  example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                  format: uuid
                  type: string
                threshold:
                  description: Data usage threshold that will trigger the notification.
                  properties:
                    amount:
                      example: '2048.1'
                      type: string
                    unit:
                      enum:
                      - MB
                      - GB
                      example: MB
                      type: string
                  type: object
              required:
              - sim_card_id
              - threshold
              type: object
        required: true
      responses:
        '201':
          $ref: '#/components/responses/CreateSimCardDataUsageNotificationResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Create a new SIM card data usage notification
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_card_data_usage_notifications/{id}:
    delete:
      description: Delete the SIM Card Data Usage Notification.
      operationId: DeleteSimCardDataUsageNotifications
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/DeleteSimCardDataUsageNotificationResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Delete SIM card data usage notifications
      tags:
      - SIM Cards
      x-latency-category: responsive
    get:
      description: Get a single SIM Card Data Usage Notification.
      operationId: GetSimCardDataUsageNotification
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      responses:
        '200':
          $ref: '#/components/responses/GetSimCardDataUsageNotificationResponse'
        '404':
          $ref: '#/components/responses/wireless_ResourceNotFound'
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get a single SIM card data usage notification
      tags:
      - SIM Cards
      x-latency-category: background
    patch:
      description: Updates information for a SIM Card Data Usage Notification.
      operationId: PatchSimCardDataUsageNotification
      parameters:
      - $ref: '#/components/parameters/ResourceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimCardDataUsageNotification'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/UpdateSimCardDataUsageNotificationResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Updates information for a SIM Card Data Usage Notification
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards:
    get:
      description: Get all SIM cards belonging to the user that match the given filters.
      operationId: GetSimCards
      parameters:
      - $ref: '#/components/parameters/FilterSIMCardConsolidated'
      - $ref: '#/components/parameters/wireless_PageConsolidated'
      - $ref: '#/components/parameters/IncludeSIMCardGroup'
      - $ref: '#/components/parameters/FilterSIMCardGroupId'
      - description: Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign.
        example: -current_billing_period_consumed_data.amount
        in: query
        name: sort
        required: false
        schema:
          enum:
          - current_billing_period_consumed_data.amount
          - -current_billing_period_consumed_data.amount
          type: string
      responses:
        '200':
          $ref: '#/components/responses/SearchSimCardsResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get all SIM cards
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/actions/bulk_disable_voice:
    post:
      description: 'This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group.<br/>

        For 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.


        The 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-card-actions/list-bulk-sim-card-actions) API.

        '
      operationId: DisableVoiceBulk
      requestBody:
        content:
          application/json:
            schema:
              properties:
                sim_card_group_id:
                  example: 6b14e151-8493-4fa1-8664-1cc4e6d14158
                  type: string
              required:
              - sim_card_group_id
              type: object
      responses:
        '202':
          $ref: '#/components/responses/BulkSIMCardActionResponse'
        '422':
          $ref: '#/components/responses/wireless_UnprocessableEntity'
      summary: Request bulk disabling voice on SIM cards.
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/actions/bulk_enable_voice:
    post:
      description: 'This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group.<br/>

        For 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.


        The 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-card-actions/list-bulk-sim-card-actions) API.

        '
      operationId: EnableVoiceBulk
      requestBody:
        content:
          application/json:
            schema:
              properties:
                sim_card_group_id:
                  example: 6b14e151-8493-4fa1-8664-1cc4e6d14158
                  type: string
              required:
              - sim_card_group_id
              type: object
      responses:
        '202':
          $ref: '#/components/responses/BulkSIMCardActionResponse'
        '422':
          $ref: '#/components/responses/wireless_UnprocessableEntity'
      summary: Request bulk enabling voice on SIM cards.
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/actions/bulk_set_public_ips:
    post:
      description: 'This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.<br/>

        For 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.

        '
      operationId: SetPublicIPsBulk
      requestBody:
        content:
          application/json:
            schema:
              properties:
                sim_card_ids:
                  example:
                  - 6b14e151-8493-4fa1-8664-1cc4e6d14158
                  items:
                    $ref: '#/components/schemas/wireless_Id'
                  type: array
              required:
              - sim_card_ids
              type: object
      responses:
        '202':
          $ref: '#/components/responses/BulkSIMCardActionResponse'
        '422':
          $ref: '#/components/responses/wireless_UnprocessableEntity'
      summary: Request bulk setting SIM card public IPs.
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/actions/validate_registration_codes:
    post:
      description: It validates whether SIM card registration codes are valid or not.
      operationId: ValidateRegistrationCodes
      requestBody:
        content:
          application/json:
            schema:
              description: The object containing the Array of SIM card registration codes.
              example:
                registration_codes:
                - '123456780'
                - '1231231230'
              properties:
                registration_codes:
                  items:
                    type: string
                  type: array
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SIMCardRegistrationCodeValidations'
          description: Successful
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Validate SIM cards registration codes
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/{id}:
    delete:
      description: '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/>

        Transitioning to the disabled state may take a period of time.

        Until 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.'
      operationId: DeleteSimCard
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      - description: Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and the eSIM cannot be re-registered.
        in: query
        name: report_lost
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/DeleteSimCardResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Deletes a SIM card
      tags:
      - SIM Cards
      x-latency-category: responsive
    get:
      description: Returns the details regarding a specific SIM card.
      operationId: GetSimCard
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      - $ref: '#/components/parameters/IncludeSIMCardGroup'
      - 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.
        in: query
        name: include_pin_puk_codes
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/GetSimCardResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get SIM card
      tags:
      - SIM Cards
      x-latency-category: responsive
    patch:
      description: Updates SIM card data
      operationId: UpdateSimCard
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SIMCard'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/UpdateSimCardResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Update a SIM card
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/{id}/actions/disable:
    post:
      description: 'This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.<br/>

        The 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.

        '
      operationId: DisableSimCard
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '202':
          $ref: '#/components/responses/SIMCardActionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Request a SIM card disable
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/{id}/actions/enable:
    post:
      description: 'This API enables a SIM card, connecting it to the network and making it possible to consume data.<br/>

        To enable a SIM card, it must be associated with a SIM card group.<br/>

        The 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.

        '
      operationId: EnableSimCard
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '202':
          $ref: '#/components/responses/SIMCardActionResponse'
        '422':
          $ref: '#/components/responses/wireless_UnprocessableEntity'
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Request a SIM card enable
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/{id}/actions/remove_public_ip:
    post:
      description: "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."
      operationId: RemoveSimCardPublicIp
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '202':
          $ref: '#/components/responses/SIMCardActionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Request removing a SIM card public IP
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/{id}/actions/set_public_ip:
    post:
      description: "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."
      operationId: SetSimCardPublicIp
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      - 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
        in: query
        name: region_code
        required: false
        schema:
          example: dc2
          type: string
      responses:
        '202':
          $ref: '#/components/responses/SIMCardActionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Request setting a SIM card public IP
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/{id}/actions/set_standby:
    post:
      description: '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/>

        To set a SIM card to standby, it must be associated with SIM card group.<br/>

        The 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/sim-card-actions/list-sim-card-actions) API.

        '
      operationId: SetSimCardStandby
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '202':
          $ref: '#/components/responses/SIMCardActionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Request setting a SIM card to standby
      tags:
      - SIM Cards
      x-latency-category: background
  /sim_cards/{id}/activation_code:
    get:
      description: "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"
      operationId: GetSimCardActivationCode
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '200':
          $ref: '#/components/responses/SIMCardActivationCodeResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get activation code for an eSIM
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/{id}/device_details:
    get:
      description: 'It returns the device details where a SIM card is currently being used.

        '
      operationId: GetSimCardDeviceDetails
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '200':
          $ref: '#/components/responses/SIMCardDeviceDetailsResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get SIM card device details
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/{id}/public_ip:
    get:
      description: 'It returns the public IP requested for a SIM card.

        '
      operationId: GetSimCardPublicIp
      parameters:
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '200':
          $ref: '#/components/responses/SIMCardPublicIPResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: Get SIM card public IP definition
      tags:
      - SIM Cards
      x-latency-category: responsive
  /sim_cards/{id}/wireless_connectivity_logs:
    get:
      description: This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.
      operationId: GetWirelessConnectivityLogs
      parameters:
      - $ref: '#/components/parameters/wireless_PageNumber'
      - $ref: '#/components/parameters/wireless_PageSize'
      - $ref: '#/components/parameters/SIMCardId'
      responses:
        '200':
          $ref: '#/components/responses/WirelessConnectivityLogCollectionResponse'
        '401':
          description: Unauthorized
        default:
          $ref: '#/components/responses/wireless_GenericErrorResponse'
      summary: List wireless connectivity logs
      tags:
      - SIM Cards
      x-latency-category: responsive
components:
  responses:
    SimCardDataUsageNotificationCollectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/SimCardDataUsageNotification'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMeta'
            type: object
      description: Successful Response
    UpdateSimCardDataUsageNotificationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SimCardDataUsageNotification'
            type: object
      description: Successful Response
    DeleteSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCard'
            type: object
      description: Successful response
    CreateSimCardDataUsageNotificationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SimCardDataUsageNotification'
            type: object
      description: Successful Response
    WirelessConnectivityLogCollectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/WirelessConnectivityLog'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMeta'
            type: object
      description: Successful Response
    GetSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCard'
            type: object
      description: Successful response
    SearchSimCardsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/SimpleSIMCard'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMeta'
            type: object
      description: Successful response
    wireless_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Errors'
      description: Unexpected error
    UpdateSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCard'
            type: object
      description: Successful response
    SIMCardActivationCodeResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCardActivationCode'
            type: object
      description: Successful response
    SIMCardDeviceDetailsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCardDeviceDetails'
            type: object
      description: Successful response
    SIMCardPublicIPResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCardPublicIP'
            type: object
      description: Successful response
    GetSimCardDataUsageNotificationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SimCardDataUsageNotification'
            type: object
      description: Successful Response
    SIMCardActionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SIMCardAction'
            type: object
      description: Successful Response
    BulkSIMCardActionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/BulkSIMCardAction'
            type: object
      description: Successful Response
    wireless_ResourceNotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Error'
      description: Resource not found
    DeleteSimCardDataUsageNotificationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/SimCardDataUsageNotification'
            type: object
      description: Successful Response
    RegisterSimCardsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                description: Successfully registered SIM cards.
                items:
                  $ref: '#/components/schemas/SimpleSIMCard'
                type: array
              errors:
                items:
                  $ref: '#/components/schemas/wireless_Error'
                type: array
            type: object
      description: Successful response
    wireless_UnprocessableEntity:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wireless_Errors'
      description: Unprocessable entity. Check the 'detail' field in response for details.
  schemas:
    wireless_UpdatedAt:
      description: ISO 8601 formatted date-time indicating when the resource was updated.
      example: '2018-02-02T22:25:27.521Z'
      readOnly: true
      type: string
    WirelessConnectivityLog:
      description: This object represents a wireless connectivity session log that happened through a SIM card. It aids in finding out potential problems when the SIM is not able to attach properly.
      properties:
        apn:
          description: The Access Point Name (APN) identifies the packet data network that a mobile data user wants to communicate with.
          example: data00.telnyx
          readOnly: true
          type: string
        cell_id:
          description: The cell ID to which the SIM connected.
          example: 311210-6813
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date-time indicating when the record was created.
          example: '2018-02-02T22:25:27.521Z'
          readOnly: true
          type: string
        id:
          description: Uniquely identifies the session.
          example: 137509451
          readOnly: true
          type: integer
        imei:
          description: The International Mobile Equipment Identity (or IMEI) is a number, usually unique, that identifies the device currently being used connect to the network.
          example: '490154203237518'
          readOnly: true
          type: string
        imsi:
          description: 'SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI). <br/>

            Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber  Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home  Location Register (HLR) or the Visitor Location Register (VLR).

            '
          example: 081932214823362973
          readOnly: true
          type: string
        ipv4:
          description: 'The SIM''s address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.

            '
          example: 192.168.0.0
          readOnly: true
          type: string
        ipv6:
          description: 'The SIM''s address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.

            '
          example: 2001:cdba:0000:0000:0000:0000:3257:9652
          readOnly: true
          type: string
        last_seen:
          description: ISO 8601 formatted date-time indicating when the last heartbeat to the device was successfully recorded.
          example: '2018-02-02T22:25:27.521Z'
          readOnly: true
          type: string
        log_type:
          description: The type of the session, 'registration' being the initial authentication session and 'data' the actual data transfer sessions.
          enum:
          - registration
          - data
          example: registration
          readOnly: true
          type: string
        mobile_country_code:
          description: 'It''s a three decimal digit that identifies a country.<br/><br/>

            This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public L

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-sim-cards-api-openapi.yml