Buy a phone number

Buy a real phone number and assign it to the Receptionist agent. This call is fully documented in Assign a phone number under "Buy and assign a phone number". This page covers only how to use it on the Receptionist go-live path.

POSThttps://api.spyne.ai/console/v1/telephony/phone-numbers
AuthBearer token (console user)Rate limit5 requests / hour per dealer group and 5 per userProcessingSynchronous; waits for purchase, messaging attach, save and call routingWarningEvery success buys a real US phone number from the carrier and bills for it. Do not send unless you mean to buy a number.

Before you call it

  • Call it with enterpriseId, teamId and the Receptionist's teamAgentMappingId. The full request and response are on the Agent Setup page.
  • The Receptionist counts as live once its agent record has a phone number, or the rooftop has a website chat script. It does not use isOnboarded.
  • Order matters. Buy the number first, then start the trial clock, so a failed purchase does not start the trial.

What happens next

Call Start the trial clock, then Grant the live product.

If the steps after the purchase fail, do not retry the purchase. A retry buys a second number. Retry only the step that failed.


Did this page help you?