APIPhone NumbersCreate Phone Number
Create Phone Number
Purchase a phone number (E.164, usually picked from Get Phone Numbers by Area Code) and add it to your organization. Uses 1 phone credit, which is refunded if provisioning fails. Toll-free numbers are not allowed. Returns 400 when you have no phone credits or the number is already in your account, and 409 when it belongs to another organization. Responds 201. Assign an agent afterwards with Update Phone Number.
Created: April 18, 2025
Updated: September 16, 2026
Overview
POST
https://dashboard.vinsi.ai/api/phone-numbers
Request
Headers
Content-Typestring
x-api-keystring
Request Body
{1 item
"phoneNumber":string"+16195550123"
}
Response
{2 items
"success":booltrue
"phoneNumber":{9 items
"id":string"phn_1757964000123_k2j4h5g6f"
"phoneNumber":string"+16195550123"
"providerId":string"2468013579246801357"
"provider":string"telnyx"
"orderId":string"3f1b2c4d-0000-4000-8000-000000..."
"orderStatus":string"success"
"livekitTrunkId":string"ST_exampleTrunk01"
"livekitTrunkConfigured":booltrue
"dispatchRuleId":null
}
}
Endpoint Explorer
Note: You must be already authenticated on https://dashboard.vinsi.ai/ to use this API tester.
POST
Headers
Content-Type: *
x-api-key: *
Response
No response yet. Click Send to test the API.