Buying a number through Bird
If you require a number for your customer, these are available to acquire through Bird CRM using our numbers API. Once you purchase the number this will automatically be verified on WhatsApp for use in the embedded signup flow.
Find an available number
If you do not already have a number available in your workspace you can find one to purchase
The ID for the organization.
d0b85ccc-b63a-4e81-b698-c359d77d250e
Limits the number of results to return per page. The default value is 10 and maximum is 99. If the nextPageToken is defined on response, you can use it to get remaining numbers. To know more, refer to the pagination section.
10
Pagination token that keeps of track of the current position in the list. Use it to query remaining results. If not provided, the first page is returned. To learn more about the pagination, please refer to the pagination section on API Access Common API Usage section.
A 2-digit ISO 3166-1 country code array.
["US","NL"]
Used to filter numbers belonging to a specific local area-code. It MUST be used in conjunction with the countryCodes filter. Always provide prefixes in full international format.
+1212
GET /organizations/{organizationId}/numbers-stock-items HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"countryCode": "US",
"type": "local",
"numberString": "+19283764510",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"monthlyPrice": {
"currencyCode": "EUR",
"amount": 3500000,
"exponent": -6
},
"backOrderRequired": true,
"backOrderStockId": "text"
}
],
"nextPageToken": "text"
}
Purchase a number
Once you have found an available number, you can purchase it by providing the number (using the unique identifier provided by the endpoint above).
Assigns Long Code Numbers to the current workspace, charging the wallet for their subscription price. When creating LCNs as a User, all specified Number Stock Items should be reserved.
The ID for the workspace.
d386a801-ee8d-4aba-a7e4-78671bd3b11e
The unique identifiers of the numbers you want to buy. You can buy up to 25 numbers at a time. This operation will incur wallet charges for the numbers. Before buying the number, you must reserve it.
POST /workspaces/{workspaceId}/numbers-long-code HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"numberStockItemIds": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
{
"results": [
{
"id": "41e3cf43-4386-464a-a1ee-e6ef6fd6883d",
"endpointId": "41e3cf43-4386-464a-a1ee-e6ef6fd6883d",
"numberString": "+14155552671",
"countryCode": "US",
"type": "local",
"capabilities": {
"voice": {
"inbound": true,
"outbound": true
},
"sms": {
"inbound": true,
"outbound": true
},
"mms": {
"inbound": true,
"outbound": true
}
},
"createdAt": "2025-07-02T00:42:48.293Z",
"updatedAt": "2025-07-02T00:42:48.293Z",
"order": {
"countryCode": "US",
"type": "local",
"capabilities": [
"voice"
],
"prefix": "text",
"status": "draft",
"createdAt": "2025-07-02T00:42:48.293Z",
"updatedAt": "2025-07-02T00:42:48.293Z"
},
"deprovisionAt": "2025-07-02T00:42:48.293Z",
"endpoint": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "long-code-number",
"instanceId": "1551f382-6870-4480-8f9b-f5ab34936288",
"name": "+14155552671",
"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-07-02T00:42:48.293Z",
"updatedAt": "2025-07-02T00:42:48.293Z"
}
}
]
}
A successful request to this endpoint will start a recurring monthly subscription based on the monthly cost of the number
Last updated
Was this helpful?