Skip to main content
POST
/
v1
/
outbound
/
create-call
Create a call
curl --request POST \
  --url https://api.cozmox.cloud/v1/outbound/create-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "toPhone": "+1234567890",
  "fromPhone": "+1234567890",
  "agentId": "cx_xxxxxx",
  "extras": {
    "Name": "Liza",
    "current_datetime": "2025-01-01 10:10:10"
  }
}
'
{
  "callId": "1234567890"
}

Authorizations

​
x-api-key
string
header
required

The API key

Body

application/json
​
toPhone
string
required

The phone number to call

Example:

"+1234567890"

​
fromPhone
string
required

From phone number

Example:

"+1234567890"

​
agentId
string
required

Agent ID which will communicate with user

Example:

"cx_xxxxxx"

​
extras
object
required

Extra parameters needed for agent on call

Example:
{
  "Name": "Liza",
  "current_datetime": "2025-01-01 10:10:10"
}

Response

​
callId
string
required

The call id

Example:

"1234567890"