Number
The user can purchase a phone number. Number endpoints are meant for querying available phone numbers. To purchase phone numbers, the sender endpoints are used.
Method: Query
List available numbers for purchase.
URL | /v1/numbers |
Method Type | GET |
Authorization | API Key |
Request Content-Type | JSON |
Response Content-Type | JSON |
Headers
Name | Type | Description | Status |
---|---|---|---|
X-Dexatel-Key | string | API key | Required |
Query parameters
Name | Type | Description | Status |
---|---|---|---|
type | string | Type of the number (Local - Mobile - Toll-free - Alphanumeric - Short-code) | Required |
country | string | Country ISO code of the number | Required |
city | string | City of the number, in case the type is local | Optional |
Request Body
-empty-Response Parameters
Name | Type | Description |
---|---|---|
data | array |
Details (see data object below) |
Name | Type | Description |
---|---|---|
number | string | Filtered phone number |
type | string | Filters phone numbers by type |
country | string | ISO country code |
city | string | Name of the city |
setup_cost | number | Setup price for acquiring the number |
monthly_cost | number | Monthly price for acquiring the number |
Example of request body
GET:
/v1/numbers
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace
Example of response body
status - 200
Error Codes
The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.
Code | Description |
---|---|
1411 | Invalid number type specified |
1412 | Invalid country iso code |