Initiate outbound call - AI Assistant

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

cURL

IntroAndVoicemail

curl --request POST \
  --url https://api.heylibby.com/api/v1/outbound/call \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "your-agent-uuid",
  "contact": {
    "phoneNumber": "+15551234567",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com"
  },
  "metadata": {
    "formLocation": "Ballard",
    "formGoals": "get in shape",
    "utmSource": "facebook"
  },
  "introMessage": "Hi Jane, this is Libby calling from Acme Fitness, calling you back about your membership inquiry...",
  "voicemailMessage": "Hi Jane, sorry we missed you. This is Libby from Acme Fitness. Call us back to learn about our May promotion..."
}
'

200

Queued

{
  "success": true,
  "message": "Your call has been scheduled and will be placed shortly."
}

Authorizations

x-api-key

string

header

required

API key secret from API Key Management. API Gateway validates the key and forwards the request to the outbound service.

Headers

Content-Type

enum

required

Must be application/json.

Available options:

application/json

Body

application/json

agentId

string

required

Agent that places and handles the call. Required.

contact

object

required

metadata

object

Optional key/value context (e.g. form or UTM fields). Values may be strings, numbers, or booleans.

introMessage

string

Message spoken when a human answers. Must be sent together with voicemailMessage, unless you use callInstructions instead.

voicemailMessage

string

Message left when voicemail is detected. Must be sent together with introMessage, unless you use callInstructions instead.

callInstructions

string

Instructions for the call when you are not providing introMessage and voicemailMessage. Use this option alone; do not send only one of the intro/voicemail pair.

Response

200

application/json

Call accepted and queued.

success

boolean

Whether the call was accepted and queued.

Example:

true

message

string

Human-readable confirmation.

Example:

"Your call has been scheduled and will be placed shortly."