Skip to main content
POST
/
phone-numbers
Create phone number
curl --request POST \
  --url https://api.helloannie.com/v1/phone-numbers \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "language": "ENGLISH",
  "voiceId": "FRIENDLY_BRIGHT",
  "areaCode": "<string>",
  "verifiedCallerId": "<string>",
  "callbackForwardingNumber": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "botId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": "<string>",
    "name": "<string>",
    "language": "ENGLISH",
    "outbound": true,
    "verifiedCallerId": "<string>",
    "callbackForwardingNumber": "<string>",
    "voiceId": "FRIENDLY_BRIGHT",
    "speed": 123,
    "stability": 123,
    "similarity": 123,
    "style": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.helloannie.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

Payload required to purchase and create a new phone number. A botId, language, and voiceId are required.

​
orgId
string<uuid>
required

The organization ID that will own this phone number

​
botId
string<uuid>
required

The bot ID to attach the phone number to

​
name
string
required

Friendly name for the phone number. Use letters, numbers, spaces, and basic punctuation. Names are capped at 100 characters.

Maximum string length: 100
Pattern: ^[A-Za-z0-9 .,_'()&#+/:;-]+$
​
language
enum<string>
required

The language of the phone number

Available options:
ENGLISH,
SPANISH,
FRENCH
​
voiceId
enum<string>
required

The voice of the phone number

Available options:
FRIENDLY_BRIGHT,
CALM_REASSURING,
POLISHED_PROFESSIONAL,
KIND_CURIOUS,
CONFIDENT_UPBEAT
​
areaCode
string

Optional 3-digit US area code to use when purchasing the phone number. Send an empty string or omit the field to use the default area code.

Pattern: ^(?:\d{3})?$
​
verifiedCallerId
string

Verified caller ID for outbound calls. Must be pre-registered and verified for the organization.

​
callbackForwardingNumber
string

If a recipient calls back an outbound number, the call will be forwarded to this phone number. Note: This field will be ignored for inbound numbers and only applied to outbound numbers.

Response

Response returned after purchasing and creating a phone number

​
success
enum<boolean>
required
Available options:
true
​
data
object
required

Represents a phone number and its configuration