Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx SIM Card Groups API

SIM Card Groups operations

Telnyx SIM Card Groups API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SIM Card Groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 6 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

9 operations 6 paths 9 schemas 1 DELETE2 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx SIM Card Groups API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

SIM Card Groups 9

SIM Card Groups operations

GET
/sim_card_groups
Get all SIM card groups
GetAllSimCardGroups 5 params → 200401default
POST
/sim_card_groups
Create a SIM card group
CreateSimCardGroup body → 200401default
DELETE
/sim_card_groups/{id}
Delete a SIM card group
DeleteSimCardGroup 1 param → 200401default
GET
/sim_card_groups/{id}
Get SIM card group
GetSimCardGroup 2 params → 200401default
PATCH
/sim_card_groups/{id}
Update a SIM card group
UpdateSimCardGroup 1 param body → 200401default
POST
/sim_card_groups/{id}/actions/remove_private_wireless_gateway
Request Private Wireless Gateway removal from SIM card group
RemoveSimCardGroupPrivateWirelessGateway 1 param → 202401default
POST
/sim_card_groups/{id}/actions/remove_wireless_blocklist
Request Wireless Blocklist removal from SIM card group
RemoveWirelessBlocklistForSimCardGroup 1 param → 202401default
POST
/sim_card_groups/{id}/actions/set_private_wireless_gateway
Request Private Wireless Gateway assignment for SIM card group
SetPrivateWirelessGatewayForSimCardGroup 1 param body → 202401default
POST
/sim_card_groups/{id}/actions/set_wireless_blocklist
Request Wireless Blocklist assignment for SIM card group
SetWirelessBlocklistForSimCardGroup 1 param body → 202401default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SearchedSIMCardGroup (11 properties), SIMCardGroup (10 properties), SIMCardGroupAction (8 properties), wireless_Error (5 properties). Each schema is shown below with its type and property counts.

ConsumedData
object
Represents the amount of data consumed.
2 properties
SearchedSIMCardGroup
object
11 properties
SIMCardGroupPatch
object
2 properties
SIMCardGroupAction
object
This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in i…
8 properties
wireless_Errors
object
1 property
wireless_Error
object
5 properties 2 required
SIMCardGroupCreate
object
2 properties 1 required
SIMCardGroup
object
10 properties
PaginationMeta
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-sim-card-groups-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API