Long Code Numbers

Overview

The current concept of Number represents the so-called Long Code Number. Long Code Number always relates to the Number purchased or ordered from the Inventory. This is any number, that has a country prefix at the beginning. The term Number is renamed to LongCodeNumber.

API Access

The following API requests can only be made using a valid access key, and attached to an access role, with an access policy that at least specifies the permissions to the resources outlined in each section below. Learn more about API access.

List Long Code Numbers

In order to retrieve a list of long code numbers available in your workspace you can use this request.

List Workspace Long Code Numbers

GET/workspaces/{workspaceId}/numbers-long-code

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

results*array of WorkspaceLongCodeNumber (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/numbers-long-code', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "endpointId": "123e4567-e89b-12d3-a456-426614174000",
      "numberString": "text",
      "countryCode": "text",
      "type": "local",
      "capabilities": {
        "voice": {
          "inbound": false,
          "outbound": false
        },
        "sms": {
          "inbound": false,
          "outbound": false
        },
        "mms": {
          "inbound": false,
          "outbound": false
        }
      },
      "createdAt": "2024-11-21T08:32:43.886Z",
      "updatedAt": "2024-11-21T08:32:43.886Z",
      "order": {
        "countryCode": "text",
        "type": "local",
        "capabilities": [
          "voice"
        ],
        "prefix": "text",
        "status": "draft",
        "createdAt": "2024-11-21T08:32:43.886Z",
        "updatedAt": "2024-11-21T08:32:43.886Z"
      },
      "deprovisionAt": "2024-11-21T08:32:43.886Z",
      "endpoint": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "long-code-number",
        "instanceId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "capabilities": [
          {
            "name": "sms",
            "inbound": {
              "status": "active",
              "issues": [
                "subscription-is-not-active"
              ]
            },
            "outbound": {
              "status": "active",
              "destinationStatuses": {
                "active": 0,
                "inactive": 0,
                "available": 0,
                "unavailable": 0
              },
              "supportsDestinations": false,
              "issues": [
                "subscription-is-not-active"
              ]
            }
          }
        ],
        "dependencies": [
          {
            "type": "connector",
            "connectorId": "123e4567-e89b-12d3-a456-426614174000",
            "connectorTemplateRef": "text",
            "capabilities": [
              "voice"
            ]
          }
        ],
        "issues": [
          "subscription-is-not-active"
        ],
        "provisioningStatus": "provisioned",
        "createdAt": "2024-11-21T08:32:43.886Z",
        "updatedAt": "2024-11-21T08:32:43.886Z"
      }
    }
  ]
}

Request

curl "https://api.bird.com/workspaces/{workpaceId}/numbers-long-code/"
-H 'Authorization: Bearer '

Response

{
    "results": [
        {
            "id": "uuid",
            "numberString": "string",
            "countryCode": "string",
            "type": "local|mobile|toll-free|national",
            "capabilities": {
                "voice": {
                    "inbound": true,
                    "outbound": true
                },
                "sms": {
                    "inbound": true,
                    "outbound": false
                },
                "mms": {
                    "inbound": false,
                    "outbound": true
                }
            },
            "endpointId": "uuid",
            "createdAt": "2023-10-20T10:27:22.489-03:00",
            "updatedAt": "2023-10-20T10:27:22.489-03:00",
            "endpoint": {
                "id": "uuid",
                "type": "long-code-number",
                "instanceId": "uuid",
                "name": "string",
                "createdAt": "2023-10-20T10:27:22.489-03:00",
                "updatedAt": "2023-10-20T10:27:22.489-03:00",
                "capabilities": [
                    {
                        "name": "voice",
                        "inbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ]
                        },
                        "outbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ],
                            "destinationStatuses": {
                                "inactive": 249
                            }
                        }
                    },
                    {
                        "name": "sms",
                        "inbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ]
                        },
                        "outbound": null
                    },
                    {
                        "name": "mms",
                        "inbound": null,
                        "outbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ],
                            "destinationStatuses": {
                                "inactive": 249
                            }
                        }
                    }
                ]
            }
        },
        {
            "id": "uuid",
            "numberString": "string",
            "countryCode": "string",
            "type": "local|mobile|toll-free|national",
            "capabilities": {
                "voice": {
                    "inbound": true,
                    "outbound": true
                },
                "sms": {
                    "inbound": true,
                    "outbound": false
                },
                "mms": {
                    "inbound": false,
                    "outbound": true
                }
            },
            "endpointId": "uuid",
            "createdAt": "2023-10-20T10:27:22.469-03:00",
            "updatedAt": "2023-10-20T10:27:22.469-03:00",
            "endpoint": {
                "id": "uuid",
                "type": "long-code-number",
                "instanceId": "uuid",
                "name": "sting",
                "createdAt": "2023-10-20T10:27:22.469-03:00",
                "updatedAt": "2023-10-20T10:27:22.469-03:00",
                "capabilities": [
                    {
                        "name": "voice",
                        "inbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ]
                        },
                        "outbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ],
                            "destinationStatuses": {
                                "inactive": 249
                            }
                        }
                    },
                    {
                        "name": "sms",
                        "inbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ]
                        },
                        "outbound": null
                    },
                    {
                        "name": "mms",
                        "inbound": null,
                        "outbound": {
                            "status": "inactive",
                            "subscriptions": [
                                "main"
                            ],
                            "destinationStatuses": {
                                "inactive": 249
                            }
                        }
                    }
                ]
            }
        }
    ]
}

Get a Long Code Number

In order to retrieve the details of a long code number available in your workspace you can use this request.

Get Workspace Long Code Number

GET/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}

Authorization

useraccessKey

Path parameters

workspaceId*string

longCodeNumberId*string

Response

200404

OK

Body

application/json

id*string (uuid)

endpointId*string (uuid)

numberString*string

countryCode*string (iso3166-1)

typeLongCodeNumberType (enum)

localnationaltoll-freemobile

capabilities*PhoneNumberCapabilities (object)

Capabilities of the phone number

createdAt*string (date-time)

updatedAt*string (date-time)

orderLongCodeNumberOrder (object)

deprovisionAtstring (date-time)

endpoint*EndpointFragment (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "endpointId": "123e4567-e89b-12d3-a456-426614174000",
  "numberString": "text",
  "countryCode": "text",
  "type": "local",
  "capabilities": {
    "voice": {
      "inbound": false,
      "outbound": false
    },
    "sms": {
      "inbound": false,
      "outbound": false
    },
    "mms": {
      "inbound": false,
      "outbound": false
    }
  },
  "createdAt": "2024-11-21T08:32:43.886Z",
  "updatedAt": "2024-11-21T08:32:43.886Z",
  "order": {
    "countryCode": "text",
    "type": "local",
    "capabilities": [
      "voice"
    ],
    "prefix": "text",
    "status": "draft",
    "createdAt": "2024-11-21T08:32:43.886Z",
    "updatedAt": "2024-11-21T08:32:43.886Z"
  },
  "deprovisionAt": "2024-11-21T08:32:43.886Z",
  "endpoint": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "long-code-number",
    "instanceId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "capabilities": [
      {
        "name": "sms",
        "inbound": {
          "status": "active",
          "issues": [
            "subscription-is-not-active"
          ]
        },
        "outbound": {
          "status": "active",
          "destinationStatuses": {
            "active": 0,
            "inactive": 0,
            "available": 0,
            "unavailable": 0
          },
          "supportsDestinations": false,
          "issues": [
            "subscription-is-not-active"
          ]
        }
      }
    ],
    "dependencies": [
      {
        "type": "connector",
        "connectorId": "123e4567-e89b-12d3-a456-426614174000",
        "connectorTemplateRef": "text",
        "capabilities": [
          "voice"
        ]
      }
    ],
    "issues": [
      "subscription-is-not-active"
    ],
    "provisioningStatus": "provisioned",
    "createdAt": "2024-11-21T08:32:43.886Z",
    "updatedAt": "2024-11-21T08:32:43.886Z"
  }
}

Request

curl "https://api.bird.com/workspaces/{workspaceId}/numbers-long-code/{longCodeId}" \
     -H 'Authorization: Bearer <your-access-key>'

Response

{
    "id": "uuid",
    "numberString": "string",
    "countryCode": "string",
    "type": "local|mobile|toll-free|national",
    "capabilities": {
        "voice": {
            "inbound": true,
            "outbound": true
        },
        "sms": {
            "inbound": true,
            "outbound": false
        },
        "mms": {
            "inbound": false,
            "outbound": true
        }
    },
    "endpointId": "uuid",
    "createdAt": "2023-10-20T10:27:22.469-03:00",
    "updatedAt": "2023-10-20T10:27:22.469-03:00",
    "endpoint": {
        "id": "uuid",
        "type": "long-code-number",
        "instanceId": "uuid",
        "name": "sting",
        "createdAt": "2023-10-20T10:27:22.469-03:00",
        "updatedAt": "2023-10-20T10:27:22.469-03:00",
        "capabilities": [
            {
                "name": "voice",
                "inbound": {
                    "status": "inactive",
                    "subscriptions": [
                        "main"
                    ]
                },
                "outbound": {
                    "status": "inactive",
                    "subscriptions": [
                        "main"
                    ],
                    "destinationStatuses": {
                        "inactive": 249
                    }
                }
            },
            {
                "name": "sms",
                "inbound": {
                    "status": "inactive",
                    "subscriptions": [
                        "main"
                    ]
                },
                "outbound": null
            },
            {
                "name": "mms",
                "inbound": null,
                "outbound": {
                    "status": "inactive",
                    "subscriptions": [
                        "main"
                    ],
                    "destinationStatuses": {
                        "inactive": 249
                    }
                }
            }
        ]
    }
}