Call outcome webhook

curl --request POST \
  --url https://app.freyavoice.ai/api/v2/webhooks/campaign-call-outcome \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignId": "<string>",
  "phoneNumber": "<string>",
  "callId": "<string>",
  "failureCategory": "<string>",
  "message": "<string>",
  "willRetry": true,
  "retryScheduledAt": "2023-11-07T05:31:56Z",
  "retriesRemaining": 123,
  "attemptNumber": 123
}
'

Webhooks

Call outcome webhook

Sent to the campaign’s webhookUrl when a call completes or fails.

Payload Types:

WebhookCallOutcome: Sent when a call completes (success or failure with ended_reason)
WebhookApiError: Sent when call initiation fails before a call is created

Failure Categories:

no_answer: Customer didn’t answer
busy: Line was busy
voicemail: Reached voicemail
timeout: Call timed out (infrastructure)
api_error: API call failed before call started
llm_fail: LLM evaluation failed (if successPrompt configured)
other: Unknown failure

Retry Behavior:

If willRetry: true, check retryScheduledAt for next attempt time
Retries respect the campaign’s schedule (activeDays, startTime, endTime, and daySchedules overrides)
retriesRemaining shows how many retries are left

POST

webhooks

campaign-call-outcome

Call outcome webhook

curl --request POST \
  --url https://app.freyavoice.ai/api/v2/webhooks/campaign-call-outcome \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignId": "<string>",
  "phoneNumber": "<string>",
  "callId": "<string>",
  "failureCategory": "<string>",
  "message": "<string>",
  "willRetry": true,
  "retryScheduledAt": "2023-11-07T05:31:56Z",
  "retriesRemaining": 123,
  "attemptNumber": 123
}
'

Body

application/json

campaignId

string

required

phoneNumber

string

required

outcome

enum<string>

required

Available options:

success,

failed

callId

string

failureCategory

string

SipCodeCategory value or 'api_error' if outcome is 'failed'

message

string

Contextual message: ended_reason, timeout message, or LLM evaluation reason

willRetry

boolean

Whether the call will be retried

retryScheduledAt

string<date-time>

ISO8601 timestamp when retry is scheduled

retriesRemaining

number

Number of retries remaining

attemptNumber

number

Which attempt this outcome is for (1-indexed)

Response

200

Webhook received successfully

List campaign customers End of call report webhook