Telnyx Mobile Number Settings API
The Mobile Number Settings API from Telnyx — 2 operation(s) for mobile number settings.
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-mobile-number-settings-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 Mobile Number Settings 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 Mobile Number Settings 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: Mobile Number Settings
paths:
/mobile_phone_numbers/messaging:
get:
summary: List mobile phone numbers with messaging settings
operationId: ListMobilePhoneNumbersWithMessagingSettings
tags:
- Mobile Number Settings
x-group-parameters: 'true'
parameters:
- $ref: '#/components/parameters/PageConsolidated'
responses:
'200':
description: Successful response with a list of mobile phone numbers with messaging settings.
content:
application/json:
schema:
type: object
title: List Messaging Settings Response
properties:
data:
type: array
items:
$ref: '#/components/schemas/MobilePhoneNumberWithMessagingSettings'
meta:
$ref: '#/components/schemas/messaging_PaginationMeta_0b38e7044b'
4XX:
$ref: '#/components/responses/messaging_GenericErrorResponse_0b38e7044b'
description: Returns mobile phone numbers with their current messaging configuration.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
/mobile_phone_numbers/{id}/messaging:
get:
summary: Retrieve a mobile phone number with messaging settings
operationId: GetMobilePhoneNumberMessagingSettings
tags:
- Mobile Number Settings
parameters:
- name: id
in: path
description: Identifies the type of resource.
required: true
schema:
type: string
responses:
'200':
description: Successful response with details about a mobile phone number.
content:
application/json:
schema:
type: object
title: Retrieve Mobile Messaging Settings Response
properties:
data:
$ref: '#/components/schemas/MobilePhoneNumberWithMessagingSettings'
4XX:
$ref: '#/components/responses/messaging_GenericErrorResponse_0b38e7044b'
description: Returns the messaging configuration for the specified mobile phone number.
servers:
- url: https://api.telnyx.com/v2
description: Version 2.0.0 of the Telnyx API
components:
schemas:
messaging_Errors_0b38e7044b:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/messaging_Error_0b38e7044b'
MessagingFeatureSet:
type:
- object
- 'null'
required:
- domestic_two_way
- international_inbound
- international_outbound
description: 'The set of features available for a specific messaging use case (SMS or MMS). Features
can vary depending on the characteristics the phone number, as well as its current
product configuration.
'
properties:
domestic_two_way:
type: boolean
description: Send messages to and receive messages from numbers in the same country.
international_inbound:
type: boolean
description: Receive messages from numbers in other countries.
international_outbound:
type: boolean
description: Send messages to numbers in other countries.
example:
domestic_two_way: true
international_inbound: false
international_outbound: true
messaging_Error_0b38e7044b:
required:
- code
- title
properties:
code:
type: string
x-format: integer
title:
type: string
detail:
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
MobilePhoneNumberWithMessagingSettings:
type: object
example:
record_type: messaging_settings
id: '2126210528794641864'
phone_number: ++13127367407
messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
created_at: '2019-01-23T18:10:02.574Z'
updated_at: '2019-01-23T18:10:02.574Z'
country_code: US
type: longcode
traffic_type: P2P
messaging_product: P2P
features:
sms:
domestic_two_way: true
international_inbound: true
international_outbound: true
properties:
record_type:
type: string
example: messaging_settings
enum:
- messaging_phone_number
- messaging_settings
description: Identifies the type of the resource.
readOnly: true
id:
type: string
description: Identifies the type of resource.
readOnly: true
phone_number:
type: string
description: +E.164 formatted phone number.
readOnly: true
x-format: e164
messaging_profile_id:
type:
- string
- 'null'
description: Unique identifier for a messaging profile.
created_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was created.
readOnly: true
updated_at:
type: string
format: date-time
description: ISO 8601 formatted date indicating when the resource was updated.
readOnly: true
country_code:
type: string
description: ISO 3166-1 alpha-2 country code.
pattern: ^[A-Z]{2}$
example: US
readOnly: true
type:
type: string
description: The type of the phone number
enum:
- longcode
readOnly: true
traffic_type:
type: string
description: The messaging traffic or use case for which the number is currently configured.
example: P2P
readOnly: true
messaging_product:
type: string
description: The messaging product that the number is registered to use
example: P2P
features:
type: object
readOnly: true
properties:
sms:
$ref: '#/components/schemas/MessagingFeatureSet'
organization_id:
type: string
description: The organization that owns this phone number.
tags:
type: array
items:
type: string
description: Tags associated with this phone number.
messaging_PaginationMeta_0b38e7044b:
type: object
required:
- total_pages
- total_results
- page_size
- page_number
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
messaging_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/messaging_Error'
type: array
messaging_Error:
properties:
code:
type: string
x-format: integer
detail:
type: string
meta:
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
format: json-pointer
type: string
type: object
title:
type: string
required:
- code
- title
messaging_PaginationMeta:
properties:
page_number:
example: 2
type: integer
page_size:
example: 25
type: integer
total_pages:
example: 3
type: integer
total_results:
example: 55
type: integer
required:
- total_pages
- total_results
- page_size
- page_number
type: object
responses:
messaging_GenericErrorResponse_0b38e7044b:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/messaging_Errors_0b38e7044b'
example:
errors:
- code: string
title: string
detail: string
source:
pointer: /data/attributes/phone_number
parameter: string
messaging_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/messaging_Errors'
description: Unexpected error
MobileListPhoneNumbersWithMessagingSettingsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/MobilePhoneNumberWithMessagingSettings'
type: array
meta:
$ref: '#/components/schemas/messaging_PaginationMeta'
title: List Messaging Settings Response
type: object
description: Successful response with a list of mobile phone numbers with messaging settings.
MobilePhoneNumberWithMessagingSettingsResponse:
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/MobilePhoneNumberWithMessagingSettings'
title: Retrieve Mobile Messaging Settings Response
type: object
description: Successful response with details about a mobile phone number.
parameters:
PageConsolidated:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page 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
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