Sign inGet Started

Get a voice number

GET
/v1/voice/numbers/{number_id}
const number = await bird.voice.numbers.get("number-id");
console.log(number.phone_number, number.directions);
Resposta200
{
  "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"
    ]
  }
}

Returns one of the numbers your workspace can use for voice.

A number with no route of its own reads back with a null route and follows your workspace's default inbound route, which Get the voice settings returns.

Parâmetros

number_idstring

Payload de resposta

id
string
obrigatório

Identifier of this number, to pass to the operations that read and change it. A number you registered as a caller ID carries the same identifier there, with the caller-ID prefix.

phone_number
string
obrigatório

The phone number in E.164 format.

country_code
nullable string
obrigatório

Country the number belongs to. Null when the number is not geographic or its country cannot be determined.

name
nullable string
obrigatório

Your own label for this number, to tell several apart. Null when it has none. Only you see it, so it never affects what a caller sees.

provider
object
obrigatório

Where this number came from, and the facts that belong to that answer. The type selects the shape. allocation is a number we allocated to your workspace, and it carries that allocation's identifier. verified_number is a number from another carrier, and it carries how far proving control of it has got.

Mostrar atributos secundários
directions
object
obrigatório

Which directions this number can carry. Both follow from the number itself, so neither is yours to change. On a SIP trunk each direction is a setting you turn on; here it is a fact about the number.

Mostrar atributos secundários
inbound_configuration
object
obrigatório

What happens to a call arriving for this number.

Mostrar atributos secundários
created_at
string
obrigatório

When this number became usable for voice: when it was allocated to you, or when you first registered it, whichever this number is.