Telnyx API — SIM Cards

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — SIM Cards
  description: 'Telnyx API — SIM Cards. 24 operations. Lead operation: Purchase eSIMs. Self-contained Naftiko capability covering
    one Telnyx business surface.'
  tags:
  - Telnyx
  - SIM Cards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-sim-cards
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — SIM Cards business capability. Self-contained, no shared references.
    resources:
    - name: actions-purchase-esims
      path: /actions/purchase/esims
      operations:
      - name: purchaseesim
        method: POST
        description: Purchase eSIMs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: actions-register-sim_cards
      path: /actions/register/sim_cards
      operations:
      - name: registersimcards
        method: POST
        description: Register SIM cards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_card_data_usage_notifications
      path: /sim_card_data_usage_notifications
      operations:
      - name: listdatausagenotifications
        method: GET
        description: List SIM card data usage notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postsimcarddatausagenotification
        method: POST
        description: Create a new SIM card data usage notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_card_data_usage_notifications-id
      path: /sim_card_data_usage_notifications/{id}
      operations:
      - name: deletesimcarddatausagenotifications
        method: DELETE
        description: Delete SIM card data usage notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: getsimcarddatausagenotification
        method: GET
        description: Get a single SIM card data usage notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchsimcarddatausagenotification
        method: PATCH
        description: Updates information for a SIM Card Data Usage Notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_cards
      path: /sim_cards
      operations:
      - name: getsimcards
        method: GET
        description: Get all SIM cards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sort
          in: query
          type: string
          description: Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus
            sign.
    - name: sim_cards-actions-bulk_disable_voice
      path: /sim_cards/actions/bulk_disable_voice
      operations:
      - name: disablevoicebulk
        method: POST
        description: Request bulk disabling voice on SIM cards.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: sim_cards-actions-bulk_enable_voice
      path: /sim_cards/actions/bulk_enable_voice
      operations:
      - name: enablevoicebulk
        method: POST
        description: Request bulk enabling voice on SIM cards.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: sim_cards-actions-bulk_set_public_ips
      path: /sim_cards/actions/bulk_set_public_ips
      operations:
      - name: setpublicipsbulk
        method: POST
        description: Request bulk setting SIM card public IPs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: sim_cards-actions-validate_registration_codes
      path: /sim_cards/actions/validate_registration_codes
      operations:
      - name: validateregistrationcodes
        method: POST
        description: Validate SIM cards registration codes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_cards-id
      path: /sim_cards/{id}
      operations:
      - name: deletesimcard
        method: DELETE
        description: Deletes a SIM card
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: report_lost
          in: query
          type: boolean
          description: Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and
            the eSIM cannot be re-registered.
      - name: getsimcard
        method: GET
        description: Get SIM card
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_pin_puk_codes
          in: query
          type: boolean
          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
      - name: updatesimcard
        method: PATCH
        description: Update a SIM card
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sim_cards-id-actions-disable
      path: /sim_cards/{id}/actions/disable
      operations:
      - name: disablesimcard
        method: POST
        description: Request a SIM card disable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-actions-enable
      path: /sim_cards/{id}/actions/enable
      operations:
      - name: enablesimcard
        method: POST
        description: Request a SIM card enable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-actions-remove_public_ip
      path: /sim_cards/{id}/actions/remove_public_ip
      operations:
      - name: removesimcardpublicip
        method: POST
        description: Request removing a SIM card public IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-actions-set_public_ip
      path: /sim_cards/{id}/actions/set_public_ip
      operations:
      - name: setsimcardpublicip
        method: POST
        description: Request setting a SIM card public IP
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: region_code
          in: query
          type: string
          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
    - name: sim_cards-id-actions-set_standby
      path: /sim_cards/{id}/actions/set_standby
      operations:
      - name: setsimcardstandby
        method: POST
        description: Request setting a SIM card to standby
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-activation_code
      path: /sim_cards/{id}/activation_code
      operations:
      - name: getsimcardactivationcode
        method: GET
        description: Get activation code for an eSIM
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-device_details
      path: /sim_cards/{id}/device_details
      operations:
      - name: getsimcarddevicedetails
        method: GET
        description: Get SIM card device details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-public_ip
      path: /sim_cards/{id}/public_ip
      operations:
      - name: getsimcardpublicip
        method: GET
        description: Get SIM card public IP definition
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sim_cards-id-wireless_connectivity_logs
      path: /sim_cards/{id}/wireless_connectivity_logs
      operations:
      - name: getwirelessconnectivitylogs
        method: GET
        description: List wireless connectivity logs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-sim-cards-rest
    port: 8080
    description: REST adapter for Telnyx API — SIM Cards. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/actions/purchase/esims
      name: actions-purchase-esims
      description: REST surface for actions-purchase-esims.
      operations:
      - method: POST
        name: purchaseesim
        description: Purchase eSIMs
        call: telnyx-sim-cards.purchaseesim
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/actions/register/sim-cards
      name: actions-register-sim-cards
      description: REST surface for actions-register-sim_cards.
      operations:
      - method: POST
        name: registersimcards
        description: Register SIM cards
        call: telnyx-sim-cards.registersimcards
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-data-usage-notifications
      name: sim-card-data-usage-notifications
      description: REST surface for sim_card_data_usage_notifications.
      operations:
      - method: GET
        name: listdatausagenotifications
        description: List SIM card data usage notifications
        call: telnyx-sim-cards.listdatausagenotifications
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postsimcarddatausagenotification
        description: Create a new SIM card data usage notification
        call: telnyx-sim-cards.postsimcarddatausagenotification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-card-data-usage-notifications/{id}
      name: sim-card-data-usage-notifications-id
      description: REST surface for sim_card_data_usage_notifications-id.
      operations:
      - method: DELETE
        name: deletesimcarddatausagenotifications
        description: Delete SIM card data usage notifications
        call: telnyx-sim-cards.deletesimcarddatausagenotifications
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsimcarddatausagenotification
        description: Get a single SIM card data usage notification
        call: telnyx-sim-cards.getsimcarddatausagenotification
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchsimcarddatausagenotification
        description: Updates information for a SIM Card Data Usage Notification
        call: telnyx-sim-cards.patchsimcarddatausagenotification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards
      name: sim-cards
      description: REST surface for sim_cards.
      operations:
      - method: GET
        name: getsimcards
        description: Get all SIM cards
        call: telnyx-sim-cards.getsimcards
        with:
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/actions/bulk-disable-voice
      name: sim-cards-actions-bulk-disable-voice
      description: REST surface for sim_cards-actions-bulk_disable_voice.
      operations:
      - method: POST
        name: disablevoicebulk
        description: Request bulk disabling voice on SIM cards.
        call: telnyx-sim-cards.disablevoicebulk
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/actions/bulk-enable-voice
      name: sim-cards-actions-bulk-enable-voice
      description: REST surface for sim_cards-actions-bulk_enable_voice.
      operations:
      - method: POST
        name: enablevoicebulk
        description: Request bulk enabling voice on SIM cards.
        call: telnyx-sim-cards.enablevoicebulk
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/actions/bulk-set-public-ips
      name: sim-cards-actions-bulk-set-public-ips
      description: REST surface for sim_cards-actions-bulk_set_public_ips.
      operations:
      - method: POST
        name: setpublicipsbulk
        description: Request bulk setting SIM card public IPs.
        call: telnyx-sim-cards.setpublicipsbulk
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/actions/validate-registration-codes
      name: sim-cards-actions-validate-registration-codes
      description: REST surface for sim_cards-actions-validate_registration_codes.
      operations:
      - method: POST
        name: validateregistrationcodes
        description: Validate SIM cards registration codes
        call: telnyx-sim-cards.validateregistrationcodes
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}
      name: sim-cards-id
      description: REST surface for sim_cards-id.
      operations:
      - method: DELETE
        name: deletesimcard
        description: Deletes a SIM card
        call: telnyx-sim-cards.deletesimcard
        with:
          report_lost: rest.report_lost
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsimcard
        description: Get SIM card
        call: telnyx-sim-cards.getsimcard
        with:
          include_pin_puk_codes: rest.include_pin_puk_codes
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesimcard
        description: Update a SIM card
        call: telnyx-sim-cards.updatesimcard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/actions/disable
      name: sim-cards-id-actions-disable
      description: REST surface for sim_cards-id-actions-disable.
      operations:
      - method: POST
        name: disablesimcard
        description: Request a SIM card disable
        call: telnyx-sim-cards.disablesimcard
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/actions/enable
      name: sim-cards-id-actions-enable
      description: REST surface for sim_cards-id-actions-enable.
      operations:
      - method: POST
        name: enablesimcard
        description: Request a SIM card enable
        call: telnyx-sim-cards.enablesimcard
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/actions/remove-public-ip
      name: sim-cards-id-actions-remove-public-ip
      description: REST surface for sim_cards-id-actions-remove_public_ip.
      operations:
      - method: POST
        name: removesimcardpublicip
        description: Request removing a SIM card public IP
        call: telnyx-sim-cards.removesimcardpublicip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/actions/set-public-ip
      name: sim-cards-id-actions-set-public-ip
      description: REST surface for sim_cards-id-actions-set_public_ip.
      operations:
      - method: POST
        name: setsimcardpublicip
        description: Request setting a SIM card public IP
        call: telnyx-sim-cards.setsimcardpublicip
        with:
          region_code: rest.region_code
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/actions/set-standby
      name: sim-cards-id-actions-set-standby
      description: REST surface for sim_cards-id-actions-set_standby.
      operations:
      - method: POST
        name: setsimcardstandby
        description: Request setting a SIM card to standby
        call: telnyx-sim-cards.setsimcardstandby
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/activation-code
      name: sim-cards-id-activation-code
      description: REST surface for sim_cards-id-activation_code.
      operations:
      - method: GET
        name: getsimcardactivationcode
        description: Get activation code for an eSIM
        call: telnyx-sim-cards.getsimcardactivationcode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/device-details
      name: sim-cards-id-device-details
      description: REST surface for sim_cards-id-device_details.
      operations:
      - method: GET
        name: getsimcarddevicedetails
        description: Get SIM card device details
        call: telnyx-sim-cards.getsimcarddevicedetails
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/public-ip
      name: sim-cards-id-public-ip
      description: REST surface for sim_cards-id-public_ip.
      operations:
      - method: GET
        name: getsimcardpublicip
        description: Get SIM card public IP definition
        call: telnyx-sim-cards.getsimcardpublicip
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sim-cards/{id}/wireless-connectivity-logs
      name: sim-cards-id-wireless-connectivity-logs
      description: REST surface for sim_cards-id-wireless_connectivity_logs.
      operations:
      - method: GET
        name: getwirelessconnectivitylogs
        description: List wireless connectivity logs
        call: telnyx-sim-cards.getwirelessconnectivitylogs
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-sim-cards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — SIM Cards. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: purchase-esims
      description: Purchase eSIMs
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.purchaseesim
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: register-sim-cards
      description: Register SIM cards
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.registersimcards
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-sim-card-data-usage
      description: List SIM card data usage notifications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.listdatausagenotifications
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-sim-card-data
      description: Create a new SIM card data usage notification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.postsimcarddatausagenotification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-sim-card-data-usage
      description: Delete SIM card data usage notifications
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-sim-cards.deletesimcarddatausagenotifications
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-sim-card-data
      description: Get a single SIM card data usage notification
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcarddatausagenotification
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-information-sim-card-data
      description: Updates information for a SIM Card Data Usage Notification
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.patchsimcarddatausagenotification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-sim-cards
      description: Get all SIM cards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcards
      with:
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: request-bulk-disabling-voice-sim
      description: Request bulk disabling voice on SIM cards.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.disablevoicebulk
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-bulk-enabling-voice-sim
      description: Request bulk enabling voice on SIM cards.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.enablevoicebulk
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-bulk-setting-sim-card
      description: Request bulk setting SIM card public IPs.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.setpublicipsbulk
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-sim-cards-registration-codes
      description: Validate SIM cards registration codes
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.validateregistrationcodes
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-sim-card
      description: Deletes a SIM card
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-sim-cards.deletesimcard
      with:
        report_lost: tools.report_lost
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sim-card
      description: Get SIM card
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcard
      with:
        include_pin_puk_codes: tools.include_pin_puk_codes
      outputParameters:
      - type: object
        mapping: $.
    - name: update-sim-card
      description: Update a SIM card
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.updatesimcard
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: request-sim-card-disable
      description: Request a SIM card disable
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.disablesimcard
      outputParameters:
      - type: object
        mapping: $.
    - name: request-sim-card-enable
      description: Request a SIM card enable
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.enablesimcard
      outputParameters:
      - type: object
        mapping: $.
    - name: request-removing-sim-card-public
      description: Request removing a SIM card public IP
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.removesimcardpublicip
      outputParameters:
      - type: object
        mapping: $.
    - name: request-setting-sim-card-public
      description: Request setting a SIM card public IP
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.setsimcardpublicip
      with:
        region_code: tools.region_code
      outputParameters:
      - type: object
        mapping: $.
    - name: request-setting-sim-card-standby
      description: Request setting a SIM card to standby
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-sim-cards.setsimcardstandby
      outputParameters:
      - type: object
        mapping: $.
    - name: get-activation-code-esim
      description: Get activation code for an eSIM
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcardactivationcode
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sim-card-device-details
      description: Get SIM card device details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcarddevicedetails
      outputParameters:
      - type: object
        mapping: $.
    - name: get-sim-card-public-ip
      description: Get SIM card public IP definition
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getsimcardpublicip
      outputParameters:
      - type: object
        mapping: $.
    - name: list-wireless-connectivity-logs
      description: List wireless connectivity logs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-sim-cards.getwirelessconnectivitylogs
      outputParameters:
      - type: object
        mapping: $.