Skip to content

docs: add number warming guide for outbound campaigns - #1333

Merged
dhruva-vapi merged 1 commit into
mainfrom
docs/number-warming-campaigns
Oct 15, 2026
Merged

dhruva-vapi merged 1 commit into
mainfrom
docs/number-warming-campaigns

Conversation

@justincrowe-hub

@justincrowe-hub justincrowe-hub commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Description

  • Adds Outbound Campaigns > Advanced > Warm outbound numbers (/outbound-campaigns/number-warming). It covers warming production numbers with small recurring campaigns to approved contacts who expect the call.
  • Defines a custom call-outcome structured output (live_success, live_incomplete, voicemail, screening_only, other_automated, unknown, plus a screeningEncountered flag). The page includes a ready-to-POST schema and shows how to attach it through artifactPlan.structuredOutputIds.
  • Covers the gap that structured outputs don't appear on the campaign page. A TypeScript example lists a campaign's contacts (GET /v2/campaign/{id}/contacts), fetches each dialed call (GET /call/{id}), and reads artifact.structuredOutputs. It falls back to endedReason and counts how many calls actually counted toward warming.
  • Defines the per-number report and completed conversation rate (live_success / calls actually dialed). The page explains how this rate differs from the campaign Pick up rate.
  • Adds reputation checks: Hiya's free Number Registration and Caller Reputation, and Twilio Trust & Engagement Insights, which requires Voice Insights Advanced Features. It notes there is no universal warming score.
  • Adds the page to docs.yml navigation.

API fields and endpoints were checked against fern/apis/api/openapi.json: Call.campaignId, CampaignContactWithOutcome.callId, contacts pagination, and the endedReason values used. Hiya and Twilio details were checked against vendor pages on 2026-10-15.

Testing Steps

  • node scripts/fern/run.cjs check with the pinned Fern 5.151.1: 0 errors and 14 warnings, the same as main
  • Open the preview deployment and confirm the page renders under Outbound Campaigns > Advanced
  • Confirm internal links resolve (#trusted-calling-and-caller-id, #receive-campaign-events, #how-campaigns-work, contacts API reference)
  • Run the aggregation snippet against a test campaign

🤖 Generated with Claude Code

Adds an Outbound Campaigns > Advanced page on warming production numbers
with recurring small campaigns: approved contacts, scheduler duties, a
call-outcome structured output, per-campaign aggregation through the API,
per-number reporting, and Hiya / Twilio reputation checks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lightsage-app

lightsage-app Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Lightsage docs evals

Lightsage could not queue docs evals for this PR.

Docs URL: https://vapi-preview-01a13fd3-0a8e-747b-8e56-8258b3b4fb02.docs.buildwithfern.com
Commit: 0e6a49c
Reason: No custom evals are selected for GitHub PR evals. Open Lightsage > Custom Evals and enable the GitHub checkbox for at least one custom eval.

@github-actions

Copy link
Copy Markdown
Contributor

@justincrowe-hub

Copy link
Copy Markdown
Contributor Author

@dhruva-reddy @dhruva-vapi should review this before it's approved

@dhruva-vapi
dhruva-vapi merged commit f043143 into main Oct 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants