voice-numbers

Get a voice 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.

get/v1/voice/numbers/{number_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/voice/numbers/{number_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The number.

idstring required
phone_numberstring required

The phone number in E.164 format.

country_codestring required

ISO 3166-1 alpha-2 country code.

namestring nullable required

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.

created_atstring date-time required

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

Example response

{
  "id": "vnu_01krdgeqcxet5s7t44vh8rt9mg",
  "phone_number": "+14155551234",
  "country_code": "US",
  "name": "Support line",
  "provider": {
    "type": "allocation",
    "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "inbound_configuration": {
    "route": {
      "type": "reject"
    },
    "forward_as_options": [
      "dialed_number",
      "calling_number"
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.