Skip to content

docs(agents): warm transfer timeouts and Wait for a person to answer - #238

Merged
Him188 merged 2 commits into
mainfrom
him188/warm-transfer-settings
Oct 9, 2026
Merged

Him188 merged 2 commits into
mainfrom
him188/warm-transfer-settings

Conversation

@Him188

@Him188 Him188 commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

What

On the Call Transfers page (agents/telephony/transfers.mdx):

  • New Warm transfer settings section:
    • Timeouts: the ring timeout (warm_ring_timeout_seconds, 5 to 120, default 30) and the confirm timeout (warm_confirm_timeout_seconds, 10 to 300, default 60), with console labels.
    • Waiting for a person to answer (warm_human_detection): the agent stays silent until the other side speaks. Voicemail and phone menus stop the transfer, a hold queue or silence waits for the confirm timeout. It covers when to leave it off, the limitation that it goes by what is said rather than the beep, and an API example.
  • The field table gains the three fields.
  • Corrects warm_connect: it takes confirm, briefing (connect right after the briefing) and direct (connect on answer, no briefing). The page described only two values and gave direct the meaning of briefing. The warm transfer steps and the console sentence follow suit.
  • The consult call's "up to 30 seconds" ring now points at the ring timeout.

Checks

  • prettier --check passes. Prettier realigned the existing field table for the new rows.
  • New anchors resolve to the new headings. mint broken-links could not run locally (the CLI fails to start on Node 25).
  • The API example uses the field names, types and ranges from the published API reference. It was not sent against a live agent.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • Documentation
    • Clarified the three warm handoff options and how briefing, direct connection, ring timeouts, and human detection affect transfers.
    • Added guidance on warm transfer settings, including timeout ranges, defaults, detection behavior and limitations, and an API example.
    • Documented that each write replaces the entire destination list.

Adds a Warm transfer settings section to the call transfers page: the ring
and confirm timeouts, and the Wait for a person to answer switch that stops
a warm transfer when voicemail or a phone menu answers. The field table
gains warm_ring_timeout_seconds, warm_confirm_timeout_seconds and
warm_human_detection.

Also corrects warm_connect, which has three handoffs: confirm, briefing
(connect right after the briefing) and direct (connect on answer, no
briefing), and points the 30 second ring at the ring timeout.

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

mintlify Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 9, 2026, 7:45 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 57 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8262c34a-3217-46fb-b975-c78085dceeb6

📥 Commits

Reviewing files that changed from the base of the PR and between d75dca0 and aa2eccb.


📒 Files selected for processing (1)
  • agents/telephony/transfers.mdx


No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ed24cc8a-f849-49b0-9eec-5d77547f9fe1

📥 Commits

Reviewing files that changed from the base of the PR and between 1dba34b and d75dca0.


📒 Files selected for processing (1)
  • agents/telephony/transfers.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

The telephony transfer guide now documents all three warm-connect modes, their API fields, timeout settings, and human-detection behavior.

Changes

Warm transfer documentation

Layer / File(s) Summary
Connect modes and API fields
agents/telephony/transfers.mdx
The console instructions list three warm handoff choices. The API reference documents briefing and direct modes, timeout fields, and optional human detection.
Transfer behavior and settings
agents/telephony/transfers.mdx
The guide explains merge behavior, timeout outcomes, and human-detection behavior. It adds an API example and notes that each API write replaces the destination list.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to d75dc

This change updates the call transfer guide with warm transfer timeouts, the three connect modes and the option to wait for a person to answer. No runtime behavior changes, so merge risk is minimal.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly identifies the documentation update for warm transfer timeouts and the new waiting behavior. It matches the main changes in the pull request.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.


✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Him188
Him188 merged commit e30ae3b into main Oct 9, 2026
6 checks passed
@Him188
Him188 deleted the him188/warm-transfer-settings branch October 9, 2026 19:47

This branch was successfully deployed

1 active deployment
staging — aa2eccb5 Deployed Oct 9, 2026 by mintlify[bot]
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.

1 participant