Skip to main content
POST
/
v1
/
calls
/
phone
Start a new phone call
curl --request POST \
  --url https://api.callrounded.com/v1/calls/phone \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "from_number": "+33912345678",
  "to_number": "+33612345678",
  "agent_id": "411b82c8-462a-4e1b-89bc-10ab3ce1ed29",
  "dynamic_variables_values": {
    "active": true,
    "age": 35,
    "appointment_date": "2023-05-15T14:30:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "opening_hours": {
      "monday": [
        {
          "end": "17:00",
          "start": "07:00"
        }
      ]
    }
  },
  "custom_headers": {
    "From": "Anonymous <sip:anonymous@example.com>;tag=3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "X-Custom-Header": "value"
  }
}'
{
  "data": {
    "call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "message": "Phone call started successfully",
  "status": 201
}

Authorizations

​
X-Api-Key
string
header
required

Body

application/json
​
from_number
string
required
Minimum length: 8
Examples:
​
to_number
string
required
Minimum length: 8
Examples:
​
agent_id
string<uuid>
required
Examples:
​
dynamic_variables_values
object | null
Examples:
​
custom_headers
object | null
Examples:

Response

​
message
string
required
​
data
object
required
​
error
object | null
Example:
​
status
integer
default:201