Error
A valid request URL is required to generate request examples{
"id": "AUIAC-EXQA",
"name": "Main line",
"e164": "+15551234567",
"area_code": "555",
"inbound_cloud_employee_id": "AUIAE-DUXA",
"outbound_cloud_employee_id": "AUIAE-DUXA"
}{
"type": "https://example.com/errors/example",
"title": "Bad Request",
"status": 400,
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"errors": [
{
"message": "<string>",
"location": "<string>",
"value": "<unknown>"
}
]
}Phone Numbers
Buy a phone number
Purchase a phone number in the requested area code.
POST
/
beta
/
phone-numbers
Error
A valid request URL is required to generate request examples{
"id": "AUIAC-EXQA",
"name": "Main line",
"e164": "+15551234567",
"area_code": "555",
"inbound_cloud_employee_id": "AUIAE-DUXA",
"outbound_cloud_employee_id": "AUIAE-DUXA"
}{
"type": "https://example.com/errors/example",
"title": "Bad Request",
"status": 400,
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"errors": [
{
"message": "<string>",
"location": "<string>",
"value": "<unknown>"
}
]
}Authorizations
API key sent in the X-Api-Key header. Generate an API key from https://app.atonom.ai/#/settings/v2/api_keys.
Body
application/json
Display name for the new phone number.
Minimum string length:
1Example:
"Overflow line"
NANP area code to search when buying.
Example:
"415"
Identifier of the cloud employee handling inbound calls.
Required string length:
10 - 21Pattern:
^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$Example:
"AUIAE-DUXA"
Identifier of the cloud employee handling outbound calls.
Required string length:
10 - 21Pattern:
^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$Example:
"AUIAE-DUXA"
Response
Created
Identifier of the phone number.
Required string length:
10 - 21Pattern:
^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$Example:
"AUIAC-EXQA"
Display name of the phone number.
Example:
"Main line"
Phone number in E.164 format.
Example:
"+15551234567"
NANP area code.
Example:
"555"
Identifier of the cloud employee handling inbound calls.
Required string length:
10 - 21Pattern:
^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$Example:
"AUIAE-DUXA"
Identifier of the cloud employee handling outbound calls.
Required string length:
10 - 21Pattern:
^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$Example:
"AUIAE-DUXA"