Repository navigation
docs: add number warming guide for outbound campaigns - #1333
Merged
Merged
Conversation
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 docs evalsLightsage could not queue docs evals for this PR. Docs URL: https://vapi-preview-01a13fd3-0a8e-747b-8e56-8258b3b4fb02.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a13fd3-0a8e-747b-8e56-8258b3b4fb02.docs.buildwithfern.com |
Contributor
Author
|
@dhruva-reddy @dhruva-vapi should review this before it's approved |
dhruva-vapi
approved these changes
Oct 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
/outbound-campaigns/number-warming). It covers warming production numbers with small recurring campaigns to approved contacts who expect the call.live_success,live_incomplete,voicemail,screening_only,other_automated,unknown, plus ascreeningEncounteredflag). The page includes a ready-to-POST schema and shows how to attach it throughartifactPlan.structuredOutputIds.GET /v2/campaign/{id}/contacts), fetches each dialed call (GET /call/{id}), and readsartifact.structuredOutputs. It falls back toendedReasonand counts how many calls actually counted toward warming.live_success/ calls actually dialed). The page explains how this rate differs from the campaign Pick up rate.docs.ymlnavigation.API fields and endpoints were checked against
fern/apis/api/openapi.json:Call.campaignId,CampaignContactWithOutcome.callId, contacts pagination, and theendedReasonvalues used. Hiya and Twilio details were checked against vendor pages on 2026-10-15.Testing Steps
node scripts/fern/run.cjs checkwith the pinned Fern 5.151.1: 0 errors and 14 warnings, the same asmain#trusted-calling-and-caller-id,#receive-campaign-events,#how-campaigns-work, contacts API reference)🤖 Generated with Claude Code