docs(agents): outbound calls — guide, API reference, and public spec (FA-227) - #148
Merged
Conversation
…(FA-227) Outbound calls (POST /v1/agent/phone-calls) shipped in platform-api #1355 but were never documented. Adds: - agents/telephony/outbound-calls.mdx: placing calls, request fields, Idempotency-Key retry semantics, dial outcome via webhook or polling, allowed destinations (US/CA/JP, JP trunk-zero normalization, BYO exemption), workspace limits, and the machine-readable reason errors. - api-reference/endpoint/agent/create-phone-call.mdx plus the endpoint in openapi.json (refreshed from prod, with /v1/agent/phone-calls merged from platform-api #1433 pending its deploy; the next spec sync converges). - Cross-links from webhooks, BYO SIP, and the errors reference. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 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. Comment |
Him188
added a commit
that referenced
this pull request
Aug 18, 2026
The FA-227 outbound-calls merge (#148) wrote the spec via Python's json.dump, which escapes non-ASCII (— etc.); the check-openapi CI diff is textual, so it stayed red against prod. Re-running scripts/update-openapi.mjs restores the canonical byte-for-byte output — no semantic change, and /v1/agent/phone-calls is now served by prod (platform-api #1433). Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Documents outbound phone calls (FA-227), live since platform-api #1355 but absent from the docs because the endpoint was missing from the public OpenAPI spec (fixed in platform-api #1433).
agents/telephony/outbound-calls: placing a call, request fields (dynamic_variables,overrides,metadata), Idempotency-Key retry semantics, the dial outcome (phone_call.dial_finishedwebhook or pollingdial_status/answered_by), ringing-never-billed, allowed destinations (US/CA/JP, JP trunk-zero normalization, premium blocked, BYO trunks exempt from the country allowlist), workspace limits (200/day, 10 concurrent), and the machine-readablereasonerror table. All facts verified againsttelephony/outbound.pyandtelephony/destinations.py.create-phone-callendpoint page;openapi.jsonrefreshed from prod with/v1/agent/phone-callsmerged in from the same generator (platform-api #1433 — once that deploys, the normalnpm run update:openapisync converges on this exact content).Test plan
mint openapi-check api-reference/openapi.jsonpassesmint broken-links: no broken links outside the pre-existingtemp/template leftoversmint dev; guide and endpoint pages verified🤖 Generated with Claude Code
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.