This endpoint is deprecated.

Purchase number

DEPRECATED:

SUNSET:

SUCCESSOR:

Jan 20, 2024.

Not planned

Using the number ID or number, this method enables you to buy a new number. For buying a US number, only the number should be provided. For all other purchases, only the numberKey must be provided.

For purchasing US numbers, it is not advisable to use this method, but rather its successor.

Authorizations:

Scopes:

numbers:manage

Request rate limit:

1 requests / second (per account)

Learn more

Request Body schema:

application/json

collapse all -

Either numberKey of the number to be purchased or a number needs to be provided

numberKey	string
number	string
applicationId	string [ 0 .. 255 ] characters ID of the Application that would be associated with the number. Find out more about Application and Application Management
entityId	string [ 0 .. 255 ] characters ID of the Entity that would be associated with the number. Find out more about Entity and Entity Management

Responses

200

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Use case: Making an appointment using 2-way SMS communication

Request samples

Content type

application/json

Example

numberKey

Copy

Collapse all


{"numberKey": "58B3840032C7774BAC840EEEA2C23A44"
}

Response samples

Content type

application/json

Copy

Collapse all


{"numberKey": "58B3840032C7774BAC840EEEA2C23A44",
"number": "447860041117",
"country": "GB",
"type": "VIRTUAL_LONG_NUMBER",
"capabilities": 
["SMS"
],
"shared": false,
"price": 
{"pricePerMonth": 5,
"setupPrice": 0,
"currency": "EUR"
}
}