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.
inbound_configurationWhat happens to a call arriving for this number.
Show child attributes
inbound_configuration.routeNull when the number has no route of its own and follows your workspace's default inbound route from the voice settings. Also null when the stored route type is unsupported, in which case configuration_error says so; inspect it before changing the route.
Show child attributes
inbound_configuration.route.typeRefuses the call. Setting it is how you stop a number answering without giving it up. It is also the default inbound route of a new workspace.
Value: reject
inbound_configuration.route.typeDelivers the call to one of your SIP trunks.
Value: trunk
inbound_configuration.route.trunk_idThe SIP trunk that answers these calls. It must be one of yours and must have inbound calling enabled. Turning that trunk's inbound calling off, or deleting it, removes this route: a number returns to your workspace's default inbound route, and a workspace default becomes "reject".
inbound_configuration.route.typePlaces a call to another of your numbers and connects the two.
Value: forward
inbound_configuration.route.forward_toThe number calls are forwarded to, in E.164 format. It has to be one of your verified caller IDs. That is checked when you set it and again on every call it forwards, so a caller ID you later remove stops forwarding rather than carrying on.
inbound_configuration.route.forward_asWhich number the forwarded leg presents as its caller. Include the choice
on every write. Reads return the effective choice; older configurations
without a stored choice return dialed_number.
Possible values: dialed_number, calling_number
inbound_configuration.route.typeRuns the named sequence's active publication from the selected voice-call entry.
Value: sequence
inbound_configuration.route.sequence_idNamed sequence whose active publication handles the call.
inbound_configuration.route.entry_node_idVoice-call entry in the sequence's active publication.
inbound_configuration.configuration_errorPossible values: unsupported_route_type
inbound_configuration.forward_as_optionsCaller identities available when configuring a forward. Use these values to populate the choice in your editor. The current choices are dialed_number and calling_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.