# Orbit Documentation ## Docs - [001 anthropic only llm with openai carveouts](https://docs.orbit.devotel.io/adr/001-anthropic-only-llm-with-openai-carveouts.md) - [002 devotel softswitch sole outbound egress](https://docs.orbit.devotel.io/adr/002-devotel-softswitch-sole-outbound-egress.md) - [003 orbit media self hosted sfu](https://docs.orbit.devotel.io/adr/003-orbit-media-self-hosted-sfu.md) - [004 pay as you go no tiers](https://docs.orbit.devotel.io/adr/004-pay-as-you-go-no-tiers.md) - [005 byo embedded signup channels](https://docs.orbit.devotel.io/adr/005-byo-embedded-signup-channels.md) - [006 push and web chat always free](https://docs.orbit.devotel.io/adr/006-push-and-web-chat-always-free.md) - [007 single production environment](https://docs.orbit.devotel.io/adr/007-single-production-environment.md) - [008 direct to main workflow](https://docs.orbit.devotel.io/adr/008-direct-to-main-workflow.md) - [009 owner mode](https://docs.orbit.devotel.io/adr/009-owner-mode.md) - [010 e911 block and disclaim](https://docs.orbit.devotel.io/adr/010-e911-block-and-disclaim.md) - [011 compliance opt in default](https://docs.orbit.devotel.io/adr/011-compliance-opt-in-default.md) - [012 single sentry project](https://docs.orbit.devotel.io/adr/012-single-sentry-project.md) - [013 design register modal resend stripe linear vercel](https://docs.orbit.devotel.io/adr/013-design-register-modal-resend-stripe-linear-vercel.md) - [014 playwright banned source audits preferred](https://docs.orbit.devotel.io/adr/014-playwright-banned-source-audits-preferred.md) - [015 migration prefix grandfather allowlist](https://docs.orbit.devotel.io/adr/015-migration-prefix-grandfather-allowlist.md) - [Adr](https://docs.orbit.devotel.io/adr/index.md) - [A2A federation](https://docs.orbit.devotel.io/agents/a2a-federation.md): Task remote A2A peer agents and accept inbound tasks from peers — implements the A2A v0.3.0 protocol. - [Agent cost controls](https://docs.orbit.devotel.io/agents/cost-controls.md): Per-run and per-conversation spend caps, token limits, and tool-iteration ceilings for AI agents. - [Creating Agents](https://docs.orbit.devotel.io/agents/creating-agents.md): Step-by-step guide to building and deploying AI agents on Orbit - [Agent handoff targets](https://docs.orbit.devotel.io/agents/handoff-targets.md): Allowlist which agents an agent can hand a conversation off to. - [Agent Marketplace](https://docs.orbit.devotel.io/agents/marketplace.md): Pre-built AI agent templates you can deploy in minutes - [AI Agents Overview](https://docs.orbit.devotel.io/agents/overview.md): Build autonomous AI agents that handle voice and messaging conversations - [Agents API](https://docs.orbit.devotel.io/api-reference/agents.md): Create, deploy, and chat with AI agents across channels - [AI API](https://docs.orbit.devotel.io/api-reference/ai.md): LLM-backed analysis, translation, suggestion, classification, and content generation. The same primitives that power the Orbit dashboard, exposed for your own apps. - [Analytics API](https://docs.orbit.devotel.io/api-reference/analytics.md): Message analytics, deliverability, scheduled reports, and conversion goals. All reads served from a read-replica. - [Billing API](https://docs.orbit.devotel.io/api-reference/billing.md): Check wallet balance, top up credits, view transactions, and download invoices - [Branding API](https://docs.orbit.devotel.io/api-reference/branding.md): Read effective branding for a host — logo, colors, brand name. Read by the dashboard middleware on every authenticated render. - [Conversations API](https://docs.orbit.devotel.io/api-reference/conversations.md): Omnichannel inbox — list, reply, assign, hand off from AI to human, and manage conversation lifecycle across SMS, WhatsApp, email, RCS, Viber, Instagram, Messenger, and LINE. - [Custom Fields API](https://docs.orbit.devotel.io/api-reference/custom-fields.md): Define typed metadata fields on contacts and set values per contact. Use them in segments, flows, and personalization. - [Email Unsubscribe API](https://docs.orbit.devotel.io/api-reference/email.md): Public List-Unsubscribe one-click handler — referenced by the `List-Unsubscribe` header in outbound email. Customer-facing, HMAC-token authenticated. - [Account API](https://docs.orbit.devotel.io/api-reference/endpoints/account.md): Account endpoints exposed by the Devotel CPaaS API - [Agents API](https://docs.orbit.devotel.io/api-reference/endpoints/agents.md): Create and manage AI agents, invoke conversations, and retrieve interaction history - [AI API](https://docs.orbit.devotel.io/api-reference/endpoints/ai.md): AI endpoints exposed by the Devotel CPaaS API - [Billing API](https://docs.orbit.devotel.io/api-reference/endpoints/billing.md): Check wallet balance, top up credits, view transactions, and access invoices - [Campaigns API](https://docs.orbit.devotel.io/api-reference/endpoints/campaigns.md): Bulk campaign creation, scheduling, and analytics - [CDP API](https://docs.orbit.devotel.io/api-reference/endpoints/cdp.md): CDP endpoints exposed by the Devotel CPaaS API - [Compliance API](https://docs.orbit.devotel.io/api-reference/endpoints/compliance.md): DSAR, consent records, compliance policy configuration - [Contacts API](https://docs.orbit.devotel.io/api-reference/endpoints/contacts.md): Create, update, and manage your contact directory - [Conversations API](https://docs.orbit.devotel.io/api-reference/endpoints/conversations.md): Multi-channel conversation threads and threading state - [CustomFields API](https://docs.orbit.devotel.io/api-reference/endpoints/custom-fields.md): Tenant-defined fields attached to contacts and conversations - [Email Builder API](https://docs.orbit.devotel.io/api-reference/endpoints/email-builder.md): Drag-and-drop email template builder and asset management - [Files API](https://docs.orbit.devotel.io/api-reference/endpoints/files.md): Files endpoints exposed by the Devotel CPaaS API - [Flows API](https://docs.orbit.devotel.io/api-reference/endpoints/flows.md): Create, manage, and monitor automation workflows and their executions - [FrequencyCaps API](https://docs.orbit.devotel.io/api-reference/endpoints/frequency-caps.md): Send-frequency throttling policy per contact / channel - [Inbox API](https://docs.orbit.devotel.io/api-reference/endpoints/inbox.md): Agent inbox triage — assignment, snooze, status, notes - [Messaging API](https://docs.orbit.devotel.io/api-reference/endpoints/messaging.md): Send and manage messages across SMS, WhatsApp, RCS, Viber, and Email channels - [Numbers API](https://docs.orbit.devotel.io/api-reference/endpoints/numbers.md): Numbers endpoints exposed by the Devotel CPaaS API - [Proxy API](https://docs.orbit.devotel.io/api-reference/endpoints/proxy.md): Anonymous proxy phone numbers connecting two endpoints - [Push API](https://docs.orbit.devotel.io/api-reference/endpoints/push.md): Mobile push notification delivery and device registration - [Settings API](https://docs.orbit.devotel.io/api-reference/endpoints/settings.md): Workspace settings, API keys, and team membership - [Surveys API](https://docs.orbit.devotel.io/api-reference/endpoints/surveys.md): Survey campaign management and response collection - [Teams API](https://docs.orbit.devotel.io/api-reference/endpoints/teams.md): Teams endpoints exposed by the Devotel CPaaS API - [Verify API](https://docs.orbit.devotel.io/api-reference/endpoints/verify.md): Send and check OTP verification codes via SMS, WhatsApp, or Email - [Verify Passkey API](https://docs.orbit.devotel.io/api-reference/endpoints/verify-passkey.md): Verify Passkey endpoints exposed by the Devotel CPaaS API - [Verify Push API](https://docs.orbit.devotel.io/api-reference/endpoints/verify-push.md): Verify Push endpoints exposed by the Devotel CPaaS API - [Voice API](https://docs.orbit.devotel.io/api-reference/endpoints/voice.md): Outbound and inbound voice calling, transcripts, and analytics - [Voice Biometrics API](https://docs.orbit.devotel.io/api-reference/endpoints/voice-biometrics.md): Voice-print enrollment and speaker verification - [Webhooks API](https://docs.orbit.devotel.io/api-reference/endpoints/webhooks.md): Register outbound webhook endpoints with HMAC signing - [WhatsApp Calling API](https://docs.orbit.devotel.io/api-reference/endpoints/whatsapp-calling.md): WhatsApp Business voice/video call capability management - [Error Codes](https://docs.orbit.devotel.io/api-reference/error-codes.md): Quick reference of common Orbit API error codes - [Events API](https://docs.orbit.devotel.io/api-reference/events.md): Read the platform-wide event firehose, or stream events live via Server-Sent Events. - [Fax API](https://docs.orbit.devotel.io/api-reference/fax.md): Send and receive fax via Telnyx-backed fax numbers. Fax sending is also exposed through the unified Messaging API. - [Files API](https://docs.orbit.devotel.io/api-reference/files.md): Upload, list, and delete files used by messages, agents, knowledge bases, and other surfaces. 25 MB upload cap. - [Frequency Caps API](https://docs.orbit.devotel.io/api-reference/frequency-caps.md): Define rolling-window send limits per contact — "no more than 3 SMS per day per contact". Enforced inside the message send pipeline. - [Inbox API](https://docs.orbit.devotel.io/api-reference/inbox.md): Real-time collaboration, saved views, routing rules, internal notes, typing indicators, and macros that power the human side of the unified inbox. - [Integrations API](https://docs.orbit.devotel.io/api-reference/integrations.md): Connect third-party apps via Nango — Salesforce, HubSpot, Shopify, Stripe, and 200+ others. Manage connections, trigger syncs, and read synced data. - [Knowledge Bases API](https://docs.orbit.devotel.io/api-reference/knowledge-bases.md): Document storage + semantic search that powers retrieval-augmented generation for AI agents. - [Short Links API](https://docs.orbit.devotel.io/api-reference/links.md): Create branded short links and read click stats. Public redirects live at `/l/:code` (no API prefix). - [Agent Marketplace API](https://docs.orbit.devotel.io/api-reference/marketplace.md): Browse and install pre-built AI agents from the Orbit marketplace. Admin endpoints to publish your own. - [Message Status Lifecycle](https://docs.orbit.devotel.io/api-reference/messages-status-lifecycle.md): Every status a message row passes through, what each state means, and which transitions are guaranteed by the platform vs. the carrier. - [BYO-SMPP Credentials API](https://docs.orbit.devotel.io/api-reference/messaging-credentials.md): Bring-your-own SMPP — connect your own carrier credentials so Orbit dispatches SMS through your trunk while still handling routing, delivery receipts, and billing. - [Numbers API](https://docs.orbit.devotel.io/api-reference/numbers.md): Search, purchase, release, and configure virtual phone numbers - [Orbit Voice Protocol](https://docs.orbit.devotel.io/api-reference/orbit-voice.md): Bidirectional WebSocket protocol for AI voice agents. Better events, better tool calls, better observability than Twilio ConversationRelay. - [Organization API](https://docs.orbit.devotel.io/api-reference/organization.md): Read your own organization profile and submit / check KYC ("know your customer") status. Single-tenant scoped to the calling org. - [API Overview](https://docs.orbit.devotel.io/api-reference/overview.md): Orbit REST API reference — base URL, authentication, response format, and error handling - [Personalization API](https://docs.orbit.devotel.io/api-reference/personalization.md): Define content slots that the embedded web SDK can fetch and render. The dashboard surface; runtime fetching is via `/sdk/personalize`. - [Number Masking (Proxy) API](https://docs.orbit.devotel.io/api-reference/proxy.md): Connect two parties through a shared masking number — for marketplaces, ride-share, classifieds. Neither side sees the other's real number. - [Push Notifications API](https://docs.orbit.devotel.io/api-reference/push.md): Register mobile device tokens (FCM / APNs) and send push notifications to your end users. - [QR Code API](https://docs.orbit.devotel.io/api-reference/qr.md): Generate QR code images that link to short links, WhatsApp deep links, or pre-filled SMS — for print, in-store, or kiosk use cases. - [RCS API](https://docs.orbit.devotel.io/api-reference/rcs.md): RCS Business Messaging brand registration, agents (bots), test devices, templates, and tester invites. Sending messages goes through the unified Messaging API. - [Referrals API](https://docs.orbit.devotel.io/api-reference/referrals.md): Referral programs Orbit customers run for **their own** end-users — issue codes, track conversions, run a leaderboard, pay out rewards. - [Embedded Web SDK API](https://docs.orbit.devotel.io/api-reference/sdk.md): Public web-SDK endpoints (/sdk/*) — identify, track, personalize. Authenticated by tenant public key (pk_*); deliberately outside /api/v1 so customer embeds don't version-pin. - [Settings API](https://docs.orbit.devotel.io/api-reference/settings.md): Org settings, user preferences, team management, API keys, sender IDs, and notification rules. - [SIP Credentials API](https://docs.orbit.devotel.io/api-reference/sip-credentials.md): Issue SIP REGISTER credentials for softphones (Linphone, Zoiper, Bria) and desk phones to connect to the Orbit voice plane. - [Subaccounts API](https://docs.orbit.devotel.io/api-reference/subaccounts.md): Parent-org control plane: create child orgs, transfer credits, manage their API keys, branding, custom domains, pricing overrides, and MCCMNC routing. - [Verify API](https://docs.orbit.devotel.io/api-reference/verify.md): OTP send + check across SMS, voice, email, and WhatsApp. Multi-channel verify with profile-based defaults. - [Verify — Get Verification Detail](https://docs.orbit.devotel.io/api-reference/verify-detail.md): Consolidated detail endpoint for the verification request drawer — channel attempts, fallback chain, code-attempt log - [Video API](https://docs.orbit.devotel.io/api-reference/video.md): Orbit Media-backed video rooms — schedule, join, record, end meetings, and issue per-participant access tokens - [Voice API](https://docs.orbit.devotel.io/api-reference/voice.md): Manage calls, SIP trunks, IVR flows, conferences, and voicemail - [WhatsApp API](https://docs.orbit.devotel.io/api-reference/whatsapp.md): Manage WhatsApp Business connections, business profile, catalogs, contacts, calls, and block lists. Sending messages goes through the unified Messaging API. - [Authentication](https://docs.orbit.devotel.io/authentication.md): API authentication methods - [Cryptocurrency payments](https://docs.orbit.devotel.io/billing/crypto-payments.md): Top up your Orbit wallet with Bitcoin, USDT, Ethereum, and other supported coins via NOWPayments. - [Crypto refunds — operator runbook](https://docs.orbit.devotel.io/billing/crypto-refunds.md): How to process a NOWPayments crypto refund from the admin dashboard. - [Changelog](https://docs.orbit.devotel.io/changelog.md): Release history and version notes for the Orbit API - [Analytics](https://docs.orbit.devotel.io/channels/analytics.md): Cross-channel delivery, engagement, and cost analytics via the Orbit Analytics API - [Email](https://docs.orbit.devotel.io/channels/email.md): Send transactional and marketing emails through the Orbit API - [Fax](https://docs.orbit.devotel.io/channels/fax.md): Send and receive faxes over the Orbit Fax API - [Instagram](https://docs.orbit.devotel.io/channels/instagram.md): Send and receive Instagram Direct Messages via the Orbit Messaging API - [Messenger](https://docs.orbit.devotel.io/channels/messenger.md): Send and receive Facebook Messenger conversations via the Orbit Messaging API - [Push Notifications](https://docs.orbit.devotel.io/channels/push.md): Send mobile + web push notifications via Orbit - [RCS](https://docs.orbit.devotel.io/channels/rcs.md): Send rich messaging experiences with RCS Business Messaging through Orbit - [SMS](https://docs.orbit.devotel.io/channels/sms.md): Send and receive SMS messages globally via the Orbit API - [Telegram](https://docs.orbit.devotel.io/channels/telegram.md): Send and receive Telegram bot messages via the Orbit Messaging API - [Viber](https://docs.orbit.devotel.io/channels/viber.md): Send Viber messages via two tiers — basic SMPP termination or full Viber Business HTTP API - [Voice](https://docs.orbit.devotel.io/channels/voice.md): Programmable voice calls, SIP trunking, and AI-powered voice agents - [WhatsApp](https://docs.orbit.devotel.io/channels/whatsapp.md): Send messages via the WhatsApp Business API through Orbit - [HIPAA Compliance](https://docs.orbit.devotel.io/compliance/hipaa.md): Devotel's HIPAA readiness controls for protecting healthcare communications - [PCI DSS Compliance](https://docs.orbit.devotel.io/compliance/pci-dss.md): How Orbit handles payment data — honest, lawyer-safe summary of Devotel's PCI DSS posture so you can answer the question in client meetings. - [Call Recording Consent](https://docs.orbit.devotel.io/compliance/recording-consent.md): Per-jurisdiction guidance for lawful call recording, and how Orbit enforces consent announcements on inbound and outbound voice - [SOC 2 Controls Mapping](https://docs.orbit.devotel.io/compliance/soc2-controls.md): Mapping of Devotel's technical controls to SOC 2 Trust Services Criteria - [WhatsApp Restricted & Prohibited Content Policy](https://docs.orbit.devotel.io/compliance/whatsapp-content-policy.md): Plain-language guide to what you can and cannot send on WhatsApp through Orbit. Aligned to Meta Commerce & Business Messaging policies. - [Transport architecture](https://docs.orbit.devotel.io/concepts/transport-architecture.md): How Orbit chooses between Orbit Media (SFU) and the WebSocket bridge for real-time audio and video sessions - [Flow Builder](https://docs.orbit.devotel.io/flows/builder.md): How to use the Orbit visual flow builder to create communication workflows - [Flow Executions](https://docs.orbit.devotel.io/flows/executions.md): Inspect, replay, and debug Orbit Flow runs via the Executions API - [Flows Overview](https://docs.orbit.devotel.io/flows/overview.md): Visual workflow builder for communication automation - [10DLC Registration](https://docs.orbit.devotel.io/guides/10dlc-registration.md): Register for US 10-Digit Long Code (10DLC) messaging compliance - [AI Voice Agents via sip_forward (callers.ai, Retell, Vapi)](https://docs.orbit.devotel.io/guides/ai-voice-agent-sip-forward.md): Route inbound calls from your Orbit numbers to a third-party AI voice agent over SIP. - [API Integration](https://docs.orbit.devotel.io/guides/api-integration.md): Everything you need to integrate with Orbit — REST API, webhooks, sandbox, rate limits, error codes, and Postman collections across every channel. - [Per-API-key IP allowlist](https://docs.orbit.devotel.io/guides/api-key-ip-allowlist.md): Restrict an API key to a specific set of source IP addresses or CIDR ranges. - [Messaging Best Practices](https://docs.orbit.devotel.io/guides/best-practices.md): Optimize deliverability, compliance, and user experience across all channels - [Email attachments](https://docs.orbit.devotel.io/guides/email-attachments.md): Attach files to outbound emails — limits, MIME allowlist, and SDK samples in every language. - [Connect Orbit to Claude and Cursor via MCP](https://docs.orbit.devotel.io/guides/mcp-claude-cursor.md): Use the Orbit MCP server to send SMS, make calls, trigger campaigns, and query your CPaaS data directly from Claude Desktop, Claude Code, or Cursor — no UI required. - [Migration from Twilio](https://docs.orbit.devotel.io/guides/migration-from-twilio.md): Step-by-step guide to migrate your Twilio integration to Orbit - [Cursor-Based Pagination](https://docs.orbit.devotel.io/guides/pagination.md): Navigate large result sets using cursor-based pagination - [Public consent form](https://docs.orbit.devotel.io/guides/public-consent-form.md): Host a public unsubscribe / preferences page on Orbit so recipients can manage channel consent without contacting support. - [Quick-action deep links](https://docs.orbit.devotel.io/guides/quick-action-deep-links.md): Open a pre-filled compose dialog on any channel page from a URL. - [Rate Limits](https://docs.orbit.devotel.io/guides/rate-limits.md): Understand Orbit API rate limits per endpoint and how to handle 429 errors - [Security Best Practices](https://docs.orbit.devotel.io/guides/security.md): API key management, webhook verification, and security hardening for Orbit integrations - [Verify integration without our SDK](https://docs.orbit.devotel.io/guides/verify-no-sdk.md): Add OTP verification to any app using plain HTTP — no Orbit SDK required. - [WhatsApp 24h freeform window](https://docs.orbit.devotel.io/guides/whatsapp/24h-window.md): Meta's 24-hour customer-care window — what it allows, how to check it, and how the platform pre-flights every send. - [WhatsApp Business Calling](https://docs.orbit.devotel.io/guides/whatsapp/business-calling.md): Voice calls between your business and WhatsApp users — provisioning, permissions, billing, and lifecycle webhooks. - [WhatsApp Pricing](https://docs.orbit.devotel.io/guides/whatsapp/pricing.md): How WhatsApp conversations are priced — Meta bills you directly; Devotel is a Tech Provider and is free to use. - [BSP Transfer / Number Porting](https://docs.orbit.devotel.io/guides/whatsapp/waba-migration.md): Move your existing WhatsApp Business Account from Infobip, Twilio, Vonage, MessageBird, or any other BSP to Orbit without losing your number, templates, or quality rating. - [WhatsApp Business Account (WABA) Setup](https://docs.orbit.devotel.io/guides/whatsapp/waba-setup.md): Full step-by-step for getting a verified WABA connected to Orbit — from Meta Business Manager to your first approved template. - [Introduction](https://docs.orbit.devotel.io/introduction.md): Welcome to the Orbit by Devotel developer documentation - [Open source attribution](https://docs.orbit.devotel.io/legal/attribution.md): Required notices for the open source software Orbit by Devotel uses or redistributes - [Phone Numbers](https://docs.orbit.devotel.io/numbers/overview.md): Search, purchase, and manage virtual phone numbers through Orbit - [Quickstart](https://docs.orbit.devotel.io/quickstart.md): Send your first message in under 5 minutes - [Error Code Reference](https://docs.orbit.devotel.io/reference/error-codes.md): Complete reference of every Orbit API error code, generated from the platform's canonical `ERROR_CODES` enum. - [Frequently Asked Questions](https://docs.orbit.devotel.io/reference/faq.md): Common questions about the Orbit API and platform - [Glossary](https://docs.orbit.devotel.io/reference/glossary.md): Agentic CCC and Orbit terminology explained - [Programmable Voice DSL Reference](https://docs.orbit.devotel.io/reference/programmable-voice-dsl.md): Verb contract for the JSON your answer_url returns to control an inbound call - [Webhook Events Reference](https://docs.orbit.devotel.io/reference/webhook-events.md): Payload shape for every webhook event Orbit dispatches - [Sandbox Magic Numbers](https://docs.orbit.devotel.io/sandbox/magic-numbers.md): Recipient-suffix mapping that drives 10 delivery states in Orbit sandbox mode - [SDKs](https://docs.orbit.devotel.io/sdks/index.md): Orbit by Devotel SDKs — 2 in active development (Node, Web), 6 on roadmap. - [Node.js SDK](https://docs.orbit.devotel.io/sdks/node.md): Official Devotel Node.js/TypeScript SDK quickstart - [Web SDK](https://docs.orbit.devotel.io/sdks/web.md): Embed Orbit messaging, AI agents, and live softphone into your web app - [Verify](https://docs.orbit.devotel.io/verify/overview.md): OTP verification service for phone and email authentication - [Dialer Dispositions](https://docs.orbit.devotel.io/voice/dialer-dispositions.md): Outbound dialer disposition matrix — how agent-submitted dispositions route the contact's lifecycle status - [Emergency Calling (911 / 112 / 999 / 000)](https://docs.orbit.devotel.io/voice/emergency-calling.md): Why Orbit blocks emergency short codes and how to handle the block in your application - [IVR Intents](https://docs.orbit.devotel.io/voice/ivr-intents.md): Conversational NLU intent buckets that route inbound voice callers to ACD queues or AI agents - [Voice Quickstart](https://docs.orbit.devotel.io/voice/quickstart.md): Make your first AI voice call in under 5 minutes - [Webhook Event Payloads](https://docs.orbit.devotel.io/webhooks/event-payloads.md): Anatomy of an Orbit webhook delivery — envelope, headers, captured request/response metadata - [Webhook Events](https://docs.orbit.devotel.io/webhooks/events.md): Canonical catalog of every webhook event Orbit dispatches, generated from the platform constant. - [Webhooks Overview](https://docs.orbit.devotel.io/webhooks/overview.md): Receive real-time event notifications from Orbit via webhooks - [Webhook Security](https://docs.orbit.devotel.io/webhooks/security.md): Verify Orbit webhook signatures with HMAC-SHA256 ## OpenAPI Specs - [openapi](https://docs.orbit.devotel.io/openapi.yaml)