Telnyx Phone Number Blocks Background Jobs API
Background jobs performed over a phone-numbers block's phone numbers
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-phone-number-blocks-background-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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 Phone Number Blocks Background Jobs 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 Phone Number Blocks Background Jobs across 2 of this provider''s published API definitions: telnyx-openapi.yml, telnyx-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: Background jobs performed over a phone-numbers block's phone numbers
name: Phone Number Blocks Background Jobs
paths:
/phone_number_blocks/jobs:
get:
operationId: ListPhoneNumberBlocksJobs
parameters:
- $ref: '#/components/parameters/numbers_PageConsolidated'
- description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
in: query
name: sort
required: false
schema:
enum:
- created_at
example: created_at
type: string
- description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[status]'
explode: true
in: query
name: filter
schema:
properties:
status:
description: Identifies the status of the background job.
enum:
- pending
- in_progress
- completed
- failed
example: in_progress
type: string
type:
description: Identifies the type of the background job.
enum:
- delete_phone_number_block
example: delete_phone_number_block
type: string
type: object
style: deepObject
responses:
'200':
$ref: '#/components/responses/ListPhoneNumberBlocksJobsResponse'
'400':
$ref: '#/components/responses/numbers_BadRequestResponse'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity'
'500':
$ref: '#/components/responses/numbers_GenericErrorResponse'
summary: Lists the phone number blocks jobs
tags:
- Phone Number Blocks Background Jobs
x-group-parameters: 'true'
x-latency-category: responsive
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
/phone_number_blocks/jobs/delete_phone_number_block:
post:
description: Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.
operationId: CreatePhoneNumberBlockDeletionJob
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest'
required: true
responses:
'202':
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/PhoneNumberBlocksJob'
title: Phone Number Blocks Job Delete Phone Number Block
type: object
description: Phone number blocks job delete phone numbers requested.
'400':
$ref: '#/components/responses/numbers_BadRequestResponse'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity'
'500':
$ref: '#/components/responses/numbers_GenericErrorResponse'
summary: Deletes all numbers associated with a phone number block
tags:
- Phone Number Blocks Background Jobs
x-group-parameters: 'true'
x-latency-category: background
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
/phone_number_blocks/jobs/{id}:
get:
operationId: GetPhoneNumberBlocksJob
parameters:
- description: Identifies the Phone Number Blocks Job.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/PhoneNumberBlocksJob'
title: Phone Number Blocks Job
type: object
description: Phone number blocks job details.
'400':
$ref: '#/components/responses/numbers_BadRequestResponse'
'401':
$ref: '#/components/responses/numbers_UnauthorizedResponse'
'404':
$ref: '#/components/responses/numbers_NotFoundResponse'
'422':
$ref: '#/components/responses/numbers_UnprocessableEntity'
'500':
$ref: '#/components/responses/numbers_GenericErrorResponse'
summary: Retrieves a phone number blocks job
tags:
- Phone Number Blocks Background Jobs
x-group-parameters: 'true'
x-latency-category: responsive
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
components:
schemas:
PhoneNumberBlocksJobDeletePhoneNumberBlockRequest:
example:
phone_number_block_id: f3946371-7199-4261-9c3d-81a0d7935146
properties:
phone_number_block_id:
type: string
required:
- phone_number_block_id
type: object
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
type: object
PhoneNumberBlocksJob:
example:
created_at: '2020-10-23T18:10:00.000Z'
etc: '2020-10-30T18:10:00.000Z'
failed_operations: []
id: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
record_type: phone_numbers_job
status: pending
successful_operations: []
type: delete_phone_number_block
updated_at: '2020-10-23T18:10:01.000Z'
properties:
created_at:
description: ISO 8601 formatted date indicating when the resource was created.
readOnly: true
type: string
etc:
description: ISO 8601 formatted date indicating when the estimated time of completion of the background job.
format: date-time
readOnly: true
type: string
failed_operations:
items:
$ref: '#/components/schemas/PhoneNumberBlocksJobFailedOperation'
readOnly: true
type: array
id:
description: Identifies the resource.
example: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
format: uuid
readOnly: true
type: string
record_type:
description: Identifies the type of the resource.
example: phone_number_block_job
readOnly: true
type: string
status:
default: pending
description: Indicates the completion status of the background operation.
enum:
- pending
- in_progress
- completed
- failed
example: pending
readOnly: true
type: string
successful_operations:
items:
$ref: '#/components/schemas/PhoneNumberBlocksJobSuccessfulOperation'
description: The phone numbers successfully updated.
readOnly: true
type: array
type:
description: Identifies the type of the background job.
enum:
- delete_phone_number_block
example: delete_phone_number_block
readOnly: true
type: string
updated_at:
description: ISO 8601 formatted date indicating when the resource was updated.
readOnly: true
type: string
type: object
PhoneNumberBlocksJobFailedOperation:
properties:
errors:
items:
$ref: '#/components/schemas/numbers_Error'
type: array
id:
description: The phone number's ID
type: string
phone_number:
description: The phone number in e164 format.
type: string
type: object
numbers_Errors:
properties:
errors:
items:
$ref: '#/components/schemas/numbers_Error'
type: array
type: object
numbers_Error:
properties:
code:
example: '10007'
type: string
detail:
example: An unexpected error occured.
type: string
meta:
properties:
url:
description: URL with additional information on the error.
example: https://developers.telnyx.com/docs/overview/errors/10015
type: string
type: object
source:
properties:
parameter:
description: Indicates which query parameter caused the error.
type: string
pointer:
description: JSON pointer (RFC6901) to the offending entity.
example: /base
type: string
type: object
title:
example: Unexpected error
type: string
type: object
PhoneNumberBlocksJobSuccessfulOperation:
properties:
id:
description: The phone number's ID
type: string
phone_number:
description: The phone number in e164 format.
type: string
type: object
Errors:
properties:
errors:
type: array
items:
$ref: '#/components/schemas/billing-group_Error'
type: object
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
responses:
numbers_GenericErrorResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unexpected error
numbers_BadRequestResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Bad request, the request was unacceptable, often due to missing a required parameter.
numbers_UnprocessableEntity:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unprocessable entity. Check the 'detail' field in response for details.
ListPhoneNumberBlocksJobsResponse:
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/PhoneNumberBlocksJob'
type: array
meta:
$ref: '#/components/schemas/PaginationMeta'
title: List Phone Number Blocks Background Jobs Response
type: object
description: Successful response with a list of phone number blocks background jobs.
numbers_NotFoundResponse:
content:
application/json:
schema:
$ref: '#/components/schemas/numbers_Errors'
description: The requested resource doesn't exist.
numbers_UnauthorizedResponse:
content:
application/json:
examples:
Authentication Failed:
value:
errors:
- code: '10009'
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
title: Authentication failed
schema:
$ref: '#/components/schemas/numbers_Errors'
description: Unauthorized
numbers_BadRequestResponse_73c9788e53:
description: Bad request, the request was unacceptable, often due to missing a required parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_UnauthorizedResponse_73c9788e53:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
examples:
Authentication Failed:
value:
errors:
- code: '10009'
title: Authentication failed
detail: Could not understand the provided credentials.
meta:
url: https://developers.telnyx.com/docs/overview/errors/10009
GenericErrorResponse:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_UnprocessableEntity_73c9788e53:
description: Unprocessable entity. Check the 'detail' field in response for details.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
numbers_NotFoundResponse_73c9788e53:
description: The requested resource doesn't exist.
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
parameters:
numbers_PageConsolidated:
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
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
style: deepObject
numbers_PageConsolidated_73c9788e53:
name: page
in: query
style: deepObject
explode: true
description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
schema:
type: object
properties:
size:
type: integer
minimum: 1
maximum: 250
default: 20
description: The size of the page
number:
type: integer
minimum: 1
default: 1
description: The page number to load
securitySchemes:
bearerAuth:
scheme: bearer
type: http
branded-calling_bearerAuth:
description: API key passed as a Bearer token in the Authorization header
scheme: bearer
type: http
oauthClientAuth:
description: OAuth 2.0 authentication for Telnyx API and MCP integrations
flows:
authorizationCode:
authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
refreshUrl: https://api.telnyx.com/v2/oauth/token
scopes:
admin: Administrative access to Telnyx resources
tokenUrl: https://api.telnyx.com/v2/oauth/token
clientCredentials:
scopes:
admin: Administrative access to Telnyx resources
tokenUrl: https://api.telnyx.com/v2/oauth/token
type: oauth2
outbound-voice-profiles_bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http
pronunciation-dicts_bearerAuth:
description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
scheme: bearer
type: http
stored-payment-transactions_bearerAuth:
bearerFormat: JWT
scheme: bearer
type: http
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
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.
rcs-registration_bearerAuth:
type: http
scheme: bearer
bearerFormat: API key
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
x-refined-from:
- telnyx-openapi.yml
- telnyx-openapi.json