List the numbers you can use for voice
/v1/voice/numbersfor await (const number of bird.voice.numbers.list()) {
console.log(number.id, number.phone_number, number.country_code);
}for number in client.voice.numbers.list():
print(number.id, number.phone_number, number.country_code)for number, err := range client.Voice.Numbers.List(context.Background(), bird.VoiceNumbersListParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(number.Id, number.PhoneNumber, number.CountryCode)
}foreach ($bird->voice->numbers->list() as $number) {
echo $number->getId(), ' ', $number->getPhoneNumber(), "\n";
}bird voice numbers listcurl -X GET "https://us1.platform.bird.com/v1/voice/numbers" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=phone_number" \
--url-query "order=asc" \
--url-query "limit=25"{
"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.
Paramètres de requête
searchstringMatches part of the phone number or name, ignoring case. Characters such as % and _ match literally.
providerstringFilter 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
routestringFilter 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
sortstringField to sort by.
Possible values: phone_number
orderstringSort direction. Defaults to asc, which sorts alphabetically or from oldest to newest, depending on the selected sort field.
Possible values: asc, desc
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor 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.
Contenu de la réponse
dataAfficher les attributs enfants
data.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.
data.phone_numberThe phone number in E.164 format.
data.country_codeCountry the number belongs to. Null when the number is not geographic or its country cannot be determined.
data.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.
data.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.
data.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.
data.inbound_configurationWhat happens to a call arriving for this number.
Afficher les attributs enfants
data.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.
Afficher les attributs enfants
data.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
data.inbound_configuration.route.typeDelivers the call to one of your SIP trunks.
Value: trunk
data.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".
data.inbound_configuration.route.typePlaces a call to another of your numbers and connects the two.
Value: forward
data.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.
data.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
data.inbound_configuration.route.typeRuns the named sequence's active publication from the selected voice-call entry.
Value: sequence
data.inbound_configuration.route.sequence_idNamed sequence whose active publication handles the call.
data.inbound_configuration.route.entry_node_idVoice-call entry in the sequence's active publication.
data.inbound_configuration.configuration_errorPossible values: unsupported_route_type
data.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.
data.created_atWhen this number became usable for voice: when it was allocated to you, or when you first registered it, whichever this number is.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh 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.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.