Purchase available number (deprecated, use /phone_numbers instead)

Purchase an available phone number.

post/phone_numbers/purchase

Request

  • Base URL
    https://api.vogent.ai/api
  • Auth
    HTTP bearer

Request body

numberstring required

The number as returned by the phone number search endpoint.

Response

Successful operation

idstring required
numberstring required

The number in e.164 format, or the SIP username, if the type is SIP_USERNAME.

type'PSTN' | 'SIP_USERNAME' required
agentIdstring nullable required

The ID of the linked agent, if the phone number is linked to one.

Example response

{
  "number": "+18001234567"
}

Changes

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