Telnyx SIM Card Actions API
View SIM card actions, their progress and timestamps using the SIM Card Actions API
View SIM card actions, their progress and timestamps using the SIM Card Actions API
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/telnyx:telnyx-sim-card-actions-api"
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.
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: 3.2.0
info:
title: Telnyx SIM Card 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 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 Actions
description: View SIM card actions, their progress and timestamps using the SIM Card Actions API
paths:
/bulk_sim_card_actions:
get:
operationId: ListBulkSimCardActions
summary: List bulk SIM card actions
description: This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.
tags:
- SIM Card Actions
parameters:
- $ref: '#/components/parameters/wireless_PageNumber_c5290d5308'
- $ref: '#/components/parameters/wireless_PageSize_c5290d5308'
- name: filter[action_type]
description: Filter by action type.
in: query
required: false
schema:
type: string
enum:
- bulk_disable_voice
- bulk_enable_voice
- bulk_set_public_ips
example: bulk_set_public_ips
responses:
'200':
$ref: '#/components/responses/BulkSIMCardActionCollectionResponse'
'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
/bulk_sim_card_actions/{id}:
get:
operationId: GetBulkSimCardAction
summary: Get bulk SIM card action details
description: This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.
tags:
- SIM Card Actions
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/BulkSIMCardActionDetailed'
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_actions:
get:
operationId: ListSimCardActions
summary: List SIM card actions
description: This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.
tags:
- SIM Card Actions
parameters:
- $ref: '#/components/parameters/FilterSIMCardActionsConsolidated'
- $ref: '#/components/parameters/wireless_PageConsolidated_c5290d5308'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/wireless_SIMCardAction'
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_actions/{id}:
get:
operationId: GetSimCardAction
summary: Get SIM card action details
description: This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
tags:
- SIM Card Actions
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/wireless_SIMCardAction'
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:
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.
BulkSIMCardActionCollectionResponse:
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BulkSIMCardActionDetailed'
meta:
$ref: '#/components/schemas/PaginationMeta'
description: Successful Response
SIMCardActionResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/SIMCardAction'
type: object
description: Successful Response
BulkSIMCardActionDetailedResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/BulkSIMCardActionDetailed_2'
type: object
description: Successful Response
SimCardActionCollectionResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/SIMCardAction'
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
parameters:
ResourceId:
name: id
description: Identifies the resource.
in: path
required: true
schema:
format: uuid
type: string
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
wireless_PageSize_c5290d5308:
name: page[size]
in: query
description: The size of the page.
schema:
type: integer
minimum: 1
maximum: 250
default: 20
wireless_PageNumber_c5290d5308:
name: page[number]
in: query
description: The page number to load.
schema:
type: integer
minimum: 1
default: 1
FilterSIMCardActionsConsolidated:
name: filter
in: query
explode: true
description: 'Consolidated filter parameter for SIM card actions (deepObject style). Originally: filter[sim_card_id], filter[status], filter[bulk_sim_card_action_id], filter[action_type]'
schema:
type: object
properties:
sim_card_id:
type: string
format: uuid
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
description: A valid SIM card ID.
status:
type: string
enum:
- in-progress
- completed
- failed
example: in-progress
description: Filter by a specific status of the resource's lifecycle.
bulk_sim_card_action_id:
type: string
format: uuid
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
description: Filter by a bulk SIM card action ID.
action_type:
type: string
enum:
- enable
- enable_standby_sim_card
- disable
- set_standby
- remove_public_ip
- set_public_ip
- enable_voice
- disable_voice
example: disable
description: Filter by action type.
wireless_PageConsolidated_c5290d5308:
name: page
in: query
explode: true
description: 'Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]'
schema:
type: object
properties:
number:
type: integer
minimum: 1
default: 1
description: The page number to load.
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page.
wireless_PageConsolidated:
description: 'Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]'
explode: true
in: query
name: page
schema:
properties:
number:
default: 1
description: The page number to load.
minimum: 1
type: integer
size:
default: 20
description: The size of the page.
maximum: 250
minimum: 1
type: integer
type: object
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
FilterSIMCardActionsConsolidated_2:
description: 'Consolidated filter parameter for SIM card actions (deepObject style). Originally: filter[sim_card_id], filter[status], filter[bulk_sim_card_action_id], filter[action_type]'
explode: true
in: query
name: filter
schema:
properties:
action_type:
description: Filter by action type.
enum:
- enable
- enable_standby_sim_card
- disable
- set_standby
- remove_public_ip
- set_public_ip
example: disable
type: string
bulk_sim_card_action_id:
description: Filter by a bulk SIM card action ID.
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
format: uuid
type: string
sim_card_id:
description: A valid SIM card ID.
example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
format: uuid
type: string
status:
description: Filter by a specific status of the resource's lifecycle.
enum:
- in-progress
- completed
- failed
example: in-progress
type: string
type: object
schemas:
wireless_SIMCardAction:
type: object
title: SIMCardAction
description: This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
properties:
id:
$ref: '#/components/schemas/wireless_Id_c5290d5308'
record_type:
type: string
example: sim_card_action
readOnly: true
sim_card_id:
type: string
format: uuid
description: The related SIM card identifier.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
action_type:
type: string
description: "The operation type. It can be one of the following: <br/>\n<ul>\n <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li>\n <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li>\n <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li>\n <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li>\n <li><code>enable_voice</code> - enable voice calling on the SIM card</li>\n <li><code>disable_voice</code> - disable voice calling on the SIM card</li>\n </ul>"
enum:
- enable
- enable_standby_sim_card
- disable
- set_standby
- enable_voice
- disable_voice
readOnly: true
example: enable
status:
type: object
properties:
value:
type: string
description: The current status of the SIM card action.
enum:
- in-progress
- completed
- failed
- interrupted
readOnly: true
example: completed
reason:
type: string
description: It describes why the SIM card action is in the current status. This will be <code>null</code> for self-explanatory statuses, such as <code>in-progress</code> and <code>completed</code> but will include further information on statuses like <code>interrupted</code> and <code>failed</code>.
readOnly: true
example: The data limit was exceeded.
settings:
type:
- object
- 'null'
description: A JSON object representation of the action params.
example: {}
readOnly: true
additionalProperties: true
created_at:
$ref: '#/components/schemas/wireless_CreatedAt_c5290d5308'
updated_at:
$ref: '#/components/schemas/wireless_UpdatedAt_c5290d5308'
wireless_Id_c5290d5308:
type: string
format: uuid
description: Identifies the resource.
readOnly: true
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
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
wireless_CreatedAt_c5290d5308:
type: string
description: ISO 8601 formatted date-time indicating when the resource was created.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
BulkSIMCardActionDetailed:
type: object
properties:
id:
$ref: '#/components/schemas/wireless_Id_c5290d5308'
record_type:
type: string
example: bulk_sim_card_action
readOnly: true
action_type:
type: string
description: 'The action type. It can be one of the following: <br/>
<ul>
<li><code>bulk_disable_voice</code> - disable voice for every SIM Card in a SIM Card Group.</li>
<li><code>bulk_enable_voice</code> - enable voice for every SIM Card in a SIM Card Group.</li>
<li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM Card.</li>
</ul>'
enum:
- bulk_disable_voice
- bulk_enable_voice
- bulk_set_public_ips
readOnly: true
example: bulk_set_public_ips
settings:
type: object
description: A JSON object representation of the bulk action payload.
example: {}
readOnly: true
additionalProperties: true
sim_card_actions_summary:
type: array
items:
$ref: '#/components/schemas/SIMCardActionsSummary'
created_at:
$ref: '#/components/schemas/wireless_CreatedAt_c5290d5308'
updated_at:
$ref: '#/components/schemas/wireless_UpdatedAt_c5290d5308'
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
SIMCardActionsSummary:
type: object
properties:
status:
type: string
enum:
- in-progress
- completed
- failed
- interrupted
example: in-progress
count:
type: integer
wireless_UpdatedAt_c5290d5308:
type: string
description: ISO 8601 formatted date-time indicating when the resource was updated.
readOnly: true
example: '2018-02-02T22:25:27.521Z'
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
SIMCardAction:
description: This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.
properties:
action_type:
description: "The operation type. It can be one of the following: <br/>\n<ul>\n <li><code>enable</code> - move the SIM card to the <code>enabled</code> status</li>\n <li><code>enable_standby_sim_card</code> - move a SIM card previously on the <code>standby</code> status to the <code>enabled</code> status after it consumes data.</li>\n <li><code>disable</code> - move the SIM card to the <code>disabled</code> status</li>\n <li><code>set_standby</code> - move the SIM card to the <code>standby</code> status</li>\n </ul>"
enum:
- enable
- enable_standby_sim_card
- disable
- set_standby
example: enable
readOnly: true
type: string
created_at:
$ref: '#/components/schemas/wireless_CreatedAt'
id:
$ref: '#/components/schemas/wireless_Id'
record_type:
example: sim_card_action
readOnly: true
type: string
settings:
additionalProperties: true
description: A JSON object representation of the action params.
example: {}
readOnly: true
type:
- object
- 'null'
sim_card_id:
description: The related SIM card identifier.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
readOnly: true
type: string
status:
properties:
reason:
description: It describes why the SIM card action is in the current status. This will be <code>null</code> for self-explanatory statuses, such as <code>in-progress</code> and <code>completed</code> but will include further information on statuses like <code>interrupted</code> and <code>failed</code>.
example: The data limit was exceeded.
readOnly: true
type: string
value:
description: The current status of the SIM card action.
enum:
- in-progress
- completed
- failed
- interrupted
example: completed
readOnly: true
type: string
type: object
updated_at:
$ref: '#/components/schemas/wireless_UpdatedAt'
title: SIMCardAction
type: object
wireless_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/wireless_Error'
type: array
type: object
BulkSIMCardActionDetailed_2:
properties:
action_type:
description: 'The action type. It can be one of the following: <br/>
<ul>
<li><code>bulk_disable_voice</code> - disable voice for every SIM Card in a SIM Card Group.</li>
<li><code>bulk_enable_voice</code> - enable voice for every SIM Card in a SIM Card Group.</li>
<li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM Card.</li>
</ul>'
enum:
- bulk_disable_voice
- bulk_enable_voice
- bulk_set_public_ips
example: bulk_set_public_ips
readOnly: true
type: string
created_at:
$ref: '#/components/schemas/wireless_CreatedAt'
id:
$ref: '#/components/schemas/wireless_Id'
record_type:
example: bulk_sim_card_action
readOnly: true
type: string
settings:
additionalProperties: true
description: A JSON object representation of the bulk action payload.
example: {}
readOnly: true
type: object
sim_card_actions_summary:
items:
$ref: '#/components/schemas/SIMCardActionsSummary'
type: array
updated_at:
$ref: '#/components/schemas/wireless_UpdatedAt'
type: object
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
wireless_Id:
description: Identifies the resource.
example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
format: uuid
readOnly: true
type: string
wireless_CreatedAt:
description: ISO 8601 formatted date-time indicating when the resource was created.
example: '2018-02-02T22:25:27.521Z'
readOnly: true
type: string
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