Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dir_id
string<uuid>
required

The DIR id. Lowercase UUID.

Example:

"16635d38-75a6-4481-82e8-69af60e05011"

batch_id
string<uuid>
required

The batch id (lowercase UUID).

Example:

"0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62"

Response

Batch.

data
object
required

A phone-number batch groups all numbers added in a single bulk-add request. Telnyx vets the batch as a unit. The response embeds the full phone_numbers array so you can read per-number status without a separate call, plus a batch-level status summarising the unit's progress.