Sign in
Numbers

Purchase A Number

Purchase a Number

post/numbers/order

Request body

labelstring

A label for the number

use_extensionsboolean

Whether to use extensions

recordboolean

Whether to record calls

routesobject[]

Routing configuration

numberstring required

The phone number to purchase

provider_idinteger

The ID of the provider to use

company_idinteger required

The ID of the company to purchase the number for

use_ai_ivrboolean

Whether the AI receptionist answers on this number

ai_ivr_agent_idstring nullable

ElevenLabs agent external ID to route calls through AI IVR

ai_answer_triggersstring[] nullable

When the AI receptionist answers. Empty/null means every call.

fax_notification_emailstring email

Email to notify for fax

number_template_idinteger

ID of the number template to apply

Example request

{
  "label": "Sales Line",
  "number": "+18005551234",
  "provider_id": 1,
  "company_id": 123
}

Response

OK

{"stackTrail":"paths:/numbers/order:post:responses:200:content:application/json:schema:properties:number","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.