Get a voice number
/v1/voice/numbers/{number_id}const number = await bird.voice.numbers.get("number-id");
console.log(number.phone_number, number.directions);number = client.voice.numbers.get("number-id")
print(number.phone_number, number.directions)number, err := client.Voice.Numbers.Get(context.Background(), "number-id")
if err != nil {
log.Fatal(err)
}
fmt.Println(number.PhoneNumber, number.Directions)$number = $bird->voice->numbers->get('number-id');
echo $number->getPhoneNumber(), "\n";bird voice numbers get <number-id>curl -X GET "https://us1.platform.bird.com/v1/voice/numbers/{number_id}" \
-H "Authorization: Bearer $TOKEN"{
"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.
Parameters
number_idstringResponse Payload
idIdentifier 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_numberThe phone number in E.164 format.
country_codeCountry the number belongs to. Null when the number is not geographic or its country cannot be determined.
nameYour 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.
providerWhere 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.
directionsWhich 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.
Show child attributes
directions.inboundWhether calls to this number arrive here. False for a number from another carrier, whose calls that carrier routes, and for one allocated to you that cannot carry calls.
directions.outboundWhether this number can be presented on a call you place. Buying a number does not grant this on its own: proving control of it does.
inbound_configurationWhat happens to a call arriving for this number.
created_atWhen this number became usable for voice: when it was allocated to you, or when you first registered it, whichever this number is.
Related resources
Continue with the documentation, guides and examples for this topic.