Skip to content

docs(voice): add machine detection guide - #693

Open
Devon-White wants to merge 1 commit into
mainfrom
Devon/machine-detection-guide
Open

Devon-White wants to merge 1 commit into
mainfrom
Devon/machine-detection-guide

Conversation

@Devon-White

Copy link
Copy Markdown
Collaborator

Summary

Adds a platform how-to for detecting a person, answering machine, or fax machine on outbound and inbound calls, following the structure and tone of #660 (outbound calling guide).

  • New guide: fern/products/platform/pages/calling/voice/machine-detection.mdx (/docs/platform/voice/machine-detection)
  • Covers SWML detect_machine inline in a REST dial, the REST calling.detect command, and Relay detect/detectAnsweringMachine/detectFax in Python and TypeScript
  • Examples: leave a message after the beep, hand a live answer to an AI agent, send/receive a fax, detect on a call already in progress, screen inbound calls, and a tuning table
  • Themed flow diagram (SVG + llms-only mermaid equivalent)
  • Voice overview: new "Detect voicemail and fax machines" card, and a fix to the stale AMD FAQ link (/docs/swml/reference/detect-machine/docs/swml/reference/calling/detect-machine, "Realtime SDK" → "Server SDKs")
  • llms.txt: repoints the "Answering machine detection" bullet to the new guide

Notes for reviewers

  • Based on main; links to /docs/platform/voice/outbound-calling resolve once docs: add outbound calling guide #660 merges.
  • Every method, parameter, and event field was verified against the shipped signalwire-sdk 3.4.1 and @signalwire/sdk 2.0.5 packages (not just the reference docs), and every SWML builder chain was executed and diffed against the equivalent hand-written JSON/cURL sample.
  • Two upstream doc/SDK inconsistencies were worked around rather than fixed: TypeScript Relay has no detectAnsweringMachine()/detectFax() in 2.0.5 (raw detect() used instead, noted in prose), and detect_message_end defaults differ by surface (false in SWML, true in REST calling.detect) — called out in a differences table.
  • No changelog entry, no nav yml change (folder-driven nav), no redirects.

Verification

  • yarn fern-md-check: all MDX files valid
  • All 39 code blocks (cURL, Python, TypeScript, JSON, YAML) extracted and validated: JSON/YAML parse, bash syntax, Python py_compile/pyflakes/mypy, TypeScript tsc --strict against the installed SDK
  • All internal links and in-page anchors verified against target slug: frontmatter

Preview: /docs/platform/voice/machine-detection and /docs/platform/voice

Adds a platform how-to for detecting a person, answering machine, or
fax machine on outbound and inbound calls, covering SWML detect_machine,
the REST calling.detect command, and Relay detect/detectAnsweringMachine/
detectFax in Python and TypeScript.

- New guide: fern/products/platform/pages/calling/voice/machine-detection.mdx
- Themed flow diagram (SVG + llms-only mermaid)
- Voice overview: new card, fixed stale AMD FAQ link
- llms.txt: repoint the answering machine detection entry
@github-actions

Copy link
Copy Markdown
Contributor

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