docs: add a live-validated Calls SDK example and troubleshooting - #59
Merged
Merged
Conversation
Collaborator
Author
|
Publication is verified: the runnable Python example is linked from Quickstart, and the troubleshooting table is available in Errors. PR #61 repaired the deployment-list pagination check, and the production deployment passed. This supplies the published documentation tracked by CALLE-AI/awesome-phone-call-agents#407. |
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.
Summary
Add a runnable Python Calls example that saves the original request before submission and the returned Call ID before polling.
startrequires a new private run directory;resumeretrieves the saved call without submitting another create request. Missing create responses stop with recovery guidance. Quickstart links the official testing hotline and explains setup, costs, saved data, and result interpretation. Errors adds a provider/configuration/billing troubleshooting table.The region-table reader accepts both published fifth-column names (
Default LineandLine Region) and preserves the source wording. Other shape and content validation remains in place.Refs CALLE-AI/awesome-phone-call-agents#407. The separate sandbox capability request is tracked in CALLE-AI/awesome-phone-call-agents#627.
API contract
Not changed. Uses the published
calle-ai==0.7.0SDK and existing Calls recovery contract. No package release or changeset.Validation
python examples/calls.py start <private-run-directory> --phone <authorized-test-hotline>locally with Python 3.12 andcalle-ai==0.7.0against the real service. One attempt connected at 08:51:04 UTC and ended at 08:51:14 UTC. The command returned zero withstatus: completed,task_completed: true, andheard_greeting: yes. The greeting summary matched both callee transcript turns.python examples/calls.py resume <same-directory>in a separate process. It returned zero and retrieved the same saved Call ID and terminal result. Call data, destination, and credentials are excluded from the PR.python -m unittest discover -s examples -vpassed. Supplemental cases cover a rejected create, non-JSON gateway response, polling timeout after saving the ID, repeated-start refusal, resume without another POST, and a null structured result on a terminal failed call.pnpm run validatepassed: typecheck, production build using the current upstream region source, static artifact checks, 11 deployment tests, and all 22 browser tests. Both new guide sections were visually checked.git diff --checkpassed.This verifies the SDK call-to-result flow against the official test recipient. Webhook delivery, live quota/provider failures, business workflows, and sandbox determinism or free calling were not tested.
Checklist
pnpm run validate.