Skip to main content
GET
/
v1
/
messaging
/
numbers
/
whatsapp
/
availability
Numbers API
curl --request GET \
  --url https://api.example.com/v1/messaging/numbers/whatsapp/availability

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
BYON verification flow

If you already have a WhatsApp Business number, the BYON (Bring Your Own Number) flow verifies ownership via OTP before connecting it to Vobiz.
  1. Step 1 - Enter your phone number and select SMS or voice verification
  2. Step 2 - Receive and enter the OTP code sent to your number
  3. Step 3 - Verification confirmed - number is connected to your channel

​
List available numbers

GET https://api.vobiz.ai/v1/messaging/numbers/whatsapp/availability
Search for WhatsApp-capable phone numbers available for purchase.
ParamRequiredDescription
countryYesISO country code (e.g. IN, US)
regionNoState/region filter
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/numbers/whatsapp/availability?country=IN" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
Create number order

POST https://api.vobiz.ai/v1/messaging/numbers/whatsapp/orders
Purchase a new WhatsApp-capable phone number. After the order is fulfilled, use Create Channel to connect it to your WABA.
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/numbers/whatsapp/orders" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"country_code":"IN","region":"MH","number_type":"local","preferred_number":"+919876543210","currency":"INR"}'

​
Verify BYON - step 1

POST https://api.vobiz.ai/v1/messaging/numbers/whatsapp/bring-your-own/verify
Initiate OTP verification for a number you already own. Choose sms or voice as the delivery method.
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/numbers/whatsapp/bring-your-own/verify" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"phone_number":"+919876543210","verification_method":"sms"}'

​
Confirm BYON verification - step 2

POST https://api.vobiz.ai/v1/messaging/numbers/whatsapp/bring-your-own/confirm
Submit the OTP received in step 1 to complete verification. On success, the number is confirmed and ready to connect via Create Channel.
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/numbers/whatsapp/bring-your-own/confirm" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"phone_number":"+919876543210","otp_code":"123456"}'