Get the voice settings
/v1/voice/settingsconst settings = await bird.voice.settings.get();
console.log(settings.inbound_configuration.route.type);settings = client.voice.settings.get()
print(settings.inbound_configuration.route.root.type)bird voice settings getcurl -X GET "https://us1.platform.bird.com/v1/voice/settings" \
-H "Authorization: Bearer $TOKEN"{
"inbound_configuration": {
"route": {
"type": "reject"
}
}
}
Returns the voice settings for your workspace.
inbound_configuration.route is what happens to calls for every Bird number that has no
inbound route of its own. Verified caller IDs receive no calls, so it never applies to them.
It is "reject" until you change it.
Response Payload
inbound_configurationWhat happens to a call arriving for any of your Bird numbers that has no inbound route of its own.
Show child attributes
inbound_configuration.routeThe workspace's default inbound route. Defaults to "reject".
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.
Related resources
Continue with the documentation, guides and examples for this topic.