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

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 99Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

numberStringstringOptional

typesstring · enum[]Optional

countryCodesstring · iso3166-1[]Optional

providerIdsstring · uuid[]Optional

capabilitiesstring · enum[]Optional

Responses

application/json

all ofOptional

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/numbers-long-code HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

200

OK

{
  "nextPageToken": "text",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "endpointId": "123e4567-e89b-12d3-a456-426614174000",
      "numberString": "text",
      "countryCode": "text",
      "type": "local",
      "capabilities": {
        "voice": {
          "inbound": true,
          "outbound": true
        },
        "sms": {
          "inbound": true,
          "outbound": true
        },
        "mms": {
          "inbound": true,
          "outbound": true
        }
      },
      "createdAt": "2025-04-18T23:48:58.676Z",
      "updatedAt": "2025-04-18T23:48:58.676Z",
      "order": {
        "countryCode": "text",
        "type": "local",
        "capabilities": [
          "voice"
        ],
        "prefix": "text",
        "status": "draft",
        "createdAt": "2025-04-18T23:48:58.676Z",
        "updatedAt": "2025-04-18T23:48:58.676Z"
      },
      "deprovisionAt": "2025-04-18T23:48:58.676Z",
      "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": 1,
                "inactive": 1,
                "available": 1,
                "unavailable": 1
              },
              "supportsDestinations": true,
              "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": "2025-04-18T23:48:58.676Z",
        "updatedAt": "2025-04-18T23:48:58.676Z"
      }
    }
  ]
}

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

Authorizations

useraccessKey

Path parameters

workspaceIdstringRequired

longCodeNumberIdstringRequired

Responses

application/json

all ofOptional

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/numbers-long-code/{longCodeNumberId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "endpointId": "123e4567-e89b-12d3-a456-426614174000",
  "numberString": "text",
  "countryCode": "text",
  "type": "local",
  "capabilities": {
    "voice": {
      "inbound": true,
      "outbound": true
    },
    "sms": {
      "inbound": true,
      "outbound": true
    },
    "mms": {
      "inbound": true,
      "outbound": true
    }
  },
  "createdAt": "2025-04-18T23:48:58.676Z",
  "updatedAt": "2025-04-18T23:48:58.676Z",
  "order": {
    "countryCode": "text",
    "type": "local",
    "capabilities": [
      "voice"
    ],
    "prefix": "text",
    "status": "draft",
    "createdAt": "2025-04-18T23:48:58.676Z",
    "updatedAt": "2025-04-18T23:48:58.676Z"
  },
  "deprovisionAt": "2025-04-18T23:48:58.676Z",
  "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": 1,
            "inactive": 1,
            "available": 1,
            "unavailable": 1
          },
          "supportsDestinations": true,
          "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": "2025-04-18T23:48:58.676Z",
    "updatedAt": "2025-04-18T23:48:58.676Z"
  }
}

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
                    }
                }
            }
        ]
    }
}