Repository navigation
docs: document the call.ending phone number hook and hook filters - #1323
Merged
stephenvapiai merged 2 commits intoOct 14, 2026
Merged
stephenvapiai merged 2 commits into
stephenvapiai merged 2 commits into
Conversation
PhoneNumberHookCallEnding runs only when the inbound assistant request fails, takes a single do action, and filters on call.endedReason with the six assistant-request ended reasons. call.ringing also accepts a startsWith filter on the caller number. Neither was documented.
chiranjeet-vapi
force-pushed
the
docs/phone-number-hooks-call-ending
branch
from
October 14, 2026 04:09
ff384c9 to
bca404d
Compare
chiranjeet-vapi
marked this pull request as ready for review
October 14, 2026 16:42
Lightsage docs evalsWaiting for the staging docs URL before running evals. Lightsage will start the selected PR evals automatically when GitHub reports a successful docs deployment for this PR. This usually happens within 15 minutes. Commit: |
stephenvapiai
approved these changes
Oct 14, 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
fern/phone-numbers/phone-number-hooks.mdxsays hooks support onlycall.ringing. The API also acceptscall.ending, andcall.ringingaccepts a caller-prefix filter; neither was documented.call.ending: it runs only when the inbound assistant request fails, takes a singledoaction (transferorsay), and can filter oncall.endedReasonwith the six assistant-request ended reasons. Names the resulting ended reasons (call.ending.hook-executed-transfer/-say, already listed on the ended-reasons page).startsWithfilter oncall.ringing(key: "number", prefixes without+).call.ringingtakes adoarray and the first action runs.Evidence
https://api.vapi.ai/api-json, 2026-10-14):PhoneNumberHookCallEnding.dois a singleoneOf(TransferPhoneNumberHookAction,SayPhoneNumberHookAction);PhoneNumberHookCallRinging.dois an array.PhoneNumberCallEndingHookFilter:typeenumoneOf,keyenumcall.endedReason,oneOfitems enum: the sixassistant-request-*reasons listed in the page.PhoneNumberCallRingingHookFilter:typeenumstartsWith,keyenumnumber, "Do not include the + prefix."fern/calls/call-ended-reason.mdxalready listscall.ending.hook-executed-sayandcall.ending.hook-executed-transfer.call.endingfires only on assistant-request failure, and that the firstdoaction runs forcall.ringing: verified against the current API implementation.Testing Steps
fern check(pinned 5.151.1) passes locally