Sign inGet Started
Comenzar
Guías
Referencia de API
SDKs
CLI
Base de conocimientos
Registro de cambios

List the numbers you can use for voice

GET
/v1/voice/numbers
for await (const number of bird.voice.numbers.list()) {
  console.log(number.id, number.phone_number, number.country_code);
}
Respuesta200
{
  "data": [
    {
      "id": "vnu_01krdgeqcxet5s7t44vh8rt9mg",
      "phone_number": "+14155551234",
      "country_code": "US",
      "name": "Support line",
      "provider": {
        "type": "allocation",
        "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "inbound_configuration": {
        "route": {
          "type": "reject"
        },
        "configuration_error": "unsupported_route_type",
        "forward_as_options": [
          "dialed_number",
          "calling_number"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Lists the phone numbers your workspace can use for voice: the voice-capable numbers we allocated to you, and the numbers from other carriers you registered and verified. One list, ordered by number.

Each entry is one phone number, and provider says which of the two it is.

This is one cursor page, not the whole set. It returns 25 numbers unless you ask for more with limit, so follow the cursor until it stops rather than treating the first page as everything you have.

Parámetros de consulta

searchstring

Matches part of the phone number or name, ignoring case. Characters such as % and _ match literally.

providerstring

Filter by number source. allocation selects numbers we allocated to your workspace. verified_number selects numbers from another carrier that you registered for use as caller IDs.

Possible values: allocation, verified_number

routestring

Filter by the answer incoming calls get. A number without a route of its own matches the route of your workspace's default.

  • reject: rejects incoming calls.
  • trunk: delivers calls to a SIP trunk.
  • forward: connects calls to the configured forwarding number.
  • sequence: runs the selected voice sequence entry.

Numbers with an unsupported route are excluded when this filter is set.

Possible values: reject, trunk, forward, sequence

sortstring

Field to sort by.

Possible values: phone_number

orderstring

Sort direction. Defaults to asc, which sorts alphabetically or from oldest to newest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Carga de respuesta

data
array of object
obligatorio
Mostrar atributos secundarios
next_cursor
nullable string
obligatorio

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
obligatorio

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
obligatorio

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Recursos relacionados

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación