Skip to main content
POST
/
api
/
calls
/
start_outbound_call
Api Start Outbound Call
curl --request POST \
  --url https://voiceagent.infers.co/api/calls/start_outbound_call \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "voice_agent_id": "<AGENT_ID>",
  "prompt_values": {
    "name": "John Doe"
  },
  "to_phone": "+1234567890"
}'
{
  "status": "success",
  "message": "<string>",
  "call_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Email [email protected] to get your API key

Body

application/json
​
voice_agent_id
string
default:<AGENT_ID>

Enter the voice agent ID, that was received once you created the voice agent. If you forgot the voice agent ID, just use the GET method to retrive it

​
prompt_values
object

If you have used prompt templating with variables in the prompt parameter while creating the voice agent using POST method then pass those variables with values here as a dict

Examples:
{ "name": "John Doe" }
​
to_phone
string

Specify the phone number on which you to initiate the outbound call

Examples:

"+1234567890"

Response

Successful Response

​
status
enum<string>
required
Available options:
success
​
message
string
required
​
call_id
string
required

Call identifier to get call logs