FRfreyavoice
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)
  • retriesRemaining shows how many retries are left
postCampaign Call Outcome

Request

  • Base URL
    https://app.freyavoice.ai/api/v2
  • Auth
    none declared

Request body

callIdstring
campaignIdstring required
phoneNumberstring required
outcome'success' | 'failed' required
failureCategorystring

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

messagestring

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

willRetryboolean

Whether the call will be retried

retryScheduledAtstring date-time

ISO8601 timestamp when retry is scheduled

retriesRemainingnumber

Number of retries remaining

attemptNumbernumber

Which attempt this outcome is for (1-indexed)

Response

Webhook received successfully

Changes

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