Buying a number through Bird
Last updated
Was this helpful?
Last updated
Was this helpful?
If you require a number for your customer, these are available to acquire through Bird CRM using our API. Once you purchase the number this will automatically be verified on WhatsApp for use in the embedded signup flow.
If you do not already have a number available in your workspace you can find one to purchase
Once you have found an available number, you can purchase it by providing the number (using the unique identifier provided by the endpoint above).
A successful request to this endpoint will start a recurring monthly subscription based on the monthly cost of the number
The ID for the organization.
d0b85ccc-b63a-4e81-b698-c359d77d250eLimits 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.
10Pagination 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"]The number type depending on its purpose. Local for regional use, national for countrywide use, mobile for mobile networks, or toll-free for caller-free charging.
["toll-free"]The number capabilities, which can be voice, SMS, and MMS for inbound, outbound, or two-way communication, plus WhatsApp.
["sms-outbound"]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.
+1212Assigns 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-78671bd3b11eThe 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.