Initiate an outbound call
POST
https://api.telvana.com/outbound
Create an outbound call from an AI agent to a phone number.
Write both numbers in E.164 form, such as +15551234567. from must be a number assigned to your workspace, exactly as the portal's Phone Numbers page shows it. The response means the call is queued, not that it connected: the call's outcome arrives with the conversation once the call ends. See Placing outbound calls.
Request body (application/json)
| Name | Description |
|---|---|
from
string
required
|
The agent's phone number in Telvana (e.g., +15559876543) |
to
string
required
|
The call recipient's phone number (e.g., +15551234567) |
outboundPromptId
string
|
ID of the outbound prompt to use. Defaults to the first prompt for the agent. |
variables
object of string
|
Object containing the call's variables. These will be dynamically injected into the prompt. For example: 'Hi {{firstName}}.' |
Example request
curl -X POST "https://api.telvana.com/outbound" \
-H "x-api-key: $TELVANA_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"from": "+15559876543",
"to": "+15551234567",
"outboundPromptId": "clx8y9z1a2b3c4d5e6f7g8h9i",
"variables": {
"firstName": "John",
"lastName": "Smith",
"appointmentTime": "2:00 PM",
"propertyAddress": "123 Main St, Anytown, CA"
}
}'Response 200
Outbound call request queued successfully. Errors use the format in Errors .
Example response
{
"data": {
"from": "+15559876543",
"to": "+15551234567",
"conversationId": "clx8y9z1a2b3c4d5e6f7g8h9i",
"outboundPromptId": "clx8y9z1a2b3c4d5e6f7g8h9i",
"variables": {
"firstName": "John",
"lastName": "Smith",
"appointmentTime": "2:00 PM",
"propertyAddress": "123 Main St, Anytown, CA"
}
},
"message": "Request queued for outbound processing"
}