Telnyx SIM Card Group Actions API
SIM Card Group actions operations
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-sim-card-group-actions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Telnyx SIM Card Group Actions API
version: 2.0.0
contact:
email: support@telnyx.com
x-endpoint-cost: light
x-refined-note:
- x-latency-category differs across the merged source definitions and was not carried
description: 'Operations tagged SIM Card Group Actions across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: SIM Card Group Actions
description: SIM Card Group actions operations
paths:
/sim_card_group_actions:
get:
operationId: GetSimCardGroupActions
summary: List SIM card group actions
description: This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
tags:
- SIM Card Group Actions
parameters:
- $ref: '#/components/parameters/wireless_PageNumber_c5290d5308'
- $ref: '#/components/parameters/wireless_PageSize_c5290d5308'
- $ref: '#/components/parameters/FilterSIMCardGroupId'
- $ref: '#/components/parameters/FilterBasicStatusLifecycle'
- name: filter[type]
description: Filter by action type.
in: query
required: false
schema:
type: string
enum:
- set_private_wireless_gateway
- remove_private_wireless_gateway
- set_wireless_blocklist
- remove_wireless_blocklist
example: set_private_wireless_gateway
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SIMCardGroupAction'
meta:
$ref: '#/components/schemas/PaginationMeta'
description: Successful Response
'401':
description: Unauthorized
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/sim_card_group_actions/{id}:
get:
operationId: GetSimCardGroupAction
summary: Get SIM card group action details
description: This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
tags:
- SIM Card Group Actions
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/SIMCardGroupAction'
description: Successful Response
'401':
description: Unauthorized
default:
$ref: '#/components/responses/wireless_GenericErrorResponse_c5290d5308'
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
parameters:
wireless_PageSize_c5290d5308:
name: page[size]
in: query
description: The size of the page.
schema:
type: integer
minimum: 1
maximum: 250
default: 20
FilterBasicStatusLifecycle:
name: filter[status]
description: Filter by a specific status of the resource's lifecycle.
in: query
required: false
schema:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
wireless_PageNumber_c5290d5308:
name: page[number]
in: query
description: The page number to load.
schema:
type: integer
minimum: 1
default: 1
FilterSIMCardGroupId:
name: filter[sim_card_group_id]
description: A valid SIM card group ID.
schema:
format: uuid
type: string
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
in: query
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
wireless_PageNumber:
description: The page number to load.
in: query
name: page[number]
schema:
default: 1
minimum: 1
type: integer
wireless_PageSize:
description: The size of the page.
in: query
name: page[size]
schema:
default: 20
maximum: 250
minimum: 1
type: integer
responses:
wireless_GenericErrorResponse_c5290d5308:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
unexpectedError:
summary: Unexpected API error
value:
errors:
- code: '10007'
title: Unexpected error
detail: An unexpected error occured.
wireless_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/wireless_Errors'
description: Unexpected error
SimCardGroupActionCollectionResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/SIMCardGroupAction_2'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
type: object
description: Successful Response
SIMCardGroupActionResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/SIMCardGroupAction_2'
type: object
description: Successful Response
schemas:
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
PaginationMeta:
type: object
properties:
total_pages:
type: integer
example: 3
total_results:
type: integer
example: 55
page_number:
type: integer
example: 2
page_size:
type: integer
example: 25
billing-group_Error:
type: object
required:
- code
- title
properties:
code:
type: integer
format: int32
title:
type: string
detail:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
properties: {}
additionalProperties: true
SIMCardGroupAction:
type: object
title: SIMCardGroupAction
description: 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 it.
properties:
id:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
record_type:
type: string
example: sim_card_group_action
readOnly: true
sim_card_group_id:
type: string
format: uuid
description: The SIM card group identification.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
type:
type: string
description: Represents the type of the operation requested.
enum:
- set_private_wireless_gateway
- remove_private_wireless_gateway
- set_wireless_blocklist
- remove_wireless_blocklist
example: set_private_wireless_gateway
status:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
settings:
type: object
description: A JSON object representation of the action params.
properties:
private_wireless_gateway_id:
description: The identification of the related Private Wireless Gateway resource.
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
wireless_blocklist_id:
description: The identification of the related Wireless Blocklist resource.
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
created_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
updated_at:
type: string
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
wireless_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/wireless_Error'
type: array
type: object
wireless_Error:
properties:
code:
type: string
detail:
type: string
meta:
additionalProperties: true
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
type: object
title:
type: string
required:
- code
- title
type: object
SIMCardGroupAction_2:
description: 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 it.
properties:
created_at:
description: ISO 8601 formatted date-time indicating when the resource was created.
example: '2018-02-02T22:25:27.521Z'
readOnly: true
type: string
id:
description: Identifies the resource.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
readOnly: true
type: string
record_type:
example: sim_card_group_action
readOnly: true
type: string
settings:
description: A JSON object representation of the action params.
properties:
private_wireless_gateway_id:
description: The identification of the related Private Wireless Gateway resource.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
type: object
sim_card_group_id:
description: The SIM card group identification.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
type: string
status:
enum:
- in-progress
- completed
- failed
example: in-progress
type: string
type:
description: Represents the type of the operation requested.
enum:
- set_private_wireless_gateway
- remove_private_wireless_gateway
- set_wireless_blocklist
- remove_wireless_blocklist
example: set_private_wireless_gateway
type: string
updated_at:
description: ISO 8601 formatted date-time indicating when the resource was updated.
example: '2018-02-02T22:25:27.521Z'
readOnly: true
type: string
title: SIMCardGroupAction
type: object
Errors_2:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/Error'
type: object
Error:
required:
- code
- title
properties:
code:
type: string
x-format: int64
title:
type: string
detail:
type: string
description: A human-readable explanation of the error.
description:
type: string
source:
type: object
properties:
pointer:
description: JSON pointer (RFC6901) to the offending entity.
type: string
format: json-pointer
parameter:
description: Indicates which query parameter caused the error.
type: string
meta:
type: object
additionalProperties: true
example:
title: Invalid street address
source:
pointer: /street_address
code: '20207'
description: The street address provided is invalid.
type: object
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
Payment:
type: apiKey
in: header
name: Authorization
description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
agent-memory_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
bearerAuth:
type: http
scheme: bearer
branded-calling_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
collections_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
number-reputation_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
oauthClientAuth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
tokenUrl: https://api.telnyx.com/v2/oauth/token
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
outbound-voice-profiles_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
pronunciation-dicts_bearerAuth:
type: http
scheme: bearer
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
stored-payment-transactions_bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
transcriptions-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
web-search_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key
pay-connectors_bearerAuth:
type: http
scheme: bearer
description: Telnyx API key, not the processor bearer token.
telnyxApiKey:
type: http
scheme: bearer
description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
categories:
- communication
- developer-tools
docs:
apiReference: https://developers.telnyx.com
homepage: https://telnyx.com
llms: https://telnyx.com/llms.txt