API Reference

Create a BusinessPhoneNumber

post
https://api.vcita.biz/v3/communication/business_phone_numbers

Overview

Purchase a phone number from a telecom provider and assign it to a business account. For US and Canadian phone numbers with text messaging, verification_request_data is required to register your business with mobile carriers and ensure reliable message delivery. Available for Staff and Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The complete phone number in E.164 format without formatting (e.g., "12127654321"). This is the actual phone number to be purchased from the telecom provider.

string
required

ISO 3166-1 alpha-2 country code (e.g., "US" for United States, "CA" for Canada).

features
array of strings
required
length ≥ 1

List of telephony features to enable for this phone number, (e.g., ["VOICE", "SMS"]).

verification_request_data
object

Business verification information required for text messaging compliance in the United States and Canada. This data registers your business with mobile carriers to enable SMS messaging capabilities. The verification process helps prevent spam and ensures your business messages are delivered reliably to customers.

Responses

400

Bad request - Invalid input data

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient permissions

409

Conflict - Phone number already exists or is not available

Updated 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago