Skip to main content
POST
/
inbound
/
setup
cURL
curl --request POST \
  --url https://api.bolna.ai/inbound/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_number_id": "123e4567-e89b-12d3-a456-426614174000",
  "allow_multiple": true,
  "ivr_config": {
    "enabled": true,
    "voice": "Polly.Aditi",
    "welcome_message": "Welcome to Acme Corp.",
    "timeout": 7,
    "max_retries": 2,
    "steps": [
      {
        "step_id": "<string>",
        "prompt": "<string>",
        "field_name": "<string>",
        "options": [
          {}
        ],
        "next_step": "<string>",
        "conditional_next": {}
      }
    ],
    "default_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
{
  "url": "https://api.bolna.ai/inbound_call?agent_id=3c90c3cc-0d44-4b50-8888-8dd25736052a&user_id=28f9c34b-8eb0-4af5-8689-c2f6c4daec22",
  "phone_number": "+19876543210",
  "id": "3c90c3cc0d444b5088888dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
agent_id
string<uuid>
required

Agent id which will handle inbound calls. Used as default if no IVR option-level agent is set.

Example:

"3c90c3cc-0d44-4b50-8888-8dd25736052a"

​
phone_number_id
string<uuid>
required

Telephone number id from Phone number list API

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
allow_multiple
boolean
default:false

Allow this phone number to be linked to multiple phone numbers for the same agent. Only applicable for Plivo phone numbers.

Example:

true

​
ivr_config
object

Optional IVR configuration for Plivo phone numbers. See IVR documentation for details.

Response

providers status response

​
url
string

Message displaying the voice URL

Example:

"https://api.bolna.ai/inbound_call?agent_id=3c90c3cc-0d44-4b50-8888-8dd25736052a&user_id=28f9c34b-8eb0-4af5-8689-c2f6c4daec22"

​
phone_number
string<string>

Phone number in (in E.164 format)

Example:

"+19876543210"

​
id
string

The ID of the phone number

Pattern: ^[0-9a-fA-F]{32}$
Example:

"3c90c3cc0d444b5088888dd25736052a"