Telnyx

opencollection: 1.0.0
info:
  name: Telnyx API
  version: 2.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: OAuth Discovery
    type: folder
  items:
  - info:
      name: Authorization server metadata
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/.well-known/oauth-authorization-server
    docs: OAuth 2.0 Authorization Server Metadata (RFC 8414)
  - info:
      name: Protected resource metadata
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/.well-known/oauth-protected-resource
    docs: OAuth 2.0 Protected Resource Metadata for resource discovery
- info:
    name: Brands
    type: folder
  items:
  - info:
      name: List Brands
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand
      params:
      - name: page
        value: ''
        type: query
      - name: recordsPerPage
        value: ''
        type: query
        description: number of records per page. maximum of 500
      - name: sort
        value: -identityStatus
        type: query
        description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
      - name: displayName
        value: ''
        type: query
      - name: entityType
        value: ''
        type: query
      - name: state
        value: ''
        type: query
      - name: country
        value: ''
        type: query
      - name: brandId
        value: ''
        type: query
        description: Filter results by the Telnyx Brand id
      - name: tcrBrandId
        value: ''
        type: query
        description: Filter results by the TCR Brand id
    docs: This endpoint is used to list all brands associated with your organization.
  - info:
      name: Create Brand
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/brand
      body:
        type: json
        data: '{}'
    docs: This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents
      an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation
      will entail an upfront, non-refundable $4 expense.
  - info:
      name: Get Brand Feedback By Id
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand/feedback/:brandId
      params:
      - name: brandId
        value: ''
        type: path
    docs: "Get feedback about a brand by ID. This endpoint can be used after creating or revetting\na brand.\n\nPossible values\
      \ for `.category[].id`:\n\n* `TAX_ID` - Data mismatch related to tax id and its associated properties.\n* `STOCK_SYMBOL`\
      \ - Non public entity registered as a public for profit entity or\n  the stock information mismatch.\n* `GOVERNMENT_ENTITY`\
      \ - Non government entity registered as a government entity.\n  Must be a U.S. government entity.\n* `NONPROFIT` - Not\
      \ a recognized non-profit entity. No "
  - info:
      name: Get Brand SMS OTP Status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand/smsOtp/:referenceId
      params:
      - name: referenceId
        value: ''
        type: path
        description: The reference ID returned when the OTP was initially triggered
      - name: brandId
        value: ''
        type: query
        description: Filter by Brand ID for easier lookup in portal applications
    docs: 'Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification.


      This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand
      verification process. You can query by either:


      * `referenceId` - The reference ID returned when the OTP was initially triggered

      * `brandId` - Query parameter for portal users to look up OTP status by Brand ID


      The response includes delivery status, verification dates, and detailed delive'
  - info:
      name: Get Brand
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId
      params:
      - name: brandId
        value: ''
        type: path
    docs: Retrieve a brand by `brandId`.
  - info:
      name: Update Brand
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId
      params:
      - name: brandId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a brand's attributes by `brandId`.
  - info:
      name: Delete Brand
      type: http
    http:
      method: DELETE
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId
      params:
      - name: brandId
        value: ''
        type: path
    docs: Delete Brand. This endpoint is used to delete a brand. Note the brand cannot be deleted if it contains one or more
      active campaigns, the campaigns need to be inactive and at least 3 months old due to billing purposes.
  - info:
      name: Resend brand 2FA email
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/2faEmail
      params:
      - name: brandId
        value: ''
        type: path
    docs: Resend brand 2FA email
  - info:
      name: List External Vettings
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting
      params:
      - name: brandId
        value: ''
        type: path
    docs: Get list of valid external vetting record for a given brand
  - info:
      name: Order Brand External Vetting
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting
      params:
      - name: brandId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Order new external vetting for a brand.


      Duplicate orders for the same `evpId` and `vettingClass` return `400` with code `10012` if a successful vetting exists
      within the last 180 days, or one is currently being processed. Failed vettings can be retried immediately.'
  - info:
      name: Import External Vetting Record
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting
      params:
      - name: brandId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'This operation can be used to import an external vetting record from a TCR-approved

      vetting provider. If the vetting provider confirms validity of the record, it will be

      saved with the brand and will be considered for future campaign qualification.'
  - info:
      name: Revet Brand
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/revet
      params:
      - name: brandId
        value: ''
        type: path
    docs: This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration
      and thereafter limited to once every 3 months.
  - info:
      name: Get Brand SMS OTP Status by Brand ID
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp
      params:
      - name: brandId
        value: ''
        type: path
        description: The Brand ID for which to query OTP status
    docs: 'Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.


      This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand
      verification process by looking it up with the brand ID.


      The response includes delivery status, verification dates, and detailed delivery information.


      **Note:** This is an alternative to the `/10dlc/brand/smsOtp/{referenceId}` endpoint when you have the Brand ID but
      n'
  - info:
      name: Trigger Brand SMS OTP
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp
      params:
      - name: brandId
        value: ''
        type: path
        description: The Brand ID for which to trigger the OTP
      body:
        type: json
        data: '{}'
    docs: 'Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.


      **Important Notes:**


      * Only allowed for Sole Proprietor (`SOLE_PROPRIETOR`) brands

      * Triggers generation of a one-time password sent to the `mobilePhone` number in the brand''s profile

      * Campaigns cannot be created until OTP verification is complete

      * US/CA numbers only for real OTPs; mock brands can use non-US/CA numbers for testing

      * Returns a `referenceId` that can be used to check OTP status via the'
  - info:
      name: Verify Brand SMS OTP
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp
      params:
      - name: brandId
        value: ''
        type: path
        description: The Brand ID for which to verify the OTP
      body:
        type: json
        data: '{}'
    docs: "Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\n**Verification Flow:**\n\n1.\
      \ User receives OTP via SMS after triggering\n2. User submits the OTP pin through this endpoint\n3. Upon successful\
      \ verification:\n   - A `BRAND_OTP_VERIFIED` webhook event is sent to the CSP\n   - The brand's `identityStatus` changes\
      \ to `VERIFIED`\n   - Campaigns can now be created for this brand\n\n**Error Handling:**\n\nProvides proper error responses\
      \ for:\n* Invalid OTP pins\n* Expired OTPs\n* OTP ve"
- info:
    name: Campaign
    type: folder
  items:
  - info:
      name: List Campaigns
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign
      params:
      - name: brandId
        value: ''
        type: query
      - name: page
        value: ''
        type: query
        description: The 1-indexed page number to get. The default value is `1`.
      - name: recordsPerPage
        value: ''
        type: query
        description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
      - name: sort
        value: -assignedPhoneNumbersCount
        type: query
        description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
    docs: Retrieve a list of campaigns associated with a supplied `brandId`.
  - info:
      name: Accept Shared Campaign
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/campaign/acceptSharing/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
        description: TCR's ID for the campaign to import
    docs: Manually accept a campaign shared with Telnyx
  - info:
      name: Get Campaign Cost
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/usecase/cost
      params:
      - name: usecase
        value: ''
        type: query
    docs: Get Campaign Cost
  - info:
      name: Get campaign
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
    docs: Retrieve campaign details by `campaignId`.
  - info:
      name: Update campaign
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update a campaign's properties by `campaignId`. **Please note:** only sample messages are editable.
  - info:
      name: Deactivate campaign
      type: http
    http:
      method: DELETE
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
    docs: Terminate a campaign. Note that once deactivated, a campaign cannot be restored.
  - info:
      name: Submit campaign appeal for manual review
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId/appeal
      params:
      - name: campaignId
        value: ''
        type: path
        description: The Telnyx campaign identifier
      body:
        type: json
        data: '{}'
    docs: 'Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. The appeal is recorded
      for manual compliance team review and the campaign status is reset to TCR_ACCEPTED. Note: Appeal forwarding is handled
      manually to allow proper review before incurring upstream charges.'
  - info:
      name: Get Campaign Mno Metadata
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId/mnoMetadata
      params:
      - name: campaignId
        value: ''
        type: path
        description: ID of the campaign in question
    docs: Get the campaign metadata for each MNO it was submitted to.
  - info:
      name: Get campaign operation status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId/operationStatus
      params:
      - name: campaignId
        value: ''
        type: path
    docs: Retrieve campaign's operation status at MNO level.
  - info:
      name: Get OSR campaign attributes
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId/osr/attributes
      params:
      - name: campaignId
        value: ''
        type: path
    docs: Get OSR campaign attributes
  - info:
      name: Get Sharing Status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaign/:campaignId/sharing
      params:
      - name: campaignId
        value: ''
        type: path
        description: ID of the campaign in question
    docs: Get Sharing Status
  - info:
      name: Submit Campaign
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/campaignBuilder
      body:
        type: json
        data: '{}'
    docs: Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/api-reference/campaign/qualify-by-usecase)
      to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign.
      **Please note:** After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign
      will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case ([see 10DLC Costs
      s
  - info:
      name: Qualify By Usecase
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/:brandId/usecase/:usecase
      params:
      - name: usecase
        value: ''
        type: path
      - name: brandId
        value: ''
        type: path
    docs: This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case.
- info:
    name: Enum
    type: folder
  items:
  - info:
      name: Get Enum
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/enum/:endpoint
      params:
      - name: endpoint
        value: ''
        type: path
    docs: Get Enum
- info:
    name: Shared Campaigns
    type: folder
  items:
  - info:
      name: List shared partner campaigns
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/partnerCampaign/sharedByMe
      params:
      - name: page
        value: ''
        type: query
        description: The 1-indexed page number to get. The default value is `1`.
      - name: recordsPerPage
        value: ''
        type: query
        description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
    docs: 'Get all partner campaigns you have shared to Telnyx in a paginated fashion


      This endpoint is currently limited to only returning shared campaigns that Telnyx

      has accepted. In other words, shared but pending campaigns are currently omitted

      from the response from this endpoint.'
  - info:
      name: Get Sharing Status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/partnerCampaign/:campaignId/sharing
      params:
      - name: campaignId
        value: ''
        type: path
        description: ID of the campaign in question
    docs: Get Sharing Status
  - info:
      name: List Shared Campaigns
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/partner_campaigns
      params:
      - name: page
        value: ''
        type: query
        description: The 1-indexed page number to get. The default value is `1`.
      - name: recordsPerPage
        value: ''
        type: query
        description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
      - name: sort
        value: -assignedPhoneNumbersCount
        type: query
        description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
    docs: 'Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion.


      This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared
      but pending campaigns are currently omitted from the response from this endpoint.'
  - info:
      name: Get Single Shared Campaign
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/partner_campaigns/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
    docs: Retrieve campaign details by `campaignId`.
  - info:
      name: Update Single Shared Campaign
      type: http
    http:
      method: PATCH
      url: https://api.telnyx.com/v2/10dlc/partner_campaigns/:campaignId
      params:
      - name: campaignId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update campaign details by `campaignId`. **Please note:** Only webhook urls are editable.
- info:
    name: Bulk Phone Number Campaigns
    type: folder
  items:
  - info:
      name: Assign Messaging Profile To Campaign
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile
      body:
        type: json
        data: '{}'
    docs: This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. **Please note:**
      if you want to assign phone numbers to a campaign that you did not create with Telnyx 10DLC services, this endpoint
      allows that provided that you've shared the campaign with Telnyx. In this case, only provide the parameter, `tcrCampaignId`,
      and not `campaignId`. In all other cases (where the campaign you're assigning was created with Telnyx 10DLC services),
      only provide `campaig
  - info:
      name: Get Assignment Task Status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile/:taskId
      params:
      - name: taskId
        value: ''
        type: path
    docs: Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by
      `taskId`.
  - info:
      name: Get Phone Number Status
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile/:taskId/phoneNumbers
      params:
      - name: taskId
        value: ''
        type: path
      - name: recordsPerPage
        value: ''
        type: query
      - name: page
        value: ''
        type: query
    docs: Check the status of the individual phone number/campaign assignments associated with the supplied `taskId`.
- info:
    name: Phone Number Campaigns
    type: folder
  items:
  - info:
      name: List phone number campaigns
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/phone_number_campaigns
      params:
      - name: recordsPerPage
        value: ''
        type: query
      - name: page
        value: ''
        type: query
      - name: filter
        value: ''
        type: query
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id],
          filter[tcr_campaign_id], filter[tcr_brand_id]'
      - name: sort
        value: -phoneNumber
        type: query
        description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
    docs: List phone number campaigns
  - info:
      name: Create New Phone Number Campaign
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/10dlc/phone_number_campaigns
      body:
        type: json
        data: '{}'
    docs: Create New Phone Number Campaign
  - info:
      name: Get Single Phone Number Campaign
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber
      params:
      - name: phoneNumber
        value: ''
        type: path
    docs: Retrieve an individual phone number/campaign assignment by `phoneNumber`.
  - info:
      name: Create New Phone Number Campaign
      type: http
    http:
      method: PUT
      url: https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber
      params:
      - name: phoneNumber
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create New Phone Number Campaign
  - info:
      name: Delete Phone Number Campaign
      type: http
    http:
      method: DELETE
      url: https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber
      params:
      - name: phoneNumber
        value: ''
        type: path
    docs: This endpoint allows you to remove a campaign assignment from the supplied `phoneNumber`.
- info:
    name: IP Addresses
    type: folder
  items:
  - info:
      name: List all Access IP Addresses
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/access_ip_address
      params:
      - name: filter
        value: ''
        type: query
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[ip_source], filter[ip_address],
          filter[created_at]. Supports complex bracket operations for dynamic filtering.'
      - name: page
        value: ''
        type: query
        description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
    docs: List all Access IP Addresses
  - info:
      name: Create new Access IP Address
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/access_ip_address
      body:
        type: json
        data: '{}'
    docs: Create new Access IP Address
  - info:
      name: Retrieve an access IP address
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/access_ip_address/:access_ip_address_id
      params:
      - name: access_ip_address_id
        value: ''
        type: path
    docs: Retrieve an access IP address
  - info:
      name: Delete access IP address
      type: http
    http:
      method: DELETE
      url: https://api.telnyx.com/v2/access_ip_address/:access_ip_address_id
      params:
      - name: access_ip_address_id
        value: ''
        type: path
    docs: Delete access IP address
- info:
    name: IP Ranges
    type: folder
  items:
  - info:
      name: List all Access IP Ranges
      type: http
    http:
      method: GET
      url: https://api.telnyx.com/v2/access_ip_ranges
      params:
      - name: filter
        value: ''
        type: query
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[cidr_block], filter[cidr_block][startswith],
          filter[cidr_block][endswith], filter[cidr_block][contains], filter[created_at]. Supports complex bracket operations
          for dynamic filtering.'
      - name: page
        value: ''
        type: query
        description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]'
    docs: List all Access IP Ranges
  - info:
      name: Create new Access IP Range
      type: http
    http:
      method: POST
      url: https://api.telnyx.com/v2/access_ip_ranges
      body:
        type: json
        data: '{}'
    docs: Create new Access IP Range
  - info:
      name: Delete access IP ranges
      type: http
    http:
      method: DELETE
      url: https://api.telnyx.com/v2/access_ip_ranges/:access_ip_range_id
      params:
      - name: access_ip_range_id
        value: ''
        type: path
    docs: Delete access IP ranges
- 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/>

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

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

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

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

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

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

      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.

      '
  - 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
        

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