POST
/
numbers
curl --request POST \
  --url https://app.happyrobot.ai/api/v1/numbers \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "area_code": "<string>"
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "number": "+14155552671",
  "sid": "<string>",
  "locality": "San Francisco",
  "use_case_id": "<string>",
  "agent_routes": [
    {
      "probability": 50,
      "id": "<string>"
    }
  ],
  "model_routes": [
    {
      "probability": 50,
      "id": "<string>"
    }
  ]
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Body

application/json
area_code
string

The area code of the phone number. Applies to only phone numbers in the US and Canada.

Response

200 - application/json
id
string
required

ID of the phone number.

organization_id
string
required

Organization ID.

number
string
required

Phone number.

sid
string
required

Twilio SID.

locality
string

Locality.

use_case_id
string | null

ID of the use case that should handle inbound on this number.

agent_routes
object[]
required
model_routes
object[]
required