Skip to main content
POST
/
h
/
v2
/
create-phone-call
Create an outbound phone call
curl --request POST \
  --url https://api.openmic.ai/h/v2/create-phone-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_number": "+12025551234",
  "to_number": "+14155559876",
  "dynamic_variables": {
    "customer_name": "John Doe",
    "order_id": "ORD-8821"
  },
  "callback_url": "https://yourapp.com/webhooks/call-status"
}
'
{
  "id": "<string>",
  "from_number": "<string>",
  "to_number": "<string>",
  "call_status": "registered",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "call_type": "phonecall",
  "agent_uid": "<string>",
  "customer_id": "<string>",
  "dynamic_variables": {},
  "callback_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the OpenMic dashboard.

Body

application/json
​
from_number
string
required

E.164 format caller number (e.g. +12025551234).

Pattern: ^\+[1-9]\d{1,14}$
​
to_number
string
required

E.164 format destination number.

Pattern: ^\+[1-9]\d{1,14}$
​
override_agent_uid
string

Override the default agent assigned to the from_number.

​
customer_id
string

Your internal customer reference. Stored with the call record.

​
dynamic_variables
object

Key-value pairs injected into the agent prompt as template variables at call time.

​
callback_url
string<uri>

Webhook URL called with call status updates.

Response

Call created and queued.

​
id
string
required

CUID call identifier.

​
from_number
string
required
​
to_number
string
required
​
call_status
enum<string>
required
Available options:
registered,
ongoing,
ended,
error
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
call_type
enum<string>
Available options:
phonecall,
webcall
​
agent_uid
string
​
customer_id
string
​
dynamic_variables
object
​
callback_url
string