Outbound

Initiate an outbound call

Create an outbound call from an AI agent to a phone number

post/outbound

Request

  • Base URL: https://api.telvana.com
  • URL: https://api.telvana.com/outbound
  • Auth: API key in header x-api-key

Request body

fromstring required

The agent's phone number in Telvana (e.g., +15559876543)

tostring required

The call recipient's phone number (e.g., +15551234567)

outboundPromptIdstring

ID of the outbound prompt to use. Defaults to the first prompt for the agent.

variablesobject

Object containing the call's variables. These will be dynamically injected into the prompt. For example: 'Hi {{firstName}}.'

Response

Outbound call request queued successfully

messagestring

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.