Sign in

v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-173538121.5 KB
Calls

Create Phone Call

Create a new outbound phone call.

post/v1/create-phone-call

Request body

from_numberstring required

The number you own in E.164 format. Must be a number purchased from OpenMic.

to_numberstring required

The number you want to call in E.164 format.

override_agent_idstring

The bot ID to override the default agent.

customer_idstring

Customer identifier for tracking

dynamic_variablesobject

Send dynamic variables in key value pairs to replace in the prompt.

callback_urlstring

Callback URL to receive call events.

Example request

{
  "from_number": "+1234567890",
  "to_number": "+0987654321",
  "override_agent_id": "bvrg8wzi487w02m2bc7dh0ev",
  "customer_id": "customer_001",
  "dynamic_variables": {
    "name": "John"
  },
  "callback_url": "https://example.com/callback"
}

Response

Call created successfully

call_type'phonecall' | 'webcall' required

Type of call

from_numberstring required

Originating phone number

to_numberstring required

Destination phone number

direction'inbound' | 'outbound' required

Call direction

call_idstring required

Unique call identifier

agent_idstring required

Bot/agent identifier

call_status'registered' | 'ongoing' | 'ended' | 'error' required

Current call status

customer_idstring

Customer identifier

telephony_identifierobject

Telephony system identifiers

start_timestampinteger

Call start time (Unix timestamp in milliseconds)

end_timestampinteger

Call end time (Unix timestamp in milliseconds)

duration_msinteger

Call duration in milliseconds

recording_urlstring

URL to call recording

dynamic_variablesobject

Send dynamic variables in key value pairs to replace in the prompt.

Example response

{
  "dynamic_variables": {
    "name": "John"
  }
}