Integrate Telnyx SIP trunking with third-party PBX systems, softphones, and communications platforms using these Bring Your Own Carrier guides.
The following Bring Your Own Carrier Guides will help you to integrate your Telnyx telephony system to your favorite communications application or platform.While we try our best to keep our guides up-to-date, there are a large number of versions, variations, add-ons, and options for many of these applications and so the settings described or shown in these guides may be slightly different to the current versions of whatever platform you are using. As such, these documents are intended as general guidelines.
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Telnyx","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","colors":{"primary":"#00B688","light":"#00B688","dark":"#00B688"},"logo":{"light":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=5ee3f61d11ba90a197dd9a1e3499fab6","dark":"https://mintcdn.com/telnyx/v2FpkbJg6PQ53qHU/assets/images/site/logo-dark.svg?fit=max\u0026auto=format\u0026n=v2FpkbJg6PQ53qHU\u0026q=85\u0026s=d65aaa12ec708c79e5833cbdea958055"},"favicon":"https://mintcdn.com/telnyx/t-qaBUa_gCxdRz_m/favicon.ico?fit=max\u0026auto=format\u0026n=t-qaBUa_gCxdRz_m\u0026q=85\u0026s=8291283238ab8c0e2a7a985e69f38c2f","background":{"decoration":"gradient"},"navbar":{"links":[{"icon":"triangle-exclamation","href":"/docs/development/api-fundamentals/api-errors","label":"Error codes"},{"icon":"headset","href":"https://telnyx.com/contact-us","label":"Contact us"},{"icon":"user","href":"https://portal.telnyx.com/#/login/sign-in","label":"Login"}],"primary":{"type":"button","label":"Sign Up","href":"https://telnyx.com/sign-up"}},"footer":{"socials":{"github":"https://github.com/team-telnyx","linkedin":"https://www.linkedin.com/company/telnyx","slack":"https://joinslack.telnyx.com","x":"https://x.com/telnyx"},"links":[{"header":"Resources","items":[{"label":"Pricing","href":"https://developers.telnyx.com/internal/pages/pricing"},{"label":"Compare Telnyx","href":"https://developers.telnyx.com/internal/pages/compare"},{"label":"Support center","href":"https://support.telnyx.com/en"},{"label":"SETI","href":"https://seti.telnyx.com"},{"label":"Agent platform configs","href":"https://github.com/team-telnyx/ai"},{"label":"About Telnyx","href":"https://developers.telnyx.com/internal/pages/about"},{"label":"Service status","href":"https://status.telnyx.com"}]},{"header":"Updates","items":[{"label":"Release notes","href":"https://telnyx.com/release-notes"}]},{"header":"Community","items":[{"label":"Low Latency Club","href":"https://lowlatencyclub.ai/"}]},{"header":"Legal","items":[{"label":"Privacy policy","href":"https://telnyx.com/privacy-policy"},{"label":"Terms and conditions","href":"https://telnyx.com/terms-and-conditions"}]}]},"seo":{"metatags":{"og:description":"Infrastructure for real-time agents. Voice, AI, Edge Compute","description":"Infrastructure for real-time agents. Voice, AI, Edge Compute"},"organization":{"name":"Telnyx","url":"https://telnyx.com","logo":"https://telnyx.com/favicon.ico","sameAs":["https://x.com/telnyx","https://www.linkedin.com/company/telnyx/","https://github.com/team-telnyx"]}},"fonts":{"heading":{"family":"PP Formula","weight":800,"source":"assets/fonts/PPFormula-Extrabold.woff2","format":"woff2"},"body":{"family":"Inter","weight":400,"source":"assets/fonts/Inter-Regular.woff2","format":"woff2"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"integrations":{"gtm":{"tagId":"GTM-NRRX236"}},"banner":{"content":"Check out our upcoming events and meetups! [View events →](https://lowlatencyclub.ai/)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"telnyx","hasAudioNarration":false,"actualSubdomain":"telnyx","customDomains":["developers.telnyx.com"],"gitSource":{"type":"github","owner":"team-telnyx","repo":"developer-docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb280bfcff05cc64737a96","collectionId":"f5f4f12b-4ac8-4a59-9d43-f06315a6d8bb","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb280bfcff05cc64737a96"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aeb2a93245c712a705a4fa6","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Calling","count":592},{"language":"default","tag":"API Reference","count":552},{"language":"default","tag":"Other APIs","count":406},{"language":"default","tag":"AI","count":382},{"language":"default","tag":"Messaging","count":353},{"language":"default","tag":"Numbers","count":287},{"language":"default","tag":"Agent Platform","count":220},{"language":"default","tag":"Assistants","count":202},{"language":"default","tag":"Voice API","count":178},{"language":"default","tag":"SMS \u0026 MMS","count":149}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"[class*=sidebar] [class*=badge],[class*=sidebar] [class*=tag],nav [class*=badge],nav [class*=tag]{font-size:.8rem!important}#ot-sdk-btn-floating{left:auto!important;right:10px!important}body:has([aria-label=\"Preview Widget\"]) #ot-sdk-btn-floating{bottom:88px!important}#navbar .nav-tabs-item:has(>div>svg[style*=\"/book-open.svg\"]),#navbar div:has(>div>.nav-tabs>a.nav-tabs-item:first-child:last-child){display:none}.nav-tabs a.nav-tabs-item:not([aria-current=location]){display:none}#mobile-nav #navigation-items>div:has(>div>button[aria-haspopup=menu]),#mobile-nav [data-component-part=products-selector-trigger],#mobile-nav.tx-has-directory #navigation-items{display:none!important}#mobile-nav .tx-mobile-directory{padding:0;margin-bottom:1.5rem}#mobile-nav .tx-mobile-directory .tx-dir-suite-head,#mobile-nav .tx-mobile-directory a{min-height:2.75rem}#mobile-nav .tx-mobile-directory :is(a, .tx-dir-suite-head):focus-visible{outline:2px solid currentColor;outline-offset:-2px}.txd-shell{display:flex;gap:0;max-width:none;margin:0;padding:3rem 2rem 6rem 0}.txd-side{width:18rem;flex-shrink:0}.txd-main{flex:1;min-width:0;max-width:56rem;margin-left:11.75rem}@media (max-width:80rem){.txd-main{margin-left:4rem}}:is(#tx-directory, .tx-mobile-directory){margin:0 0 .5rem;padding:0 .5rem 0 1rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label{font-size:.72rem;font-weight:600;letter-spacing:.06em;text-transform:uppercase;opacity:.55;margin:0 0 .4rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-label-gap{margin-top:1.5rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link,:is(#tx-directory, .tx-mobile-directory) summary{display:flex;align-items:center;cursor:pointer;font-size:.875rem;line-height:1.25rem;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81);text-decoration:none}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link,html.dark :is(#tx-directory, .tx-mobile-directory) summary{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,:is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#00b688;background:0 0;box-shadow:none;font-weight:400;text-shadow:-.2px 0 0 currentColor,.2px 0 0 currentColor}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link:hover,html.dark :is(#tx-directory, .tx-mobile-directory) summary:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-link[aria-current=page]{color:#5eead4;background:0 0;box-shadow:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-soon:hover{cursor:default;opacity:.45;background:0 0;color:inherit}:is(#tx-directory, .tx-mobile-directory) .tx-dir-soon sup{font-size:.6rem;line-height:1;letter-spacing:.05em;text-transform:uppercase;margin-left:.4rem;vertical-align:super}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite{margin-bottom:.15rem}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head{display:flex;align-items:center;cursor:pointer;user-select:none;font-size:.875rem;line-height:1.25rem;font-weight:500;padding:.35rem .5rem;border-radius:.375rem;color:rgb(55 65 81)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a{color:rgb(156 163 175)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,:is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(17 24 39);background:rgb(0 0 0/.04)}html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head:hover,html.dark :is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head,html.dark :is(#tx-directory, .tx-mobile-directory) li a:hover{color:rgb(229 231 235);background:rgb(255 255 255/.06)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite-head::after{content:'';width:.42rem;height:.42rem;margin-left:auto;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(-45deg);transition:transform .15s;flex-shrink:0;opacity:.7}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head::after{transform:rotate(45deg)}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head{color:rgb(17 24 39);background:rgb(0 0 0/.04);font-weight:600}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite>ul{display:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-suite.open>ul{display:block}:is(#tx-directory, .tx-mobile-directory) ul{margin:.15rem 0 .5rem;padding:0}:is(#tx-directory, .tx-mobile-directory) li{list-style:none}:is(#tx-directory, .tx-mobile-directory) li a{display:flex;align-items:center;font-size:.875rem;line-height:1.25rem;padding:.3rem .5rem .3rem 1.6rem;border-radius:.375rem;color:rgb(107 114 128);text-decoration:none}:is(#tx-directory, .tx-mobile-directory) .tx-dir-section-item{font-weight:500}:is(#tx-directory, .tx-mobile-directory) .tx-dir-icon{display:inline-block;width:1rem;height:1rem;flex-shrink:0;margin-right:.5rem;background-color:currentColor;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-position:center;mask-position:center;-webkit-mask-size:contain;mask-size:contain}.txi-arrows-left-right-to-line{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/arrows-left-right-to-line.svg)}.txi-bolt{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/bolt.svg)}.txi-brain{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain.svg)}.txi-brain-circuit{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/brain-circuit.svg)}.txi-brands-whatsapp{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/brands/whatsapp.svg)}.txi-broadcast-tower{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/broadcast-tower.svg)}.txi-browser{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/browser.svg)}.txi-circle-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/circle-nodes.svg)}.txi-clone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/clone.svg)}.txi-cloud{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cloud.svg)}.txi-code{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/code.svg)}.txi-comment-sms{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/comment-sms.svg)}.txi-cubes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/cubes.svg)}.txi-database{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/database.svg)}.txi-envelope{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/envelope.svg)}.txi-eye{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/eye.svg)}.txi-file-certificate{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/file-certificate.svg)}.txi-fingerprint{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/fingerprint.svg)}.txi-folder-tree{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/folder-tree.svg)}.txi-globe{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/globe.svg)}.txi-hard-drive{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hard-drive.svg)}.txi-hashtag{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/hashtag.svg)}.txi-headset{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/headset.svg)}.txi-key{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/key.svg)}.txi-layer-group{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/layer-group.svg)}.txi-magnifying-glass{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/magnifying-glass.svg)}.txi-message{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message.svg)}.txi-message-dots{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/message-dots.svg)}.txi-microchip-ai{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microchip-ai.svg)}.txi-microphone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/microphone.svg)}.txi-network-wired{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/network-wired.svg)}.txi-phone{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone.svg)}.txi-phone-volume{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/phone-volume.svg)}.txi-plug{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/plug.svg)}.txi-right-left{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/right-left.svg)}.txi-robot{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/robot.svg)}.txi-server{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/server.svg)}.txi-share-nodes{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/share-nodes.svg)}.txi-shield{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield.svg)}.txi-shield-check{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/shield-check.svg)}.txi-signal{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/signal.svg)}.txi-sim-card{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/sim-card.svg)}.txi-split{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/split.svg)}.txi-table{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/table.svg)}.txi-tower-control{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/tower-control.svg)}.txi-train-tunnel{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/train-tunnel.svg)}.txi-video{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/video.svg)}.txi-wand-magic-sparkles{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/wand-magic-sparkles.svg)}.txi-waveform{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform.svg)}.txi-waveform-lines{-webkit-mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg);mask-image:url(https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/waveform-lines.svg)}.txd-main .txd-h1{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:2.1rem;font-weight:500;letter-spacing:-.01em;margin:1.2rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h1{color:rgb(229 231 235)}.txd-main .txd-lead{font-size:1.3rem;line-height:1.55;font-weight:500;margin:.9rem 0 1.3rem;color:rgb(31 41 55)}html.dark .txd-main .txd-lead{color:rgb(209 213 219)}.txd-main .txd-h2{font-family:var(--font-family-headings-custom, \"PP Formula\"),-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-size:1.45rem;font-weight:500;margin:2.4rem 0 .4rem;color:rgb(22 28 26)}html.dark .txd-main .txd-h2{color:rgb(229 231 235)}.txd-main .txd-section-h{font-size:1.05rem;font-weight:600;margin:1.8rem 0 .2rem;opacity:.85}.txd-main .txd-p{margin:.7rem 0 1rem;line-height:1.65;color:rgb(75 85 99)}html.dark .txd-main .txd-p{color:rgb(156 163 175)}.txd-main .txd-follow-up a:hover,.txd-main .txd-p a{text-decoration:underline}.txd-main .txd-h1{max-width:46rem;line-height:1.12}.txd-main .txd-hero-copy{max-width:45rem}.txd-main .txd-follow-up{margin-top:1rem}.txd-main .txd-follow-up a{color:#00b688;font-weight:600;text-decoration:none}.txd-main a:focus-visible{outline:2px solid #00b688;outline-offset:3px}@media (max-width:48rem){.txd-main .txd-h1{font-size:1.9rem}}@media (min-width:64.01rem) and (max-width:90rem){.txd-main{margin-right:4rem}}.rm-explorer{--rm-border:rgb(15 23 42 / 14%);--rm-muted:#5f6b68;--rm-soft:#f6f8f7}.dark .rm-explorer{--rm-border:rgb(255 255 255 / 14%);--rm-muted:#a2aaa8;--rm-soft:#151a19}#resource-map-toolbar{position:sticky;top:5rem;z-index:20;margin:1.25rem 0 1.75rem;padding:.75rem 0;background:var(--rm-surface, #fff);border-bottom:1px solid var(--rm-border)}.dark #resource-map-toolbar{background:#0b0e0d}.rm-controls{display:grid;grid-template-columns:minmax(15rem,1fr) minmax(10rem,auto) auto;gap:.625rem;align-items:center}.rm-search{position:relative;min-width:0}.rm-search svg{position:absolute;top:50%;left:.75rem;width:1rem;height:1rem;color:var(--rm-muted);fill:none;stroke:currentColor;stroke-width:1.8;transform:translateY(-50%);pointer-events:none}.rm-area-select,.rm-collapse,.rm-search input{min-height:2.5rem;font-size:.875rem}.rm-area-select,.rm-clear,.rm-collapse,.rm-empty button,.rm-search input{color:inherit;background:0 0;border:1px solid var(--rm-border);border-radius:.5rem;font:inherit}.rm-empty button{font-size:.875rem}.rm-search input{width:100%;padding:.58rem 2.6rem .58rem 2.35rem}.rm-search input::placeholder{color:var(--rm-muted);opacity:1}.rm-shortcut{position:absolute;top:50%;right:.65rem;display:grid;width:1.5rem;height:1.5rem;place-items:center;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.35rem;font:inherit;font-size:.72rem;transform:translateY(-50%);pointer-events:none}.rm-area-wrap{position:relative;max-width:13rem}.rm-area-select{width:100%;max-width:13rem;padding:.55rem 2.25rem .55rem .75rem;appearance:none;cursor:pointer}.rm-area-caret{position:absolute;top:50%;right:.85rem;width:.45rem;height:.45rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:translateY(-70%) rotate(45deg);pointer-events:none}.rm-collapse{padding:.5rem .75rem}.rm-clear,.rm-collapse,.rm-empty button{font-weight:650;cursor:pointer}.rm-empty button{padding:.5rem .75rem}.rm-area-select:focus-visible,.rm-clear:focus-visible,.rm-collapse:focus-visible,.rm-empty button:focus-visible,.rm-search input:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-color:#00b688;box-shadow:none!important}.rm-clear:hover,.rm-collapse:hover,.rm-empty button:hover{color:#08785d;background:var(--rm-soft)}.dark .rm-clear:hover,.dark .rm-collapse:hover,.dark .rm-empty button:hover{color:#5eead4}.rm-meta{display:flex;min-height:1.65rem;align-items:center;justify-content:space-between;gap:.75rem;padding:.45rem .15rem 0}.rm-status{color:var(--rm-muted);font-size:.78rem;line-height:1.35}.rm-clear{min-height:1.8rem;padding:.2rem .55rem;border-color:transparent;font-size:.78rem}.rm-empty{display:grid;justify-items:start;gap:.35rem;margin:-.5rem 0 1.75rem;padding:1.1rem 1.2rem;color:var(--rm-muted);background:var(--rm-soft);border:1px solid var(--rm-border);border-radius:.75rem;font-size:.875rem}.rm-empty strong{color:inherit;font-size:.95rem}.rm-empty button{min-height:2.2rem;margin-top:.35rem}.rm-resource-list{display:block!important;margin:0 0 .75rem!important;border-color:var(--rm-border)!important;border-top:0!important;border-radius:0 0 .75rem .75rem!important}.rm-resource-list>details.accordion{margin:0!important;border:0!important;border-radius:0!important}.rm-resource-list>details.accordion+details.accordion{border-top:1px solid var(--rm-border)!important}.rm-resource-list>details.accordion>summary{min-height:3rem;padding:.7rem .9rem!important;border-radius:0!important}.rm-resource-list>details.accordion:first-child>summary{border-radius:0!important}.rm-resource-list>details.accordion:last-child:not([open])>summary{border-radius:0 0 .75rem .75rem!important}.rm-resource-list [data-component-part=accordion-title]{display:flex;min-width:0;align-items:baseline;justify-content:space-between;gap:1rem}.rm-resource-name{min-width:0;overflow-wrap:anywhere;font-weight:650}.rm-method-count{flex:0 0 auto;color:var(--rm-muted);font-size:.75rem;font-weight:500;white-space:nowrap}.rm-resource-list details[open]>summary{background:var(--rm-soft)}.rm-resource-list details[open] [data-component-part=accordion-content]{margin-right:1rem;margin-left:1rem}.rm-resource-list tbody tr.rm-row-match{background:rgb(0 182 136/8%)}.rm-resource-list td:first-child code{white-space:nowrap}.rm-clear[hidden],.rm-collapse[hidden],.rm-empty[hidden],.rm-explorer h2[hidden],.rm-resource-list tbody tr[hidden],.rm-resource-list[hidden]{display:none!important}.rm-explorer h2{position:relative;min-height:3rem;margin:.45rem 0 0!important;scroll-margin-top:10rem;border:1px solid var(--rm-border);border-radius:.75rem}.rm-explorer h2.rm-section-open{border-radius:.75rem .75rem 0 0}.rm-section-toggle{display:grid;width:100%;min-height:3rem;grid-template-columns:minmax(0,1fr) auto auto;align-items:center;gap:.75rem;padding:.6rem .9rem;color:inherit;text-align:left;background:0 0;border:0;cursor:pointer}.rm-section-toggle:focus-visible,.rm-section-toggle:hover{background:var(--rm-soft)}.rm-section-toggle:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-radius:.7rem}.rm-section-name{font-size:1rem;font-weight:700}.rm-section-count{display:grid;min-width:1.65rem;min-height:1.4rem;place-items:center;padding:3px 6px;color:#08785d;background:rgb(0 182 136/10%);border-radius:.35rem;font-size:12px;font-weight:700;line-height:16px;white-space:nowrap}.dark .rm-section-count{color:#5eead4;background:#12302b}.rm-section-caret{width:.5rem;height:.5rem;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(45deg) translateY(-.15rem)}.rm-section-toggle[aria-expanded=true] .rm-section-caret{transform:rotate(225deg) translate(-.1rem,-.05rem)}@media (max-width:767px){#resource-map-toolbar{position:static;top:auto;z-index:auto;margin-top:1rem;padding-top:.6rem}.rm-controls{grid-template-columns:minmax(0,1fr) auto}.rm-search{grid-column:1/-1}.rm-search input{padding-right:.75rem}.rm-resource-list thead,.rm-shortcut{display:none}.rm-area-select,.rm-area-wrap{width:100%;max-width:none}.rm-resource-list [data-component-part=accordion-title]{gap:.65rem}.rm-method-count{font-size:.7rem}.rm-resource-list table,.rm-resource-list tbody{display:block;width:100%;min-width:0!important}.rm-resource-list tbody tr{display:grid;width:100%;grid-template-columns:minmax(0,1fr);gap:.45rem;padding:.75rem 0}.rm-resource-list tbody tr+tr{border-top:1px solid var(--rm-border)}.rm-resource-list tbody td{display:grid;width:100%;min-width:0!important;grid-template-columns:4.5rem minmax(0,1fr);align-items:start;gap:.5rem;padding:0!important;border:0!important}.rm-resource-list tbody td::before{color:var(--rm-muted);font-size:.68rem;font-weight:700;letter-spacing:.04em;text-transform:uppercase}.rm-resource-list tbody td:first-child::before{content:\"Method\"}.rm-resource-list tbody td:last-child::before{content:\"Endpoint\"}.rm-resource-list tbody td a,.rm-resource-list tbody td code{min-width:0;white-space:normal!important;overflow-wrap:anywhere}}@media (prefers-reduced-motion:reduce){.rm-explorer *,.rm-explorer ::after,.rm-explorer ::before{scroll-behavior:auto!important;transition-duration:.01ms!important}}.sdk-launchpad{--sdk-border:#d8e1de;--sdk-panel:#ffffff;margin:1rem 0 1.5rem;padding:1rem;overflow:hidden;color:inherit;background:var(--sdk-panel);border:1px solid var(--sdk-border);border-radius:12px}.dark .sdk-launchpad{--sdk-border:#293431;--sdk-panel:#101513}.sdk-launchpad-kicker{margin:0 0 .25rem!important;color:#08785d;font-size:.68rem;font-weight:800;letter-spacing:.1em}.dark .sdk-launchpad-kicker{color:#5eead4}.sdk-launchpad>h2{margin-top:.25rem}.sdk-launchpad [role=tablist]{display:flex;flex-wrap:wrap;gap:.25rem}.sdk-launchpad [role=tab]{min-width:56px;min-height:44px}.sdk-launchpad [role=tab][aria-selected=true]{color:#08785d!important}.dark .sdk-launchpad [role=tab][aria-selected=true]{color:#5eead4!important}.sdk-launchpad [role=tab]:focus-visible,.sdk-launchpad a:focus-visible,.sdk-launchpad-code:focus-visible{outline:2px solid #08785d;outline-offset:2px}.dark .sdk-launchpad [role=tab]:focus-visible,.dark .sdk-launchpad a:focus-visible,.dark .sdk-launchpad-code:focus-visible{outline-color:#5eead4}.sdk-launchpad-code{max-width:100%;overflow-x:auto;border-radius:.5rem}.sdk-launchpad-code pre{max-width:none;overflow-x:visible!important}.sdk-launchpad-code button{min-width:44px;min-height:44px}#content-area:has(#sdk-launchpad) .chat-assistant-floating-input{display:none}@media (max-width:640px){.sdk-launchpad{margin-top:.75rem;padding:.75rem}.sdk-launchpad-kicker{display:none}.sdk-launchpad [role=tablist]{display:grid;grid-template-columns:repeat(6,minmax(0,1fr));gap:.2rem;overflow:visible}.sdk-launchpad [role=tab]{min-width:0;min-height:44px;padding-inline:.2rem;font-size:.75rem;line-height:1.15;white-space:nowrap}}.sdk-directory li{margin-block:.5rem}.mdx-content table td{min-width:0!important}.mdx-content table td :is(code, a){overflow-wrap:anywhere}.mdx-content table :is(th, td):first-child code{white-space:nowrap;word-break:normal;overflow-wrap:normal}@media (min-width:768px){.tx-table-grid table{table-layout:fixed}.tx-table-grid table :is(th, td):first-child{width:40%}}.tx-retirement-banner{margin-bottom:1.5rem}.tx-retirement-banner>div{margin:0}@media (min-width:1024px){.tx-retirement-banner{position:sticky;top:calc(6rem + var(--banner-height, 0px));z-index:20;padding-top:.5rem;background:rgb(var(--background-light, 255 255 255))}.dark .tx-retirement-banner{background:rgb(var(--background-dark, 9 12 14))}}#content>.callout:first-child{margin-top:0}#content strong{font-weight:600}"}],"page":{"pagePath":"docs/voice/sip-trunking/bring-your-own-carrier","slug":"/docs/voice/sip-trunking/bring-your-own-carrier","pageMetadata":{"type":"page","title":"Deprecated - Bring Your Own Carrier Guides","description":"Integrate Telnyx SIP trunking with third-party PBX systems, softphones, and communications platforms using these Bring Your Own Carrier guides.","sidebarTitle":"Deprecated - Bring Your Own Carrier","href":"/docs/voice/sip-trunking/bring-your-own-carrier/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Integrate Telnyx SIP trunking with third-party PBX systems, softphones, and communications platforms using these Bring Your Own Carrier guides.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The following Bring Your Own Carrier Guides will help you to integrate your Telnyx telephony system to your favorite communications application or platform.`}),`\n`,_jsx(_components.p,{children:`While we try our best to keep our guides up-to-date, there are a large number of versions, variations, add-ons, and options for many of these applications and so the settings described or shown in these guides may be slightly different to the current versions of whatever platform you are using. As such, these documents are intended as general guidelines.`}),`\n`,_jsx(Heading,{level:`2`,id:`bring-your-own-carrier-guide-listing`,children:`Bring Your Own Carrier Guide Listing`}),`\n`,_jsx(`table`,{class:`mint-table`,children:_jsxs(`tbody`,{children:[_jsx(`tr`,{children:_jsx(`td`,{children:`3CX`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Asterix`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`FreePBX`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`FusionPBX`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Genesys Cloud`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Microsoft Teams Direct Routing`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Plivo`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Thirdlane`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Twilio`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Vodia`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`X-Lite`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Yealink`})}),_jsx(`tr`,{children:_jsx(`td`,{children:`Zoiper`})})]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"type":"page","title":"Deprecated - Bring Your Own Carrier Guides","description":"Integrate Telnyx SIP trunking with third-party PBX systems, softphones, and communications platforms using these Bring Your Own Carrier guides.","sidebarTitle":"Deprecated - Bring Your Own Carrier","href":"/docs/voice/sip-trunking/bring-your-own-carrier/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Bring Your Own Carrier Guide Listing","slug":"bring-your-own-carrier-guide-listing","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/telnyx/a2dd5aaa2ff5831a/reading-progress.js","/_mintlify/custom/telnyx/7b77ce9cedb163fd/webmcp-init.js","/_mintlify/custom/telnyx/7fbfee588ac7ad38/structured-data.js","/_mintlify/custom/telnyx/41d9633b1a2dd405/scripts/tests/generate-llms-txt.test.js","/_mintlify/custom/telnyx/8851ad5fd6e9b5c7/scripts/tests/direct-source-workflows.test.js","/_mintlify/custom/telnyx/7ad13bb6588be22f/scripts/tests/redirects.test.js","/_mintlify/custom/telnyx/f981035eb45fcbdb/scripts/tests/generate-error-catalog.test.js","/_mintlify/custom/telnyx/132bc205f55282a5/scripts/tests/sync-llms-automerge.test.js","/_mintlify/custom/telnyx/05e787f15f45952b/scripts/tests/webhook-catalog-lifecycle.test.js","/_mintlify/custom/telnyx/01b840b27496e6c8/scripts/tests/repository-structure.test.js","/_mintlify/custom/telnyx/5ebc7d6e18012563/scripts/tests/legacy-content-usage.test.js","/_mintlify/custom/telnyx/ac1f21e68bf4050a/scripts/docs/check-llms-links.js","/_mintlify/custom/telnyx/5f7d2f1ae375b9ad/scripts/docs/check-llms-native-routes.js","/_mintlify/custom/telnyx/b8d13287c2dcc5b9/scripts/docs/fetch-coverage.js","/_mintlify/custom/telnyx/e0a29f76f2645359/scripts/docs/generate-error-catalog.js","/_mintlify/custom/telnyx/3d8fe29c5f30f1bc/scripts/docs/generate-llms-txt.js","/_mintlify/custom/telnyx/f1f111fe784c3ede/scripts/docs/update-tts-voices.js","/_mintlify/custom/telnyx/c48ad0189f7f1c57/scripts/docs/build-sdk-doc-pages.js","/_mintlify/custom/telnyx/f840117777d76f9e/scripts/tests/sdk-doc-pages.test.js","/_mintlify/custom/telnyx/414c53c50b0e1968/resource-map-filter.js","/_mintlify/custom/telnyx/80af622b3010a712/scripts/tests/sdk-language-switcher.test.js","/_mintlify/custom/telnyx/52fa0fbcb966f8b6/sdk-language-switcher.js","/_mintlify/custom/telnyx/3de33ceedb29f568/home-directory.js","/_mintlify/custom/telnyx/da7a630a1adf8a7a/scripts/generate-home-directory.js","/_mintlify/custom/telnyx/137e3eb8e1d1d85a/scripts/tests/api-fundamentals.test.js","/_mintlify/custom/telnyx/24a8eed3a5010d4c/scripts/tests/agent-sdk-workflow.test.js","/_mintlify/custom/telnyx/abc2169efcd5115c/scripts/tests/homepage-overview.test.js","/_mintlify/custom/telnyx/8edf49ac62deef02/scripts/tests/batch-detail-records-navigation.test.js","/_mintlify/custom/telnyx/e005178572336f01/scripts/tests/api-discoverability.test.js","/_mintlify/custom/telnyx/78cb83896fbea5cf/scripts/tests/home-directory.test.js","/_mintlify/custom/telnyx/11ae45253e6b7be6/scripts/tests/agent-readiness.test.js","/_mintlify/custom/telnyx/82396d5a75077c2a/scripts/tests/sample-workflow-regressions.test.js","/_mintlify/custom/telnyx/5f6625c0420c9328/scripts/tests/openapi-mintlify-parsing.test.js","/_mintlify/custom/telnyx/c7dca602ca9641ec/scripts/tests/llms-markdown-assets.test.js","/_mintlify/custom/telnyx/02d6acd7c86b79f9/scripts/tests/agent-browser-quickstart.test.js"],"dynamicCss":".mint-table {\n display: table\n}","subdomain":"telnyx","siteName":"Telnyx","title":"Deprecated - Bring Your Own Carrier Guides - Telnyx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-14T13:10:52.877Z","originalFileLocation":"docs/voice/sip-trunking/bring-your-own-carrier/index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Integrate Telnyx SIP trunking with third-party PBX systems, softphones, and communications platforms using these Bring Your Own Carrier guides.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Deprecated - Bring Your Own Carrier Guides - Telnyx\">\u003cmeta data-mint-head property=\"og:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Telnyx\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.telnyx.com/docs/voice/sip-trunking/bring-your-own-carrier\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Deprecated+-+Bring+Your+Own+Carrier+Guides\u0026amp;description=Integrate+Telnyx+SIP+trunking+with+third-party+PBX+systems%2C+softphones%2C+and+communications+platforms+using+these+Bring+Your+Own+Carrier+guides.\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=f09677222c73540e423461eee23625d9a124999a6135e0c0628710b4e793d699\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Deprecated - Bring Your Own Carrier Guides - Telnyx\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Infrastructure for real-time agents. Voice, AI, Edge Compute\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://telnyx.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Deprecated+-+Bring+Your+Own+Carrier+Guides\u0026amp;description=Integrate+Telnyx+SIP+trunking+with+third-party+PBX+systems%2C+softphones%2C+and+communications+platforms+using+these+Bring+Your+Own+Carrier+guides.\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=f09677222c73540e423461eee23625d9a124999a6135e0c0628710b4e793d699\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/telnyx/MhCJ9JWG11MInbt6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Telnyx\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B688\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.telnyx.com/docs/voice/sip-trunking/bring-your-own-carrier\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/voice/sip-trunking/bring-your-own-carrier.md\">","siteName":"Telnyx","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"products":[{"product":"Home","icon":"house","groups":[{"group":" ","pages":[{"title":"Telnyx Developer Docs","mode":"custom","href":"/docs/overview"},{"title":"Telnyx API Documentation","sidebarTitle":"API documentation","href":"/internal/pages/api-reference-overview"}]},{"group":"Development","pages":[{"title":"Development","sidebarTitle":"Overview","href":"/docs/development/index"},{"group":"Account setup","pages":[{"group":"Getting Started","pages":[{"title":"Create Your Telnyx Account","sidebarTitle":"Create Account","href":"/docs/account-setup/create-account"},{"title":"Account Signup","sidebarTitle":"Account Signup","href":"/docs/account-setup/signup"},{"title":"Account Levels and Capabilities","sidebarTitle":"Account Levels Overview","href":"/docs/account-setup/levels-and-capabilities/index"}]},{"group":"Account Types \u0026 Capabilities","pages":[{"title":"Pretrial Account Privileges \u0026 Limitations","sidebarTitle":"Pretrial Account","href":"/docs/account-setup/levels-and-capabilities/pretrial"},{"title":"Trial Account Privileges \u0026 Limitations","sidebarTitle":"Trial Account","href":"/docs/account-setup/levels-and-capabilities/trial"},{"title":"Using Your Trial Account","sidebarTitle":"Using Your Trial Account","href":"/docs/account-setup/using-trial-account"},{"title":"Paid Account Privileges \u0026 Limitations","sidebarTitle":"Paid Account","href":"/docs/account-setup/levels-and-capabilities/paid"},{"title":"Verified Account Privileges \u0026 Limitations","sidebarTitle":"Verified Account","href":"/docs/account-setup/levels-and-capabilities/verified"}]},{"group":"Account Management","pages":[{"title":"Account Upgrade","sidebarTitle":"Account Upgrade","href":"/docs/account-setup/account-upgrade"},{"title":"Data Locality","href":"/docs/account-setup/data-locality/index"},{"title":"Regional Endpoints \u0026 the EU PoP","sidebarTitle":"Regional Endpoints \u0026 the EU PoP","href":"/docs/account-setup/regional-endpoints/index"}]}]},{"group":"API fundamentals","pages":[{"title":"API fundamentals","sidebarTitle":"Overview","href":"/docs/development/api-fundamentals/index"},{"group":"Get started","pages":[{"title":"Create and manage API keys","sidebarTitle":"Create API keys","href":"/docs/development/api-fundamentals/create-api-keys/index"},{"title":"Make the first API request","sidebarTitle":"Make the first request","href":"/docs/development/api-fundamentals/first-api-request"}]},{"group":"Build with the API","pages":[{"title":"API authentication","sidebarTitle":"Authentication","href":"/docs/development/api-fundamentals/authentication/index"},{"title":"Requests and responses","sidebarTitle":"Requests and responses","href":"/docs/development/api-fundamentals/request-response/index"},{"title":"Pagination, filtering, and sorting","sidebarTitle":"Pagination and filtering","href":"/docs/development/api-fundamentals/pagination-filtering-sorting"},{"title":"API error catalog","href":"/docs/development/api-fundamentals/api-errors/index"},{"title":"API rate limiting","sidebarTitle":"Rate limiting","href":"/docs/development/api-fundamentals/reliability/rate-limiting"},{"title":"API retries and reliability","sidebarTitle":"Retries and reliability","href":"/docs/development/api-fundamentals/reliability/command-retries"},{"title":"Webhook fundamentals","sidebarTitle":"Webhook fundamentals","href":"/docs/development/api-fundamentals/webhooks/receiving-webhooks"}]},{"group":"Reference","pages":[{"title":"Parameters and field names","sidebarTitle":"Parameters and fields","href":"/docs/development/api-fundamentals/data-standards/parameters-fields"},{"title":"API versions and deprecations","sidebarTitle":"Versions and deprecations","href":"/docs/development/api-fundamentals/api-versions"},{"title":"Other Telnyx interfaces","sidebarTitle":"Other interfaces","href":"/docs/development/api-fundamentals/legacy-apis"}]},{"title":"API troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/development/api-fundamentals/troubleshooting"}]},{"group":"Server-side SDKs","pages":[{"title":"Server-side SDKs","sidebarTitle":"Overview","href":"/docs/development/sdk/index"},{"group":"TypeScript / Node.js","pages":[{"title":"TypeScript and Node.js SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/node/index"},{"title":"TypeScript and Node.js SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/node/requests-and-types"},{"title":"Node.js SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/node/resource-map"},{"title":"Node.js SDK errors, retries, and timeouts","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/node/errors-and-retries"},{"title":"Node.js SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/node/webhooks"},{"title":"Node.js SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/node/advanced"}]},{"group":"Python","pages":[{"title":"Python SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/python/index"},{"title":"Python SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/python/requests-and-types"},{"title":"Python SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/python/resource-map"},{"title":"Python SDK errors, retries, and timeouts","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/python/errors-and-retries"},{"title":"Python SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/python/webhooks"},{"title":"Python SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/python/advanced"}]},{"group":"Go","pages":[{"title":"Go SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/golang/index"},{"title":"Go SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/golang/requests-and-types"},{"title":"Go SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/golang/resource-map"},{"title":"Go SDK errors, retries, and timeouts","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/golang/errors-and-retries"},{"title":"Go SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/golang/webhooks"},{"title":"Go SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/golang/advanced"}]},{"group":"Java","pages":[{"title":"Java SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/java/index"},{"title":"Java SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/java/requests-and-types"},{"title":"Java SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/java/resource-map"},{"title":"Java SDK errors, retries, and timeouts","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/java/errors-and-retries"},{"title":"Java SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/java/webhooks"},{"title":"Java SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/java/advanced"}]},{"group":"Ruby","pages":[{"title":"Ruby SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/ruby/index"},{"title":"Ruby SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/ruby/requests-and-types"},{"title":"Ruby SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/ruby/resource-map"},{"title":"Ruby SDK errors, retries, and timeouts","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/ruby/errors-and-retries"},{"title":"Ruby SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/ruby/webhooks"},{"title":"Ruby SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/ruby/advanced"}]},{"group":"PHP","pages":[{"title":"PHP SDK","sidebarTitle":"Overview and quickstart","href":"/docs/development/sdk/php/index"},{"title":"PHP SDK requests, types, and pagination","sidebarTitle":"Requests, types, and pagination","href":"/docs/development/sdk/php/requests-and-types"},{"title":"PHP SDK resource map","sidebarTitle":"Resource map","href":"/docs/development/sdk/php/resource-map"},{"title":"PHP SDK errors and retries","sidebarTitle":"Errors and retries","href":"/docs/development/sdk/php/errors-and-retries"},{"title":"PHP SDK webhooks","sidebarTitle":"Webhooks","href":"/docs/development/sdk/php/webhooks"},{"title":"PHP SDK advanced usage","sidebarTitle":"Advanced","href":"/docs/development/sdk/php/advanced"}]}]},{"group":"Telnyx CLI","pages":[{"title":"Telnyx CLI","sidebarTitle":"Overview","href":"/docs/development/cli/index"},{"group":"Getting Started","pages":[{"title":"Install the Telnyx CLI","sidebarTitle":"Install","href":"/docs/development/cli/getting-started/install"},{"title":"Telnyx CLI Quickstart","sidebarTitle":"Quickstart","href":"/docs/development/cli/getting-started/quickstart"},{"title":"CLI Authentication","sidebarTitle":"Authentication","href":"/docs/development/cli/getting-started/authentication"}]},{"title":"Scripting \u0026 Automation","sidebarTitle":"Scripting \u0026 Automation","href":"/docs/development/cli/general-usage/index"},{"title":"Command Reference","sidebarTitle":"Command Reference","href":"/docs/development/cli/reference"},{"group":"Workflows","pages":[{"title":"How to Register for 10DLC via CLI","sidebarTitle":"10DLC Registration","href":"/docs/development/cli/workflows/10dlc"}]},{"title":"Telnyx CLI troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/development/cli/troubleshooting"},{"title":"Telnyx Agent CLI","sidebarTitle":"Agent CLI","href":"/docs/development/cli/agent-cli/index"},{"group":"Legacy CLI (Deprecated)","pages":[{"title":"Legacy CLI (@telnyx/api-cli)","sidebarTitle":"Overview","href":"/docs/development/cli/legacy/index"},{"title":"Install Legacy CLI","sidebarTitle":"Installation","href":"/docs/development/cli/legacy/install"},{"title":"Legacy CLI Authentication","sidebarTitle":"Authentication","href":"/docs/development/cli/legacy/authentication"},{"title":"Legacy Command Reference","sidebarTitle":"Command Reference","href":"/docs/development/cli/legacy/reference"}]}]},{"group":"Migration Guides","pages":[{"title":"Call Control migration to Voice API","sidebarTitle":"Call Control Migration","href":"/docs/development/migration/call-control-migration-guide/index"},{"title":"Messaging migration to SMS/MMS API","sidebarTitle":"Messaging Migration","href":"/docs/development/migration/messaging-migration-guide/index"},{"title":"Twilio Migration Guide","sidebarTitle":"Twilio Migration","href":"/docs/development/migration/twilio-migration-guide/index"}]},{"group":"For AI Agents","pages":[{"title":"Agent-readable API documentation","sidebarTitle":"Agent-readable docs","href":"/docs/development/agent-readable-documentation/index"},{"group":"MCP servers","pages":[{"title":"Telnyx Local MCP Server","href":"/docs/development/mcp/local-mcp/index"},{"title":"Telnyx Remote MCP","href":"/docs/development/mcp/remote-mcp/index"},{"title":"Telnyx MCP Apps","sidebarTitle":"MCP Apps","href":"/docs/development/mcp/mcp-apps/index"},{"title":"Telnyx AI Connector","sidebarTitle":"AI Connector","href":"/docs/development/mcp/ai-connector/index"}]},{"title":"Development llms.txt","sidebarTitle":"Development llms txt","href":"/docs/development/llms-txt/index"},{"title":"Development llms-full.txt","sidebarTitle":"Development llms full txt","href":"/docs/development/llms-txt-full/index"}]}]}]},{"product":"Other APIs","icon":"ellipsis","tabs":[{"tab":"Other APIs","icon":"ellipsis","groups":[{"group":" ","pages":[{"title":"Other APIs","href":"/docs/other-apis"}]},{"group":"Account \u0026 Billing","pages":[{"group":"User Profile","pages":[{"title":"Retrieve the current user profile (Beta)","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json get /user_profile","href":"/api-reference/user-profile/retrieve-the-current-user-profile-beta"},{"title":"Update the current user profile (Beta)","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-profile/user-profile.json patch /user_profile","href":"/api-reference/user-profile/update-the-current-user-profile-beta"}]},{"group":"Payment APIs","pages":[{"title":"List auto recharge preferences","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/payment.json get /payment/auto_recharge_prefs","href":"/api-reference/autorechargepreferences/list-auto-recharge-preferences"},{"title":"Update auto recharge preferences","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/payment.json patch /payment/auto_recharge_prefs","href":"/api-reference/autorechargepreferences/update-auto-recharge-preferences"},{"group":"x402 Payment Transactions API","pages":[{"title":"Create a payment quote","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json post /x402/credit_account/quote","href":"/api-reference/x402-payment-transactions/create-a-payment-quote"},{"title":"Settle a payment","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json post /x402/credit_account","href":"/api-reference/x402-payment-transactions/settle-a-payment"},{"title":"List x402 payments","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json get /x402/credit_account/payments","href":"/api-reference/x402-payment-transactions/list-x402-payments"},{"title":"Get an x402 payment","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/x402-transactions.json get /x402/credit_account/payments/{id}","href":"/api-reference/x402-payment-transactions/get-an-x402-payment"}]},{"group":"Machine Payments API","pages":[{"title":"Create a machine payment account credit","deprecated":null,"version":null,"openapi":"/openapi/source/external/payment/machine-payments.json post /machine-payments/account-credit","href":"/api-reference/machine-payments/create-a-machine-payment-account-credit"}]}]},{"group":"Notifications","pages":[{"title":"List notification channels","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_channels","href":"/api-reference/notifications/list-notification-channels"},{"title":"Create a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_channels","href":"/api-reference/notifications/create-a-notification-channel"},{"title":"Delete a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_channels/{id}","href":"/api-reference/notifications/delete-a-notification-channel"},{"title":"Get a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_channels/{id}","href":"/api-reference/notifications/get-a-notification-channel"},{"title":"Update a notification channel","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json patch /notification_channels/{id}","href":"/api-reference/notifications/update-a-notification-channel"},{"title":"List all Notifications Events Conditions","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_event_conditions","href":"/api-reference/notifications/list-all-notifications-events-conditions"},{"title":"List all Notifications Events","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_events","href":"/api-reference/notifications/list-all-notifications-events"},{"title":"List all Notifications Profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_profiles","href":"/api-reference/notifications/list-all-notifications-profiles"},{"title":"Create a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_profiles","href":"/api-reference/notifications/create-a-notification-profile"},{"title":"Delete a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_profiles/{id}","href":"/api-reference/notifications/delete-a-notification-profile"},{"title":"Get a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_profiles/{id}","href":"/api-reference/notifications/get-a-notification-profile"},{"title":"Update a notification profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json patch /notification_profiles/{id}","href":"/api-reference/notifications/update-a-notification-profile"},{"title":"List notification settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_settings","href":"/api-reference/notifications/list-notification-settings"},{"title":"Add a Notification Setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json post /notification_settings","href":"/api-reference/notifications/add-a-notification-setting"},{"title":"Delete a notification setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json delete /notification_settings/{id}","href":"/api-reference/notifications/delete-a-notification-setting"},{"title":"Get a notification setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/notifications/notifications.json get /notification_settings/{id}","href":"/api-reference/notifications/get-a-notification-setting"}]},{"group":"Addresses","pages":[{"title":"List all addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json get /addresses","href":"/api-reference/addresses/list-all-addresses"},{"title":"Creates an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses","href":"/api-reference/addresses/creates-an-address"},{"title":"Deletes an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json delete /addresses/{id}","href":"/api-reference/addresses/deletes-an-address"},{"title":"Retrieve an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json get /addresses/{id}","href":"/api-reference/addresses/retrieve-an-address"},{"title":"Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses/{id}/actions/accept_suggestions","href":"/api-reference/addresses/accepts-this-address-suggestion-as-a-new-emergency-address-for-operator-connect-and-finishes-the-uploads-of-the-numbers-associated-with-it-to-microsoft"},{"title":"Validate an address","deprecated":null,"version":null,"openapi":"/openapi/source/external/addresses/address.json post /addresses/actions/validate","href":"/api-reference/addresses/validate-an-address"}]},{"group":"Balance","pages":[{"title":"Get user balance details","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/billing.json get /balance","href":"/api-reference/billing/get-user-balance-details"}]},{"group":"Charges","pages":[{"title":"Get monthly charges summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/charges.json get /charges_summary","href":"/api-reference/get-monthly-charges-summary"},{"title":"Get monthly charges breakdown","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/charges.json get /charges_breakdown","href":"/api-reference/get-monthly-charges-breakdown"}]},{"group":"Spend limits","pages":[{"title":"List spend limits","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json get /spend_limits","href":"/api-reference/spend-limits/list-spend-limits"},{"title":"Create a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json post /spend_limits","href":"/api-reference/spend-limits/create-a-spend-limit"},{"title":"Update a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json patch /spend_limits/{product}","href":"/api-reference/spend-limits/update-a-spend-limit"},{"title":"Delete a spend limit","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/spend-limits.json delete /spend_limits/{product}","href":"/api-reference/spend-limits/delete-a-spend-limit"}]},{"group":"Stored Payment Transactions API","pages":[{"title":"Create a stored payment transaction","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/stored-payment-transactions.json post /v2/payment/stored_payment_transactions","href":"/api-reference/stored-payment-transactions/create-a-stored-payment-transaction"}]},{"group":"Pricing","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi/source/external/pricing/pricing.json get /pricing/products","href":"/api-reference/pricing/list-products"},{"title":"Get product pricing","deprecated":null,"version":null,"openapi":"/openapi/source/external/pricing/pricing.json get /pricing/products/{slug}","href":"/api-reference/pricing/get-product-pricing"}]},{"group":"Authentication providers","pages":[{"title":"List all SSO authentication providers","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json get /authentication_providers","href":"/api-reference/authentication-providers/list-all-sso-authentication-providers"},{"title":"Creates an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json post /authentication_providers","href":"/api-reference/authentication-providers/creates-an-authentication-provider"},{"title":"Deletes an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json delete /authentication_providers/{id}","href":"/api-reference/authentication-providers/deletes-an-authentication-provider"},{"title":"Retrieve an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json get /authentication_providers/{id}","href":"/api-reference/authentication-providers/retrieve-an-authentication-provider"},{"title":"Update an authentication provider","deprecated":false,"version":null,"openapi":"/openapi/source/external/authentication-providers/authentication-providers.json patch /authentication_providers/{id}","href":"/api-reference/authentication-providers/update-an-authentication-provider"}]},{"group":"IP addresses","pages":[{"group":"IP Addresses API","pages":[{"title":"List all Access IP Addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_address","href":"/api-reference/ip-addresses/list-all-access-ip-addresses"},{"title":"Create new Access IP Address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json post /access_ip_address","href":"/api-reference/ip-addresses/create-new-access-ip-address"},{"title":"Delete access IP address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json delete /access_ip_address/{access_ip_address_id}","href":"/api-reference/ip-addresses/delete-access-ip-address"},{"title":"Retrieve an access IP address","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_address/{access_ip_address_id}","href":"/api-reference/ip-addresses/retrieve-an-access-ip-address"}]},{"group":"IP Ranges API","pages":[{"title":"List all Access IP Ranges","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json get /access_ip_ranges","href":"/api-reference/ip-ranges/list-all-access-ip-ranges"},{"title":"Create new Access IP Range","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json post /access_ip_ranges","href":"/api-reference/ip-ranges/create-new-access-ip-range"},{"title":"Delete access IP ranges","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/cloudflare-ip-list-sync.json delete /access_ip_ranges/{access_ip_range_id}","href":"/api-reference/ip-ranges/delete-access-ip-ranges"}]}]},{"group":"Managed accounts","pages":[{"group":"Managed Accounts API","pages":[{"title":"Lists accounts managed by the current user.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts","href":"/api-reference/managed-accounts/lists-accounts-managed-by-the-current-user"},{"title":"Create a new managed account.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts","href":"/api-reference/managed-accounts/create-a-new-managed-account"},{"title":"Retrieve a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts/{id}","href":"/api-reference/managed-accounts/retrieve-a-managed-account"},{"title":"Update a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json patch /managed_accounts/{id}","href":"/api-reference/managed-accounts/update-a-managed-account"},{"title":"Disables a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts/{id}/actions/disable","href":"/api-reference/managed-accounts/disables-a-managed-account"},{"title":"Enables a managed account","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json post /managed_accounts/{id}/actions/enable","href":"/api-reference/managed-accounts/enables-a-managed-account"},{"title":"Update the amount of allocatable global outbound channels allocated to a specific managed account.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json patch /managed_accounts/{id}/update_global_channel_limit","href":"/api-reference/managed-accounts/update-the-amount-of-allocatable-global-outbound-channels-allocated-to-a-specific-managed-account"},{"title":"Display information about allocatable global outbound channels for the current user.","deprecated":null,"version":null,"openapi":"/openapi/source/external/managed-accounts/managed-accounts.json get /managed_accounts/allocatable_global_outbound_channels","href":"/api-reference/managed-accounts/display-information-about-allocatable-global-outbound-channels-for-the-current-user"}]},{"group":"Organization Users API","pages":[{"title":"List organization users","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users","href":"/api-reference/organization-users/list-organization-users"},{"title":"Get organization user","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users/{id}","href":"/api-reference/organization-users/get-organization-user"},{"title":"Delete organization user","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json post /organizations/users/{id}/actions/remove","href":"/api-reference/organization-users/delete-organization-user"},{"title":"Get organization users groups report","deprecated":null,"version":null,"openapi":"/openapi/source/external/organizations/users.json get /organizations/users/users_groups_report","href":"/api-reference/organization-users/get-organization-users-groups-report"}]}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/invoice.json get /invoices","href":"/api-reference/list-invoices"},{"title":"Get invoice by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/billing/invoice.json get /invoices/{id}","href":"/api-reference/get-invoice-by-id"}]},{"group":"Billing groups","pages":[{"title":"List all billing groups","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json get /billing_groups","href":"/api-reference/billing-groups/list-all-billing-groups"},{"title":"Create a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json post /billing_groups","href":"/api-reference/billing-groups/create-a-billing-group"},{"title":"Delete a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json delete /billing_groups/{id}","href":"/api-reference/billing-groups/delete-a-billing-group"},{"title":"Get a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json get /billing_groups/{id}","href":"/api-reference/billing-groups/get-a-billing-group"},{"title":"Update a billing group","deprecated":false,"version":null,"openapi":"/openapi/source/external/billing-groups/billing-group.json patch /billing_groups/{id}","href":"/api-reference/billing-groups/update-a-billing-group"}]},{"group":"Detail records","pages":[{"title":"Search detail records","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/detail-records.json get /detail_records","href":"/api-reference/detail-records/search-detail-records"}]},{"group":"Batch detail records","pages":[{"group":"MDR Detailed Reports API","pages":[{"title":"Get all MDR detailed report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/messaging","href":"/api-reference/mdr-detailed-reports/get-all-mdr-detailed-report-requests"},{"title":"Create a new MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/messaging","href":"/api-reference/mdr-detailed-reports/create-a-new-mdr-detailed-report-request"},{"title":"Get a specific MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/messaging/{id}","href":"/api-reference/mdr-detailed-reports/get-a-specific-mdr-detailed-report-request"},{"title":"Delete a MDR detailed report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/messaging/{id}","href":"/api-reference/mdr-detailed-reports/delete-a-mdr-detailed-report-request"}]},{"group":"CDR Reports API","pages":[{"title":"Get all CDR report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice","href":"/api-reference/cdr-reports/get-all-cdr-report-requests"},{"title":"Create a new CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/voice","href":"/api-reference/cdr-reports/create-a-new-cdr-report-request"},{"title":"Get a specific CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice/{id}","href":"/api-reference/cdr-reports/get-a-specific-cdr-report-request"},{"title":"Delete a CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/voice/{id}","href":"/api-reference/cdr-reports/delete-a-cdr-report-request"},{"title":"Get available CDR report fields","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/voice/fields","href":"/api-reference/cdr-reports/get-available-cdr-report-fields"}]},{"group":"Speech to Text Batch Reports API","pages":[{"title":"Get all Speech to Text batch report requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/speech_to_text","href":"/api-reference/speech-to-text-batch-reports/get-all-speech-to-text-batch-report-requests"},{"title":"Create a new Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json post /legacy/reporting/batch_detail_records/speech_to_text","href":"/api-reference/speech-to-text-batch-reports/create-a-new-speech-to-text-batch-report-request"},{"title":"Get a specific Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json get /legacy/reporting/batch_detail_records/speech_to_text/{id}","href":"/api-reference/speech-to-text-batch-reports/get-a-specific-speech-to-text-batch-report-request"},{"title":"Delete a Speech to Text batch report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/detail-records/batch-csv.json delete /legacy/reporting/batch_detail_records/speech_to_text/{id}","href":"/api-reference/speech-to-text-batch-reports/delete-a-speech-to-text-batch-report-request"}]}]},{"group":"Usage reports","pages":[{"title":"Usage Reports","href":"/docs/reporting/usage-reports/index"},{"group":"MDR Usage Reports API","pages":[{"title":"List MDR usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/messaging","href":"/api-reference/mdr-usage-reports/list-mdr-usage-reports"},{"title":"Create a new legacy usage V2 MDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/messaging","href":"/api-reference/mdr-usage-reports/create-a-new-legacy-usage-v2-mdr-report-request"},{"title":"Get an MDR usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/messaging/{id}","href":"/api-reference/mdr-usage-reports/get-an-mdr-usage-report"},{"title":"Delete a V2 legacy usage MDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/messaging/{id}","href":"/api-reference/mdr-usage-reports/delete-a-v2-legacy-usage-mdr-report-request"},{"title":"Fetch all Messaging usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports","href":"/api-reference/mdr-usage-reports/fetch-all-messaging-usage-reports"},{"title":"Create MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json post /reports/mdr_usage_reports","href":"/api-reference/mdr-usage-reports/create-mdr-usage-report"},{"title":"Retrieve messaging report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports/{id}","href":"/api-reference/mdr-usage-reports/retrieve-messaging-report"},{"title":"Delete MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json delete /reports/mdr_usage_reports/{id}","href":"/api-reference/mdr-usage-reports/delete-mdr-usage-report"},{"title":"Generate and fetch MDR Usage Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdr_usage_reports/sync","href":"/api-reference/mdr-usage-reports/generate-and-fetch-mdr-usage-report"}]},{"group":"Telco Data Usage Reports API","pages":[{"title":"List telco data usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/number_lookup","href":"/api-reference/telco-data-usage-reports/list-telco-data-usage-reports"},{"title":"Submit telco data usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/number_lookup","href":"/api-reference/telco-data-usage-reports/submit-telco-data-usage-report"},{"title":"Get telco data usage report by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/number_lookup/{id}","href":"/api-reference/telco-data-usage-reports/get-telco-data-usage-report-by-id"},{"title":"Delete telco data usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/number_lookup/{id}","href":"/api-reference/telco-data-usage-reports/delete-telco-data-usage-report"}]},{"group":"Speech to text Usage Reports API","pages":[{"title":"Get speech to text usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/speech_to_text","href":"/api-reference/speech-to-text-usage-reports/get-speech-to-text-usage-report"}]},{"group":"CDR Usage Reports API","pages":[{"title":"List CDR usage reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/voice","href":"/api-reference/cdr-usage-reports/list-cdr-usage-reports"},{"title":"Create a new legacy usage V2 CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json post /legacy/reporting/usage_reports/voice","href":"/api-reference/cdr-usage-reports/create-a-new-legacy-usage-v2-cdr-report-request"},{"title":"Get a CDR usage report","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json get /legacy/reporting/usage_reports/voice/{id}","href":"/api-reference/cdr-usage-reports/get-a-cdr-usage-report"},{"title":"Delete a V2 legacy usage CDR report request","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/standard.json delete /legacy/reporting/usage_reports/voice/{id}","href":"/api-reference/cdr-usage-reports/delete-a-v2-legacy-usage-cdr-report-request"},{"title":"Generates and fetches CDR Usage Reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/cdr_usage_reports/sync","href":"/api-reference/cdr-usage-reports/generates-and-fetches-cdr-usage-reports"}]},{"group":"Usage Reports (BETA) API","pages":[{"title":"Get Telnyx product usage data (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/usage-reports.json get /usage_reports","href":"/api-reference/usage-reports-beta/get-telnyx-product-usage-data-beta"},{"title":"Get Usage Reports query options (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/usage-reports/usage-reports.json get /usage_reports/options","href":"/api-reference/usage-reports-beta/get-usage-reports-query-options-beta"}]},{"group":"MDR Detail Reports API","pages":[{"title":"Fetch all Mdr records","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/reporting.json get /reports/mdrs","href":"/api-reference/mdr-detail-reports/fetch-all-mdr-records"}]},{"group":"WDR Detail Reports API","pages":[{"title":"Fetches all Wdr records","deprecated":null,"version":null,"openapi":"/openapi/source/external/reporting/wireless-public.json get /reports/wdrs","href":"/api-reference/wdr-detail-reports/fetches-all-wdr-records"}]}]},{"group":"Session analysis","pages":[{"title":"Session Analysis API: trace session costs and event trees","sidebarTitle":"Session Analysis","href":"/docs/reporting/session-analysis/index"},{"title":"Get metadata overview","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/metadata","href":"/api-reference/session-analysis/get-metadata-overview"},{"title":"Get record type metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/metadata/{record_type}","href":"/api-reference/session-analysis/get-record-type-metadata"},{"title":"Get session analysis","deprecated":null,"version":null,"openapi":"/openapi/source/external/session-analysis/session-analysis.json get /session_analysis/{record_type}/{event_id}","href":"/api-reference/session-analysis/get-session-analysis"}]},{"group":"On-Demand Reports","pages":[{"title":"On-Demand Reports","href":"/docs/reporting/on-demand-reports/index"}]},{"group":"Webhooks","pages":[{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi/source/external/webhooks/webhooks.json get /webhook_deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Find webhook_delivery details by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/webhooks/webhooks.json get /webhook_deliveries/{id}","href":"/api-reference/webhooks/find-webhook_delivery-details-by-id"}]},{"group":"Audit trail","pages":[{"title":"List Audit Logs","deprecated":null,"version":null,"openapi":"/openapi/source/external/audit-logs/audit-logs.json get /audit_events","href":"/api-reference/audit-logs/list-audit-logs"}]},{"group":"Taggings","pages":[{"group":"User Tags API","pages":[{"title":"List User Tags","deprecated":null,"version":null,"openapi":"/openapi/source/external/user-tags/user-tags.json get /user_tags","href":"/api-reference/user-tags/list-user-tags"}]},{"group":"UserAddresses API","pages":[{"title":"List all user addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json get /user/addresses","href":"/api-reference/useraddresses/list-all-user-addresses"},{"title":"Creates a user address","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json post /user/addresses","href":"/api-reference/useraddresses/creates-a-user-address"},{"title":"Retrieve a user address","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/account-billing/taggings.json get /user/addresses/{id}","href":"/api-reference/useraddresses/retrieve-a-user-address"}]}]},{"group":"Integration Secrets","pages":[{"title":"List integration secrets","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json get /integration_secrets","href":"/api-reference/integration-secrets/list-integration-secrets"},{"title":"Create a secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json post /integration_secrets","href":"/api-reference/integration-secrets/create-a-secret"},{"title":"Delete an integration secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/secrets-manager/integration-secrets.json delete /integration_secrets/{id}","href":"/api-reference/integration-secrets/delete-an-integration-secret"}]}]},{"group":"Video","pages":[{"title":"Getting Started with Video","sidebarTitle":"Getting Started","href":"/docs/video/get-started/index"},{"group":"SDKs","pages":[{"group":"JavaScript","pages":[{"title":"Getting Started with JavaScript SDK for Video","sidebarTitle":"Getting Started","href":"/docs/video/javascript-sdk/index"},{"title":"Room and Events","sidebarTitle":"Room and Events","href":"/docs/video/javascript-sdk/room-events/index"},{"title":"JavaScript Video Tutorial","sidebarTitle":"Tutorial","href":"/docs/video/javascript-sdk/javascript-video-tutorial/index"}]},{"title":"Getting Started with Android Client SDK","sidebarTitle":"Android SDK","href":"/docs/video/android-client-sdk/index"},{"title":"Getting Started with iOS Client SDK","sidebarTitle":"iOS SDK","href":"/docs/video/ios-client-sdk/index"}]},{"group":"Room Compositions API","pages":[{"title":"View a list of room compositions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_compositions","href":"/api-reference/room-compositions/view-a-list-of-room-compositions"},{"title":"Create a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_compositions","href":"/api-reference/room-compositions/create-a-room-composition"},{"title":"View a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_compositions/{room_composition_id}","href":"/api-reference/room-compositions/view-a-room-composition"},{"title":"Delete a room composition.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_compositions/{room_composition_id}","href":"/api-reference/room-compositions/delete-a-room-composition"}]},{"group":"Room Participants API","pages":[{"title":"View a list of room participants.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_participants","href":"/api-reference/room-participants/view-a-list-of-room-participants"},{"title":"View a room participant.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_participants/{room_participant_id}","href":"/api-reference/room-participants/view-a-room-participant"}]},{"group":"Room Recordings API","pages":[{"title":"View a list of room recordings.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_recordings","href":"/api-reference/room-recordings/view-a-list-of-room-recordings"},{"title":"Delete several room recordings in a bulk.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_recordings","href":"/api-reference/room-recordings/delete-several-room-recordings-in-a-bulk"},{"title":"View a room recording.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_recordings/{room_recording_id}","href":"/api-reference/room-recordings/view-a-room-recording"},{"title":"Delete a room recording.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /room_recordings/{room_recording_id}","href":"/api-reference/room-recordings/delete-a-room-recording"}]},{"group":"Room Sessions API","pages":[{"title":"View a list of room sessions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions","href":"/api-reference/room-sessions/view-a-list-of-room-sessions"},{"title":"View a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions/{room_session_id}","href":"/api-reference/room-sessions/view-a-room-session"},{"title":"End a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/end","href":"/api-reference/room-sessions/end-a-room-session"},{"title":"Kick participants from a room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/kick","href":"/api-reference/room-sessions/kick-participants-from-a-room-session"},{"title":"Mute participants in room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/mute","href":"/api-reference/room-sessions/mute-participants-in-room-session"},{"title":"Unmute participants in room session.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /room_sessions/{room_session_id}/actions/unmute","href":"/api-reference/room-sessions/unmute-participants-in-room-session"},{"title":"View a list of room participants.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /room_sessions/{room_session_id}/participants","href":"/api-reference/room-sessions/view-a-list-of-room-participants"}]},{"group":"Rooms API","pages":[{"title":"View a list of rooms.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms","href":"/api-reference/rooms/view-a-list-of-rooms"},{"title":"Create a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms","href":"/api-reference/rooms/create-a-room"},{"title":"View a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms/{room_id}","href":"/api-reference/rooms/view-a-room"},{"title":"Update a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json patch /rooms/{room_id}","href":"/api-reference/rooms/update-a-room"},{"title":"Delete a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json delete /rooms/{room_id}","href":"/api-reference/rooms/delete-a-room"},{"title":"View a list of room sessions.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json get /rooms/{room_id}/sessions","href":"/api-reference/rooms/view-a-list-of-room-sessions"}]},{"group":"Rooms Client Tokens API","pages":[{"title":"Create Client Token to join a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms/{room_id}/actions/generate_join_client_token","href":"/api-reference/rooms-client-tokens/create-client-token-to-join-a-room"},{"title":"Refresh Client Token to join a room.","deprecated":null,"version":null,"openapi":"/openapi/source/external/video/video.json post /rooms/{room_id}/actions/refresh_client_token","href":"/api-reference/rooms-client-tokens/refresh-client-token-to-join-a-room"}]}]},{"group":"SETI","pages":[{"title":"Retrieve Black Box Test Results","deprecated":null,"version":null,"openapi":"/openapi/source/external/seti/seti.json get /seti/black_box_test_results","href":"/api-reference/seti-observability/retrieve-black-box-test-results"}]},{"group":"Fax","pages":[{"title":"Getting Started with Telnyx Programmable Fax","sidebarTitle":"Getting Started","href":"/docs/programmable-fax/get-started/index"},{"title":"Quickstart Guide for Programmable Fax","sidebarTitle":"Quickstart","href":"/docs/programmable-fax/quickstart/index"},{"title":"Receiving Webhooks for Programmable Fax","sidebarTitle":"Receiving Webhooks","href":"/docs/programmable-fax/receiving-webhooks/index"},{"title":"Sending Commands","sidebarTitle":"Sending Commands","href":"/docs/programmable-fax/sending-commands/index"},{"title":"Send a Fax via API","sidebarTitle":"Send a fax via API","href":"/docs/programmable-fax/send-a-fax-api/index"},{"title":"Receive a Fax via API","sidebarTitle":"Receive a fax via API","href":"/docs/programmable-fax/receive-a-fax-api/index"},{"title":"Email to Fax","sidebarTitle":"Email to fax","href":"/docs/programmable-fax/email-to-fax/index"},{"group":"API Reference","pages":[{"group":"Programmable Fax Applications API","pages":[{"title":"List all Fax Applications","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /fax_applications","href":"/api-reference/programmable-fax-applications/list-all-fax-applications"},{"title":"Creates a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /fax_applications","href":"/api-reference/programmable-fax-applications/creates-a-fax-application"},{"title":"Deletes a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json delete /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/deletes-a-fax-application"},{"title":"Retrieve a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/retrieve-a-fax-application"},{"title":"Update a Fax Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json patch /fax_applications/{id}","href":"/api-reference/programmable-fax-applications/update-a-fax-application"}]},{"group":"Programmable Fax Commands API","pages":[{"title":"View a list of faxes","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /faxes","href":"/api-reference/programmable-fax-commands/view-a-list-of-faxes"},{"title":"Send a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes","href":"/api-reference/programmable-fax-commands/send-a-fax"},{"title":"Delete a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json delete /faxes/{id}","href":"/api-reference/programmable-fax-commands/delete-a-fax"},{"title":"View a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json get /faxes/{id}","href":"/api-reference/programmable-fax-commands/view-a-fax"},{"title":"Cancel a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes/{id}/actions/cancel","href":"/api-reference/programmable-fax-commands/cancel-a-fax"},{"title":"Refresh a fax","deprecated":null,"version":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json post /faxes/{id}/actions/refresh","href":"/api-reference/programmable-fax-commands/refresh-a-fax"}]},{"group":"Callbacks API","pages":[{"title":"Fax delivered","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.delivered","href":"/api-reference/callbacks/fax-delivered"},{"title":"Fax failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.failed","href":"/api-reference/callbacks/fax-failed"},{"title":"Fax media processed","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.media.processed","href":"/api-reference/callbacks/fax-media-processed"},{"title":"Fax queued","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.queued","href":"/api-reference/callbacks/fax-queued"},{"title":"Fax sending started","version":null,"deprecated":null,"openapi":"/openapi/source/external/programmable-fax/programmable-fax.json webhook fax.sending.started","href":"/api-reference/callbacks/fax-sending-started"}]}]}]},{"group":"OAuth","pages":[{"group":"OAuth Discovery API","pages":[{"title":"Authorization server metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /.well-known/oauth-authorization-server","href":"/api-reference/oauth-discovery/authorization-server-metadata"},{"title":"Protected resource metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /.well-known/oauth-protected-resource","href":"/api-reference/oauth-discovery/protected-resource-metadata"}]},{"group":"OAuth Protocol API","pages":[{"title":"OAuth authorization endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/authorize","href":"/api-reference/oauth-protocol/oauth-authorization-endpoint"},{"title":"Get OAuth consent token","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/consent/{consent_token}","href":"/api-reference/oauth-protocol/get-oauth-consent-token"},{"title":"Token introspection","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/introspect","href":"/api-reference/oauth-protocol/token-introspection"},{"title":"JSON Web Key Set","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json get /oauth/jwks","href":"/api-reference/oauth-protocol/json-web-key-set"},{"title":"Dynamic client registration","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/register","href":"/api-reference/oauth-protocol/dynamic-client-registration"},{"title":"OAuth token endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/oauth/oauth.json post /oauth/token","href":"/api-reference/oauth-protocol/oauth-token-endpoint"}]},{"group":"OAuth Clients API","pages":[{"title":"List OAuth clients","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/clients","href":"/api-reference/oauth-clients/list-oauth-clients"},{"title":"Create OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json post /oauth/clients","href":"/api-reference/oauth-clients/create-oauth-client"},{"title":"Delete OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json delete /oauth/clients/{id}","href":"/api-reference/oauth-clients/delete-oauth-client"},{"title":"Get OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/clients/{id}","href":"/api-reference/oauth-clients/get-oauth-client"},{"title":"Update OAuth client","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json put /oauth/clients/{id}","href":"/api-reference/oauth-clients/update-oauth-client"}]},{"group":"OAuth Grants API","pages":[{"title":"List OAuth grants","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/grants","href":"/api-reference/oauth-grants/list-oauth-grants"},{"title":"Revoke OAuth grant","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json delete /oauth/grants/{id}","href":"/api-reference/oauth-grants/revoke-oauth-grant"},{"title":"Get OAuth grant","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/oauth.json get /oauth/grants/{id}","href":"/api-reference/oauth-grants/get-oauth-grant"}]}]},{"group":"Bot Signup","pages":[{"group":"Bot Signup API","pages":[{"title":"Issue a bot challenge","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_challenge","href":"/api-reference/bot-signup/issue-a-bot-challenge"},{"title":"Register via bot signup","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_signup","href":"/api-reference/bot-signup/register-via-bot-signup"},{"title":"Resend a bot signup magic link","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json post /bot_signup/resend_magic_link","href":"/api-reference/bot-signup/resend-a-bot-signup-magic-link"},{"title":"Exchange a magic link token for a session","deprecated":null,"version":null,"openapi":"/openapi/source/external/signup/bot-signup.json get /bot_sessions","href":"/api-reference/bot-signup/exchange-a-magic-link-token-for-a-session"}]}]},{"group":"For AI Agents","pages":[{"title":"Other APIs llms.txt","sidebarTitle":"Other APIs llms txt","href":"/docs/development/llms/other-apis-llms-txt/index"},{"title":"Other APIs llms-full.txt","sidebarTitle":"Other APIs llms full txt","href":"/docs/development/llms/other-apis-llms-full-txt/index"}]}]}]},{"product":"Agent Platform","icon":"circle-nodes","tabs":[{"tab":"Overview","icon":"layer-group","groups":[{"group":"Overview","pages":[{"title":"Agent Platform","sidebarTitle":"Overview","href":"/docs/agent-platform"}]},{"group":"For AI Agents","pages":[{"title":"Agent SDK llms.txt","sidebarTitle":"Agent SDK llms txt","href":"/docs/development/llms/ai-agent-sdk-beta-llms-txt/index"},{"title":"Agent SDK llms-full.txt","sidebarTitle":"Agent SDK llms full txt","href":"/docs/development/llms/ai-agent-sdk-beta-llms-full-txt/index"}]}]},{"tab":"Agent Control Plane","icon":"tower-control","groups":[{"group":"Get Started","pages":[{"title":"Agent Control Plane","sidebarTitle":"Overview","href":"/docs/agents/index"},{"title":"Deploy the First Agent","sidebarTitle":"Deploy the First Agent","href":"/docs/agents/get-started/index"},{"title":"Beta Limitations","sidebarTitle":"Beta Limitations","href":"/docs/agents/beta-limitations/index"}]},{"group":"Runtime Platform","pages":[{"title":"Edge Compute Serverless","sidebarTitle":"Edge Compute Serverless","href":"/docs/agents/runtime-platform/edge-compute-serverless/index"},{"group":"The Abstraction Model","pages":[{"title":"Agents and Conversations","sidebarTitle":"Agents and Conversations","href":"/docs/agents/model/agents-and-conversations/index"},{"title":"Execution Model","sidebarTitle":"Execution Model","href":"/docs/agents/model/execution-model/index"},{"title":"Memory Model","sidebarTitle":"Memory Model","href":"/docs/agents/model/memory-model/index"},{"title":"Isolation","sidebarTitle":"Isolation","href":"/docs/agents/model/isolation/index"},{"title":"Lifecycle","sidebarTitle":"Lifecycle","href":"/docs/agents/model/lifecycle/index"}]}]},{"group":"Managed Harness","pages":[{"title":"Project Layout","sidebarTitle":"Project Layout","href":"/docs/agents/project-layout/index"},{"title":"Models and Instructions","sidebarTitle":"Models and Instructions","href":"/docs/agents/models-and-instructions/index"},{"title":"Memory","sidebarTitle":"Memory","href":"/docs/agents/memory/index"},{"group":"Tools","pages":[{"title":"Tools","sidebarTitle":"Overview","href":"/docs/agents/tools/index"},{"title":"Web Search","sidebarTitle":"Web Search","href":"/docs/agents/tools/web-search/index"},{"title":"MCP Servers","sidebarTitle":"MCP Servers","href":"/docs/agents/tools/mcp-servers/index"},{"title":"Agent Gateway","sidebarTitle":"Gateway","tag":"Preview","href":"/docs/agents/tools/agent-gateway/index"},{"title":"Browser","sidebarTitle":"Browser","href":"/docs/agents/tools/agent-browser/index"},{"title":"Agent Sandbox","sidebarTitle":"Sandbox","tag":"Preview","href":"/docs/agents/tools/agent-sandbox/index"},{"title":"File System","sidebarTitle":"File System","tag":"Preview","href":"/docs/agents/tools/file-system/index"}]},{"title":"Voice","sidebarTitle":"Voice","href":"/docs/agents/voice/index"},{"title":"Messaging","sidebarTitle":"Messaging","href":"/docs/agents/messaging/index"},{"title":"Local Development","sidebarTitle":"Local Development","href":"/docs/agents/local-development/index"},{"title":"Test and Debug","sidebarTitle":"Test and Debug","href":"/docs/agents/test-and-debug/index"},{"title":"Deploy and Operate","sidebarTitle":"Deploy and Operate","href":"/docs/agents/deploy-and-operate/index"}]},{"group":"CLI","pages":[{"title":"CLI","sidebarTitle":"Overview","href":"/docs/agents/cli/index"},{"group":"Project Lifecycle","pages":[{"title":"create","sidebarTitle":"create","href":"/docs/agents/cli/create/index"},{"title":"dev","sidebarTitle":"dev","href":"/docs/agents/cli/dev/index"},{"title":"deploy","sidebarTitle":"deploy","href":"/docs/agents/cli/deploy/index"},{"title":"invoke","sidebarTitle":"invoke","href":"/docs/agents/cli/invoke/index"},{"title":"eval","sidebarTitle":"eval","href":"/docs/agents/cli/eval/index"},{"title":"chat","sidebarTitle":"chat","href":"/docs/agents/cli/chat/index"},{"title":"text","sidebarTitle":"text","href":"/docs/agents/cli/text/index"},{"title":"rpc","sidebarTitle":"rpc","href":"/docs/agents/cli/rpc/index"}]},{"group":"Resources","pages":[{"title":"add","sidebarTitle":"add","href":"/docs/agents/cli/add/index"},{"title":"remove","sidebarTitle":"remove","href":"/docs/agents/cli/remove/index"},{"title":"set","sidebarTitle":"set","href":"/docs/agents/cli/set/index"},{"title":"unset","sidebarTitle":"unset","href":"/docs/agents/cli/unset/index"},{"title":"tools","sidebarTitle":"tools","href":"/docs/agents/cli/tools/index"}]},{"group":"Observe","pages":[{"title":"status","sidebarTitle":"status","href":"/docs/agents/cli/status/index"},{"title":"logs","sidebarTitle":"logs","href":"/docs/agents/cli/logs/index"},{"title":"traces","sidebarTitle":"traces","href":"/docs/agents/cli/traces/index"},{"title":"versions","sidebarTitle":"versions","href":"/docs/agents/cli/versions/index"},{"title":"rollback","sidebarTitle":"rollback","href":"/docs/agents/cli/rollback/index"}]},{"group":"Lifecycle","pages":[{"title":"delete","sidebarTitle":"delete","href":"/docs/agents/cli/delete/index"},{"title":"export","sidebarTitle":"export","href":"/docs/agents/cli/export/index"}]},{"title":"Utilities","sidebarTitle":"Utilities","href":"/docs/agents/cli/utilities/index"},{"title":"Troubleshoot","sidebarTitle":"Troubleshoot","href":"/docs/agents/troubleshoot/index"}]},{"group":"Reference","pages":[{"title":"agent.json Reference","sidebarTitle":"agent.json","href":"/docs/agents/reference/agent-json/index"}]},{"group":"For AI Agents","pages":[{"title":"Agent Control Plane llms.txt","sidebarTitle":"Agent Control Plane llms txt","href":"/docs/development/llms/ai-agent-control-plane-beta-llms-txt/index"},{"title":"Agent Control Plane llms-full.txt","sidebarTitle":"Agent Control Plane llms full txt","href":"/docs/development/llms/ai-agent-control-plane-beta-llms-full-txt/index"}]}]},{"tab":"Agent SDK","icon":"code","groups":[{"group":"Get Started","pages":[{"title":"Agent SDK","sidebarTitle":"Overview","href":"/docs/agent-sdk/index"}]},{"group":"Inside the Managed Harness","pages":[{"title":"The Generated Code","sidebarTitle":"The Generated Code","href":"/docs/agent-sdk/inside/generated-code/index"},{"group":"Configuration","pages":[{"title":"Model","sidebarTitle":"Model","href":"/docs/agent-sdk/inside/configuration/model/index"},{"title":"Instructions","sidebarTitle":"Instructions","href":"/docs/agent-sdk/inside/configuration/instructions/index"},{"title":"Phone","sidebarTitle":"Phone","href":"/docs/agent-sdk/inside/configuration/phone/index"},{"title":"Channels","sidebarTitle":"Channels","href":"/docs/agent-sdk/inside/configuration/channels/index"},{"title":"Voice","sidebarTitle":"Voice","href":"/docs/agent-sdk/inside/configuration/voice/index"},{"title":"Memory","sidebarTitle":"Memory","href":"/docs/agent-sdk/inside/configuration/memory/index"},{"title":"Tools, Approvals and Limits","sidebarTitle":"Tools, Approvals and Limits","href":"/docs/agent-sdk/inside/configuration/tools/index"},{"title":"Secrets","sidebarTitle":"Secrets","href":"/docs/agent-sdk/inside/configuration/secrets/index"}]},{"title":"The Harness","sidebarTitle":"The Harness","href":"/docs/agent-sdk/inside/harness/index"},{"group":"Request Handling","pages":[{"title":"The RPC Methods","sidebarTitle":"The RPC Methods","href":"/docs/agent-sdk/inside/request-handling/rpc-methods/index"},{"title":"The Streams","sidebarTitle":"The Streams","href":"/docs/agent-sdk/inside/request-handling/streams/index"},{"title":"The Messaging Webhook","sidebarTitle":"The Messaging Webhook","href":"/docs/agent-sdk/inside/request-handling/messaging-webhook/index"},{"title":"The Call Webhook","sidebarTitle":"The Call Webhook","href":"/docs/agent-sdk/inside/request-handling/call-webhook/index"}]},{"group":"Turn Taking","pages":[{"title":"Admit","sidebarTitle":"Admit","href":"/docs/agent-sdk/inside/turn-taking/admit/index"},{"title":"The Run","sidebarTitle":"The Run","href":"/docs/agent-sdk/inside/turn-taking/run/index"},{"title":"Delivery","sidebarTitle":"Delivery","href":"/docs/agent-sdk/inside/turn-taking/delivery/index"},{"title":"The Voice Loop","sidebarTitle":"The Voice Loop","href":"/docs/agent-sdk/inside/turn-taking/voice-loop/index"}]},{"title":"Extending the Managed Agent","sidebarTitle":"Extending the Managed Agent","href":"/docs/agent-sdk/extending/index"}]},{"group":"The Agent Harness SDK","pages":[{"title":"The Agent Harness SDK","sidebarTitle":"The Package","href":"/docs/agent-sdk/harness-sdk/index"},{"group":"The Interface","pages":[{"title":"createHarness()","sidebarTitle":"createHarness()","href":"/docs/agent-sdk/harness-sdk/create-harness/index"},{"group":"Turns","pages":[{"title":"turn()","sidebarTitle":"turn()","href":"/docs/agent-sdk/harness-sdk/harness/turn/index"},{"title":"begin()","sidebarTitle":"begin()","href":"/docs/agent-sdk/harness-sdk/harness/begin/index"}]},{"group":"Runs","pages":[{"title":"accept()","sidebarTitle":"accept()","href":"/docs/agent-sdk/harness-sdk/harness/accept/index"},{"title":"dispatch()","sidebarTitle":"dispatch()","href":"/docs/agent-sdk/harness-sdk/harness/dispatch/index"},{"title":"run()","sidebarTitle":"run()","href":"/docs/agent-sdk/harness-sdk/harness/run/index"},{"title":"recover()","sidebarTitle":"recover()","href":"/docs/agent-sdk/harness-sdk/harness/recover/index"},{"title":"get()","sidebarTitle":"get()","href":"/docs/agent-sdk/harness-sdk/harness/get/index"},{"title":"status()","sidebarTitle":"status()","href":"/docs/agent-sdk/harness-sdk/harness/status/index"},{"title":"list()","sidebarTitle":"list()","href":"/docs/agent-sdk/harness-sdk/harness/list/index"},{"title":"cancel()","sidebarTitle":"cancel()","href":"/docs/agent-sdk/harness-sdk/harness/cancel/index"},{"title":"approvals","sidebarTitle":"approvals","href":"/docs/agent-sdk/harness-sdk/harness/approvals/index"}]}]},{"group":"Plug-ins","pages":[{"title":"createVirtualWorkspace()","sidebarTitle":"createVirtualWorkspace()","href":"/docs/agent-sdk/harness-sdk/plug-ins/workspace/index"},{"title":"createHarnessWithScheduling()","sidebarTitle":"createHarnessWithScheduling()","href":"/docs/agent-sdk/harness-sdk/plug-ins/scheduling/index"},{"title":"HarnessMiddleware","sidebarTitle":"HarnessMiddleware","href":"/docs/agent-sdk/harness-sdk/plug-ins/middleware/index"},{"title":"browserTools()","sidebarTitle":"browserTools()","href":"/docs/agent-sdk/harness-sdk/tools/browser/index"}]},{"group":"The Internals","pages":[{"group":"Ports","pages":[{"title":"Ports","sidebarTitle":"The Contract","href":"/docs/agent-sdk/harness-sdk/ports/index"},{"title":"ports.messages","sidebarTitle":"ports.messages","href":"/docs/agent-sdk/harness-sdk/ports/messages/index"},{"title":"ports.state","sidebarTitle":"ports.state","href":"/docs/agent-sdk/harness-sdk/ports/state/index"},{"title":"ports.events","sidebarTitle":"ports.events","href":"/docs/agent-sdk/harness-sdk/ports/events/index"},{"title":"ports.tasks","sidebarTitle":"ports.tasks","href":"/docs/agent-sdk/harness-sdk/ports/tasks/index"},{"title":"ports.sql","sidebarTitle":"ports.sql","href":"/docs/agent-sdk/harness-sdk/ports/sql/index"},{"title":"ports.identity","sidebarTitle":"ports.identity","href":"/docs/agent-sdk/harness-sdk/ports/identity/index"},{"title":"ports.clock","sidebarTitle":"ports.clock","href":"/docs/agent-sdk/harness-sdk/ports/clock/index"},{"title":"ports.authorization","sidebarTitle":"ports.authorization","href":"/docs/agent-sdk/harness-sdk/ports/authorization/index"},{"title":"ports.environment","sidebarTitle":"ports.environment","href":"/docs/agent-sdk/harness-sdk/ports/environment/index"},{"title":"ports.activation","sidebarTitle":"ports.activation","href":"/docs/agent-sdk/harness-sdk/ports/activation/index"},{"title":"ports.version","sidebarTitle":"ports.version","href":"/docs/agent-sdk/harness-sdk/ports/version/index"}]},{"group":"Adapters","pages":[{"title":"createRuntimeAgentHarnessPorts()","sidebarTitle":"createRuntimeAgentHarnessPorts()","href":"/docs/agent-sdk/harness-sdk/adapters/runtime/index"},{"title":"createNodeAgentHarnessPorts()","sidebarTitle":"createNodeAgentHarnessPorts()","href":"/docs/agent-sdk/harness-sdk/adapters/node/index"},{"title":"defineAgentHarnessPortsContract()","sidebarTitle":"defineAgentHarnessPortsContract()","href":"/docs/agent-sdk/harness-sdk/adapters/contract/index"}]},{"group":"Persistence","pages":[{"title":"createHarnessRunLedger()","sidebarTitle":"createHarnessRunLedger()","href":"/docs/agent-sdk/harness-sdk/persistence/run-ledger/index"},{"title":"createHarnessStepContext()","sidebarTitle":"createHarnessStepContext()","href":"/docs/agent-sdk/harness-sdk/persistence/step-context/index"}]},{"group":"Channels","pages":[{"title":"createChannelRouter()","sidebarTitle":"createChannelRouter()","href":"/docs/agent-sdk/harness-sdk/channels/router/index"},{"title":"InMemoryChannelLedger","sidebarTitle":"InMemoryChannelLedger","href":"/docs/agent-sdk/harness-sdk/channels/in-memory-ledger/index"},{"title":"SmsReferenceAdapter","sidebarTitle":"SmsReferenceAdapter","href":"/docs/agent-sdk/harness-sdk/channels/sms-reference-adapter/index"},{"title":"emailChannel()","sidebarTitle":"emailChannel()","href":"/docs/agent-sdk/harness-sdk/channels/email-adapter/index"}]}]}]},{"group":"The Agent Runtime SDK","pages":[{"title":"The Agent Runtime SDK","sidebarTitle":"The Package","href":"/docs/agent-sdk/runtime-sdk/index"},{"group":"The Interface","pages":[{"group":"Lifecycle","pages":[{"title":"constructor()","sidebarTitle":"constructor()","href":"/docs/agent-sdk/interface/constructor/index"},{"title":"destroy()","sidebarTitle":"destroy()","href":"/docs/agent-sdk/interface/destroy/index"}]},{"group":"Values","pages":[{"title":"messages","sidebarTitle":"messages","href":"/docs/agent-sdk/interface/messages/index"},{"title":"events","sidebarTitle":"events","href":"/docs/agent-sdk/interface/events/index"},{"title":"env","sidebarTitle":"env","href":"/docs/agent-sdk/interface/env/index"},{"title":"ctx","sidebarTitle":"ctx","href":"/docs/agent-sdk/interface/ctx/index"}]},{"group":"State","pages":[{"title":"initialState()","sidebarTitle":"initialState()","href":"/docs/agent-sdk/interface/initialState/index"},{"title":"getState()","sidebarTitle":"getState()","href":"/docs/agent-sdk/interface/getState/index"},{"title":"setState()","sidebarTitle":"setState()","href":"/docs/agent-sdk/interface/setState/index"},{"title":"replaceState()","sidebarTitle":"replaceState()","href":"/docs/agent-sdk/interface/replaceState/index"},{"title":"onStateChanged()","sidebarTitle":"onStateChanged()","href":"/docs/agent-sdk/interface/onStateChanged/index"}]},{"group":"Tasks","pages":[{"title":"queue()","sidebarTitle":"queue()","href":"/docs/agent-sdk/interface/queue/index"},{"title":"schedule()","sidebarTitle":"schedule()","href":"/docs/agent-sdk/interface/schedule/index"},{"title":"every()","sidebarTitle":"every()","href":"/docs/agent-sdk/interface/every/index"},{"title":"cancelSchedule()","sidebarTitle":"cancelSchedule()","href":"/docs/agent-sdk/interface/cancelSchedule/index"},{"title":"listSchedules()","sidebarTitle":"listSchedules()","href":"/docs/agent-sdk/interface/listSchedules/index"},{"title":"onTask()","sidebarTitle":"onTask()","href":"/docs/agent-sdk/interface/onTask/index"},{"title":"now()","sidebarTitle":"now()","href":"/docs/agent-sdk/interface/now/index"},{"title":"alarm()","sidebarTitle":"alarm()","href":"/docs/agent-sdk/interface/alarm/index"}]},{"group":"Children","pages":[{"title":"spawn()","sidebarTitle":"spawn()","href":"/docs/agent-sdk/interface/spawn/index"},{"title":"children()","sidebarTitle":"children()","href":"/docs/agent-sdk/interface/children/index"},{"title":"despawn()","sidebarTitle":"despawn()","href":"/docs/agent-sdk/interface/despawn/index"}]},{"group":"Connections","pages":[{"title":"authorize()","sidebarTitle":"authorize()","href":"/docs/agent-sdk/interface/authorize/index"},{"title":"onConnect()","sidebarTitle":"onConnect()","href":"/docs/agent-sdk/interface/onConnect/index"},{"title":"onAttach()","sidebarTitle":"onAttach()","href":"/docs/agent-sdk/interface/onAttach/index"},{"title":"attachments","sidebarTitle":"attachments","href":"/docs/agent-sdk/interface/attachments/index"},{"title":"connectionEngine","sidebarTitle":"connectionEngine","href":"/docs/agent-sdk/interface/connectionEngine/index"},{"title":"webSocket()","sidebarTitle":"webSocket()","href":"/docs/agent-sdk/interface/webSocket/index"},{"title":"fetch()","sidebarTitle":"fetch()","href":"/docs/agent-sdk/interface/fetch/index"}]},{"group":"RPC","pages":[{"title":"@rpc","sidebarTitle":"@rpc","href":"/docs/agent-sdk/interface/rpc/index"},{"title":"rpcSurface()","sidebarTitle":"rpcSurface()","href":"/docs/agent-sdk/interface/rpcSurface/index"}]}]},{"title":"Bring Your Own Framework","sidebarTitle":"BYO Framework","href":"/docs/agent-sdk/examples/bring-your-own-framework/index"},{"group":"The Internals","pages":[{"title":"Entry Points","sidebarTitle":"Entry Points","href":"/docs/agent-sdk/contract/entry-points/index"},{"title":"The Address and Transports","sidebarTitle":"The Address and Transports","href":"/docs/agent-sdk/contract/address-and-transports/index"},{"group":"Mount","pages":[{"title":"Mounting Agents","href":"/docs/agent-sdk/mounting-agents/index"},{"title":"The Mount","sidebarTitle":"The Mount","href":"/docs/agent-sdk/internals/the-mount/index"},{"title":"mountAgents()","sidebarTitle":"mountAgents()","href":"/docs/agent-sdk/internals/mount/mountAgents/index"},{"title":"encodeAgentName()","sidebarTitle":"encodeAgentName()","href":"/docs/agent-sdk/internals/mount/encodeAgentName/index"},{"title":"decodeAgentName()","sidebarTitle":"decodeAgentName()","href":"/docs/agent-sdk/internals/mount/decodeAgentName/index"}]},{"group":"AgentSocketServer","pages":[{"title":"The Socket Server","sidebarTitle":"The Socket Server","href":"/docs/agent-sdk/internals/the-socket-server/index"},{"title":"new AgentSocketServer()","sidebarTitle":"new AgentSocketServer()","href":"/docs/agent-sdk/internals/socket/constructor/index"},{"title":"attach()","sidebarTitle":"attach()","href":"/docs/agent-sdk/internals/socket/attach/index"},{"title":"broadcastPatch()","sidebarTitle":"broadcastPatch()","href":"/docs/agent-sdk/internals/socket/broadcastPatch/index"},{"title":"broadcastSnapshot()","sidebarTitle":"broadcastSnapshot()","href":"/docs/agent-sdk/internals/socket/broadcastSnapshot/index"},{"title":"broadcastMessages()","sidebarTitle":"broadcastMessages()","href":"/docs/agent-sdk/internals/socket/broadcastMessages/index"},{"title":"broadcastEvent()","sidebarTitle":"broadcastEvent()","href":"/docs/agent-sdk/internals/socket/broadcastEvent/index"},{"title":"handleCall()","sidebarTitle":"handleCall()","href":"/docs/agent-sdk/internals/socket/handleCall/index"},{"title":"close()","sidebarTitle":"close()","href":"/docs/agent-sdk/internals/socket/close/index"},{"title":"watcherCount","sidebarTitle":"watcherCount","href":"/docs/agent-sdk/internals/socket/watcherCount/index"},{"title":"authorizeEnabled","sidebarTitle":"authorizeEnabled","href":"/docs/agent-sdk/internals/socket/authorizeEnabled/index"}]},{"group":"AgentHttpServer","pages":[{"title":"The HTTP Server","sidebarTitle":"The HTTP Server","href":"/docs/agent-sdk/internals/the-http-server/index"},{"title":"new AgentHttpServer()","sidebarTitle":"new AgentHttpServer()","href":"/docs/agent-sdk/internals/http/constructor/index"},{"title":"fetch()","sidebarTitle":"fetch()","href":"/docs/agent-sdk/internals/http/fetch/index"},{"title":"handleRpc()","sidebarTitle":"handleRpc()","href":"/docs/agent-sdk/internals/http/handleRpc/index"},{"title":"handleSse()","sidebarTitle":"handleSse()","href":"/docs/agent-sdk/internals/http/handleSse/index"}]},{"title":"The Protocol","sidebarTitle":"The Protocol","href":"/docs/agent-sdk/internals/protocol/index"},{"title":"Limits","href":"/docs/agent-sdk/limits/index"}]}]},{"group":"The Agent Client SDK","pages":[{"title":"The Agent Client SDK","sidebarTitle":"The Package","href":"/docs/agent-sdk/client-sdk/index"},{"group":"The Interface","pages":[{"group":"Connection","pages":[{"title":"new AgentClient()","sidebarTitle":"new AgentClient()","href":"/docs/agent-sdk/client-sdk/constructor/index"},{"title":"claims","sidebarTitle":"claims","href":"/docs/agent-sdk/client-sdk/claims/index"},{"title":"isConnected()","sidebarTitle":"isConnected()","href":"/docs/agent-sdk/client-sdk/isConnected/index"},{"title":"close()","sidebarTitle":"close()","href":"/docs/agent-sdk/client-sdk/close/index"}]},{"group":"Streams","pages":[{"title":"onState()","sidebarTitle":"onState()","href":"/docs/agent-sdk/client-sdk/onState/index"},{"title":"onMessages()","sidebarTitle":"onMessages()","href":"/docs/agent-sdk/client-sdk/onMessages/index"},{"title":"onEvents()","sidebarTitle":"onEvents()","href":"/docs/agent-sdk/client-sdk/onEvents/index"}]},{"group":"RPC","pages":[{"title":"stub","sidebarTitle":"stub","href":"/docs/agent-sdk/client-sdk/stub/index"}]}]}]}]},{"tab":"Agent Memory","icon":"brain","groups":[{"group":"Agent Memory","pages":[{"title":"Agent Memory: Long-Term Memory for AI Agents","sidebarTitle":"Overview","href":"/docs/agent-memory/index"}]},{"group":"Features","pages":[{"title":"Writing Memories","href":"/docs/agent-memory/writing"},{"title":"Recalling Memories","href":"/docs/agent-memory/recall"},{"title":"Sources","sidebarTitle":"Sources","href":"/docs/agent-memory/sources"},{"title":"Forgetting","sidebarTitle":"Forgetting","href":"/docs/agent-memory/deleting"},{"group":"Isolation","pages":[{"title":"Isolation Levels","sidebarTitle":"Isolation Levels","href":"/docs/agent-memory/isolation"},{"title":"Namespace Settings","sidebarTitle":"Namespace Settings","href":"/docs/agent-memory/namespace-settings"}]}]},{"group":"API Reference","pages":[{"group":"Namespaces","pages":[{"title":"List your namespaces","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces","href":"/api-reference/namespaces/list-your-namespaces"},{"title":"Create a namespace","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json post /ai/memory/namespaces","href":"/api-reference/namespaces/create-a-namespace"},{"title":"Delete a namespace","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json delete /ai/memory/namespaces/{namespace}","href":"/api-reference/namespaces/delete-a-namespace"}]},{"group":"Memory","pages":[{"title":"Ingest a session's messages into a profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json post /ai/memory/namespaces/{namespace}/profiles/{profile_id}/ingest","href":"/api-reference/memory/ingest-a-sessions-messages-into-a-profile"},{"title":"Remember one fact, stored as written","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json post /ai/memory/namespaces/{namespace}/profiles/{profile_id}/remember","href":"/api-reference/memory/remember-one-fact-stored-as-written"},{"title":"Recall a profile's memories, ranked","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json post /ai/memory/namespaces/{namespace}/profiles/{profile_id}/recall","href":"/api-reference/memory/recall-a-profiles-memories-ranked"},{"title":"Get a profile's precomputed summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles/{profile_id}/summary","href":"/api-reference/memory/get-a-profiles-precomputed-summary"},{"title":"Preview a candidate note before saving it","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json post /ai/memory/namespaces/{namespace}/profiles/{profile_id}/summary/preview","href":"/api-reference/memory/preview-a-candidate-note-before-saving-it"}]},{"group":"Profiles","pages":[{"title":"List a namespace's profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles","href":"/api-reference/profiles/list-a-namespaces-profiles"},{"title":"List a profile's memories, most recent first","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles/{profile_id}/memories","href":"/api-reference/profiles/list-a-profiles-memories-most-recent-first"},{"title":"Read one memory, and what it came from","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles/{profile_id}/memories/{memory_id}","href":"/api-reference/profiles/read-one-memory-and-what-it-came-from"},{"title":"Forget a profile's memories","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json delete /ai/memory/namespaces/{namespace}/profiles/{profile_id}","href":"/api-reference/profiles/forget-a-profiles-memories"}]},{"group":"Sources","pages":[{"title":"List a profile's sources, most recently written first","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles/{profile_id}/sources","href":"/api-reference/sources/list-a-profiles-sources-most-recently-written-first"},{"title":"Read one source, with what was stored","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/profiles/{profile_id}/sources/{source_id}","href":"/api-reference/sources/read-one-source-with-what-was-stored"},{"title":"Forget one source","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json delete /ai/memory/namespaces/{namespace}/profiles/{profile_id}/sources/{source_id}","href":"/api-reference/sources/forget-one-source"}]},{"group":"Settings","pages":[{"title":"Get a namespace's settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/settings","href":"/api-reference/settings/get-a-namespaces-settings"},{"title":"Change a namespace's settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json patch /ai/memory/namespaces/{namespace}/settings","href":"/api-reference/settings/change-a-namespaces-settings"}]},{"group":"Operations","pages":[{"title":"Status of a write","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-memory/agent-memory.json get /ai/memory/namespaces/{namespace}/operations/{operation_id}","href":"/api-reference/operations/status-of-a-write"}]}]},{"group":"For AI Agents","pages":[{"title":"Agent Memory llms.txt","sidebarTitle":"Agent Memory llms txt","href":"/docs/development/llms/agent-tools-agent-memory-beta-llms-txt/index"},{"title":"Agent Memory llms-full.txt","sidebarTitle":"Agent Memory llms full txt","href":"/docs/development/llms/agent-tools-agent-memory-beta-llms-full-txt/index"}]}]},{"tab":"Agent Browser","icon":"browser","groups":[{"group":"Agent Browser","pages":[{"title":"Agent Browser Overview","sidebarTitle":"Overview","href":"/docs/agent-browser/index"},{"title":"Get Started","href":"/docs/agent-browser/getting-started"}]},{"group":"Features","pages":[{"title":"Sessions","href":"/docs/agent-browser/sessions"},{"title":"Actions","href":"/docs/agent-browser/actions"},{"title":"Observations","href":"/docs/agent-browser/observations"}]},{"group":"API Reference","pages":[{"group":"Browser Sessions","pages":[{"title":"Create browser session","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json post /browser_sessions","href":"/api-reference/browser-sessions/create-browser-session"},{"title":"List browser sessions","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json get /browser_sessions","href":"/api-reference/browser-sessions/list-browser-sessions"},{"title":"Get browser session","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json get /browser_sessions/{id}","href":"/api-reference/browser-sessions/get-browser-session"},{"title":"Close browser session","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json delete /browser_sessions/{id}","href":"/api-reference/browser-sessions/close-browser-session"}]},{"group":"Actions","pages":[{"title":"Execute browser action","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json post /browser_sessions/{id}/actions","href":"/api-reference/actions/execute-browser-action"},{"title":"Get action result","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json get /browser_sessions/{id}/actions/{actionId}","href":"/api-reference/actions/get-action-result"}]},{"group":"Artifacts","pages":[{"title":"Get artifact metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json get /browser_sessions/{id}/artifacts/{artifactId}","href":"/api-reference/artifacts/get-artifact-metadata"},{"title":"Download artifact","deprecated":null,"version":null,"openapi":"/openapi/source/external/agent-browser/agent-browser.json get /artifact_downloads/{artifactId}","href":"/api-reference/artifacts/download-artifact"}]}]},{"group":"For AI Agents","pages":[{"title":"Agent Browser llms.txt","sidebarTitle":"Agent Browser llms txt","href":"/docs/development/llms/agent-tools-agent-browser-llms-txt/index"},{"title":"Agent Browser llms-full.txt","sidebarTitle":"Agent Browser llms full txt","href":"/docs/development/llms/agent-tools-agent-browser-llms-full-txt/index"}]}]}]},{"product":"AI","icon":"microchip-ai","tabs":[{"tab":"Inference","icon":"brain-circuit","groups":[{"group":"Inference","pages":[{"title":"Available Models","sidebarTitle":"Models","href":"/docs/inference/models"},{"title":"Decision Models (Beta)","sidebarTitle":"Decision Models","href":"/docs/inference/decision-models/index"},{"title":"Regions \u0026 Availability","sidebarTitle":"Regions \u0026 Availability","href":"/docs/inference/models/regions/index"},{"title":"Inference service tiers","sidebarTitle":"Service tiers","href":"/docs/inference/service-tiers/index"},{"title":"Inference token rate limits","sidebarTitle":"Rate limits","href":"/docs/inference/rate-limits/index"},{"title":"Set inference spending limits","sidebarTitle":"Spending limits","href":"/docs/inference/spending-limits/index"},{"title":"Telnyx Inference API pricing","sidebarTitle":"Pricing","href":"/docs/inference/models/pricing/index"}]},{"group":"Data Residency","pages":[{"title":"Data Residency, Processing \u0026 Compliance FAQ","sidebarTitle":"Data Residency \u0026 Compliance FAQ","href":"/docs/inference/data-residency/index"}]},{"group":"Integrations","pages":[{"title":"Framework Integrations","sidebarTitle":"Integrations","href":"/docs/inference/integrations/index"},{"title":"Anthropic API Migration Guide","sidebarTitle":"Anthropic Migration","href":"/docs/inference/anthropic/index"},{"title":"LangChain Integration","sidebarTitle":"LangChain","href":"/docs/inference/langchain-integration/index"},{"title":"LlamaIndex Integration","sidebarTitle":"LlamaIndex","href":"/docs/inference/llama-index/index"},{"title":"CrewAI Integration","sidebarTitle":"CrewAI","href":"/docs/inference/crewai/index"},{"title":"Telnyx LiveKit Plugin","sidebarTitle":"LiveKit","href":"/docs/inference/livekit/index"}]},{"group":"Tutorials","pages":[{"title":"Inference API Quickstart","sidebarTitle":"Inference API","href":"/docs/inference/getting-started/index"},{"title":"Function Calling","sidebarTitle":"Function Calling","href":"/docs/inference/functions/index"},{"title":"Function Calling (Streaming + Parallel Calls)","sidebarTitle":"Streaming and Parallel Calls","href":"/docs/inference/streaming-functions/index"},{"title":"JSON Mode and Beyond","sidebarTitle":"JSON Mode and Beyond","href":"/docs/inference/json-mode/index"},{"title":"Audio Language Models","sidebarTitle":"Audio Language Models","href":"/docs/inference/audio-language-models/index"},{"title":"PR Reviewer","sidebarTitle":"PR Reviewer - Github Action","href":"/docs/inference/pr-reviewer/index"},{"title":"AI SMS Outfit Recs with OpenMeteo","sidebarTitle":"AI SMS Outfit Recommender with OpenMeteo","href":"/docs/inference/ai-outfit-recommender/index"}]},{"group":"API Reference","pages":[{"group":"OpenAI Chat API","pages":[{"title":"Create a chat completion (OpenAI-compatible)","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/openai/chat/completions","href":"/api-reference/openai-chat/create-a-chat-completion-openai-compatible"},{"title":"Get available models (OpenAI-compatible)","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/openai/models","href":"/api-reference/openai-chat/get-available-models-openai-compatible"},{"title":"Create an OpenAI-compatible response","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/openai/responses","href":"/api-reference/openai-chat/create-an-openai-compatible-response"}]},{"group":"Decision Models API","pages":[{"title":"Evaluate decision models (TypeSafe-compatible)","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-decision-models.json post /ai/typesafe/v1/systemone","href":"/api-reference/decision-models/evaluate-decision-models-typesafe-compatible"}]},{"group":"Fine Tuning API","pages":[{"title":"List fine tuning jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/fine_tuning/jobs","href":"/api-reference/fine-tuning/list-fine-tuning-jobs"},{"title":"Create a fine tuning job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/fine_tuning/jobs","href":"/api-reference/fine-tuning/create-a-fine-tuning-job"},{"title":"Get a fine tuning job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/fine_tuning/jobs/{job_id}","href":"/api-reference/fine-tuning/get-a-fine-tuning-job"},{"title":"Cancel a fine tuning job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/fine_tuning/jobs/{job_id}/cancel","href":"/api-reference/fine-tuning/cancel-a-fine-tuning-job"}]},{"group":"Anthropic Messages API","pages":[{"title":"Create a message (Anthropic-compatible)","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/anthropic/v1/messages","href":"/api-reference/anthropic-messages/create-a-message-anthropic-compatible"}]},{"group":"Chat API","pages":[{"title":"Summarize file content","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/summarize","href":"/api-reference/chat/summarize-file-content"}]}]},{"group":"For AI Agents","pages":[{"title":"Inference llms.txt","sidebarTitle":"Inference llms txt","href":"/docs/development/llms/ai-inference-llms-txt/index"},{"title":"Inference llms-full.txt","sidebarTitle":"Inference llms full txt","href":"/docs/development/llms/ai-inference-llms-full-txt/index"}]}]},{"tab":"AI Gateway","icon":"key","groups":[{"group":"AI Gateway","pages":[{"title":"AI Gateway: Scoped Inference Credentials for Apps","sidebarTitle":"Overview","href":"/docs/inference/ai-gateway/index"},{"title":"AI Gateway Quickstart","sidebarTitle":"Quickstart","href":"/docs/inference/ai-gateway/quickstart"}]},{"group":"API","pages":[{"title":"AI Gateway Inference API","sidebarTitle":"Inference API","href":"/docs/inference/ai-gateway/inference-api"},{"title":"AI Gateway Management API","sidebarTitle":"Management API","href":"/docs/inference/ai-gateway/management-api"},{"title":"List gateway spend events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-spend.json get /llm_token_gateway/spend/events","href":"/api-reference/ai-gateway/list-gateway-spend-events"},{"title":"Get gateway spend summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-spend.json get /llm_token_gateway/spend/summary","href":"/api-reference/ai-gateway/get-gateway-spend-summary"},{"title":"Get gateway usage summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway.json get /llm_token_gateway/usage/summary","href":"/api-reference/ai-gateway/get-gateway-usage-summary"},{"title":"List gateway token groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json get /llm_token_gateway/token_groups","href":"/api-reference/ai-gateway/list-gateway-token-groups"},{"title":"Create gateway token group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json post /llm_token_gateway/token_groups","href":"/api-reference/ai-gateway/create-gateway-token-group"},{"title":"Get gateway token group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json get /llm_token_gateway/token_groups/{id}","href":"/api-reference/ai-gateway/get-gateway-token-group"},{"title":"Update gateway token group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json patch /llm_token_gateway/token_groups/{id}","href":"/api-reference/ai-gateway/update-gateway-token-group"},{"title":"Delete gateway token group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json delete /llm_token_gateway/token_groups/{id}","href":"/api-reference/ai-gateway/delete-gateway-token-group"},{"title":"List gateway token keys","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json get /llm_token_gateway/token_keys","href":"/api-reference/ai-gateway/list-gateway-token-keys"},{"title":"Create gateway token key","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json post /llm_token_gateway/token_keys","href":"/api-reference/ai-gateway/create-gateway-token-key"},{"title":"Get gateway token key","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json get /llm_token_gateway/token_keys/{id}","href":"/api-reference/ai-gateway/get-gateway-token-key"},{"title":"Update gateway token key","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json patch /llm_token_gateway/token_keys/{id}","href":"/api-reference/ai-gateway/update-gateway-token-key"},{"title":"Delete gateway token key","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway-resources.json delete /llm_token_gateway/token_keys/{id}","href":"/api-reference/ai-gateway/delete-gateway-token-key"},{"title":"Export gateway usage","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/ai-gateway.json get /llm_token_gateway/usage/export","href":"/api-reference/ai-gateway/export-gateway-usage"}]},{"group":"Concepts","pages":[{"title":"Gateway Controls","sidebarTitle":"Controls","href":"/docs/inference/ai-gateway/controls"},{"title":"AI Gateway Guardrails","sidebarTitle":"Guardrails","href":"/docs/inference/ai-gateway/guardrails"},{"title":"Bring Your Own Key","sidebarTitle":"Bring your own key","href":"/docs/inference/ai-gateway/byok"},{"title":"Usage Reporting","sidebarTitle":"Usage reporting","href":"/docs/inference/ai-gateway/usage"},{"title":"AI Gateway Errors","sidebarTitle":"Errors","href":"/docs/inference/ai-gateway/errors"}]},{"group":"For AI Agents","pages":[{"title":"AI Gateway llms.txt","sidebarTitle":"AI Gateway llms txt","href":"/docs/development/llms/ai-ai-gateway-llms-txt/index"},{"title":"AI Gateway llms-full.txt","sidebarTitle":"AI Gateway llms full txt","href":"/docs/development/llms/ai-ai-gateway-llms-full-txt/index"}]}]},{"tab":"Embedding","icon":"database","groups":[{"group":"Embedding","pages":[{"title":"Embedding","sidebarTitle":"Overview","href":"/docs/inference/embedding-rag/index"},{"title":"Pricing","href":"/docs/inference/embedding-rag/pricing"}]},{"group":"Bucket","pages":[{"title":"Embeddings","sidebarTitle":"Embeddings","href":"/docs/inference/embeddings/index"},{"title":"Identifying themes in your data with Clusters","sidebarTitle":"Clusters","href":"/docs/inference/clusters/index"}]},{"group":"OpenAI-compatible","pages":[{"group":"OpenAI Embeddings API","pages":[{"title":"Create embeddings","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/openai/embeddings","href":"/api-reference/openai-embeddings/create-embeddings"},{"title":"List embedding models","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/openai/embeddings/models","href":"/api-reference/openai-embeddings/list-embedding-models"}]}]},{"group":"API Reference","pages":[{"group":"Embeddings API","pages":[{"title":"Get Tasks by Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/embeddings","href":"/api-reference/embeddings/get-tasks-by-status"},{"title":"Embed documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/embeddings","href":"/api-reference/embeddings/embed-documents"},{"title":"List embedded buckets","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/embeddings/buckets","href":"/api-reference/embeddings/list-embedded-buckets"},{"title":"Disable AI for an Embedded Bucket","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/embeddings/buckets/{bucket_name}","href":"/api-reference/embeddings/disable-ai-for-an-embedded-bucket"},{"title":"Get file-level embedding statuses for a bucket","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/embeddings/buckets/{bucket_name}","href":"/api-reference/embeddings/get-file-level-embedding-statuses-for-a-bucket"},{"title":"Search for documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/embeddings/similarity-search","href":"/api-reference/embeddings/search-for-documents"},{"title":"Embed URL content","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/embeddings/url","href":"/api-reference/embeddings/embed-url-content"},{"title":"Get an embedding task's status","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/embeddings/{task_id}","href":"/api-reference/embeddings/get-an-embedding-tasks-status"}]},{"group":"Clusters API","pages":[{"title":"List all clusters","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/clusters","href":"/api-reference/clusters/list-all-clusters"},{"title":"Compute new clusters","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/clusters","href":"/api-reference/clusters/compute-new-clusters"},{"title":"Delete a cluster","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/clusters/{task_id}","href":"/api-reference/clusters/delete-a-cluster"},{"title":"Fetch a cluster","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/clusters/{task_id}","href":"/api-reference/clusters/fetch-a-cluster"},{"title":"Fetch a cluster visualization","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/clusters/{task_id}/graph","href":"/api-reference/clusters/fetch-a-cluster-visualization"}]},{"group":"Conversation Histories API","tag":"Legacy","pages":[{"title":"Search conversation histories","deprecated":null,"version":null,"openapi":"/openapi/source/external/transcriptions-search/transcriptions-search.json get /ai/conversation_histories","href":"/api-reference/conversation-histories/search-conversation-histories"}]}]},{"group":"For AI Agents","pages":[{"title":"Embedding llms.txt","sidebarTitle":"Embedding llms txt","href":"/docs/development/llms/ai-embedding-llms-txt/index"},{"title":"Embedding llms-full.txt","sidebarTitle":"Embedding llms full txt","href":"/docs/development/llms/ai-embedding-llms-full-txt/index"}]}]},{"tab":"Assistants","icon":"robot","groups":[{"group":"Guides","pages":[{"group":"Getting Started","pages":[{"title":"Voice Assistant Quickstart","sidebarTitle":"Voice Assistant","href":"/docs/inference/ai-assistants/no-code-voice-assistant/index"},{"title":"Web Chat Without Voice","sidebarTitle":"Web Chat Without Voice","href":"/docs/inference/ai-assistants/web-chat/index"},{"title":"Importing Assistants from another Provider","sidebarTitle":"Importing Assistants","href":"/docs/inference/ai-assistants/importing/index"},{"title":"Realtime voice conversations over WebSocket","sidebarTitle":"Realtime Conversations","href":"/docs/inference/ai-assistants/realtime-conversations/index"},{"title":"Realtime voice and avatar conversations over WebRTC","sidebarTitle":"WebRTC Conversations","tag":"Beta","href":"/docs/inference/ai-assistants/webrtc-conversations/index"},{"title":"Assistant Deletion and Restore","sidebarTitle":"Deletion and Restore","href":"/docs/inference/ai-assistants/assistant-deletion/index"}]},{"group":"Models \u0026 Voice","pages":[{"title":"Speech-to-speech models","sidebarTitle":"Speech-to-speech models","href":"/docs/inference/ai-assistants/speech-to-speech/index"},{"title":"GPT Live voice assistants","sidebarTitle":"GPT Live","href":"/docs/inference/ai-assistants/gpt-live/index"},{"title":"Configure custom LLM providers for AI assistants","sidebarTitle":"Custom LLMs for Assistants","href":"/docs/inference/ai-assistants/custom-llm/index"},{"title":"Transcription Settings","sidebarTitle":"Transcription Settings","href":"/docs/inference/ai-assistants/transcription-settings/index"},{"title":"Avatars","sidebarTitle":"Avatars","tag":"Beta","href":"/docs/inference/ai-assistants/avatars/index"},{"title":"Interruption Settings","sidebarTitle":"Interruption Settings","href":"/docs/inference/ai-assistants/interruption-settings/index"}]},{"group":"Context \u0026 Memory","pages":[{"title":"Dynamic Variables","sidebarTitle":"Dynamic Variables","href":"/docs/inference/ai-assistants/dynamic-variables/index"},{"title":"How conversations are keyed across channels","sidebarTitle":"Conversation Keying","href":"/docs/inference/ai-assistants/conversation-keying/index"},{"title":"Memory","sidebarTitle":"Memory","href":"/docs/inference/ai-assistants/memory/index"}]},{"group":"Tools \u0026 Integrations","pages":[{"title":"Tools Library","sidebarTitle":"Tools Library","href":"/docs/inference/ai-assistants/tools-library/index"},{"title":"AI assistant integrations","sidebarTitle":"Integrations","href":"/docs/inference/ai-assistants/integrations/index"},{"title":"Add MCP servers to an AI assistant","href":"/docs/development/mcp/assistant-mcp-servers/index"},{"title":"Per-Caller Credentials","sidebarTitle":"Per-Caller Credentials","href":"/docs/inference/ai-assistants/per-caller-credentials/index"},{"title":"Preset Webhook Parameters","sidebarTitle":"Preset Webhook Parameters","href":"/docs/inference/ai-assistants/preset-webhook-parameters/index"},{"title":"Async Tools \u0026 Deferred Context","sidebarTitle":"Async Tools","href":"/docs/inference/ai-assistants/async-tools/index"},{"title":"Webhook Tool Filler Messages","sidebarTitle":"Filler Messages","href":"/docs/inference/ai-assistants/filler-messages/index"},{"title":"Client-Side Tools","sidebarTitle":"Client-Side Tools","href":"/docs/inference/ai-assistants/client-side-tools/index"},{"title":"Vision","sidebarTitle":"Vision","tag":"BETA","href":"/docs/inference/ai-assistants/vision/index"},{"title":"Power AI Assistants with Edge Compute","sidebarTitle":"AI Assistants and Edge Compute","href":"/docs/edge-compute/guides/ai-assistant-backend/index"}]},{"group":"Workflows \u0026 Agents","pages":[{"title":"Conversation Workflows","sidebarTitle":"Conversation Workflows","href":"/docs/inference/ai-assistants/workflows/index"},{"title":"Delegation","sidebarTitle":"Delegation","href":"/docs/inference/ai-assistants/delegation/index"},{"title":"A2A Agents","sidebarTitle":"A2A Agents","tag":"Beta","href":"/docs/inference/ai-assistants/a2a-agents/index"},{"title":"Agent Handoff","sidebarTitle":"Agent Handoff","href":"/docs/inference/ai-assistants/agent-handoff/index"}]},{"group":"Calls \u0026 Transfers","pages":[{"title":"Multi-Participant Voice AI Calls","sidebarTitle":"Multi-Participant Calls","href":"/docs/inference/ai-assistants/multi-participant-calls/index"},{"title":"Warm Transfer Acceptance","sidebarTitle":"Warm Transfer Acceptance","href":"/docs/inference/ai-assistants/warm-transfer-acceptance/index"},{"title":"Voicemail Detection on Transfer","sidebarTitle":"Voicemail Detection on Transfer","href":"/docs/inference/ai-assistants/voicemail-detection-on-transfer/index"},{"title":"Scheduled Events","sidebarTitle":"Scheduled Events","href":"/docs/inference/ai-assistants/scheduled-events/index"}]},{"group":"Testing \u0026 Monitoring","pages":[{"title":"Testing and Traffic Distribution for AI Assistants","sidebarTitle":"Testing, Versions \u0026 Traffic Distribution","href":"/docs/inference/ai-assistants/version-testing-traffic-distribution/index"},{"title":"Stream conversation events to your WebSocket","sidebarTitle":"Conversation Event Stream","href":"/docs/inference/ai-assistants/conversation-event-stream/index"},{"title":"Observability","sidebarTitle":"Observability","href":"/docs/inference/ai-assistants/agent-observability/index"},{"title":"Post-Conversation Processing","sidebarTitle":"Post-Conversation Processing","href":"/docs/inference/ai-assistants/post-conversation-processing/index"}]}]},{"group":"Missions","pages":[{"title":"Voice Outreach with AI Missions","sidebarTitle":"Voice Outreach","href":"/docs/inference/missions/index"}]},{"group":"AI Insights","pages":[{"title":"Creating Insights","sidebarTitle":"Creating insights","href":"/docs/inference/ai-insights/creating-insights/index"},{"title":"AI insights use cases","sidebarTitle":"Use cases","href":"/docs/inference/ai-insights/use-cases/index"},{"title":"Structured data insights","sidebarTitle":"Structured insights","href":"/docs/inference/ai-insights/structured-insights/index"},{"title":"Insight Groups","sidebarTitle":"Insight groups","href":"/docs/inference/ai-insights/insight-groups/index"},{"title":"Telnyx-Managed Insights","sidebarTitle":"Telnyx-managed insights","href":"/docs/inference/ai-insights/telnyx-managed-insights/index"}]},{"group":"Assistants API","pages":[{"group":"Assistants API","pages":[{"title":"List assistants","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants","href":"/api-reference/assistants/list-assistants"},{"title":"Create an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants","href":"/api-reference/assistants/create-an-assistant"},{"title":"Delete an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}","href":"/api-reference/assistants/delete-an-assistant"},{"title":"List deleted assistants","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/deleted","href":"/api-reference/assistants/list-deleted-assistants"},{"title":"Get a deleted assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/deleted","href":"/api-reference/assistants/get-a-deleted-assistant"},{"title":"Restore an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/restore","href":"/api-reference/assistants/restore-an-assistant"},{"title":"Get an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}","href":"/api-reference/assistants/get-an-assistant"},{"title":"Update an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}","href":"/api-reference/assistants/update-an-assistant"},{"title":"Assistant Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat","href":"/api-reference/assistants/assistant-chat"},{"title":"Assistant Sms Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat/sms","href":"/api-reference/assistants/assistant-sms-chat"},{"title":"Assistant WhatsApp Chat","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/chat/whatsapp","href":"/api-reference/assistants/assistant-whatsapp-chat"},{"title":"Clone Assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/clone","href":"/api-reference/assistants/clone-assistant"},{"title":"Enhance Assistant Instructions","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/instructions/enhance","href":"/api-reference/assistants/enhance-assistant-instructions"},{"title":"Import assistants from external provider","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/import","href":"/api-reference/assistants/import-assistants-from-external-provider"},{"title":"List scheduled events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/scheduled_events","href":"/api-reference/assistants/list-scheduled-events"},{"title":"Create a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/scheduled_events","href":"/api-reference/assistants/create-a-scheduled-event"},{"title":"Delete a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/scheduled_events/{event_id}","href":"/api-reference/assistants/delete-a-scheduled-event"},{"title":"Get a scheduled event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/scheduled_events/{event_id}","href":"/api-reference/assistants/get-a-scheduled-event"},{"title":"List assistant tests with pagination","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests","href":"/api-reference/assistants/list-assistant-tests-with-pagination"},{"title":"Create a new assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests","href":"/api-reference/assistants/create-a-new-assistant-test"},{"title":"Get all test suite names","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/test-suites","href":"/api-reference/assistants/get-all-test-suite-names"},{"title":"Get test suite run history","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/test-suites/{suite_name}/runs","href":"/api-reference/assistants/get-test-suite-run-history"},{"title":"Trigger test suite execution","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests/test-suites/{suite_name}/runs","href":"/api-reference/assistants/trigger-test-suite-execution"},{"title":"Delete an assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/delete-an-assistant-test"},{"title":"Get assistant test by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/get-assistant-test-by-id"},{"title":"Update an assistant test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/tests/{test_id}","href":"/api-reference/assistants/update-an-assistant-test"},{"title":"Get test run history for a specific test","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}/runs","href":"/api-reference/assistants/get-test-run-history-for-a-specific-test"},{"title":"Trigger a manual test run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/tests/{test_id}/runs","href":"/api-reference/assistants/trigger-a-manual-test-run"},{"title":"Get specific test run details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tests/{test_id}/runs/{run_id}","href":"/api-reference/assistants/get-specific-test-run-details"},{"title":"Get all versions of an assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/versions","href":"/api-reference/assistants/get-all-versions-of-an-assistant"},{"title":"Delete a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/delete-a-specific-assistant-version"},{"title":"Get a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/get-a-specific-assistant-version"},{"title":"Update a specific assistant version","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/versions/{version_id}","href":"/api-reference/assistants/update-a-specific-assistant-version"},{"title":"Promote an assistant version to main","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/versions/{version_id}/promote","href":"/api-reference/assistants/promote-an-assistant-version-to-main"},{"title":"Delete Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/delete-canary-deploy"},{"title":"Get Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/get-canary-deploy"},{"title":"Create Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/create-canary-deploy"},{"title":"Update Canary Deploy","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/{assistant_id}/canary-deploys","href":"/api-reference/assistants/update-canary-deploy"},{"title":"Get assistant texml","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/{assistant_id}/texml","href":"/api-reference/assistants/get-assistant-texml"},{"title":"Test Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/tools/{tool_id}/test","href":"/api-reference/assistants/test-assistant-tool"},{"title":"Get All Tags","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/assistants/tags","href":"/api-reference/assistants/get-all-tags"},{"title":"Add Assistant Tag","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/assistants/{assistant_id}/tags","href":"/api-reference/assistants/add-assistant-tag"},{"title":"Remove Assistant Tag","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/tags/{tag}","href":"/api-reference/assistants/remove-assistant-tag"},{"title":"Remove Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/assistants/{assistant_id}/tools/{tool_id}","href":"/api-reference/assistants/remove-assistant-tool"},{"title":"Add Assistant Tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/assistants/{assistant_id}/tools/{tool_id}","href":"/api-reference/assistants/add-assistant-tool"}]},{"group":"Avatars API","pages":[{"title":"Create a custom avatar","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/avatars","href":"/api-reference/avatars/create-a-custom-avatar"},{"title":"List avatars","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/avatars","href":"/api-reference/avatars/list-avatars"},{"title":"Get an avatar","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/avatars/{avatar_id}","href":"/api-reference/avatars/get-an-avatar"},{"title":"Update a custom avatar","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json patch /ai/avatars/{avatar_id}","href":"/api-reference/avatars/update-a-custom-avatar"}]},{"group":"Conversation WebSocket","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/assistant-conversation/assistant-conversation.yml assistant-conversation-websocket","href":"/api-reference/websockets/talk-to-an-ai-assistant-over-websocket","title":"Talk to an AI Assistant over WebSocket","version":null}]}]},{"group":"Assistant Event Stream","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/assistant-events/assistant-events.yml assistant-events-websocket","href":"/api-reference/websockets/assistant-event-stream-websocket-channel","title":"Assistant event stream WebSocket channel","version":null}]}]},{"group":"Integrations API","pages":[{"title":"List Integrations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"List User Integrations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/connections","href":"/api-reference/integrations/list-user-integrations"},{"title":"Delete Integration Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/integrations/connections/{user_connection_id}","href":"/api-reference/integrations/delete-integration-connection"},{"title":"Get User Integration connection By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/connections/{user_connection_id}","href":"/api-reference/integrations/get-user-integration-connection-by-id"},{"title":"List Integration By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/integrations/{integration_id}","href":"/api-reference/integrations/list-integration-by-id"}]},{"group":"MCP Servers API","pages":[{"title":"List MCP Servers","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/mcp_servers","href":"/api-reference/mcp-servers/list-mcp-servers"},{"title":"Create MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/mcp_servers","href":"/api-reference/mcp-servers/create-mcp-server"},{"title":"Delete MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/delete-mcp-server"},{"title":"Get MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/get-mcp-server"},{"title":"Update MCP Server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/mcp_servers/{mcp_server_id}","href":"/api-reference/mcp-servers/update-mcp-server"}]}]},{"group":"Missions API","pages":[{"title":"List missions","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions","href":"/api-reference/missions/list-missions"},{"title":"Create mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions","href":"/api-reference/missions/create-mission"},{"title":"List recent events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/events","href":"/api-reference/missions/list-recent-events"},{"title":"List recent runs","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/runs","href":"/api-reference/missions/list-recent-runs"},{"title":"Delete mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}","href":"/api-reference/missions/delete-mission"},{"title":"Get mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}","href":"/api-reference/missions/get-mission"},{"title":"Update mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}","href":"/api-reference/missions/update-mission"},{"title":"Clone mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/clone","href":"/api-reference/missions/clone-mission"},{"title":"List runs for mission","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs","href":"/api-reference/missions/list-runs-for-mission"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs","href":"/api-reference/missions/start-a-run"},{"title":"Get run details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}","href":"/api-reference/missions/get-run-details"},{"title":"Update run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json patch /ai/missions/{mission_id}/runs/{run_id}","href":"/api-reference/missions/update-run"},{"title":"Cancel run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/cancel","href":"/api-reference/missions/cancel-run"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/events","href":"/api-reference/missions/list-events"},{"title":"Log event","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/events","href":"/api-reference/missions/log-event"},{"title":"Get event details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/events/{event_id}","href":"/api-reference/missions/get-event-details"},{"title":"Pause run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/pause","href":"/api-reference/missions/pause-run"},{"title":"Get plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/plan","href":"/api-reference/missions/get-plan"},{"title":"Create initial plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/plan","href":"/api-reference/missions/create-initial-plan"},{"title":"Add step(s) to plan","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/plan/steps","href":"/api-reference/missions/add-steps-to-plan"},{"title":"Get step details","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}","href":"/api-reference/missions/get-step-details"},{"title":"Update step status","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json patch /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}","href":"/api-reference/missions/update-step-status"},{"title":"Resume run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/resume","href":"/api-reference/missions/resume-run"},{"title":"List linked Telnyx agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents","href":"/api-reference/missions/list-linked-telnyx-agents"},{"title":"Link Telnyx agent to run","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents","href":"/api-reference/missions/link-telnyx-agent-to-run"},{"title":"Unlink Telnyx agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}","href":"/api-reference/missions/unlink-telnyx-agent"},{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/knowledge-bases","href":"/api-reference/missions/list-knowledge-bases"},{"title":"Create knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/knowledge-bases","href":"/api-reference/missions/create-knowledge-base"},{"title":"Delete knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/delete-knowledge-base"},{"title":"Get knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/get-knowledge-base"},{"title":"Update knowledge base","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}","href":"/api-reference/missions/update-knowledge-base"},{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/mcp-servers","href":"/api-reference/missions/list-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/mcp-servers","href":"/api-reference/missions/create-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/delete-mcp-server"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/get-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}","href":"/api-reference/missions/update-mcp-server"},{"title":"List tools","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/tools","href":"/api-reference/missions/list-tools"},{"title":"Create tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json post /ai/missions/{mission_id}/tools","href":"/api-reference/missions/create-tool"},{"title":"Delete tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json delete /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/delete-tool"},{"title":"Get tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json get /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/get-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-missions.json put /ai/missions/{mission_id}/tools/{tool_id}","href":"/api-reference/missions/update-tool"}]},{"group":"AI Tests API","pages":[{"title":"List test agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/aiagents","href":"/api-reference/ai-tests/list-test-agents"},{"title":"Create a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/aiagents","href":"/api-reference/ai-tests/create-a-test-agent"},{"title":"Delete a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/delete-a-test-agent"},{"title":"Retrieve a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/retrieve-a-test-agent"},{"title":"Update a test agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json put /ai/tests/test_framework/v1/aiagents/{id}","href":"/api-reference/ai-tests/update-a-test-agent"},{"title":"List test personalities","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/personalities","href":"/api-reference/ai-tests/list-test-personalities"},{"title":"List test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics","href":"/api-reference/ai-tests/list-test-metrics"},{"title":"Create a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics","href":"/api-reference/ai-tests/create-a-test-metric"},{"title":"Bulk create test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics/bulk_create","href":"/api-reference/ai-tests/bulk-create-test-metrics"},{"title":"Generate test metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/metrics/generate_metrics","href":"/api-reference/ai-tests/generate-test-metrics"},{"title":"Get test metric generation progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics/generate_metrics_progress","href":"/api-reference/ai-tests/get-test-metric-generation-progress"},{"title":"Delete a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/delete-a-test-metric"},{"title":"Retrieve a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/retrieve-a-test-metric"},{"title":"Update a test metric","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/test_framework/v1/metrics/{id}","href":"/api-reference/ai-tests/update-a-test-metric"},{"title":"List evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios","href":"/api-reference/ai-tests/list-evaluator-scenarios"},{"title":"Create an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios","href":"/api-reference/ai-tests/create-an-evaluator-scenario"},{"title":"Delete an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/delete-an-evaluator-scenario"},{"title":"Retrieve an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/retrieve-an-evaluator-scenario"},{"title":"Update an evaluator scenario","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/test_framework/v1/scenarios/{id}","href":"/api-reference/ai-tests/update-an-evaluator-scenario"},{"title":"Generate evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/generate-bg","href":"/api-reference/ai-tests/generate-evaluator-scenarios"},{"title":"Get scenario generation progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/generate-progress","href":"/api-reference/ai-tests/get-scenario-generation-progress"},{"title":"Run evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/run_scenarios","href":"/api-reference/ai-tests/run-evaluator-scenarios"},{"title":"Get improve-scenarios progress","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/scenario-agent-progress","href":"/api-reference/ai-tests/get-improve-scenarios-progress"},{"title":"Improve evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/scenarios/scenario-agent","href":"/api-reference/ai-tests/improve-evaluator-scenarios"},{"title":"Export evaluator scenarios","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/scenarios/export_scenarios","href":"/api-reference/ai-tests/export-evaluator-scenarios"},{"title":"List test run results","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/results","href":"/api-reference/ai-tests/list-test-run-results"},{"title":"Delete a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/test_framework/v1/results/{id}","href":"/api-reference/ai-tests/delete-a-test-run-result"},{"title":"Retrieve a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/test_framework/v1/results/{id}","href":"/api-reference/ai-tests/retrieve-a-test-run-result"},{"title":"Rerun a test run result","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/test_framework/v1/results/{id}/rerun","href":"/api-reference/ai-tests/rerun-a-test-run-result"},{"title":"List scheduled test jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/schedules/v1/cron-jobs","href":"/api-reference/ai-tests/list-scheduled-test-jobs"},{"title":"Create a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json post /ai/tests/schedules/v1/cron-jobs","href":"/api-reference/ai-tests/create-a-scheduled-test-job"},{"title":"Delete a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json delete /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/delete-a-scheduled-test-job"},{"title":"Retrieve a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json get /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/retrieve-a-scheduled-test-job"},{"title":"Update a scheduled test job","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-ai-tests.json patch /ai/tests/schedules/v1/cron-jobs/{id}","href":"/api-reference/ai-tests/update-a-scheduled-test-job"}]},{"group":"Conversations API","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Create a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations","href":"/api-reference/conversations/create-a-conversation"},{"title":"Aggregate Conversation Insights","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/conversation-insights/aggregates","href":"/api-reference/conversations/aggregate-conversation-insights"},{"title":"Get Insight Template Groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insight-groups","href":"/api-reference/conversations/get-insight-template-groups"},{"title":"Create Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insight-groups","href":"/api-reference/conversations/create-insight-template-group"},{"title":"Delete Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/delete-insight-template-group"},{"title":"Get Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/get-insight-template-group"},{"title":"Update Insight Template Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/insight-groups/{group_id}","href":"/api-reference/conversations/update-insight-template-group"},{"title":"Assign Insight Template To Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign","href":"/api-reference/conversations/assign-insight-template-to-group"},{"title":"Unassign Insight Template From Group","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign","href":"/api-reference/conversations/unassign-insight-template-from-group"},{"title":"Get Insight Templates","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insights","href":"/api-reference/conversations/get-insight-templates"},{"title":"Create Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/insights","href":"/api-reference/conversations/create-insight-template"},{"title":"Delete Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/delete-insight-template"},{"title":"Get Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/get-insight-template"},{"title":"Update Insight Template","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/insights/{insight_id}","href":"/api-reference/conversations/update-insight-template"},{"title":"Delete a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/{conversation_id}","href":"/api-reference/conversations/delete-a-conversation"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"Update conversation metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json put /ai/conversations/{conversation_id}","href":"/api-reference/conversations/update-conversation-metadata"},{"title":"Get insights for a conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}/conversations-insights","href":"/api-reference/conversations/get-insights-for-a-conversation"},{"title":"Delete a conversation's insight generation results","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json delete /ai/conversations/{conversation_id}/conversations-insights/{insight_id}","href":"/api-reference/conversations/delete-a-conversations-insight-generation-results"},{"title":"Create Message","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/conversations/{conversation_id}/message","href":"/api-reference/conversations/create-message"},{"title":"Get conversation messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json get /ai/conversations/{conversation_id}/messages","href":"/api-reference/conversations/get-conversation-messages"}]},{"group":"For AI Agents","pages":[{"title":"Assistants llms.txt","sidebarTitle":"Assistants llms txt","href":"/docs/development/llms/ai-assistants-llms-txt/index"},{"title":"Assistants llms-full.txt","sidebarTitle":"Assistants llms full txt","href":"/docs/development/llms/ai-assistants-llms-full-txt/index"}]}]},{"tab":"LiveKit on Telnyx (Beta)","icon":"waveform-lines","groups":[{"group":"LiveKit on Telnyx (Beta)","pages":[{"title":"LiveKit on Telnyx overview","sidebarTitle":"Overview","tag":"Beta","href":"/docs/livekit/index"},{"title":"Compatibility","sidebarTitle":"Compatibility","href":"/docs/livekit/compatibility"},{"title":"LiveKit on Telnyx quick start","sidebarTitle":"Quick Start","href":"/docs/livekit/quickstart"},{"title":"Connect to Telnyx","sidebarTitle":"Connect","href":"/docs/livekit/connect"}]},{"group":"Migration","pages":[{"title":"Migrate from LiveKit Cloud","sidebarTitle":"From LiveKit Cloud","href":"/docs/livekit/migration/from-livekit-cloud"},{"title":"Migrate from Self-Hosted","sidebarTitle":"From Self-Hosted","href":"/docs/livekit/migration/from-self-hosted"}]},{"group":"Build","pages":[{"title":"Build","href":"/docs/livekit/build/index"}]},{"group":"Deploy","pages":[{"title":"Deploy","sidebarTitle":"Deploy","href":"/docs/livekit/deploy/index"},{"title":"LiveKit agent deployment configuration","sidebarTitle":"Configuration","href":"/docs/livekit/deploy/configuration"},{"title":"LiveKit agent secrets management","sidebarTitle":"Secrets","href":"/docs/livekit/deploy/secrets"},{"title":"Management \u0026 Access","sidebarTitle":"Management \u0026 Access","href":"/docs/livekit/deploy/management"}]},{"group":"Plugin Reference","pages":[{"title":"LiveKit models overview","sidebarTitle":"Overview","href":"/docs/livekit/models/index"},{"title":"Speech-to-Text (STT)","sidebarTitle":"STT","href":"/docs/livekit/models/stt"},{"title":"Text-to-Speech (TTS)","sidebarTitle":"TTS","href":"/docs/livekit/models/tts"},{"title":"Large Language Models (LLM)","sidebarTitle":"LLM","href":"/docs/livekit/models/llm"}]},{"group":"Observability","pages":[{"title":"LiveKit on Telnyx observability","sidebarTitle":"Observability","href":"/docs/livekit/observability/index"}]},{"group":"Telephony","pages":[{"title":"Telephony","sidebarTitle":"Telephony","href":"/docs/livekit/telephony"}]},{"group":"Reference","pages":[{"title":"LiveKit on Telnyx architecture","sidebarTitle":"Architecture","href":"/docs/livekit/architecture"},{"title":"Regions","sidebarTitle":"Regions","href":"/docs/livekit/regions"},{"title":"LiveKit on Telnyx limits and quotas","sidebarTitle":"Limits","href":"/docs/livekit/limits"}]},{"group":"For AI Agents","pages":[{"title":"LiveKit on Telnyx (Beta) llms.txt","sidebarTitle":"LiveKit on Telnyx (Beta) llms txt","href":"/docs/development/llms/ai-livekit-llms-txt/index"},{"title":"LiveKit on Telnyx (Beta) llms-full.txt","sidebarTitle":"LiveKit on Telnyx (Beta) llms full txt","href":"/docs/development/llms/ai-livekit-llms-full-txt/index"}]}]},{"tab":"Web Search","icon":"globe","groups":[{"group":"Web Search","pages":[{"title":"Web Search Overview","sidebarTitle":"Overview","href":"/docs/web-search/index"},{"title":"Get Started","href":"/docs/web-search/getting-started"}]},{"group":"Features","pages":[{"title":"Web Search","href":"/docs/web-search/web-search"},{"title":"Content Retrieval","href":"/docs/web-search/contents"},{"title":"Research","href":"/docs/web-search/research"}]},{"group":"API Reference","pages":[{"group":"Web Search","pages":[{"title":"Web search","deprecated":null,"version":null,"openapi":"/openapi/source/external/web-search/web-search.json post /web_search","href":"/api-reference/web-search/web-search"}]},{"group":"Contents","pages":[{"title":"Retrieve page contents","deprecated":null,"version":null,"openapi":"/openapi/source/external/web-search/web-search.json post /web_search/contents","href":"/api-reference/contents/retrieve-page-contents"}]},{"group":"Research","pages":[{"title":"Start research task","deprecated":null,"version":null,"openapi":"/openapi/source/external/web-search/web-search.json post /web_search/research","href":"/api-reference/research/start-research-task"},{"title":"Get research task status","deprecated":null,"version":null,"openapi":"/openapi/source/external/web-search/web-search.json get /web_search/research/{task_id}","href":"/api-reference/research/get-research-task-status"}]}]},{"group":"For AI Agents","pages":[{"title":"Web Search llms.txt","sidebarTitle":"Web Search llms txt","href":"/docs/development/llms/agent-tools-web-search-llms-txt/index"},{"title":"Web Search llms-full.txt","sidebarTitle":"Web Search llms full txt","href":"/docs/development/llms/agent-tools-web-search-llms-full-txt/index"}]}]},{"tab":"AI Search","icon":"magnifying-glass","groups":[{"group":"AI Search","tag":"Beta","pages":[{"title":"AI Search Overview","sidebarTitle":"Overview","href":"/docs/ai-search/index"},{"title":"Get Started","href":"/docs/ai-search/get-started"},{"title":"Search","href":"/docs/ai-search/searching"}]},{"group":"Concepts","pages":[{"title":"How AI Search Works","href":"/docs/ai-search/how-it-works"},{"title":"Search Modes","href":"/docs/ai-search/search-modes"}]},{"group":"Configuration","pages":[{"title":"Collections","href":"/docs/ai-search/manage-collections"},{"group":"Sources","pages":[{"title":"Sources","sidebarTitle":"Overview","href":"/docs/ai-search/sources/index"},{"title":"Voice","href":"/docs/ai-search/sources/voice"}]},{"title":"Settings","href":"/docs/ai-search/settings"}]},{"group":"API","pages":[{"group":"Collections","pages":[{"title":"Create a collection","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json post /ai/collections","href":"/api-reference/ai-collections/create-a-collection"},{"title":"List collections","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/collections","href":"/api-reference/ai-collections/list-collections"},{"title":"Get a collection by slug","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/collections/slug/{slug}","href":"/api-reference/ai-collections/get-a-collection-by-slug"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/collections/{uuid}","href":"/api-reference/ai-collections/get-a-collection"},{"title":"Update a collection","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json patch /ai/collections/{uuid}","href":"/api-reference/ai-collections/update-a-collection"},{"title":"Delete a collection","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json delete /ai/collections/{uuid}","href":"/api-reference/ai-collections/delete-a-collection"}]},{"group":"Sources","pages":[{"title":"List collection sources","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/collections/{uuid}/sources","href":"/api-reference/ai-collections/list-collection-sources"},{"title":"Add a collection source","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json post /ai/collections/{uuid}/sources","href":"/api-reference/ai-collections/add-a-collection-source"},{"title":"Replace collection sources","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json put /ai/collections/{uuid}/sources","href":"/api-reference/ai-collections/replace-collection-sources"},{"title":"Remove a collection source","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json delete /ai/collections/{uuid}/sources/{sourceId}","href":"/api-reference/ai-collections/remove-a-collection-source"}]},{"group":"Settings","pages":[{"title":"Get collection settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/collections/{uuid}/settings","href":"/api-reference/ai-collections/get-collection-settings"},{"title":"Replace collection settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json put /ai/collections/{uuid}/settings","href":"/api-reference/ai-collections/replace-collection-settings"},{"title":"Update collection settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json patch /ai/collections/{uuid}/settings","href":"/api-reference/ai-collections/update-collection-settings"}]},{"group":"Search","pages":[{"title":"Search collection documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/collections/collections.json get /ai/knowledge/collections/{slug}/documents","href":"/api-reference/ai-collections/search-collection-documents"}]}]},{"group":"For AI Agents","pages":[{"title":"AI Search llms.txt","sidebarTitle":"AI Search llms txt","href":"/docs/development/llms/agent-tools-ai-search-llms-txt/index"},{"title":"AI Search llms-full.txt","sidebarTitle":"AI Search llms full txt","href":"/docs/development/llms/agent-tools-ai-search-llms-full-txt/index"}]}]},{"tab":"Meeting","icon":"video","groups":[{"group":"Meeting","pages":[{"title":"Meeting Overview","sidebarTitle":"Overview","href":"/docs/meeting/index"},{"title":"Meeting Quick Start","sidebarTitle":"Quick Start","href":"/docs/meeting/quick-start"},{"title":"Meeting Pricing","sidebarTitle":"Pricing","href":"/docs/meeting/pricing"}]},{"group":"Join a Meeting","pages":[{"title":"Join a Meeting","href":"/docs/meeting/join-meeting/index"},{"title":"Join with a Meeting URL","sidebarTitle":"Meeting URL","href":"/docs/meeting/join-meeting/meeting-url"},{"title":"Calendar Auto-join","sidebarTitle":"Calendar Auto-join","href":"/docs/meeting/join-meeting/calendar-auto-join"},{"title":"Announce the Bot on Arrival","href":"/docs/meeting/join-meeting/introductions"}]},{"group":"During the Meeting","pages":[{"title":"Live Transcript","href":"/docs/meeting/live-transcript"},{"title":"Recording","href":"/docs/meeting/recording"},{"group":"Meeting Presence","pages":[{"title":"Meeting bot roster name, identity, and introductions","sidebarTitle":"Meeting Presence","href":"/docs/meeting/presence/index"},{"group":"Identity","pages":[{"title":"Still Images","href":"/docs/meeting/presence/still-images"},{"title":"Digital Avatars","tag":"Beta","href":"/docs/meeting/digital-avatars"}]}]},{"group":"Controlling the Bot","pages":[{"title":"Control the meeting bot: speak, chat, and automate","sidebarTitle":"Controlling the Bot","href":"/docs/meeting/control/index"},{"group":"Manually","pages":[{"title":"Speak","href":"/docs/meeting/control/speak"},{"title":"Chat","href":"/docs/meeting/control/chat"}]},{"title":"Telnyx AI Assistants","href":"/docs/meeting/ai-assistants"}]}]},{"group":"After the Meeting","pages":[{"title":"Collect Results","href":"/docs/meeting/collect-results"}]},{"group":"Integration","pages":[{"title":"Session Events","sidebarTitle":"Events","href":"/docs/meeting/events"},{"title":"Webhooks","href":"/docs/meeting/webhooks"},{"title":"Meeting API Errors","sidebarTitle":"API Errors","href":"/docs/meeting/errors"},{"title":"Meeting MCP Server","sidebarTitle":"MCP Server","href":"/docs/meeting/mcp"}]},{"group":"API Reference","pages":[{"group":"Meeting Sessions","pages":[{"title":"Create a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json post /meeting_sessions","href":"/api-reference/meeting-sessions/create-a-meeting-session"},{"title":"List meeting sessions","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions","href":"/api-reference/meeting-sessions/list-meeting-sessions"},{"title":"Retrieve a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions/{id}","href":"/api-reference/meeting-sessions/retrieve-a-meeting-session"},{"title":"Update a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json patch /meeting_sessions/{id}","href":"/api-reference/meeting-sessions/update-a-meeting-session"},{"title":"Delete a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json delete /meeting_sessions/{id}","href":"/api-reference/meeting-sessions/delete-a-meeting-session"}]},{"group":"Actions","pages":[{"title":"Speak in a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json post /meeting_sessions/{id}/actions/speak","href":"/api-reference/meeting-session-actions/speak-in-a-meeting-session"},{"title":"Stop speaking in a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json post /meeting_sessions/{id}/actions/stop_speaking","href":"/api-reference/meeting-session-actions/stop-speaking-in-a-meeting-session"},{"title":"Send chat in a meeting session","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json post /meeting_sessions/{id}/actions/send_chat","href":"/api-reference/meeting-session-actions/send-chat-in-a-meeting-session"}]},{"group":"Events","pages":[{"title":"List meeting session events","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions/{id}/events","href":"/api-reference/meeting-session-data/list-meeting-session-events"}]},{"group":"Transcript","pages":[{"title":"List meeting session transcript","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions/{id}/transcript","href":"/api-reference/meeting-session-data/list-meeting-session-transcript"}]},{"group":"Recordings","pages":[{"title":"Delete meeting session recording media","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json delete /meeting_sessions/{id}/recording_media","href":"/api-reference/meeting-session-data/delete-meeting-session-recording-media"}]},{"group":"Artifacts","pages":[{"title":"Create a meeting session artifact","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json post /meeting_sessions/{id}/artifacts","href":"/api-reference/meeting-session-artifacts/create-a-meeting-session-artifact"},{"title":"List meeting session artifacts","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions/{id}/artifacts","href":"/api-reference/meeting-session-artifacts/list-meeting-session-artifacts"},{"title":"Retrieve a meeting session artifact","deprecated":null,"version":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json get /meeting_sessions/{id}/artifacts/{artifact_id}","href":"/api-reference/meeting-session-artifacts/retrieve-a-meeting-session-artifact"}]},{"group":"Webhook Events","pages":[{"title":"Sessionstatus changed","version":null,"deprecated":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json webhook sessionStatusChanged","href":"/api-reference/meeting-session-webhooks/sessionstatus_changed"},{"title":"Transcriptcompleted","version":null,"deprecated":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json webhook transcriptCompleted","href":"/api-reference/meeting-session-webhooks/transcriptcompleted"},{"title":"Artifactcompleted","version":null,"deprecated":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json webhook artifactCompleted","href":"/api-reference/meeting-session-webhooks/artifactcompleted"},{"title":"Artifactfailed","version":null,"deprecated":null,"openapi":"/openapi/source/external/meeting-sessions/meeting-sessions.json webhook artifactFailed","href":"/api-reference/meeting-session-webhooks/artifactfailed"}]}]},{"group":"WebSocket","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/meeting-session-stream/meeting-session-stream.yml meeting-session-stream","href":"/api-reference/websockets/meeting-session-agent-stream","title":"Meeting Session agent stream","version":null}]}]},{"group":"For AI Agents","pages":[{"title":"Meeting llms.txt","sidebarTitle":"Meeting llms txt","href":"/docs/development/llms/agent-tools-meeting-beta-llms-txt/index"},{"title":"Meeting llms-full.txt","sidebarTitle":"Meeting llms full txt","href":"/docs/development/llms/agent-tools-meeting-beta-llms-full-txt/index"}]}]}]},{"product":"Voice","icon":"waveform","tabs":[{"tab":"Overview","icon":"eye","groups":[{"group":" ","pages":[{"title":"Voice","sidebarTitle":"Overview","href":"/docs/voice/overview"}]},{"group":"For AI Agents","pages":[{"title":"Overview llms.txt","sidebarTitle":"Overview llms txt","href":"/docs/development/llms/voice-overview-llms-txt/index"},{"title":"Overview llms-full.txt","sidebarTitle":"Overview llms full txt","href":"/docs/development/llms/voice-overview-llms-full-txt/index"}]}]},{"tab":"STT","icon":"microphone","groups":[{"group":" ","pages":[{"title":"Speech-to-Text","sidebarTitle":"Overview","href":"/docs/voice/stt/overview"},{"title":"Speech-to-Text quickstart","sidebarTitle":"Quickstart","href":"/docs/voice/stt/getting-started/index"},{"title":"Models \u0026 Engines","sidebarTitle":"Models","href":"/docs/voice/stt/models/index"},{"title":"Migrate to Telnyx STT","sidebarTitle":"Migration","href":"/docs/voice/stt/migration/index"}]},{"group":"WebSocket","pages":[{"title":"Speech-to-Text WebSocket lifecycle","sidebarTitle":"Lifecycle","href":"/docs/voice/stt/websocket-streaming/index"},{"group":"Parameters","pages":[{"title":"Speech-to-Text WebSocket parameters","sidebarTitle":"Overview","href":"/docs/voice/stt/websocket-streaming/parameters/index"},{"title":"Speech-to-Text WebSocket audio formats","sidebarTitle":"Audio Formats","href":"/docs/voice/stt/websocket-streaming/parameters/audio-formats"},{"title":"Engines \u0026 Models","sidebarTitle":"Engines \u0026 Models","href":"/docs/voice/stt/websocket-streaming/parameters/engines-and-models"},{"title":"End-of-Turn Detection","sidebarTitle":"End-of-Turn Detection","href":"/docs/voice/stt/websocket-streaming/parameters/end-of-turn"},{"title":"Language","sidebarTitle":"Language","href":"/docs/voice/stt/websocket-streaming/parameters/language"},{"title":"Interim Results","sidebarTitle":"Interim Results","href":"/docs/voice/stt/websocket-streaming/parameters/interim-results"},{"title":"Endpointing","sidebarTitle":"Endpointing","href":"/docs/voice/stt/websocket-streaming/parameters/endpointing"},{"title":"Keyword Boosting","sidebarTitle":"Keyword Boosting","href":"/docs/voice/stt/websocket-streaming/parameters/keyword-boosting"},{"title":"Redaction","sidebarTitle":"Redaction","href":"/docs/voice/stt/websocket-streaming/parameters/redaction"},{"title":"Noise suppression","sidebarTitle":"Noise Suppression","href":"/docs/voice/stt/websocket-streaming/parameters/noise-suppression"}]},{"title":"Speech-to-Text WebSocket messages","sidebarTitle":"Messages","href":"/docs/voice/stt/websocket-streaming/responses"},{"title":"Speech-to-Text WebSocket errors","sidebarTitle":"Errors","href":"/docs/voice/stt/websocket-streaming/errors"},{"title":"Speech-to-Text WebSocket streaming examples","sidebarTitle":"Examples","href":"/docs/voice/stt/websocket-streaming/examples"},{"title":"Production Patterns","sidebarTitle":"Production Patterns","href":"/docs/voice/stt/websocket-streaming/production-patterns"},{"title":"Speech-to-Text WebSocket streaming pricing","sidebarTitle":"Pricing","href":"/docs/voice/stt/websocket-streaming/pricing"},{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/speech-to-text-websockets/speech-to-text-websockets.yml speech-to-text-websockets","href":"/api-reference/websockets/stream-speech-to-text-over-websocket","title":"Stream speech to text over WebSocket","version":null}]}]},{"group":"REST API","pages":[{"title":"Speech-to-Text REST API overview","sidebarTitle":"Overview","href":"/docs/voice/stt/rest-api/index"},{"group":"Request Body","pages":[{"title":"Speech-to-Text REST API parameters","sidebarTitle":"Overview","href":"/docs/voice/stt/rest-api/parameters/index"},{"title":"Speech-to-Text REST API models","sidebarTitle":"Models","href":"/docs/voice/stt/rest-api/parameters/models"},{"title":"Speech-to-Text REST API audio formats","sidebarTitle":"Audio Formats","href":"/docs/voice/stt/rest-api/parameters/audio-formats"},{"title":"Model Config","sidebarTitle":"Model Config","href":"/docs/voice/stt/rest-api/parameters/model-config"},{"title":"Response Format","sidebarTitle":"Response Format","href":"/docs/voice/stt/rest-api/parameters/response"}]},{"title":"Speech-to-Text REST API pricing","sidebarTitle":"Pricing","href":"/docs/voice/stt/rest-api/pricing"},{"group":"API Reference","pages":[{"title":"Transcribe speech to text","deprecated":null,"version":null,"openapi":"/openapi/source/external/inference/inference-embedding.json post /ai/audio/transcriptions","href":"/api-reference/audio/transcribe-speech-to-text"},{"group":"Speech To Text Capabilities API","pages":[{"title":"List supported STT providers","deprecated":null,"version":null,"openapi":"/openapi/source/external/speech-to-text/speech-to-text.json get /speech-to-text/providers","href":"/api-reference/speech-to-text-capabilities/list-supported-stt-providers"}]}]}]},{"group":"In-Call","pages":[{"title":"In-Call Transcription","sidebarTitle":"In-Call Transcription","href":"/docs/voice/stt/in-call-transcription/index"}]},{"group":"For AI Agents","pages":[{"title":"STT llms.txt","sidebarTitle":"STT llms txt","href":"/docs/development/llms/voice-stt-llms-txt/index"},{"title":"STT llms-full.txt","sidebarTitle":"STT llms full txt","href":"/docs/development/llms/voice-stt-llms-full-txt/index"}]}]},{"tab":"TTS","icon":"waveform","groups":[{"group":" ","pages":[{"title":"Text-to-Speech Overview","sidebarTitle":"Overview","href":"/docs/voice/tts/overview"},{"title":"Programmable Voice TTS voices","sidebarTitle":"Text-to-Speech Available Voices","href":"/docs/voice/tts/available-voices/index"}]},{"group":"WebSocket Streaming","pages":[{"title":"Text-to-Speech WebSocket lifecycle","sidebarTitle":"Lifecycle","href":"/docs/voice/tts/websocket-streaming/index"},{"title":"Text-to-Speech WebSocket configuration","sidebarTitle":"Configuration","href":"/docs/voice/tts/websocket-streaming/configuration"},{"title":"Text-to-Speech WebSocket messages","sidebarTitle":"Messages","href":"/docs/voice/tts/websocket-streaming/messages"},{"title":"Text-to-Speech WebSocket errors","sidebarTitle":"Errors","href":"/docs/voice/tts/websocket-streaming/errors"},{"title":"Text-to-Speech WebSocket streaming examples","sidebarTitle":"Examples","href":"/docs/voice/tts/websocket-streaming/examples"},{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/text-to-speech-websockets/text-to-speech-websockets.yml text-to-speech-websockets","href":"/api-reference/websockets/stream-text-to-speech-over-websocket","title":"Stream text to speech over WebSocket","version":null}]}]},{"group":"REST API","pages":[{"title":"REST API","sidebarTitle":"Overview","href":"/docs/voice/tts/rest-api/index"},{"title":"Request","sidebarTitle":"Request","href":"/docs/voice/tts/rest-api/request"},{"title":"Response","sidebarTitle":"Response","href":"/docs/voice/tts/rest-api/response"},{"title":"Text-to-Speech REST API examples","sidebarTitle":"Examples","href":"/docs/voice/tts/rest-api/examples"},{"title":"Text-to-Speech REST API reference","sidebarTitle":"API Reference","href":"/docs/voice/tts/rest-api/api-reference"}]},{"group":"Providers","pages":[{"group":"Telnyx","pages":[{"title":"Telnyx native TTS provider","sidebarTitle":"Overview","href":"/docs/voice/tts/providers/telnyx/index"},{"title":"KokoroTTS","sidebarTitle":"KokoroTTS","href":"/docs/voice/tts/providers/telnyx/kokoro"},{"title":"Qwen3TTS","sidebarTitle":"Qwen3TTS","href":"/docs/voice/tts/providers/telnyx/qwen3"},{"title":"Ultra","sidebarTitle":"Ultra","href":"/docs/voice/tts/providers/telnyx/ultra"},{"title":"xAI Grok Voices","sidebarTitle":"Grok","href":"/docs/voice/tts/providers/telnyx/grok"},{"title":"Bayan","sidebarTitle":"Bayan","href":"/docs/voice/tts/providers/telnyx/bayan"},{"title":"Sukhan","sidebarTitle":"Sukhan","href":"/docs/voice/tts/providers/telnyx/sukhan"}]},{"title":"Minimax TTS provider","sidebarTitle":"Minimax","href":"/docs/voice/tts/providers/minimax"},{"title":"Resemble TTS provider","sidebarTitle":"Resemble","href":"/docs/voice/tts/providers/resemble"},{"title":"Inworld TTS provider","sidebarTitle":"Inworld","href":"/docs/voice/tts/providers/inworld"},{"title":"xAI","sidebarTitle":"xAI","href":"/docs/voice/tts/providers/xai"},{"title":"Fish Audio TTS provider","sidebarTitle":"Fish Audio","href":"/docs/voice/tts/providers/fishaudio"},{"title":"Soniox","sidebarTitle":"Soniox","href":"/docs/voice/tts/providers/soniox"},{"title":"AssemblyAI","sidebarTitle":"AssemblyAI","href":"/docs/voice/tts/providers/assemblyai"},{"group":"AWS Polly","pages":[{"title":"AWS Polly TTS provider","sidebarTitle":"AWS Polly","href":"/docs/voice/tts/providers/aws/index"},{"title":"SSML Tags","sidebarTitle":"SSML Tags","href":"/docs/voice/tts/providers/aws/ssml-tags"}]},{"title":"Azure Speech TTS provider","sidebarTitle":"Azure","href":"/docs/voice/tts/providers/azure"},{"title":"ElevenLabs TTS provider","sidebarTitle":"ElevenLabs","href":"/docs/voice/tts/providers/elevenlabs"}]},{"group":"Other","pages":[{"title":"Pronunciation Dictionaries","sidebarTitle":"Pronunciation Dictionaries","href":"/docs/voice/tts/pronunciation-dictionaries/index"},{"title":"In-Call Playback","sidebarTitle":"In-Call Playback","href":"/docs/voice/tts/in-call-playback/index"},{"title":"Text-to-Speech REST API pricing","sidebarTitle":"Pricing","href":"/docs/voice/tts/rest-api/pricing"}]},{"group":"API Reference","pages":[{"title":"List available voices","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/text-to-speech.json get /text-to-speech/voices","href":"/api-reference/text-to-speech-commands/list-available-voices"},{"group":"Pronunciation Dictionaries API","pages":[{"title":"Create a pronunciation dictionary","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/pronunciation-dicts.json post /pronunciation_dicts","href":"/api-reference/pronunciation-dictionaries/create-a-pronunciation-dictionary"},{"title":"List pronunciation dictionaries","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/pronunciation-dicts.json get /pronunciation_dicts","href":"/api-reference/pronunciation-dictionaries/list-pronunciation-dictionaries"},{"title":"Get a pronunciation dictionary","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/pronunciation-dicts.json get /pronunciation_dicts/{id}","href":"/api-reference/pronunciation-dictionaries/get-a-pronunciation-dictionary"},{"title":"Update a pronunciation dictionary","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/pronunciation-dicts.json patch /pronunciation_dicts/{id}","href":"/api-reference/pronunciation-dictionaries/update-a-pronunciation-dictionary"},{"title":"Delete a pronunciation dictionary","deprecated":null,"version":null,"openapi":"/openapi/source/external/text-to-speech/pronunciation-dicts.json delete /pronunciation_dicts/{id}","href":"/api-reference/pronunciation-dictionaries/delete-a-pronunciation-dictionary"}]}]},{"group":"For AI Agents","pages":[{"title":"TTS llms.txt","sidebarTitle":"TTS llms txt","href":"/docs/development/llms/voice-tts-llms-txt/index"},{"title":"TTS llms-full.txt","sidebarTitle":"TTS llms full txt","href":"/docs/development/llms/voice-tts-llms-full-txt/index"}]}]},{"tab":"Noise Suppression","icon":"wand-magic-sparkles","groups":[{"group":"WebSocket","pages":[{"title":"Noise Suppression WebSocket API","sidebarTitle":"Overview","href":"/docs/voice/noise-suppression/websocket-streaming"},{"title":"Noise Suppression WebSocket examples","sidebarTitle":"Examples","href":"/docs/voice/noise-suppression/websocket-streaming/examples"},{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/noise-suppression-websockets/noise-suppression-websockets.yml noise-suppression-websockets","href":"/api-reference/websockets/remove-background-noise-over-websocket","title":"Remove background noise over WebSocket","version":null}]}]},{"group":"For AI Agents","pages":[{"title":"Noise Suppression llms.txt","sidebarTitle":"Noise Suppression llms txt","href":"/docs/development/llms/voice-noise-suppression-llms-txt/index"},{"title":"Noise Suppression llms-full.txt","sidebarTitle":"Noise Suppression llms full txt","href":"/docs/development/llms/voice-noise-suppression-llms-full-txt/index"}]}]},{"tab":"Voice Design","icon":"clone","groups":[{"group":" ","pages":[{"title":"Voice Design","sidebarTitle":"Overview","href":"/docs/voice/voice-design-lab"}]},{"group":"Design a Voice","pages":[{"title":"Design a Voice from a Prompt","sidebarTitle":"Overview","href":"/docs/voice/voice-design-lab/design-voice/concepts/index"},{"title":"Design a Voice — Quickstart","sidebarTitle":"Quickstart","href":"/docs/voice/voice-design-lab/design-voice/quickstart/index"},{"title":"Voice Design API parameters","sidebarTitle":"Parameters","href":"/docs/voice/voice-design-lab/design-voice/api-details/index"},{"title":"How to Write Effective Prompts","sidebarTitle":"Prompting Guide","href":"/docs/voice/voice-design-lab/design-voice/prompting-guide/index"},{"group":"API Reference","pages":[{"title":"List voice designs","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs","href":"/api-reference/voice-designs/list-voice-designs"},{"title":"Create or add a version to a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_designs","href":"/api-reference/voice-designs/create-or-add-a-version-to-a-voice-design"},{"title":"Get a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}","href":"/api-reference/voice-designs/get-a-voice-design"},{"title":"Rename a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_designs/{id}","href":"/api-reference/voice-designs/rename-a-voice-design"},{"title":"Delete a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}","href":"/api-reference/voice-designs/delete-a-voice-design"},{"title":"Download voice design audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}/sample","href":"/api-reference/voice-designs/download-voice-design-audio-sample"},{"title":"Delete a specific version of a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}/versions/{version}","href":"/api-reference/voice-designs/delete-a-specific-version-of-a-voice-design"}]},{"group":"Voice Designs API","pages":[{"title":"List voice designs","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs","href":"/api-reference/voice-designs/list-voice-designs"},{"title":"Create or add a version to a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_designs","href":"/api-reference/voice-designs/create-or-add-a-version-to-a-voice-design"},{"title":"Get a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}","href":"/api-reference/voice-designs/get-a-voice-design"},{"title":"Rename a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_designs/{id}","href":"/api-reference/voice-designs/rename-a-voice-design"},{"title":"Delete a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}","href":"/api-reference/voice-designs/delete-a-voice-design"},{"title":"Download voice design audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}/sample","href":"/api-reference/voice-designs/download-voice-design-audio-sample"},{"title":"Delete a specific version of a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}/versions/{version}","href":"/api-reference/voice-designs/delete-a-specific-version-of-a-voice-design"}]},{"group":"Voice Clones API","pages":[{"title":"List voice clones","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones","href":"/api-reference/voice-clones/list-voice-clones"},{"title":"Create a voice clone from a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones","href":"/api-reference/voice-clones/create-a-voice-clone-from-a-voice-design"},{"title":"Create a voice clone from an audio file upload","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones/from_upload","href":"/api-reference/voice-clones/create-a-voice-clone-from-an-audio-file-upload"},{"title":"Update a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_clones/{id}","href":"/api-reference/voice-clones/update-a-voice-clone"},{"title":"Delete a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_clones/{id}","href":"/api-reference/voice-clones/delete-a-voice-clone"},{"title":"Download voice clone audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones/{id}/sample","href":"/api-reference/voice-clones/download-voice-clone-audio-sample"}]}]},{"group":"Clone from Audio","pages":[{"title":"Clone from Audio","sidebarTitle":"Overview","href":"/docs/voice/voice-design-lab/clone-voice/concepts/index"},{"title":"Clone from Audio — Quickstart","sidebarTitle":"Quickstart","href":"/docs/voice/voice-design-lab/clone-voice/quickstart/index"},{"title":"Voice Clone API parameters","sidebarTitle":"Parameters","href":"/docs/voice/voice-design-lab/clone-voice/parameters/index"},{"title":"Responses","sidebarTitle":"Responses","href":"/docs/voice/voice-design-lab/clone-voice/responses/index"},{"title":"Voice Clone API errors","sidebarTitle":"Errors","href":"/docs/voice/voice-design-lab/clone-voice/errors/index"},{"group":"API Reference","pages":[{"title":"List voice clones","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones","href":"/api-reference/voice-clones/list-voice-clones"},{"title":"Create a voice clone from a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones","href":"/api-reference/voice-clones/create-a-voice-clone-from-a-voice-design"},{"title":"Create a voice clone from an audio file upload","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones/from_upload","href":"/api-reference/voice-clones/create-a-voice-clone-from-an-audio-file-upload"},{"title":"Update a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_clones/{id}","href":"/api-reference/voice-clones/update-a-voice-clone"},{"title":"Delete a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_clones/{id}","href":"/api-reference/voice-clones/delete-a-voice-clone"},{"title":"Download voice clone audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones/{id}/sample","href":"/api-reference/voice-clones/download-voice-clone-audio-sample"}]},{"group":"Voice Designs API","pages":[{"title":"List voice designs","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs","href":"/api-reference/voice-designs/list-voice-designs"},{"title":"Create or add a version to a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_designs","href":"/api-reference/voice-designs/create-or-add-a-version-to-a-voice-design"},{"title":"Get a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}","href":"/api-reference/voice-designs/get-a-voice-design"},{"title":"Rename a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_designs/{id}","href":"/api-reference/voice-designs/rename-a-voice-design"},{"title":"Delete a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}","href":"/api-reference/voice-designs/delete-a-voice-design"},{"title":"Download voice design audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_designs/{id}/sample","href":"/api-reference/voice-designs/download-voice-design-audio-sample"},{"title":"Delete a specific version of a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_designs/{id}/versions/{version}","href":"/api-reference/voice-designs/delete-a-specific-version-of-a-voice-design"}]},{"group":"Voice Clones API","pages":[{"title":"List voice clones","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones","href":"/api-reference/voice-clones/list-voice-clones"},{"title":"Create a voice clone from a voice design","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones","href":"/api-reference/voice-clones/create-a-voice-clone-from-a-voice-design"},{"title":"Create a voice clone from an audio file upload","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json post /voice_clones/from_upload","href":"/api-reference/voice-clones/create-a-voice-clone-from-an-audio-file-upload"},{"title":"Update a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json patch /voice_clones/{id}","href":"/api-reference/voice-clones/update-a-voice-clone"},{"title":"Delete a voice clone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json delete /voice_clones/{id}","href":"/api-reference/voice-clones/delete-a-voice-clone"},{"title":"Download voice clone audio sample","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-designs/voice-designs.json get /voice_clones/{id}/sample","href":"/api-reference/voice-clones/download-voice-clone-audio-sample"}]}]},{"group":"Using Custom Voices","pages":[{"title":"Using Your Custom Voices","sidebarTitle":"Using Custom Voices","href":"/docs/voice/voice-design-lab/using-custom-voices/index"}]},{"group":"For AI Agents","pages":[{"title":"Voice Design llms.txt","sidebarTitle":"Voice Design llms txt","href":"/docs/development/llms/voice-voice-design-llms-txt/index"},{"title":"Voice Design llms-full.txt","sidebarTitle":"Voice Design llms full txt","href":"/docs/development/llms/voice-voice-design-llms-full-txt/index"}]}]}]},{"product":"Compute","icon":"server","tabs":[{"tab":"Overview","icon":"layer-group","groups":[{"group":"Overview","pages":[{"title":"Edge Compute","href":"/docs/edge-compute/platform-overview"}]},{"group":"For AI Agents","pages":[{"title":"Overview llms.txt","sidebarTitle":"Overview llms txt","href":"/docs/development/llms/compute-overview-llms-txt/index"},{"title":"Overview llms-full.txt","sidebarTitle":"Overview llms full txt","href":"/docs/development/llms/compute-overview-llms-full-txt/index"}]}]},{"tab":"Functions","icon":"bolt","groups":[{"group":"Overview","pages":[{"title":"Functions","href":"/docs/edge-compute/overview/index"}]},{"group":"Get Started","pages":[{"title":"Quickstart","href":"/docs/edge-compute/quickstart/index"}]},{"group":"Best Practices","pages":[{"title":"Best Practices","href":"/docs/edge-compute/best-practices/index"}]},{"group":"Guides","pages":[{"title":"Power AI Assistants with Edge Compute","sidebarTitle":"AI Assistants and Edge Compute","href":"/docs/edge-compute/guides/ai-assistant-backend/index"}]},{"group":"Local Development","pages":[{"title":"Local Development","href":"/docs/edge-compute/development/index"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/docs/edge-compute/configuration/index"},{"title":"Environment Variables","href":"/docs/edge-compute/configuration/environment-variables"},{"title":"Secrets","href":"/docs/edge-compute/configuration/secrets"}]},{"group":"CI/CD","pages":[{"title":"CI/CD","href":"/docs/edge-compute/deploy/index"},{"title":"Routes \u0026 Domains","href":"/docs/edge-compute/configuration/routing"},{"title":"Versions \u0026 Rollback","href":"/docs/edge-compute/configuration/versions"}]},{"group":"Custom Domains","pages":[{"title":"Custom Domains","sidebarTitle":"Overview","href":"/docs/edge-compute/custom-domains/index"},{"title":"Quick Start","sidebarTitle":"Quick Start","href":"/docs/edge-compute/custom-domains/quick-start"},{"title":"Custom domains API reference","sidebarTitle":"API Reference","href":"/docs/edge-compute/custom-domains/api-reference"}]},{"group":"Runtime APIs","pages":[{"title":"Runtime APIs","sidebarTitle":"Overview","href":"/docs/edge-compute/runtime/index"},{"title":"Execution Model","href":"/docs/edge-compute/runtime/execution-model"},{"title":"HTTP Handler","href":"/docs/edge-compute/runtime/http-handler"},{"group":"Bindings","pages":[{"title":"Bindings","sidebarTitle":"Overview","href":"/docs/edge-compute/runtime/bindings"},{"title":"Network Binding","sidebarTitle":"Network","href":"/docs/edge-compute/runtime/bindings/network"},{"group":"Telnyx API","pages":[{"title":"Telnyx API","sidebarTitle":"Overview","href":"/docs/edge-compute/telnyx-api/index"},{"title":"Quick Start","href":"/docs/edge-compute/telnyx-api/quick-start"},{"title":"API Reference","href":"/docs/edge-compute/telnyx-api/api-reference"},{"group":"Use Cases","pages":[{"title":"Receiving Messages","href":"/docs/edge-compute/telnyx-api/receiving-messages"},{"title":"Handling Calls","href":"/docs/edge-compute/telnyx-api/handling-calls"}]}]},{"group":"Rate Limiting","pages":[{"title":"Rate Limiting","sidebarTitle":"Overview","href":"/docs/edge-compute/rate-limiting/index"},{"title":"Quick Start","href":"/docs/edge-compute/rate-limiting/quick-start"},{"title":"API Reference","href":"/docs/edge-compute/rate-limiting/api-reference"}]}]}]},{"group":"Observability","pages":[{"title":"Edge Compute observability","sidebarTitle":"Overview","href":"/docs/edge-compute/observability/index"},{"title":"Logs","href":"/docs/edge-compute/observability/logs"},{"title":"Log export","href":"/docs/edge-compute/observability/log-export"},{"title":"Metrics","href":"/docs/edge-compute/observability/metrics"},{"title":"Deployment history","href":"/docs/edge-compute/observability/deployment-history"},{"title":"Health checks","href":"/docs/edge-compute/observability/health-checks"},{"group":"API Reference","pages":[{"title":"Observability API reference","sidebarTitle":"API Reference","href":"/docs/edge-compute/observability/api-reference"},{"title":"Get function logs","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json get /compute/funcs/{id}/logs","href":"/api-reference/functions/get-function-logs"},{"title":"Get log export configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json get /compute/funcs/{id}/logs/export","href":"/api-reference/functions/get-log-export-configuration"},{"title":"Configure log export destination","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json put /compute/funcs/{id}/logs/export","href":"/api-reference/functions/configure-log-export-destination"},{"title":"Delete log export configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json delete /compute/funcs/{id}/logs/export","href":"/api-reference/functions/delete-log-export-configuration"},{"title":"Get function metric aggregates","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json get /compute/funcs/{id}/metric_aggregates","href":"/api-reference/functions/get-function-metric-aggregates"},{"title":"List function revisions","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json get /compute/funcs/{id}/revisions","href":"/api-reference/functions/list-function-revisions"},{"title":"Inspect latest function ship","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/functions-observability.json get /compute/funcs/{id}/ship_inspection","href":"/api-reference/functions/inspect-latest-function-ship"}]}]},{"group":"Management REST API","expanded":false,"pages":[{"title":"List functions","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /compute/funcs","href":"/api-reference/functions/list-functions"}]},{"group":"CLI","pages":[{"title":"CLI Reference","href":"/docs/edge-compute/reference/cli"}]},{"group":"Platform","pages":[{"title":"Pricing","href":"/docs/edge-compute/platform/pricing"},{"title":"Limits","href":"/docs/edge-compute/platform/limits"}]},{"group":"For AI Agents","pages":[{"title":"Functions llms.txt","sidebarTitle":"Functions llms txt","href":"/docs/development/llms/compute-functions-llms-txt/index"},{"title":"Functions llms-full.txt","sidebarTitle":"Functions llms full txt","href":"/docs/development/llms/compute-functions-llms-full-txt/index"}]}]},{"tab":"Stateful Actors","icon":"cubes","groups":[{"group":"Overview","pages":[{"title":"Stateful Actors","tag":"Beta","href":"/docs/edge-compute/stateful-actors/index"}]},{"group":"Get Started","pages":[{"title":"Stateful Actors Quick Start","href":"/docs/edge-compute/stateful-actors/quick-start/index"}]},{"group":"Concepts","pages":[{"title":"How It Works","href":"/docs/edge-compute/stateful-actors/concepts/how-it-works/index"},{"title":"Execution Model","href":"/docs/edge-compute/stateful-actors/concepts/execution-model/index"},{"title":"Lifecycle \u0026 Placement","href":"/docs/edge-compute/stateful-actors/concepts/lifecycle/index"},{"title":"Addressing","href":"/docs/edge-compute/stateful-actors/concepts/addressing/index"}]},{"group":"Reference","pages":[{"group":"Runtime API","expanded":false,"pages":[{"title":"Stateful Actor API reference","sidebarTitle":"Overview","href":"/docs/edge-compute/stateful-actors/api-reference/index"},{"title":"Base Class","href":"/docs/edge-compute/stateful-actors/api-reference/base/index"},{"title":"Actor Context","href":"/docs/edge-compute/stateful-actors/api-reference/context/index"},{"title":"Actor Storage","href":"/docs/edge-compute/stateful-actors/api-reference/storage/index"},{"title":"Actor Namespace","href":"/docs/edge-compute/stateful-actors/api-reference/namespace/index"},{"title":"Actor Stub","href":"/docs/edge-compute/stateful-actors/api-reference/stub/index"},{"title":"Actor Alarms","href":"/docs/edge-compute/stateful-actors/alarms/index"},{"title":"Configuration","href":"/docs/edge-compute/stateful-actors/api-reference/configuration/index"},{"title":"Errors","href":"/docs/edge-compute/stateful-actors/api-reference/errors/index"}]},{"group":"Management REST API","expanded":false,"pages":[{"title":"Retrieve a Stateful Actor type","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /compute/actors/{id}","href":"/api-reference/stateful-actors/retrieve-a-stateful-actor-type"}]}]},{"group":"Guides","pages":[{"title":"Project Structure","href":"/docs/edge-compute/stateful-actors/guides/project-structure/index"},{"title":"Local Development","href":"/docs/edge-compute/stateful-actors/local-development/index"},{"title":"Shared Actors","href":"/docs/edge-compute/stateful-actors/shared-actors/index"},{"title":"When to Use Stateful Actors","href":"/docs/edge-compute/stateful-actors/guides/when-to-use/index"},{"group":"Storage","pages":[{"title":"Key-Value","href":"/docs/edge-compute/stateful-actors/guides/storage/key-value/index"},{"title":"SQL","href":"/docs/edge-compute/stateful-actors/guides/storage/sql/index"}]},{"group":"WebSockets","expanded":false,"pages":[{"title":"WebSockets","href":"/docs/edge-compute/stateful-actors/websockets/index"},{"title":"Connection Lifecycle \u0026 Limits","href":"/docs/edge-compute/stateful-actors/websockets/lifecycle/index"}]}]},{"group":"Observability","pages":[{"title":"Actor observability","sidebarTitle":"Overview","href":"/docs/edge-compute/stateful-actors/observability/index"},{"title":"Actor logs","sidebarTitle":"Logs","href":"/docs/edge-compute/stateful-actors/observability/logs"},{"title":"Actor metrics","sidebarTitle":"Metrics","href":"/docs/edge-compute/stateful-actors/observability/metrics"}]},{"group":"For AI Agents","pages":[{"title":"Stateful Actors llms.txt","sidebarTitle":"Stateful Actors llms txt","href":"/docs/development/llms/compute-stateful-actors-beta-llms-txt/index"},{"title":"Stateful Actors llms-full.txt","sidebarTitle":"Stateful Actors llms full txt","href":"/docs/development/llms/compute-stateful-actors-beta-llms-full-txt/index"}]}]}]},{"product":"Storage","icon":"hard-drive","tabs":[{"tab":"Object Storage","icon":"database","groups":[{"group":"Overview","pages":[{"title":"Object Storage","sidebarTitle":"Overview","href":"/docs/cloud-storage/overview"}]},{"group":"Get Started","pages":[{"title":"Cloud Storage quick start","sidebarTitle":"Quick Start Guide","href":"/docs/cloud-storage/quick-start/index"}]},{"group":"Concepts","pages":[{"title":"API Endpoints and Organization","sidebarTitle":"API Endpoints \u0026 Organization","href":"/docs/cloud-storage/api-endpoints/index"},{"title":"Cloud Storage authentication","sidebarTitle":"Authentication","href":"/docs/cloud-storage/authentication/index"},{"title":"Bucket Addressing","sidebarTitle":"Bucket Addressing","href":"/docs/cloud-storage/bucket-addressing/index"}]},{"group":"Access via S3 API","pages":[{"group":"SDK Examples","pages":[{"title":"AWS Node.js SDK Example","sidebarTitle":"Node.js","href":"/docs/cloud-storage/sdk/node/index"},{"title":"AWS Python SDK Example","sidebarTitle":"Python","href":"/docs/cloud-storage/sdk/python/index"},{"title":"AWS Java SDK Example","sidebarTitle":"Java","href":"/docs/cloud-storage/sdk/java/index"},{"title":"AWS Golang SDK Example","sidebarTitle":"Go","href":"/docs/cloud-storage/sdk/golang/index"},{"title":"AWS Ruby SDK Example","sidebarTitle":"Ruby","href":"/docs/cloud-storage/sdk/ruby/index"},{"title":"AWS PHP SDK Example","sidebarTitle":"PHP","href":"/docs/cloud-storage/sdk/php/index"},{"title":"AWS .Net SDK Example","sidebarTitle":".NET","href":"/docs/cloud-storage/sdk/dotnet/index"},{"title":"AWS Elixir SDK Example","sidebarTitle":"Elixir","href":"/docs/cloud-storage/sdk/elixir/index"}]},{"title":"Third Party S3 Compatible Applications","sidebarTitle":"Third Party Applications","href":"/docs/cloud-storage/third-party/index"}]},{"group":"Access from Edge Compute","pages":[{"title":"Use a bucket from an Edge Function","sidebarTitle":"Edge Function Binding","href":"/docs/cloud-storage/bindings/index"},{"title":"CloudStorageBucket","sidebarTitle":"Binding API Reference","href":"/docs/cloud-storage/bindings/reference/index"}]},{"group":"Features","pages":[{"title":"Multipart Upload","sidebarTitle":"Multipart Upload","href":"/docs/cloud-storage/multipart-upload/index"},{"title":"Presigned URLs","sidebarTitle":"Presigned URLs","href":"/docs/cloud-storage/presigned-urls/index"},{"title":"Object Encryption","sidebarTitle":"Object Encryption","href":"/docs/cloud-storage/object-encryption/index"},{"title":"Making Bucket Public","sidebarTitle":"Public Buckets","href":"/docs/cloud-storage/public-buckets/index"},{"title":"HTTPS with Custom Domain","sidebarTitle":"HTTPS with Custom Domain","href":"/docs/cloud-storage/ssl-certificates/index"},{"title":"Object Lock \u0026 Retention","sidebarTitle":"Data Protection \u0026 Retention","href":"/docs/cloud-storage/lock-and-retention/index"},{"title":"Emptying Buckets","sidebarTitle":"Emptying Buckets","href":"/docs/cloud-storage/emptying-bucket/index"}]},{"group":"Compatibility \u0026 Migration","pages":[{"title":"Compatibility with AWS S3","sidebarTitle":"AWS S3 Compatibility","href":"/docs/cloud-storage/aws-s3-compatibility/index"},{"title":"Compatibility Matrix","sidebarTitle":"Compatibility Matrix","href":"/docs/cloud-storage/supported/index"},{"title":"Migrating from S3","sidebarTitle":"Migration from AWS S3","href":"/docs/cloud-storage/migrating-from-aws/index"}]},{"group":"Platform","pages":[{"title":"Cloud Storage limits and quotas","sidebarTitle":"Limits \u0026 Quotas","href":"/docs/cloud-storage/limits/index"},{"title":"Billing","sidebarTitle":"Billing \u0026 Pricing","href":"/docs/cloud-storage/billing/index"},{"title":"Performance Benchmarks","sidebarTitle":"Performance Benchmarks","href":"/docs/cloud-storage/performance-benchmarks/index"}]},{"group":"API Reference (S3-Compatible)","pages":[{"group":"Bucket Operations","expanded":false,"pages":[{"title":"Create bucket","href":"/docs/cloud-storage/api-reference/bucket-operations/create-bucket/index"},{"title":"Delete bucket","href":"/docs/cloud-storage/api-reference/bucket-operations/delete-bucket/index"},{"title":"Delete bucket CORS","href":"/docs/cloud-storage/api-reference/bucket-operations/delete-bucket-cors/index"},{"title":"Delete bucket lifecycle","href":"/docs/cloud-storage/api-reference/bucket-operations/delete-bucket-lifecycle/index"},{"title":"Delete bucket policy","href":"/docs/cloud-storage/api-reference/bucket-operations/delete-bucket-policy/index"},{"title":"Delete bucket tagging","href":"/docs/cloud-storage/api-reference/bucket-operations/delete-bucket-tagging/index"},{"title":"Get bucket ACL","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-acl/index"},{"title":"Get bucket CORS","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-cors/index"},{"title":"Get bucket lifecycle configuration","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-lifecycle-configuration/index"},{"title":"Get bucket location","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-location/index"},{"title":"Get bucket policy","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-policy/index"},{"title":"Get bucket policy status","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-policy-status/index"},{"title":"Get bucket tagging","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-tagging/index"},{"title":"Get bucket versioning","href":"/docs/cloud-storage/api-reference/bucket-operations/get-bucket-versioning/index"},{"title":"Head bucket","href":"/docs/cloud-storage/api-reference/bucket-operations/head-bucket/index"},{"title":"List buckets","href":"/docs/cloud-storage/api-reference/bucket-operations/list-bucket/index"},{"title":"Put bucket ACL","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-acl/index"},{"title":"Put bucket CORS","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-cors/index"},{"title":"Put bucket lifecycle configuration","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-life-cycle-configuration/index"},{"title":"Put bucket policy","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-policy/index"},{"title":"Put bucket tagging","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-tagging/index"},{"title":"Put bucket versioning","href":"/docs/cloud-storage/api-reference/bucket-operations/put-bucket-versioning/index"}]},{"group":"Object Operations","expanded":false,"pages":[{"title":"Delete object","href":"/docs/cloud-storage/api-reference/object-operations/delete-object/index"},{"title":"Delete object tagging","href":"/docs/cloud-storage/api-reference/object-operations/delete-object-tagging/index"},{"title":"Delete objects","href":"/docs/cloud-storage/api-reference/object-operations/delete-objects/index"},{"title":"Get object","href":"/docs/cloud-storage/api-reference/object-operations/get-object/index"},{"title":"Get object ACL","href":"/docs/cloud-storage/api-reference/object-operations/get-object-acl/index"},{"title":"Get object tagging","href":"/docs/cloud-storage/api-reference/object-operations/get-object-tagging/index"},{"title":"Head object","href":"/docs/cloud-storage/api-reference/object-operations/head-object/index"},{"title":"List object versions","href":"/docs/cloud-storage/api-reference/object-operations/list-object-versions/index"},{"title":"List objects","href":"/docs/cloud-storage/api-reference/object-operations/list-objects/index"},{"title":"Put object","href":"/docs/cloud-storage/api-reference/object-operations/put-object/index"},{"title":"Put object ACL","href":"/docs/cloud-storage/api-reference/object-operations/put-object-acl/index"},{"title":"Put object tagging","href":"/docs/cloud-storage/api-reference/object-operations/put-object-tagging/index"}]},{"group":"Multipart Operations","expanded":false,"pages":[{"title":"Abort multipart upload","href":"/docs/cloud-storage/api-reference/multipart-operations/abort-multipart-upload/index"},{"title":"Complete multipart upload","href":"/docs/cloud-storage/api-reference/multipart-operations/complete-multipart-upload/index"},{"title":"Create multipart upload","href":"/docs/cloud-storage/api-reference/multipart-operations/create-multipart-upload/index"},{"title":"List multipart uploads","href":"/docs/cloud-storage/api-reference/multipart-operations/list-multipart-uploads/index"},{"title":"Upload parts","href":"/docs/cloud-storage/api-reference/multipart-operations/upload-part/index"},{"title":"List parts","href":"/docs/cloud-storage/api-reference/multipart-operations/list-parts/index"}]}]},{"group":"API Reference (JSON Companion)","pages":[{"group":"Presigned Object URLs API","pages":[{"title":"Create Presigned Object URL","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json post /storage/buckets/{bucketName}/{objectName}/presigned_url","href":"/api-reference/presigned-object-urls/create-presigned-object-url"}]},{"group":"Bucket SSL Certificate API","pages":[{"title":"Remove SSL Certificate","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json delete /storage/buckets/{bucketName}/ssl_certificate","href":"/api-reference/bucket-ssl-certificate/remove-ssl-certificate"},{"title":"Get Bucket SSL Certificate","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/buckets/{bucketName}/ssl_certificate","href":"/api-reference/bucket-ssl-certificate/get-bucket-ssl-certificate"},{"title":"Add SSL Certificate","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json put /storage/buckets/{bucketName}/ssl_certificate","href":"/api-reference/bucket-ssl-certificate/add-ssl-certificate"}]},{"group":"Bucket Usage API","pages":[{"title":"Get API Usage","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/buckets/{bucketName}/usage/api","href":"/api-reference/bucket-usage/get-api-usage"},{"title":"Get Bucket Usage","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/buckets/{bucketName}/usage/storage","href":"/api-reference/bucket-usage/get-bucket-usage"}]},{"group":"Data Migration API","pages":[{"title":"List Migration Source coverage","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/migration_source_coverage","href":"/api-reference/data-migration/list-migration-source-coverage"},{"title":"List all Migration Sources","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/migration_sources","href":"/api-reference/data-migration/list-all-migration-sources"},{"title":"Create a Migration Source","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json post /storage/migration_sources","href":"/api-reference/data-migration/create-a-migration-source"},{"title":"Delete a Migration Source","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json delete /storage/migration_sources/{id}","href":"/api-reference/data-migration/delete-a-migration-source"},{"title":"Get a Migration Source","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/migration_sources/{id}","href":"/api-reference/data-migration/get-a-migration-source"},{"title":"List all Migrations","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/migrations","href":"/api-reference/data-migration/list-all-migrations"},{"title":"Create a Migration","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json post /storage/migrations","href":"/api-reference/data-migration/create-a-migration"},{"title":"Get a Migration","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json get /storage/migrations/{id}","href":"/api-reference/data-migration/get-a-migration"},{"title":"Stop a Migration","deprecated":false,"version":null,"openapi":"/openapi/source/external/cloud-storage-companion/cloud-storage-companion.json post /storage/migrations/{id}/actions/stop","href":"/api-reference/data-migration/stop-a-migration"}]}]},{"group":"For AI Agents","pages":[{"title":"Object Storage llms.txt","sidebarTitle":"Object Storage llms txt","href":"/docs/development/llms/storage-object-storage-llms-txt/index"},{"title":"Object Storage llms-full.txt","sidebarTitle":"Object Storage llms full txt","href":"/docs/development/llms/storage-object-storage-llms-full-txt/index"}]}]},{"tab":"KV","icon":"key","groups":[{"group":"Get Started","pages":[{"title":"KV","href":"/docs/edge-compute/kv/index"},{"title":"Quick Start","href":"/docs/edge-compute/kv/quick-start/index"}]},{"group":"Concepts","pages":[{"title":"How KV Works","href":"/docs/edge-compute/kv/concepts/how-kv-works/index"},{"title":"Key Expiration","href":"/docs/edge-compute/kv/ttl-and-metadata/index"}]},{"group":"Examples","pages":[{"title":"Session Storage","href":"/docs/edge-compute/kv/examples/session-storage/index"},{"title":"API Response Caching","href":"/docs/edge-compute/kv/examples/api-response-caching/index"},{"title":"Feature Flags","href":"/docs/edge-compute/kv/examples/feature-flags/index"}]},{"group":"Reference","pages":[{"group":"Runtime API","expanded":false,"pages":[{"title":"Overview","href":"/docs/edge-compute/kv/reference/index"},{"title":"KvNamespace","href":"/docs/edge-compute/kv/reference/kv-namespace/index"}]},{"group":"REST API","expanded":false,"pages":[{"group":"kv namespaces API","pages":[{"title":"List KV namespaces","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/kvs","href":"/api-reference/kv-namespaces/list-kv-namespaces"},{"title":"Create a KV namespace","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/kvs","href":"/api-reference/kv-namespaces/create-a-kv-namespace"},{"title":"Get a KV namespace","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/kvs/{id}","href":"/api-reference/kv-namespaces/get-a-kv-namespace"},{"title":"Delete a KV namespace","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json delete /storage/kvs/{id}","href":"/api-reference/kv-namespaces/delete-a-kv-namespace"}]},{"group":"kv keys API","pages":[{"title":"List keys","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/kvs/{id}/keys","href":"/api-reference/kv-keys/list-keys"},{"title":"Get a key's value","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/kvs/{id}/keys/{key}","href":"/api-reference/kv-keys/get-a-keys-value"},{"title":"Set a key's value","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json put /storage/kvs/{id}/keys/{key}","href":"/api-reference/kv-keys/set-a-keys-value"},{"title":"Delete a key","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json delete /storage/kvs/{id}/keys/{key}","href":"/api-reference/kv-keys/delete-a-key"}]},{"group":"cloudfs filesystems API","pages":[{"title":"List CloudFS filesystems","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/cloudfs","href":"/api-reference/cloudfs-filesystems/list-cloudfs-filesystems"},{"title":"Create a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/cloudfs","href":"/api-reference/cloudfs-filesystems/create-a-cloudfs-filesystem"},{"title":"Get a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/get-a-cloudfs-filesystem"},{"title":"Update a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json patch /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/update-a-cloudfs-filesystem"},{"title":"Delete a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json delete /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/delete-a-cloudfs-filesystem"},{"title":"Rotate the metadata token","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/cloudfs/{id}/actions/rotate-meta-token","href":"/api-reference/cloudfs-filesystems/rotate-the-metadata-token"}]}]},{"title":"CLI","href":"/docs/edge-compute/kv/cli/index"},{"title":"Best Practices","href":"/docs/edge-compute/kv/best-practices/index"}]},{"group":"Platform","pages":[{"title":"Pricing","href":"/docs/edge-compute/kv/pricing/index"}]},{"group":"For AI Agents","pages":[{"title":"KV llms.txt","sidebarTitle":"KV llms txt","href":"/docs/development/llms/storage-kv-llms-txt/index"},{"title":"KV llms-full.txt","sidebarTitle":"KV llms full txt","href":"/docs/development/llms/storage-kv-llms-full-txt/index"}]}]},{"tab":"SQL","icon":"table","groups":[{"group":"Get Started","pages":[{"title":"SQL Databases","tag":"Beta","href":"/docs/edge-compute/sqldb/index"},{"title":"Quick Start","href":"/docs/edge-compute/sqldb/quick-start/index"}]},{"group":"Concepts","pages":[{"title":"How SQL Databases Work","href":"/docs/edge-compute/sqldb/concepts/how-sqldb-works/index"},{"title":"Migrations","href":"/docs/edge-compute/sqldb/migrations/index"}]},{"group":"Reference","pages":[{"group":"Runtime API","expanded":false,"pages":[{"title":"Overview","href":"/docs/edge-compute/sqldb/reference/index"},{"title":"SqlDatabase","href":"/docs/edge-compute/sqldb/reference/sql-database/index"}]},{"group":"REST API","expanded":false,"pages":[{"group":"sql databases API","pages":[{"title":"List SQL databases","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/sqldbs","href":"/api-reference/sql-databases/list-sql-databases"},{"title":"Create a SQL database","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/sqldbs","href":"/api-reference/sql-databases/create-a-sql-database"},{"title":"Get a SQL database","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/sqldbs/{id}","href":"/api-reference/sql-databases/get-a-sql-database"},{"title":"Delete a SQL database","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json delete /storage/sqldbs/{id}","href":"/api-reference/sql-databases/delete-a-sql-database"},{"title":"Run SQL against a SQL database","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/sqldbs/{id}/actions/query","href":"/api-reference/sql-databases/run-sql-against-a-sql-database"}]}]},{"title":"CLI","href":"/docs/edge-compute/sqldb/cli/index"},{"title":"Limits","href":"/docs/edge-compute/sqldb/limits/index"}]},{"group":"For AI Agents","pages":[{"title":"SQL llms.txt","sidebarTitle":"SQL llms txt","href":"/docs/development/llms/storage-sql-llms-txt/index"},{"title":"SQL llms-full.txt","sidebarTitle":"SQL llms full txt","href":"/docs/development/llms/storage-sql-llms-full-txt/index"}]}]},{"tab":"CloudFS","icon":"folder-tree","groups":[{"group":"Get Started","pages":[{"title":"CloudFS","tag":"Beta","href":"/docs/edge-compute/cloudfs/index"},{"title":"Quick Start","href":"/docs/edge-compute/cloudfs/quickstart/index"}]},{"group":"Concepts","pages":[{"title":"Filesystems From First Principles","href":"/docs/edge-compute/cloudfs/concepts/filesystems-from-first-principles/index"},{"title":"Network Filesystems","href":"/docs/edge-compute/cloudfs/concepts/network-filesystems/index"},{"title":"How CloudFS Works","href":"/docs/edge-compute/cloudfs/concepts/how-cloudfs-works/index"}]},{"group":"Guides","pages":[{"title":"Mounting a Filesystem","href":"/docs/edge-compute/cloudfs/mount/index"},{"title":"Serving Without FUSE","href":"/docs/edge-compute/cloudfs/serve/index"},{"title":"Concurrent Access","href":"/docs/edge-compute/cloudfs/concurrent-access/index"}]},{"group":"Reference","pages":[{"group":"REST API","expanded":false,"pages":[{"title":"List CloudFS filesystems","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/cloudfs","href":"/api-reference/cloudfs-filesystems/list-cloudfs-filesystems"},{"title":"Create a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/cloudfs","href":"/api-reference/cloudfs-filesystems/create-a-cloudfs-filesystem"},{"title":"Get a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json get /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/get-a-cloudfs-filesystem"},{"title":"Update a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json patch /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/update-a-cloudfs-filesystem"},{"title":"Delete a CloudFS filesystem","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json delete /storage/cloudfs/{id}","href":"/api-reference/cloudfs-filesystems/delete-a-cloudfs-filesystem"},{"title":"Rotate the metadata token","deprecated":null,"version":null,"openapi":"/openapi/source/external/edge-compute/edge-compute.json post /storage/cloudfs/{id}/actions/rotate-meta-token","href":"/api-reference/cloudfs-filesystems/rotate-the-metadata-token"}]}]},{"group":"For AI Agents","pages":[{"title":"CloudFS llms.txt","sidebarTitle":"CloudFS llms txt","href":"/docs/development/llms/storage-cloudfs-beta-llms-txt/index"},{"title":"CloudFS llms-full.txt","sidebarTitle":"CloudFS llms full txt","href":"/docs/development/llms/storage-cloudfs-beta-llms-full-txt/index"}]}]}]},{"product":"Virtual Private Cloud","icon":"cloud","tabs":[{"tab":"Overview","icon":"layer-group","groups":[{"group":"Overview","pages":[{"title":"Virtual Private Cloud","sidebarTitle":"Overview","href":"/docs/virtual-private-cloud"}]},{"group":"For AI Agents","pages":[{"title":"Virtual Private Cloud Overview llms.txt","sidebarTitle":"Virtual Private Cloud Overview llms txt","href":"/docs/development/llms/compute-virtual-private-cloud-overview-llms-txt/index"},{"title":"Virtual Private Cloud Overview llms-full.txt","sidebarTitle":"Virtual Private Cloud Overview llms full txt","href":"/docs/development/llms/compute-virtual-private-cloud-overview-llms-full-txt/index"}]}]},{"tab":"Network","icon":"network-wired","groups":[{"group":"Network","pages":[{"title":"Network","sidebarTitle":"Overview","href":"/docs/network/overview/index"},{"title":"Create and manage Networks","sidebarTitle":"Networks","href":"/docs/network/networks/index"},{"title":"Routes","sidebarTitle":"Routes","href":"/docs/network/routes/index"},{"title":"Coverage","sidebarTitle":"Coverage","href":"/docs/network/coverage/index"},{"group":"Network API","pages":[{"title":"List all Networks","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /networks","href":"/api-reference/networks/list-all-networks"},{"title":"Create a Network","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /networks","href":"/api-reference/networks/create-a-network"},{"title":"Delete a Network","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /networks/{id}","href":"/api-reference/networks/delete-a-network"},{"title":"Retrieve a Network","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /networks/{id}","href":"/api-reference/networks/retrieve-a-network"},{"title":"Update a Network","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json patch /networks/{id}","href":"/api-reference/networks/update-a-network"}]},{"group":"Interfaces API","pages":[{"title":"List all Interfaces for a Network.","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /networks/{id}/network_interfaces","href":"/api-reference/networks/list-all-interfaces-for-a-network"}]},{"group":"Routes API","pages":[{"title":"List all Network Routes","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /network_routes","href":"/api-reference/network-routes/list-all-network-routes"},{"title":"Create a Network Route","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /network_routes","href":"/api-reference/network-routes/create-a-network-route"},{"title":"Retrieve a Network Route","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /network_routes/{id}","href":"/api-reference/network-routes/retrieve-a-network-route"},{"title":"Delete a Network Route","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /network_routes/{id}","href":"/api-reference/network-routes/delete-a-network-route"}]},{"group":"Default Gateway API","pages":[{"title":"Delete Default Gateway.","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /networks/{id}/default_gateway","href":"/api-reference/networks/delete-default-gateway"},{"title":"Get Default Gateway status.","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /networks/{id}/default_gateway","href":"/api-reference/networks/get-default-gateway-status"},{"title":"Create Default Gateway.","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /networks/{id}/default_gateway","href":"/api-reference/networks/create-default-gateway"}]}]},{"group":"For AI Agents","pages":[{"title":"Network llms.txt","sidebarTitle":"Network llms txt","href":"/docs/development/llms/compute-network-llms-txt/index"},{"title":"Network llms-full.txt","sidebarTitle":"Network llms full txt","href":"/docs/development/llms/compute-network-llms-full-txt/index"}]}]},{"tab":"WireGuard Interface","icon":"shield","groups":[{"group":"Get Started","pages":[{"title":"WireGuard Interface","sidebarTitle":"Overview","href":"/docs/network/wireguard-interfaces/index"},{"title":"WireGuard Interface Quick Start","sidebarTitle":"Quick Start","href":"/docs/network/wireguard-interfaces/quick-start"}]},{"group":"Configure Peers","pages":[{"title":"WireGuard Peer Config on Linux","sidebarTitle":"Linux","href":"/docs/network/wireguard-peer-config/linux/index"},{"title":"WireGuard Peer Config on macOS","sidebarTitle":"macOS","href":"/docs/network/wireguard-peer-config/macos/index"},{"title":"WireGuard Peer Config on Windows","sidebarTitle":"Windows","href":"/docs/network/wireguard-peer-config/windows/index"}]},{"group":"Use Cases","pages":[{"title":"Connect Peers Across Clouds","sidebarTitle":"Peers Across Clouds","href":"/docs/network/wireguard-interfaces/use-cases/multi-cloud"},{"title":"Route SIP Through a WireGuard Interface","sidebarTitle":"SIP Over WireGuard","href":"/docs/network/wireguard-interfaces/use-cases/sip"}]},{"group":"API Reference","pages":[{"group":"WireGuard Interfaces","expanded":false,"pages":[{"title":"List all WireGuard Interfaces","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /wireguard_interfaces","href":"/api-reference/wireguard-interfaces/list-all-wireguard-interfaces"},{"title":"Create a WireGuard Interface","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /wireguard_interfaces","href":"/api-reference/wireguard-interfaces/create-a-wireguard-interface"},{"title":"Retrieve a WireGuard Interfaces","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /wireguard_interfaces/{id}","href":"/api-reference/wireguard-interfaces/retrieve-a-wireguard-interfaces"},{"title":"Delete a WireGuard Interface","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /wireguard_interfaces/{id}","href":"/api-reference/wireguard-interfaces/delete-a-wireguard-interface"}]},{"group":"WireGuard Peers","expanded":false,"pages":[{"title":"List all WireGuard Peers","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /wireguard_peers","href":"/api-reference/wireguard-interfaces/list-all-wireguard-peers"},{"title":"Create a WireGuard Peer","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /wireguard_peers","href":"/api-reference/wireguard-interfaces/create-a-wireguard-peer"},{"title":"Retrieve the WireGuard Peer","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /wireguard_peers/{id}","href":"/api-reference/wireguard-interfaces/retrieve-the-wireguard-peer"},{"title":"Update the WireGuard Peer","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json patch /wireguard_peers/{id}","href":"/api-reference/wireguard-interfaces/update-the-wireguard-peer"},{"title":"Delete the WireGuard Peer","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /wireguard_peers/{id}","href":"/api-reference/wireguard-interfaces/delete-the-wireguard-peer"},{"title":"Retrieve Wireguard config template for Peer","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /wireguard_peers/{id}/config","href":"/api-reference/wireguard-interfaces/retrieve-wireguard-config-template-for-peer"}]}]},{"group":"For AI Agents","pages":[{"title":"WireGuard Interface llms.txt","sidebarTitle":"WireGuard Interface llms txt","href":"/docs/development/llms/compute-wireguard-interfaces-llms-txt/index"},{"title":"WireGuard Interface llms-full.txt","sidebarTitle":"WireGuard Interface llms full txt","href":"/docs/development/llms/compute-wireguard-interfaces-llms-full-txt/index"}]}]},{"tab":"Tunnel","icon":"train-tunnel","groups":[{"group":"Get Started","pages":[{"title":"Tunnel","sidebarTitle":"Overview","href":"/docs/network/tunnel/index"},{"title":"Tunnel Quick Start","sidebarTitle":"Quick Start","href":"/docs/network/tunnel/quick-start"},{"title":"Beta Limitations","sidebarTitle":"Beta Limitations","href":"/docs/network/tunnel/beta-limitations"}]},{"group":"Concepts","pages":[{"title":"What a Tunnel Is Not","sidebarTitle":"What It Is Not","href":"/docs/network/tunnel/concepts/what-it-is-not"},{"title":"What a Tunnel Is","sidebarTitle":"What It Is","href":"/docs/network/tunnel/concepts/what-it-is"},{"title":"Connections","sidebarTitle":"Connections","href":"/docs/network/tunnel/concepts/connections"},{"title":"Lifecycle","sidebarTitle":"Lifecycle","href":"/docs/network/tunnel/concepts/lifecycle"}]},{"group":"Features","pages":[{"title":"Routes","sidebarTitle":"Routes","href":"/docs/network/tunnel/features/routes"},{"title":"Private Services","sidebarTitle":"Private Services","tag":"Preview","href":"/docs/network/tunnel/features/private-services"}]},{"group":"Operations","pages":[{"title":"Run as a Service","sidebarTitle":"Run as a Service","tag":"Preview","href":"/docs/network/tunnel/operations/run-as-a-service"},{"title":"Test a Destination","sidebarTitle":"Test a Destination","tag":"Preview","href":"/docs/network/tunnel/operations/test-a-destination"}]},{"group":"API Reference","pages":[{"group":"Tunnels","expanded":false,"pages":[{"title":"List all Tunnels","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /tunnels","href":"/api-reference/tunnels/list-all-tunnels"},{"title":"Create a Tunnel","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /tunnels","href":"/api-reference/tunnels/create-a-tunnel"},{"title":"Retrieve a Tunnel","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /tunnels/{id}","href":"/api-reference/tunnels/retrieve-a-tunnel"},{"title":"Delete a Tunnel","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /tunnels/{id}","href":"/api-reference/tunnels/delete-a-tunnel"},{"title":"Rotate a Tunnel Token","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /tunnels/{id}/actions/rotate_token","href":"/api-reference/tunnels/rotate-a-tunnel-token"}]}]},{"group":"For AI Agents","pages":[{"title":"Tunnel llms.txt","sidebarTitle":"Tunnel llms txt","href":"/docs/development/llms/compute-tunnel-llms-txt/index"},{"title":"Tunnel llms-full.txt","sidebarTitle":"Tunnel llms full txt","href":"/docs/development/llms/compute-tunnel-llms-full-txt/index"}]}]},{"tab":"Tailscale Subnet Router","icon":"share-nodes","groups":[{"group":"Get Started","pages":[{"title":"Tailscale Subnet Router","sidebarTitle":"Overview","href":"/docs/network/tailscale-subnet-router/index"},{"title":"Tailscale Subnet Router Quick Start","sidebarTitle":"Quick Start","href":"/docs/network/tailscale-subnet-router/quick-start"},{"title":"Beta Limitations","sidebarTitle":"Beta Limitations","href":"/docs/network/tailscale-subnet-router/beta-limitations"}]},{"group":"Concepts","pages":[{"title":"Routes","sidebarTitle":"Routes","href":"/docs/network/tailscale-subnet-router/concepts/routes"},{"title":"Addresses","sidebarTitle":"Addresses","href":"/docs/network/tailscale-subnet-router/concepts/addresses"},{"title":"Lifecycle","sidebarTitle":"Lifecycle","href":"/docs/network/tailscale-subnet-router/concepts/lifecycle"}]},{"group":"Security","pages":[{"title":"Tailnet Control","sidebarTitle":"Tailnet Control","href":"/docs/network/tailscale-subnet-router/security/tailnet-control"},{"title":"Auth Key","sidebarTitle":"Auth Key","href":"/docs/network/tailscale-subnet-router/security/auth-key"},{"title":"Route Approval","sidebarTitle":"Route Approval","href":"/docs/network/tailscale-subnet-router/security/route-approval"},{"title":"One-Way Traffic","sidebarTitle":"One Way","href":"/docs/network/tailscale-subnet-router/security/one-way"},{"title":"Source Address","sidebarTitle":"Source Address","href":"/docs/network/tailscale-subnet-router/security/source-address"},{"title":"Isolation","sidebarTitle":"Isolation","href":"/docs/network/tailscale-subnet-router/security/isolation"}]},{"group":"API Reference","pages":[{"group":"Tailscale Subnet Routers","expanded":false,"pages":[{"title":"List all Tailscale Subnet Routers","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /tailscale_subnet_routers","href":"/api-reference/tailscale-subnet-routers/list-all-tailscale-subnet-routers"},{"title":"Create a Tailscale Subnet Router","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /tailscale_subnet_routers","href":"/api-reference/tailscale-subnet-routers/create-a-tailscale-subnet-router"},{"title":"Retrieve a Tailscale Subnet Router","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /tailscale_subnet_routers/{id}","href":"/api-reference/tailscale-subnet-routers/retrieve-a-tailscale-subnet-router"},{"title":"Update a Tailscale Subnet Router","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json patch /tailscale_subnet_routers/{id}","href":"/api-reference/tailscale-subnet-routers/update-a-tailscale-subnet-router"},{"title":"Delete a Tailscale Subnet Router","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /tailscale_subnet_routers/{id}","href":"/api-reference/tailscale-subnet-routers/delete-a-tailscale-subnet-router"}]}]},{"group":"For AI Agents","pages":[{"title":"Tailscale Subnet Router llms.txt","sidebarTitle":"Tailscale Subnet Router llms txt","href":"/docs/development/llms/compute-tailscale-subnet-router-beta-llms-txt/index"},{"title":"Tailscale Subnet Router llms-full.txt","sidebarTitle":"Tailscale Subnet Router llms full txt","href":"/docs/development/llms/compute-tailscale-subnet-router-beta-llms-full-txt/index"}]}]},{"tab":"Virtual Cross Connect","icon":"arrows-left-right-to-line","groups":[{"group":"Guides","pages":[{"title":"VXC Introduction","sidebarTitle":"VXC Introduction","href":"/docs/network/vxc/intro/index"},{"title":"VXC Coverage","sidebarTitle":"Coverage \u0026 Availability","href":"/docs/network/vxc/coverage/index"},{"title":"VXC Cost","sidebarTitle":"Pricing","href":"/docs/network/vxc/cost/index"},{"title":"VXC API","sidebarTitle":"VXC API","href":"/docs/network/vxc/api/index"},{"group":"Cloud Provider Guides","pages":[{"title":"AWS VXC Setup","sidebarTitle":"AWS Direct Connect","href":"/docs/network/vxc/aws/index"},{"title":"Google VXC Setup","sidebarTitle":"Google Cloud Interconnect","href":"/docs/network/vxc/gcp/index"},{"title":"Azure VXC Setup","sidebarTitle":"Azure ExpressRoute","href":"/docs/network/vxc/azure/index"}]}]},{"group":"Virtual Cross Connects API","pages":[{"title":"List all Virtual Cross Connects","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /virtual_cross_connects","href":"/api-reference/virtual-cross-connects/list-all-virtual-cross-connects"},{"title":"Create a Virtual Cross Connect","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json post /virtual_cross_connects","href":"/api-reference/virtual-cross-connects/create-a-virtual-cross-connect"},{"title":"Delete a Virtual Cross Connect","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json delete /virtual_cross_connects/{id}","href":"/api-reference/virtual-cross-connects/delete-a-virtual-cross-connect"},{"title":"Retrieve a Virtual Cross Connect","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json get /virtual_cross_connects/{id}","href":"/api-reference/virtual-cross-connects/retrieve-a-virtual-cross-connect"},{"title":"Update the Virtual Cross Connect","deprecated":null,"version":null,"openapi":"/openapi/source/external/netapps/netapps.json patch /virtual_cross_connects/{id}","href":"/api-reference/virtual-cross-connects/update-the-virtual-cross-connect"},{"title":"List Virtual Cross Connect Cloud Coverage","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/networking/networking.json get /virtual_cross_connects/coverage","href":"/api-reference/virtual-cross-connects/list-virtual-cross-connect-cloud-coverage"}]},{"group":"For AI Agents","pages":[{"title":"Virtual Cross Connect llms.txt","sidebarTitle":"Virtual Cross Connect llms txt","href":"/docs/development/llms/compute-virtual-cross-connect-llms-txt/index"},{"title":"Virtual Cross Connect llms-full.txt","sidebarTitle":"Virtual Cross Connect llms full txt","href":"/docs/development/llms/compute-virtual-cross-connect-llms-full-txt/index"}]}]}]},{"product":"Calling","icon":"phone","tabs":[{"tab":"Voice API","icon":"phone-volume","groups":[{"group":"Voice API Fundamentals","pages":[{"title":"Getting Started with Telnyx Voice API","sidebarTitle":"Getting Started","href":"/docs/voice/programmable-voice/voice-api-fundamentals"},{"title":"Commands and Resources","sidebarTitle":"Commands and Resources","href":"/docs/voice/programmable-voice/voice-api-commands-and-resources/index"},{"title":"Voice API Webhooks","sidebarTitle":"Webhooks","href":"/docs/voice/programmable-voice/voice-api-webhooks/index"},{"title":"Sending Commands for Programmable Voice","sidebarTitle":"Sending Commands","href":"/docs/voice/programmable-voice/sending-commands/index"},{"title":"Receiving Webhooks for Programmable Voice","sidebarTitle":"Receiving Webhooks","href":"/docs/voice/programmable-voice/receiving-webhooks/index"},{"title":"Command Retries","sidebarTitle":"Command Retries","href":"/docs/voice/programmable-voice/command-retries/index"},{"title":"Dials Per Second Limit","sidebarTitle":"Dials Per Second Limit","href":"/docs/voice/programmable-voice/dials-per-second-limit/index"},{"title":"Dial Metrics","sidebarTitle":"Dial Metrics","href":"/docs/voice/programmable-voice/dial-metrics/index"}]},{"group":"Voice Features","pages":[{"title":"Speech-to-Text with Voice API and TeXML","sidebarTitle":"Speech-to-Text","href":"/docs/voice/programmable-voice/speech-to-text/index"},{"title":"Text-to-Speech","sidebarTitle":"Text-to-Speech","href":"/docs/voice/programmable-voice/tts/index"},{"title":"Queueing Calls","sidebarTitle":"Call Queueing","href":"/docs/voice/programmable-voice/queueing-calls/index"},{"title":"Answering Machine Detection","sidebarTitle":"Answering Machine Detection","href":"/docs/voice/programmable-voice/answering-machine-detection/index"},{"title":"Custom voicemail greeting","sidebarTitle":"Custom Voicemail Greeting","href":"/docs/voice/programmable-voice/custom-voicemail-greeting/index"},{"title":"Storing call recordings","sidebarTitle":"Call Recordings Storage","href":"/docs/voice/programmable-voice/storing-call-recordings/index"},{"title":"Pay over Voice","sidebarTitle":"Pay","href":"/docs/voice/programmable-voice/pay/index"},{"group":"SIPREC Recording","pages":[{"title":"Telnyx SIPREC server (SRS) Configuration Guide","sidebarTitle":"SIPREC Server Configuration","href":"/docs/voice/programmable-voice/siprec-server/index"},{"title":"Using SIPREC client for Voice API and TeXML calls","sidebarTitle":"SIPREC Client","href":"/docs/voice/programmable-voice/siprec-client/index"}]}]},{"group":"AI Capabilities","pages":[{"title":"Gather using AI","sidebarTitle":"Gather Using AI","href":"/docs/voice/programmable-voice/gather-using-ai/index"},{"title":"Attach an AI Assistant to a Call","href":"/docs/voice/programmable-voice/ai-assistant-start/index"},{"title":"Dialogflow ES","sidebarTitle":"Dialogflow Integration","href":"/docs/voice/programmable-voice/dialogflow-es/index"},{"title":"Media Streaming over Websockets","sidebarTitle":"Real-Time Media Streaming","href":"/docs/voice/programmable-voice/media-streaming/index"},{"title":"Conversation Relay over WebSockets","sidebarTitle":"Conversation Relay","href":"/docs/voice/programmable-voice/conversation-relay/index"},{"title":"Noise Suppression","sidebarTitle":"Noise Suppression","href":"/docs/voice/programmable-voice/noise-suppression/index"},{"title":"Deepfake Detection","sidebarTitle":"Deepfake Detection","href":"/docs/voice/programmable-voice/deepfake-detection/index"}]},{"group":"Tutorials","pages":[{"title":"IVR Demo","sidebarTitle":"IVR","href":"/docs/voice/programmable-voice/ivr-demo/index"},{"title":"Call Center Demo","sidebarTitle":"Call Center","href":"/docs/voice/programmable-voice/call-center/index"},{"title":"Call Tracking Demo","sidebarTitle":"Call Tracking","href":"/docs/voice/programmable-voice/call-tracking/index"},{"title":"Conferencing Demo","sidebarTitle":"Conferencing","href":"/docs/voice/programmable-voice/conferencing-demo/index"}]},{"group":"Regional \u0026 Restrictions","pages":[{"title":"Voice API Services in Europe","sidebarTitle":"Voice API Services in Europe","href":"/docs/voice/programmable-voice/voice-api-services-in-europe/index"},{"title":"Programmable Voice restrictions for L1 verified accounts","sidebarTitle":"L1 Account Restrictions","href":"/docs/voice/programmable-voice/l1-accounts-restirctions/index"}]},{"group":"API Reference","pages":[{"group":"Voice API Applications","pages":[{"group":"Applications","pages":[{"title":"List call control applications","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /call_control_applications","href":"/api-reference/call-control-applications/list-call-control-applications"},{"title":"Create a call control application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /call_control_applications","href":"/api-reference/call-control-applications/create-a-call-control-application"},{"title":"Delete a call control application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json delete /call_control_applications/{id}","href":"/api-reference/call-control-applications/delete-a-call-control-application"},{"title":"Retrieve a call control application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /call_control_applications/{id}","href":"/api-reference/call-control-applications/retrieve-a-call-control-application"},{"title":"Update a call control application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json patch /call_control_applications/{id}","href":"/api-reference/call-control-applications/update-a-call-control-application"}]},{"group":"Active Calls","pages":[{"title":"List all active calls for given connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /connections/{connection_id}/active_calls","href":"/api-reference/call-information/list-all-active-calls-for-given-connection"}]},{"group":"Call Events","pages":[{"title":"List call events","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /call_events","href":"/api-reference/debugging/list-call-events"}]},{"group":"Call Information","pages":[{"title":"Retrieve a call status","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /calls/{call_control_id}","href":"/api-reference/call-information/retrieve-a-call-status"}]},{"group":"Dial Metrics","pages":[{"title":"List dial metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /dial_metrics","href":"/api-reference/call-information/list-dial-metrics"}]}]},{"group":"Voice API Commands","pages":[{"group":"Dial","pages":[{"group":"Call Commands API","pages":[{"title":"Dial","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls","href":"/api-reference/call-commands/dial"}]},{"group":"Callbacks API","pages":[{"title":"Call answered","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callAnswered","href":"/api-reference/callbacks/call-answered"},{"title":"Call conversation created","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationCreated","href":"/api-reference/callbacks/call-conversation-created"},{"title":"Call conversation start failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationStartFailed","href":"/api-reference/callbacks/call-conversation-start-failed"},{"title":"Call cost","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callCost","href":"/api-reference/callbacks/call-cost"},{"title":"Call deepfake detection error","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDeepfakeDetectionError","href":"/api-reference/callbacks/call-deepfake-detection-error"},{"title":"Call deepfake detection result","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDeepfakeDetectionResult","href":"/api-reference/callbacks/call-deepfake-detection-result"},{"title":"Call hold","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callHold","href":"/api-reference/callbacks/call-hold"},{"title":"Call initiated","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callInitiated","href":"/api-reference/callbacks/call-initiated"},{"title":"Call streaming failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingFailed","href":"/api-reference/callbacks/call-streaming-failed"},{"title":"Call streaming started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStarted","href":"/api-reference/callbacks/call-streaming-started"},{"title":"Call streaming stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStopped","href":"/api-reference/callbacks/call-streaming-stopped"},{"title":"Call unhold","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callUnhold","href":"/api-reference/callbacks/call-unhold"}]}]},{"group":"Answer","pages":[{"group":"Call Commands API","pages":[{"title":"Answer call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/answer","href":"/api-reference/call-commands/answer-call"}]},{"group":"Callbacks API","pages":[{"title":"Call answered","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callAnswered","href":"/api-reference/callbacks/call-answered"},{"title":"Call conversation created","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationCreated","href":"/api-reference/callbacks/call-conversation-created"},{"title":"Call conversation start failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationStartFailed","href":"/api-reference/callbacks/call-conversation-start-failed"},{"title":"Call deepfake detection error","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDeepfakeDetectionError","href":"/api-reference/callbacks/call-deepfake-detection-error"},{"title":"Call deepfake detection result","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDeepfakeDetectionResult","href":"/api-reference/callbacks/call-deepfake-detection-result"},{"title":"Call streaming failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingFailed","href":"/api-reference/callbacks/call-streaming-failed"},{"title":"Call streaming started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStarted","href":"/api-reference/callbacks/call-streaming-started"},{"title":"Call streaming stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStopped","href":"/api-reference/callbacks/call-streaming-stopped"}]}]},{"group":"Bridge","pages":[{"group":"Call Commands API","pages":[{"title":"Bridge calls","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/bridge","href":"/api-reference/call-commands/bridge-calls"}]},{"group":"Callbacks API","pages":[{"title":"Call bridged","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callBridged","href":"/api-reference/callbacks/call-bridged"}]}]},{"group":"Start AI assistant","pages":[{"group":"Call Commands API","pages":[{"title":"Start AI Assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/ai_assistant_start","href":"/api-reference/call-commands/start-ai-assistant"}]},{"group":"Callbacks API","pages":[{"title":"Call conversation created","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationCreated","href":"/api-reference/callbacks/call-conversation-created"},{"title":"Call conversation ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationEnded","href":"/api-reference/callbacks/call-conversation-ended"},{"title":"Call conversation insights generated","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationInsightsGenerated","href":"/api-reference/callbacks/call-conversation-insights-generated"},{"title":"Call analyzed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callAnalyzed","href":"/api-reference/callbacks/call-analyzed"}]}]},{"group":"Join AI assistant","pages":[{"group":"Call Commands API","pages":[{"title":"Join AI Assistant Conversation","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/ai_assistant_join","href":"/api-reference/call-commands/join-ai-assistant-conversation"}]},{"group":"Callbacks API","pages":[{"title":"Call conversation ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationEnded","href":"/api-reference/callbacks/call-conversation-ended"},{"title":"Call conversation insights generated","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationInsightsGenerated","href":"/api-reference/callbacks/call-conversation-insights-generated"},{"title":"Call analyzed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callAnalyzed","href":"/api-reference/callbacks/call-analyzed"}]}]},{"group":"Stop AI assistant","pages":[{"title":"Stop AI Assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/ai_assistant_stop","href":"/api-reference/call-commands/stop-ai-assistant"}]},{"group":"Add messages to AI Assistant","pages":[{"title":"Add messages to AI Assistant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/ai_assistant_add_messages","href":"/api-reference/call-commands/add-messages-to-ai-assistant"}]},{"group":"Start Conversation Relay","pages":[{"title":"Start Conversation Relay","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/conversation_relay_start","href":"/api-reference/call-commands/start-conversation-relay"}]},{"group":"Stop Conversation Relay","pages":[{"title":"Stop Conversation Relay","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/conversation_relay_stop","href":"/api-reference/call-commands/stop-conversation-relay"}]},{"group":"Conversation Relay","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/conversation-relay/conversation-relay.yml conversation-relay-websocket","href":"/api-reference/websockets/conversationrelay-websocket-channel","title":"ConversationRelay WebSocket channel","version":null}]}]},{"group":"Update client state","pages":[{"title":"Update client state","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json put /calls/{call_control_id}/actions/client_state_update","href":"/api-reference/call-commands/update-client-state"}]},{"group":"Enqueue call","pages":[{"group":"Call Commands API","pages":[{"title":"Enqueue call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/enqueue","href":"/api-reference/call-commands/enqueue-call"}]},{"group":"Callbacks API","pages":[{"title":"Call enqueued","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callEnqueued","href":"/api-reference/callbacks/call-enqueued"},{"title":"Call left queue","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callLeftQueue","href":"/api-reference/callbacks/call-left-queue"}]}]},{"group":"Forking start","pages":[{"group":"Call Commands API","pages":[{"title":"Forking start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/fork_start","href":"/api-reference/call-commands/forking-start"}]},{"group":"Callbacks API","pages":[{"title":"Call fork started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callForkStarted","href":"/api-reference/callbacks/call-fork-started"}]}]},{"group":"Forking stop","pages":[{"group":"Call Commands API","pages":[{"title":"Forking stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/fork_stop","href":"/api-reference/call-commands/forking-stop"}]},{"group":"Callbacks API","pages":[{"title":"Call fork stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callForkStopped","href":"/api-reference/callbacks/call-fork-stopped"}]}]},{"group":"Gather","pages":[{"group":"Call Commands API","pages":[{"title":"Gather","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/gather","href":"/api-reference/call-commands/gather"}]},{"group":"Callbacks API","pages":[{"title":"Call dtmf received","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDtmfReceived","href":"/api-reference/callbacks/call-dtmf-received"},{"title":"Call gather ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callGatherEnded","href":"/api-reference/callbacks/call-gather-ended"}]}]},{"group":"Gather stop","pages":[{"group":"Call Commands API","pages":[{"title":"Gather stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/gather_stop","href":"/api-reference/call-commands/gather-stop"}]},{"group":"Callbacks API","pages":[{"title":"Call gather ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callGatherEnded","href":"/api-reference/callbacks/call-gather-ended"}]}]},{"group":"Gather using AI","pages":[{"group":"Call Commands API","pages":[{"title":"Gather using AI","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/gather_using_ai","href":"/api-reference/call-commands/gather-using-ai"}]},{"group":"Callbacks API","pages":[{"title":"Call conversation created","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationCreated","href":"/api-reference/callbacks/call-conversation-created"},{"title":"Call ai gather ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook CallAIGatherEnded","href":"/api-reference/callbacks/call-ai-gather-ended"},{"title":"Call ai gather message history updated","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook CallAIGatherMessageHistoryUpdated","href":"/api-reference/callbacks/call-ai-gather-message-history-updated"},{"title":"Call ai gather partial results","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook CallAIGatherPartialResults","href":"/api-reference/callbacks/call-ai-gather-partial-results"},{"title":"Call conversation ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callConversationEnded","href":"/api-reference/callbacks/call-conversation-ended"}]}]},{"group":"Gather using audio","pages":[{"group":"Call Commands API","pages":[{"title":"Gather using audio","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/gather_using_audio","href":"/api-reference/call-commands/gather-using-audio"}]},{"group":"Callbacks API","pages":[{"title":"Call dtmf received","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDtmfReceived","href":"/api-reference/callbacks/call-dtmf-received"},{"title":"Call gather ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callGatherEnded","href":"/api-reference/callbacks/call-gather-ended"},{"title":"Call playback ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPlaybackEnded","href":"/api-reference/callbacks/call-playback-ended"},{"title":"Call playback started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPlaybackStarted","href":"/api-reference/callbacks/call-playback-started"}]}]},{"group":"Gather using speak","pages":[{"group":"Call Commands API","pages":[{"title":"Gather using speak","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/gather_using_speak","href":"/api-reference/call-commands/gather-using-speak"}]},{"group":"Callbacks API","pages":[{"title":"Call dtmf received","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callDtmfReceived","href":"/api-reference/callbacks/call-dtmf-received"},{"title":"Call gather ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callGatherEnded","href":"/api-reference/callbacks/call-gather-ended"}]}]},{"group":"Hangup","pages":[{"group":"Call Commands API","pages":[{"title":"Hangup call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/hangup","href":"/api-reference/call-commands/hangup-call"}]},{"group":"Callbacks API","pages":[{"title":"Call hangup","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callHangup","href":"/api-reference/callbacks/call-hangup"},{"title":"Call recording saved","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callRecordingSaved","href":"/api-reference/callbacks/call-recording-saved"}]}]},{"group":"Reject a call","pages":[{"group":"Call Commands API","pages":[{"title":"Reject a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/reject","href":"/api-reference/call-commands/reject-a-call"}]},{"group":"Callbacks API","pages":[{"title":"Call hangup","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callHangup","href":"/api-reference/callbacks/call-hangup"}]}]},{"group":"Remove call from the queue","pages":[{"title":"Remove call from a queue","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/leave_queue","href":"/api-reference/call-commands/remove-call-from-a-queue"}]},{"group":"Process a payment","pages":[{"group":"Call Commands API","pages":[{"title":"Process a payment","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/pay","href":"/api-reference/call-commands/process-a-payment"}]},{"group":"Callbacks API","pages":[{"title":"Call payment completed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPaymentCompleted","href":"/api-reference/callbacks/call-payment-completed"},{"title":"Call payment progress","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPaymentProgress","href":"/api-reference/callbacks/call-payment-progress"}]}]},{"group":"Play audio playback","pages":[{"group":"Call Commands API","pages":[{"title":"Play audio URL","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/playback_start","href":"/api-reference/call-commands/play-audio-url"}]},{"group":"Callbacks API","pages":[{"title":"Call playback ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPlaybackEnded","href":"/api-reference/callbacks/call-playback-ended"},{"title":"Call playback started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPlaybackStarted","href":"/api-reference/callbacks/call-playback-started"}]}]},{"group":"Stop audio playback","pages":[{"group":"Call Commands API","pages":[{"title":"Stop audio playback","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/playback_stop","href":"/api-reference/call-commands/stop-audio-playback"}]},{"group":"Callbacks API","pages":[{"title":"Call playback ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callPlaybackEnded","href":"/api-reference/callbacks/call-playback-ended"},{"title":"Call speak ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSpeakEnded","href":"/api-reference/callbacks/call-speak-ended"}]}]},{"group":"Recording start","pages":[{"group":"Call Commands API","pages":[{"title":"Recording start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/record_start","href":"/api-reference/call-commands/recording-start"}]},{"group":"Callbacks API","pages":[{"title":"Call recording error","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callRecordingError","href":"/api-reference/callbacks/call-recording-error"},{"title":"Call recording saved","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callRecordingSaved","href":"/api-reference/callbacks/call-recording-saved"},{"title":"Call recording transcription saved","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callRecordingTranscriptionSaved","href":"/api-reference/callbacks/call-recording-transcription-saved"}]}]},{"group":"Recording stop","pages":[{"group":"Call Commands API","pages":[{"title":"Recording stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/record_stop","href":"/api-reference/call-commands/recording-stop"}]},{"group":"Callbacks API","pages":[{"title":"Call recording saved","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callRecordingSaved","href":"/api-reference/callbacks/call-recording-saved"}]}]},{"group":"Recording resume","pages":[{"title":"Record resume","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/record_resume","href":"/api-reference/call-commands/record-resume"}]},{"group":"Recording pause","pages":[{"title":"Record pause","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/record_pause","href":"/api-reference/call-commands/record-pause"}]},{"group":"Send DTMF","pages":[{"title":"Send DTMF","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/send_dtmf","href":"/api-reference/call-commands/send-dtmf"}]},{"group":"SIP refer","pages":[{"group":"Call Commands API","pages":[{"title":"SIP Refer a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/refer","href":"/api-reference/call-commands/sip-refer-a-call"}]},{"group":"Callbacks API","pages":[{"title":"Call refer completed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callReferCompleted","href":"/api-reference/callbacks/call-refer-completed"},{"title":"Call refer failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callReferFailed","href":"/api-reference/callbacks/call-refer-failed"},{"title":"Call refer started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callReferStarted","href":"/api-reference/callbacks/call-refer-started"}]}]},{"group":"SIPREC start","pages":[{"group":"Call Commands API","pages":[{"title":"SIPREC start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/siprec_start","href":"/api-reference/call-commands/siprec-start"}]},{"group":"Callbacks API","pages":[{"title":"Call siprec failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSiprecFailed","href":"/api-reference/callbacks/call-siprec-failed"},{"title":"Call siprec started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSiprecStarted","href":"/api-reference/callbacks/call-siprec-started"},{"title":"Call siprec stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSiprecStopped","href":"/api-reference/callbacks/call-siprec-stopped"}]}]},{"group":"SIPREC stop","pages":[{"group":"Call Commands API","pages":[{"title":"SIPREC stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/siprec_stop","href":"/api-reference/call-commands/siprec-stop"}]},{"group":"Callbacks API","pages":[{"title":"Call siprec stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSiprecStopped","href":"/api-reference/callbacks/call-siprec-stopped"}]}]},{"group":"Speak text","pages":[{"group":"Call Commands API","pages":[{"title":"Speak text","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/speak","href":"/api-reference/call-commands/speak-text"}]},{"group":"Callbacks API","pages":[{"title":"Call speak ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSpeakEnded","href":"/api-reference/callbacks/call-speak-ended"},{"title":"Call speak started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callSpeakStarted","href":"/api-reference/callbacks/call-speak-started"}]}]},{"group":"Streaming start","pages":[{"group":"Call Commands API","pages":[{"title":"Streaming start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/streaming_start","href":"/api-reference/call-commands/streaming-start"}]},{"group":"Callbacks API","pages":[{"title":"Call streaming failed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingFailed","href":"/api-reference/callbacks/call-streaming-failed"},{"title":"Call streaming started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStarted","href":"/api-reference/callbacks/call-streaming-started"},{"title":"Call streaming stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStopped","href":"/api-reference/callbacks/call-streaming-stopped"}]}]},{"group":"Streaming stop","pages":[{"group":"Call Commands API","pages":[{"title":"Streaming stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/streaming_stop","href":"/api-reference/call-commands/streaming-stop"}]},{"group":"Callbacks API","pages":[{"title":"Call streaming stopped","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callStreamingStopped","href":"/api-reference/callbacks/call-streaming-stopped"}]}]},{"group":"Media Streaming","pages":[{"group":"Websockets","pages":[{"asyncapi":"openapi/asyncapi/media-streaming/media-streaming.yml media-streaming-websocket","href":"/api-reference/websockets/stream-call-media-over-websocket","title":"Stream call media over WebSocket","version":null}]}]},{"group":"Noise Suppression start","pages":[{"title":"Noise Suppression Start (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/suppression_start","href":"/api-reference/call-commands/noise-suppression-start-beta"}]},{"group":"Noise Suppression stop","pages":[{"title":"Noise Suppression Stop (BETA)","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/suppression_stop","href":"/api-reference/call-commands/noise-suppression-stop-beta"}]},{"group":"Switch supervisor role","pages":[{"title":"Switch supervisor role","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/switch_supervisor_role","href":"/api-reference/call-commands/switch-supervisor-role"}]},{"group":"Transcription start","pages":[{"group":"Call Commands API","pages":[{"title":"Transcription start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/transcription_start","href":"/api-reference/call-commands/transcription-start"}]},{"group":"Callbacks API","pages":[{"title":"Transcription","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook transcription","href":"/api-reference/callbacks/transcription"}]}]},{"group":"Transcription stop","pages":[{"title":"Transcription stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/transcription_stop","href":"/api-reference/call-commands/transcription-stop"}]},{"group":"Transfer call","pages":[{"group":"Call Commands API","pages":[{"title":"Transfer call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /calls/{call_control_id}/actions/transfer","href":"/api-reference/call-commands/transfer-call"}]},{"group":"Callbacks API","pages":[{"title":"Call answered","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callAnswered","href":"/api-reference/callbacks/call-answered"},{"title":"Call bridged","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callBridged","href":"/api-reference/callbacks/call-bridged"},{"title":"Call initiated","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callInitiated","href":"/api-reference/callbacks/call-initiated"},{"title":"Call machine detection ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachineDetectionEnded","href":"/api-reference/callbacks/call-machine-detection-ended"},{"title":"Call machine greeting ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachineGreetingEnded","href":"/api-reference/callbacks/call-machine-greeting-ended"},{"title":"Call machine premium detection ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachinePremiumDetectionEnded","href":"/api-reference/callbacks/call-machine-premium-detection-ended"},{"title":"Call machine premium detection started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachinePremiumDetectionStarted","href":"/api-reference/callbacks/call-machine-premium-detection-started"},{"title":"Call machine premium greeting ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachinePremiumGreetingEnded","href":"/api-reference/callbacks/call-machine-premium-greeting-ended"},{"title":"Call machine premium call screening detected","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook callMachinePremiumCallScreeningDetected","href":"/api-reference/callbacks/call-machine-premium-call-screening-detected"}]}]},{"group":"Conference Commands","pages":[{"group":"Conference Commands API","pages":[{"title":"List conferences","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /conferences","href":"/api-reference/conference-commands/list-conferences"},{"title":"Create conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences","href":"/api-reference/conference-commands/create-conference"},{"title":"Retrieve a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /conferences/{id}","href":"/api-reference/conference-commands/retrieve-a-conference"},{"title":"Hold conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/hold","href":"/api-reference/conference-commands/hold-conference-participants"},{"title":"Join a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/join","href":"/api-reference/conference-commands/join-a-conference"},{"title":"Leave a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/leave","href":"/api-reference/conference-commands/leave-a-conference"},{"title":"Mute conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/mute","href":"/api-reference/conference-commands/mute-conference-participants"},{"title":"Play audio to conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/play","href":"/api-reference/conference-commands/play-audio-to-conference-participants"},{"title":"Conference recording pause","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/record_pause","href":"/api-reference/conference-commands/conference-recording-pause"},{"title":"Conference recording resume","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/record_resume","href":"/api-reference/conference-commands/conference-recording-resume"},{"title":"Conference recording start","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/record_start","href":"/api-reference/conference-commands/conference-recording-start"},{"title":"Conference recording stop","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/record_stop","href":"/api-reference/conference-commands/conference-recording-stop"},{"title":"Speak text to conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/speak","href":"/api-reference/conference-commands/speak-text-to-conference-participants"},{"title":"Stop audio being played on the conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/stop","href":"/api-reference/conference-commands/stop-audio-being-played-on-the-conference"},{"title":"Unhold conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/unhold","href":"/api-reference/conference-commands/unhold-conference-participants"},{"title":"Unmute conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/unmute","href":"/api-reference/conference-commands/unmute-conference-participants"},{"title":"Update conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/update","href":"/api-reference/conference-commands/update-conference-participant"},{"title":"End a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/end","href":"/api-reference/conference-commands/end-a-conference"},{"title":"Gather DTMF using audio prompt in a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/gather_using_audio","href":"/api-reference/conference-commands/gather-dtmf-using-audio-prompt-in-a-conference"},{"title":"Send DTMF to conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json post /conferences/{id}/actions/send_dtmf","href":"/api-reference/conference-commands/send-dtmf-to-conference-participants"},{"title":"List conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /conferences/{conference_id}/participants","href":"/api-reference/conference-commands/list-conference-participants"},{"title":"Retrieve a conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json get /conferences/{id}/participants/{participant_id}","href":"/api-reference/conference-commands/retrieve-a-conference-participant"},{"title":"Update a conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/call-control.json patch /conferences/{id}/participants/{participant_id}","href":"/api-reference/conference-commands/update-a-conference-participant"}]},{"group":"Callbacks API","pages":[{"title":"Conference created","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceCreated","href":"/api-reference/callbacks/conference-created"},{"title":"Conference ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceEnded","href":"/api-reference/callbacks/conference-ended"},{"title":"Conference floor changed","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceFloorChanged","href":"/api-reference/callbacks/conference-floor-changed"},{"title":"Conference participant joined","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantJoined","href":"/api-reference/callbacks/conference-participant-joined"},{"title":"Conference participant left","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantLeft","href":"/api-reference/callbacks/conference-participant-left"},{"title":"Conference participant playback ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantPlaybackEnded","href":"/api-reference/callbacks/conference-participant-playback-ended"},{"title":"Conference participant playback started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantPlaybackStarted","href":"/api-reference/callbacks/conference-participant-playback-started"},{"title":"Conference participant speak ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantSpeakEnded","href":"/api-reference/callbacks/conference-participant-speak-ended"},{"title":"Conference participant speak started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceParticipantSpeakStarted","href":"/api-reference/callbacks/conference-participant-speak-started"},{"title":"Conference playback ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferencePlaybackEnded","href":"/api-reference/callbacks/conference-playback-ended"},{"title":"Conference playback started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferencePlaybackStarted","href":"/api-reference/callbacks/conference-playback-started"},{"title":"Conference recording saved","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceRecordingSaved","href":"/api-reference/callbacks/conference-recording-saved"},{"title":"Conference speak ended","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceSpeakEnded","href":"/api-reference/callbacks/conference-speak-ended"},{"title":"Conference speak started","version":null,"deprecated":null,"openapi":"/openapi/source/external/call-control/call-control.json webhook conferenceSpeakStarted","href":"/api-reference/callbacks/conference-speak-started"}]}]}]},{"group":"Pay Connectors API","pages":[{"title":"Create a Pay connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/pay-connectors.json post /pay_connectors","href":"/api-reference/pay-connectors/create-a-pay-connector"},{"title":"List Pay connectors","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/pay-connectors.json get /pay_connectors","href":"/api-reference/pay-connectors/list-pay-connectors"},{"title":"Retrieve a Pay connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/pay-connectors.json get /pay_connectors/{name}","href":"/api-reference/pay-connectors/retrieve-a-pay-connector"},{"title":"Update a Pay connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/pay-connectors.json patch /pay_connectors/{name}","href":"/api-reference/pay-connectors/update-a-pay-connector"},{"title":"Delete a Pay connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-control/pay-connectors.json delete /pay_connectors/{name}","href":"/api-reference/pay-connectors/delete-a-pay-connector"}]},{"group":"SIPREC Connectors API","pages":[{"title":"Create a SIPREC connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/siprec/siprec.json post /siprec_connectors","href":"/api-reference/siprec-connectors/create-a-siprec-connector"},{"title":"Retrieve a SIPREC connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/siprec/siprec.json get /siprec_connectors/{connector_name}","href":"/api-reference/siprec-connectors/retrieve-a-siprec-connector"},{"title":"Update a SIPREC connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/siprec/siprec.json put /siprec_connectors/{connector_name}","href":"/api-reference/siprec-connectors/update-a-siprec-connector"},{"title":"Delete a SIPREC connector","deprecated":null,"version":null,"openapi":"/openapi/source/external/siprec/siprec.json delete /siprec_connectors/{connector_name}","href":"/api-reference/siprec-connectors/delete-a-siprec-connector"}]}]},{"group":"For AI Agents","pages":[{"title":"Voice API llms.txt","sidebarTitle":"Voice API llms txt","href":"/docs/development/llms/calling-voice-api-llms-txt/index"},{"title":"Voice API llms-full.txt","sidebarTitle":"Voice API llms full txt","href":"/docs/development/llms/calling-voice-api-llms-full-txt/index"}]}]},{"tab":"TeXML","icon":"code","groups":[{"group":"Guides","pages":[{"title":"TeXML Fundamentals","sidebarTitle":"TeXML Fundamentals","href":"/docs/voice/programmable-voice/texml-fundamentals"},{"title":"TeXML Instruction Fetching","sidebarTitle":"Instruction Fetching","href":"/docs/voice/programmable-voice/texml-instruction-fetching/index"},{"title":"TeXML Interpreter","sidebarTitle":"TeXML Interpreter","href":"/docs/voice/programmable-voice/texml-interpreter/index"},{"title":"TeXML and TwiML Compatibility","sidebarTitle":"TeXML TwiML Compatibility","href":"/docs/voice/programmable-voice/texml-twiml-compatibility/index"},{"title":"TeXML Bin Dynamic Content","sidebarTitle":"Dynamic TeXML Bins","href":"/docs/voice/programmable-voice/texml-bin-dynamic/index"},{"title":"Sending HTTP requests in TeXML - tutorial","sidebarTitle":"Sending HTTP Requests","href":"/docs/voice/programmable-voice/texml-sending-http-requests/index"},{"title":"TeXML Answering Machine Detection Support","sidebarTitle":"TeXML Answering Machine","href":"/docs/voice/programmable-voice/texml-answering-machine/index"}]},{"group":"Markup Language","pages":[{"title":"Dial","sidebarTitle":"Dial","href":"/docs/voice/programmable-voice/texml-verbs/dial/index"},{"title":"Say","sidebarTitle":"Say","href":"/docs/voice/programmable-voice/texml-verbs/say/index"},{"title":"Play","sidebarTitle":"Play","href":"/docs/voice/programmable-voice/texml-verbs/play/index"},{"title":"Gather","sidebarTitle":"Gather","href":"/docs/voice/programmable-voice/texml-verbs/gather/index"},{"title":"AIGather","sidebarTitle":"AIGather","href":"/docs/voice/programmable-voice/texml-verbs/aigather/index"},{"title":"AIAssistant","sidebarTitle":"AIAssistant","href":"/docs/voice/programmable-voice/texml-verbs/aiassistant/index"},{"title":"Record","sidebarTitle":"Record","href":"/docs/voice/programmable-voice/texml-verbs/record/index"},{"title":"Conference","sidebarTitle":"Conference","href":"/docs/voice/programmable-voice/texml-verbs/conference/index"},{"title":"Enqueue","sidebarTitle":"Enqueue","href":"/docs/voice/programmable-voice/texml-verbs/enqueue/index"},{"title":"Hangup","sidebarTitle":"Hangup","href":"/docs/voice/programmable-voice/texml-verbs/hangup/index"},{"title":"Pause","sidebarTitle":"Pause","href":"/docs/voice/programmable-voice/texml-verbs/pause/index"},{"title":"Pay","sidebarTitle":"Pay","href":"/docs/voice/programmable-voice/texml-verbs/pay/index"},{"title":"Redirect","sidebarTitle":"Redirect","href":"/docs/voice/programmable-voice/texml-verbs/redirect/index"},{"title":"Reject","sidebarTitle":"Reject","href":"/docs/voice/programmable-voice/texml-verbs/reject/index"},{"title":"Stream","sidebarTitle":"Stream","href":"/docs/voice/programmable-voice/texml-verbs/stream/index"},{"title":"ConversationRelay","sidebarTitle":"ConversationRelay","href":"/docs/voice/programmable-voice/texml-verbs/conversationrelay/index"},{"title":"Connect","sidebarTitle":"Connect","href":"/docs/voice/programmable-voice/texml-verbs/connect/index"},{"title":"HttpRequest","sidebarTitle":"HttpRequest","href":"/docs/voice/programmable-voice/texml-verbs/httprequest/index"},{"title":"Leave","sidebarTitle":"Leave","href":"/docs/voice/programmable-voice/texml-verbs/leave/index"},{"title":"Refer","sidebarTitle":"Refer","href":"/docs/voice/programmable-voice/texml-verbs/refer/index"},{"title":"Siprec","sidebarTitle":"Siprec","href":"/docs/voice/programmable-voice/texml-verbs/siprec/index"},{"title":"Start","sidebarTitle":"Start","href":"/docs/voice/programmable-voice/texml-verbs/start/index"},{"title":"Stop","sidebarTitle":"Stop","href":"/docs/voice/programmable-voice/texml-verbs/stop/index"},{"title":"Suppression","sidebarTitle":"Suppression","href":"/docs/voice/programmable-voice/texml-verbs/suppression/index"},{"title":"Transcription","sidebarTitle":"Transcription","href":"/docs/voice/programmable-voice/texml-verbs/transcription/index"}]},{"group":"API Reference","pages":[{"group":"Applications","pages":[{"title":"Applications","href":"/docs/voice/texml/rest-api/applications/index"},{"title":"List all TeXML Applications","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml_applications","href":"/api-reference/texml-applications/list-all-texml-applications"},{"title":"Creates a TeXML Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml_applications","href":"/api-reference/texml-applications/creates-a-texml-application"},{"title":"Retrieve a TeXML Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml_applications/{id}","href":"/api-reference/texml-applications/retrieve-a-texml-application"},{"title":"Update a TeXML Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json patch /texml_applications/{id}","href":"/api-reference/texml-applications/update-a-texml-application"},{"title":"Deletes a TeXML Application","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json delete /texml_applications/{id}","href":"/api-reference/texml-applications/deletes-a-texml-application"}]},{"group":"Calls","pages":[{"title":"Calls","href":"/docs/voice/texml/rest-api/calls/index"},{"group":"TeXML REST Commands API","pages":[{"title":"Fetch multiple call resources","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Calls","href":"/api-reference/texml-rest-commands/fetch-multiple-call-resources"},{"title":"Initiate an outbound call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls","href":"/api-reference/texml-rest-commands/initiate-an-outbound-call"},{"title":"Create a connection-scoped TeXML call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/calls/{connection_id}","href":"/api-reference/texml-rest-commands/create-a-connection-scoped-texml-call"},{"title":"Fetch a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Calls/{call_sid}","href":"/api-reference/texml-rest-commands/fetch-a-call"},{"title":"Update call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}","href":"/api-reference/texml-rest-commands/update-call"},{"title":"Initiate an outbound AI call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/ai_calls/{connection_id}","href":"/api-reference/texml-rest-commands/initiate-an-outbound-ai-call"}]},{"group":"Callbacks API","pages":[{"title":"Texml ai gather","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlAiGatherWebhook","href":"/api-reference/callbacks/texml-ai-gather"},{"title":"Texml call amd","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallAmdWebhook","href":"/api-reference/callbacks/texml-call-amd"},{"title":"Texml call answered","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallAnsweredWebhook","href":"/api-reference/callbacks/texml-call-answered"},{"title":"Texml call completed","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallCompletedWebhook","href":"/api-reference/callbacks/texml-call-completed"},{"title":"Texml call dtmf","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallDtmfWebhook","href":"/api-reference/callbacks/texml-call-dtmf"},{"title":"Texml call initiated","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallInitiatedWebhook","href":"/api-reference/callbacks/texml-call-initiated"},{"title":"Texml call ringing","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlCallRingingWebhook","href":"/api-reference/callbacks/texml-call-ringing"},{"title":"Texml gather","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlGatherWebhook","href":"/api-reference/callbacks/texml-gather"},{"title":"Texml http request","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlHttpRequestWebhook","href":"/api-reference/callbacks/texml-http-request"},{"title":"Texml refer status","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/calls.json webhook TexmlReferStatusWebhook","href":"/api-reference/callbacks/texml-refer-status"}]}]},{"group":"Conferences","pages":[{"title":"Conferences","href":"/docs/voice/texml/rest-api/conferences/index"},{"group":"TeXML REST Commands API","pages":[{"title":"List conference resources","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences","href":"/api-reference/texml-rest-commands/list-conference-resources"},{"title":"Fetch a conference resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences/{conference_sid}","href":"/api-reference/texml-rest-commands/fetch-a-conference-resource"},{"title":"Update a conference resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Conferences/{conference_sid}","href":"/api-reference/texml-rest-commands/update-a-conference-resource"}]},{"group":"Callbacks API","pages":[{"title":"Texml conference end","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conferences.json webhook TexmlConferenceEndWebhook","href":"/api-reference/callbacks/texml-conference-end"},{"title":"Texml conference join","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceJoinWebhook","href":"/api-reference/callbacks/texml-conference-join"},{"title":"Texml conference leave","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceLeaveWebhook","href":"/api-reference/callbacks/texml-conference-leave"},{"title":"Texml conference speaker","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceSpeakerWebhook","href":"/api-reference/callbacks/texml-conference-speaker"},{"title":"Texml conference start","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conferences.json webhook TexmlConferenceStartWebhook","href":"/api-reference/callbacks/texml-conference-start"}]}]},{"group":"Conference Participants","pages":[{"title":"Conference participants","href":"/docs/voice/texml/rest-api/conference-participants/index"},{"group":"TeXML REST Commands API","pages":[{"title":"List conference participants","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants","href":"/api-reference/texml-rest-commands/list-conference-participants"},{"title":"Dial a new conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants","href":"/api-reference/texml-rest-commands/dial-a-new-conference-participant"},{"title":"Get conference participant resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}","href":"/api-reference/texml-rest-commands/get-conference-participant-resource"},{"title":"Update a conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}","href":"/api-reference/texml-rest-commands/update-a-conference-participant"},{"title":"Delete a conference participant","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json delete /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}","href":"/api-reference/texml-rest-commands/delete-a-conference-participant"}]},{"group":"Callbacks API","pages":[{"title":"Texml conference join","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceJoinWebhook","href":"/api-reference/callbacks/texml-conference-join"},{"title":"Texml conference leave","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceLeaveWebhook","href":"/api-reference/callbacks/texml-conference-leave"},{"title":"Texml conference speaker","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/conference-participants.json webhook TexmlConferenceSpeakerWebhook","href":"/api-reference/callbacks/texml-conference-speaker"}]}]},{"group":"Recordings","pages":[{"title":"Recordings","href":"/docs/voice/texml/rest-api/recordings/index"},{"group":"TeXML REST Commands API","pages":[{"title":"Fetch multiple recording resources","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Recordings.json","href":"/api-reference/texml-rest-commands/fetch-multiple-recording-resources"},{"title":"Fetch recording resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json","href":"/api-reference/texml-rest-commands/fetch-recording-resource"},{"title":"Delete recording resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json delete /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json","href":"/api-reference/texml-rest-commands/delete-recording-resource"},{"title":"Fetch recordings for a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json","href":"/api-reference/texml-rest-commands/fetch-recordings-for-a-call"},{"title":"Request recording for a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json","href":"/api-reference/texml-rest-commands/request-recording-for-a-call"},{"title":"Update recording on a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json","href":"/api-reference/texml-rest-commands/update-recording-on-a-call"},{"title":"List conference recordings","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings","href":"/api-reference/texml-rest-commands/list-conference-recordings"},{"title":"Fetch recordings for a conference","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json","href":"/api-reference/texml-rest-commands/fetch-recordings-for-a-conference"}]},{"group":"Callbacks API","pages":[{"title":"Texml recording completed","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/recordings.json webhook TexmlRecordingCompletedWebhook","href":"/api-reference/callbacks/texml-recording-completed"},{"title":"Texml recording in progress","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/recordings.json webhook TexmlRecordingInProgressWebhook","href":"/api-reference/callbacks/texml-recording-in-progress"}]}]},{"group":"Transcripts","pages":[{"title":"Transcripts","href":"/docs/voice/texml/rest-api/transcripts/index"},{"group":"TeXML REST Commands API","pages":[{"title":"List recording transcriptions","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Transcriptions.json","href":"/api-reference/texml-rest-commands/list-recording-transcriptions"},{"title":"Fetch a recording transcription resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json","href":"/api-reference/texml-rest-commands/fetch-a-recording-transcription-resource"},{"title":"Delete a recording transcription","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json delete /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json","href":"/api-reference/texml-rest-commands/delete-a-recording-transcription"}]},{"group":"Callbacks API","pages":[{"title":"Texml transcription","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/transcriptions.json webhook TexmlTranscriptionWebhook","href":"/api-reference/callbacks/texml-transcription"}]}]},{"group":"SIPREC","pages":[{"title":"SIPREC","href":"/docs/voice/texml/rest-api/siprec/index"},{"group":"TeXML REST Commands API","pages":[{"title":"Request siprec session for a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json","href":"/api-reference/texml-rest-commands/request-siprec-session-for-a-call"},{"title":"Updates siprec session for a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json","href":"/api-reference/texml-rest-commands/updates-siprec-session-for-a-call"}]},{"group":"Callbacks API","pages":[{"title":"Texml siprec","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/siprec.json webhook TexmlSiprecWebhook","href":"/api-reference/callbacks/texml-siprec"}]}]},{"group":"Streams","pages":[{"title":"Streams","href":"/docs/voice/texml/rest-api/streams/index"},{"group":"TeXML REST Commands API","pages":[{"title":"Start streaming media from a call.","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json","href":"/api-reference/texml-rest-commands/start-streaming-media-from-a-call"},{"title":"Update streaming on a call","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json","href":"/api-reference/texml-rest-commands/update-streaming-on-a-call"}]},{"group":"Callbacks API","pages":[{"title":"Texml stream","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/streams.json webhook TexmlStreamWebhook","href":"/api-reference/callbacks/texml-stream"}]}]},{"group":"Queues","pages":[{"title":"Queues","href":"/docs/voice/texml/rest-api/queues/index"},{"group":"TeXML REST Commands API","pages":[{"title":"List queue resources","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Queues","href":"/api-reference/texml-rest-commands/list-queue-resources"},{"title":"Create a new queue","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Queues","href":"/api-reference/texml-rest-commands/create-a-new-queue"},{"title":"Fetch a queue resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json get /texml/Accounts/{account_sid}/Queues/{queue_sid}","href":"/api-reference/texml-rest-commands/fetch-a-queue-resource"},{"title":"Update a queue resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/Accounts/{account_sid}/Queues/{queue_sid}","href":"/api-reference/texml-rest-commands/update-a-queue-resource"},{"title":"Delete a queue resource","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json delete /texml/Accounts/{account_sid}/Queues/{queue_sid}","href":"/api-reference/texml-rest-commands/delete-a-queue-resource"}]},{"group":"Callbacks API","pages":[{"title":"Texml queue","version":null,"deprecated":null,"openapi":"/openapi/source/external/legacy-published/texml/queues.json webhook TexmlQueueWebhook","href":"/api-reference/callbacks/texml-queue"}]}]},{"group":"Secrets","pages":[{"title":"TeXML application secrets","href":"/docs/voice/texml/rest-api/secrets/index"},{"title":"Create a TeXML secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-scripting/call-scripting.json post /texml/secrets","href":"/api-reference/texml-rest-commands/create-a-texml-secret"}]}]},{"group":"For AI Agents","pages":[{"title":"TeXML llms.txt","sidebarTitle":"TeXML llms txt","href":"/docs/development/llms/calling-texml-llms-txt/index"},{"title":"TeXML llms-full.txt","sidebarTitle":"TeXML llms full txt","href":"/docs/development/llms/calling-texml-llms-full-txt/index"}]}]},{"tab":"SIP Trunking","icon":"headset","groups":[{"group":"Getting Started","pages":[{"title":"SIP Trunking Overview","sidebarTitle":"Overview","href":"/docs/voice/sip-trunking/get-started"},{"title":"TLS Requirements","sidebarTitle":"TLS Requirements","href":"/docs/voice/sip-trunking/tls-requirements/index"}]},{"group":"Authentication","pages":[{"title":"SIP Authentication Methods","sidebarTitle":"Overview","href":"/docs/voice/sip-trunking/authentication/credential-types/index"},{"title":"IP Authentication Token","sidebarTitle":"IP Authentication Token","href":"/docs/voice/sip-trunking/authentication/ip-authentication-token/index"},{"title":"Tech Prefix Authentication","sidebarTitle":"Tech Prefix","href":"/docs/voice/sip-trunking/authentication/tech-prefix/index"}]},{"group":"Configuration","pages":[{"title":"Caller ID Policy","sidebarTitle":"Caller ID Policy","href":"/docs/voice/sip-trunking/configuration/caller-id-policy/index"},{"title":"Concurrent Call Limits","sidebarTitle":"Concurrent Call Limits","href":"/docs/voice/sip-trunking/configuration/concurrent-limits/index"},{"title":"P-Charge-Info Header","sidebarTitle":"P-Charge-Info","href":"/docs/voice/sip-trunking/configuration/p-charge-info-header/index"},{"title":"Outbound Voice Profiles for SIP trunking","href":"/docs/voice/sip-trunking/configuration/outbound-voice-profiles/index"}]},{"group":"Routing","pages":[{"title":"Round Robin Routing","sidebarTitle":"Round Robin Routing","href":"/docs/voice/sip-trunking/routing/round-robin-routing/index"},{"title":"AnchorSite Configuration","sidebarTitle":"AnchorSite","href":"/docs/voice/sip-trunking/routing/anchorsite-configuration/index"},{"title":"Failover and Retries","sidebarTitle":"Failover \u0026 Retries","href":"/docs/voice/sip-trunking/routing/failover-and-retries/index"}]},{"group":"Network Configuration","pages":[{"title":"IP Whitelisting","sidebarTitle":"IP Whitelisting","href":"/docs/voice/sip-trunking/network-configuration/ip-whitelisting/index"},{"title":"STUN/TURN Servers","sidebarTitle":"STUN/TURN","href":"/docs/voice/sip-trunking/network-configuration/stun-turn-servers/index"}]},{"group":"Features","pages":[{"title":"Noise suppression for SIP Trunking","sidebarTitle":"Noise Suppression","href":"/docs/voice/sip-trunking/features/noise-suppression/index"},{"title":"Adaptive jitter buffer for SIP Trunking","sidebarTitle":"Jitter Buffer","href":"/docs/voice/sip-trunking/features/jitter-buffer/index"},{"title":"External Call Transfers","sidebarTitle":"External Transfers","href":"/docs/voice/sip-trunking/features/external-transfers/index"},{"title":"SIP URI Calling","sidebarTitle":"SIP URI Calling","href":"/docs/voice/sip-trunking/features/sip-uri-calling/index"}]},{"group":"STIR/SHAKEN","pages":[{"title":"STIR/SHAKEN Attestation Behavior","sidebarTitle":"Attestation Behavior","href":"/docs/voice/stir-shaken/attestation-behavior/index"},{"title":"Hosted STIR/SHAKEN Certificate","sidebarTitle":"Hosted Certificate","href":"/docs/voice/stir-shaken/hosted-cert/index"},{"title":"STIR/SHAKEN SIP Header Parameters","sidebarTitle":"SIP Header Parameters","href":"/docs/voice/stir-shaken/sip-header-parameters/index"}]},{"group":"Emergency Calling","pages":[{"title":"Dynamic E911","sidebarTitle":"Dynamic E911","href":"/docs/voice/sip-trunking/emergency-calling-dynamic-e911/index"}]},{"group":"Troubleshooting","pages":[{"title":"SIP Response Codes","sidebarTitle":"Response Codes","href":"/docs/voice/sip-trunking/troubleshooting/response-codes/index"}]},{"group":"SIP Integrations Guides","pages":[{"title":"SIP Trunking Configuration Guides","sidebarTitle":"Configuration Overview","href":"/docs/voice/sip-trunking/configuration-guides/index"},{"title":"Telnyx \u0026 LiveKit: SIP Trunk Configuration","sidebarTitle":"LiveKit","href":"/docs/voice/sip-trunking/livekit-configuration-guide/index"},{"title":"Connect Telnyx to GPT-Live over SIP","sidebarTitle":"OpenAI GPT-Live","href":"/docs/voice/sip-trunking/gpt-live-configuration-guide/index"}]},{"group":"API Reference","pages":[{"group":"SIP Connections","pages":[{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /connections","href":"/api-reference/connections/list-connections"},{"title":"Count connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /connections/count","href":"/api-reference/connections/count-connections"},{"title":"Retrieve a connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /connections/{id}","href":"/api-reference/connections/retrieve-a-connection"}]},{"group":"Credential Connections","pages":[{"title":"List credential connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /credential_connections","href":"/api-reference/credential-connections/list-credential-connections"},{"title":"Create a credential connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /credential_connections","href":"/api-reference/credential-connections/create-a-credential-connection"},{"title":"Delete a credential connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /credential_connections/{id}","href":"/api-reference/credential-connections/delete-a-credential-connection"},{"title":"Retrieve a credential connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /credential_connections/{id}","href":"/api-reference/credential-connections/retrieve-a-credential-connection"},{"title":"Update a credential connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /credential_connections/{id}","href":"/api-reference/credential-connections/update-a-credential-connection"},{"title":"SIP Credential Registration status","deprecated":null,"version":null,"sidebarTitle":"SIP Credential Registration status","openapi":"/openapi/playground/sip-registration-status/credentials.json get /sip_registration_status","href":"/api-reference/sip_registration_status"}]},{"group":"IPs","pages":[{"title":"List Ips","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /ips","href":"/api-reference/ips/list-ips"},{"title":"Create an Ip","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /ips","href":"/api-reference/ips/create-an-ip"},{"title":"Delete an Ip","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /ips/{id}","href":"/api-reference/ips/delete-an-ip"},{"title":"Retrieve an Ip","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /ips/{id}","href":"/api-reference/ips/retrieve-an-ip"},{"title":"Update an Ip","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /ips/{id}","href":"/api-reference/ips/update-an-ip"}]},{"group":"IP Connections","pages":[{"title":"List Ip connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /ip_connections","href":"/api-reference/ip-connections/list-ip-connections"},{"title":"Create an Ip connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /ip_connections","href":"/api-reference/ip-connections/create-an-ip-connection"},{"title":"Delete an Ip connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /ip_connections/{id}","href":"/api-reference/ip-connections/delete-an-ip-connection"},{"title":"Retrieve an Ip connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /ip_connections/{id}","href":"/api-reference/ip-connections/retrieve-an-ip-connection"},{"title":"Update an Ip connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /ip_connections/{id}","href":"/api-reference/ip-connections/update-an-ip-connection"}]},{"group":"FQDNs","pages":[{"title":"List FQDNs","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /fqdns","href":"/api-reference/fqdns/list-fqdns"},{"title":"Create an FQDN","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /fqdns","href":"/api-reference/fqdns/create-an-fqdn"},{"title":"Delete an FQDN","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /fqdns/{id}","href":"/api-reference/fqdns/delete-an-fqdn"},{"title":"Retrieve an FQDN","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /fqdns/{id}","href":"/api-reference/fqdns/retrieve-an-fqdn"},{"title":"Update an FQDN","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /fqdns/{id}","href":"/api-reference/fqdns/update-an-fqdn"}]},{"group":"FQDN Connections","pages":[{"title":"List FQDN connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /fqdn_connections","href":"/api-reference/fqdn-connections/list-fqdn-connections"},{"title":"Create an FQDN connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /fqdn_connections","href":"/api-reference/fqdn-connections/create-an-fqdn-connection"},{"title":"Delete an FQDN connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /fqdn_connections/{id}","href":"/api-reference/fqdn-connections/delete-an-fqdn-connection"},{"title":"Retrieve an FQDN connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /fqdn_connections/{id}","href":"/api-reference/fqdn-connections/retrieve-an-fqdn-connection"},{"title":"Update an FQDN connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /fqdn_connections/{id}","href":"/api-reference/fqdn-connections/update-an-fqdn-connection"},{"title":"Retrieve an FQDN authentication","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /fqdn_connections/{fqdn_connection_id}/fqdn_authentication","href":"/api-reference/fqdn-connections/retrieve-an-fqdn-authentication"},{"title":"Update an FQDN authentication","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /fqdn_connections/{fqdn_connection_id}/fqdn_authentication","href":"/api-reference/fqdn-connections/update-an-fqdn-authentication"}]},{"group":"UAC Connections","pages":[{"title":"List UAC connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /uac_connections","href":"/api-reference/uac-connections/list-uac-connections"},{"title":"Create a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /uac_connections","href":"/api-reference/uac-connections/create-a-uac-connection"},{"title":"Delete a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /uac_connections/{id}","href":"/api-reference/uac-connections/delete-a-uac-connection"},{"title":"Retrieve a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /uac_connections/{id}","href":"/api-reference/uac-connections/retrieve-a-uac-connection"},{"title":"Update a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /uac_connections/{id}","href":"/api-reference/uac-connections/update-a-uac-connection"},{"title":"SIP UAC registration status","deprecated":null,"version":null,"sidebarTitle":"SIP UAC registration status","openapi":"/openapi/playground/sip-registration-status/uac.json get /sip_registration_status","href":"/api-reference/uac-connections/sip-registration-status"}]},{"group":"Noise Suppression Engines","pages":[{"title":"List available noise suppression engines","deprecated":null,"version":null,"openapi":"/openapi/source/external/noise-suppression-engines/noise-suppression-engines.json get /noise_suppression_engines","href":"/api-reference/noise-suppression-engines/list-available-noise-suppression-engines"}]}]},{"group":"Outbound Voice Profiles","pages":[{"title":"Get all outbound voice profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/outbound-voice-profiles/outbound-voice-profiles.json get /outbound_voice_profiles","href":"/api-reference/outbound-voice-profiles/get-all-outbound-voice-profiles"},{"title":"Create an outbound voice profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/outbound-voice-profiles/outbound-voice-profiles.json post /outbound_voice_profiles","href":"/api-reference/outbound-voice-profiles/create-an-outbound-voice-profile"},{"title":"Delete an outbound voice profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/outbound-voice-profiles/outbound-voice-profiles.json delete /outbound_voice_profiles/{id}","href":"/api-reference/outbound-voice-profiles/delete-an-outbound-voice-profile"},{"title":"Retrieve an outbound voice profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/outbound-voice-profiles/outbound-voice-profiles.json get /outbound_voice_profiles/{id}","href":"/api-reference/outbound-voice-profiles/retrieve-an-outbound-voice-profile"},{"title":"Updates an existing outbound voice profile.","deprecated":null,"version":null,"openapi":"/openapi/source/external/outbound-voice-profiles/outbound-voice-profiles.json patch /outbound_voice_profiles/{id}","href":"/api-reference/outbound-voice-profiles/updates-an-existing-outbound-voice-profile"}]},{"group":"Dialogflow Integration","pages":[{"title":"Delete stored Dialogflow Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-streaming/media-streaming.json delete /dialogflow_connections/{connection_id}","href":"/api-reference/dialogflow-integration/delete-stored-dialogflow-connection"},{"title":"Retrieve stored Dialogflow Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-streaming/media-streaming.json get /dialogflow_connections/{connection_id}","href":"/api-reference/dialogflow-integration/retrieve-stored-dialogflow-connection"},{"title":"Create a Dialogflow Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-streaming/media-streaming.json post /dialogflow_connections/{connection_id}","href":"/api-reference/dialogflow-integration/create-a-dialogflow-connection"},{"title":"Update stored Dialogflow Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-streaming/media-streaming.json put /dialogflow_connections/{connection_id}","href":"/api-reference/dialogflow-integration/update-stored-dialogflow-connection"}]},{"group":"External Connections","pages":[{"title":"List all External Connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections","href":"/api-reference/external-connections/list-all-external-connections"},{"title":"Creates an External Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json post /external_connections","href":"/api-reference/external-connections/creates-an-external-connection"},{"title":"Deletes an External Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json delete /external_connections/{id}","href":"/api-reference/external-connections/deletes-an-external-connection"},{"title":"Retrieve an External Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}","href":"/api-reference/external-connections/retrieve-an-external-connection"},{"title":"Update an External Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json patch /external_connections/{id}","href":"/api-reference/external-connections/update-an-external-connection"},{"title":"List all civic addresses and locations","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/civic_addresses","href":"/api-reference/external-connections/list-all-civic-addresses-and-locations"},{"title":"Retrieve a Civic Address","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/civic_addresses/{address_id}","href":"/api-reference/external-connections/retrieve-a-civic-address"},{"title":"Update a location's static emergency address","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json patch /external_connections/{id}/locations/{location_id}","href":"/api-reference/external-connections/update-a-locations-static-emergency-address"},{"title":"List all phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/phone_numbers","href":"/api-reference/external-connections/list-all-phone-numbers"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/phone_numbers/{phone_number_id}","href":"/api-reference/external-connections/retrieve-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json patch /external_connections/{id}/phone_numbers/{phone_number_id}","href":"/api-reference/external-connections/update-a-phone-number"},{"title":"List all Releases","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/releases","href":"/api-reference/external-connections/list-all-releases"},{"title":"Retrieve a Release request","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/releases/{release_id}","href":"/api-reference/external-connections/retrieve-a-release-request"},{"title":"List all Upload requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/uploads","href":"/api-reference/external-connections/list-all-upload-requests"},{"title":"Creates an Upload request","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json post /external_connections/{id}/uploads","href":"/api-reference/external-connections/creates-an-upload-request"},{"title":"Refresh the status of all Upload requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json post /external_connections/{id}/uploads/refresh","href":"/api-reference/external-connections/refresh-the-status-of-all-upload-requests"},{"title":"Get the count of pending upload requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/uploads/status","href":"/api-reference/external-connections/get-the-count-of-pending-upload-requests"},{"title":"Retrieve an Upload request","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/{id}/uploads/{ticket_id}","href":"/api-reference/external-connections/retrieve-an-upload-request"},{"title":"Retry an Upload request","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json post /external_connections/{id}/uploads/{ticket_id}/retry","href":"/api-reference/external-connections/retry-an-upload-request"},{"title":"List all log messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/log_messages","href":"/api-reference/external-connections/list-all-log-messages"},{"title":"Dismiss a log message","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json delete /external_connections/log_messages/{id}","href":"/api-reference/external-connections/dismiss-a-log-message"},{"title":"Retrieve a log message","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json get /external_connections/log_messages/{id}","href":"/api-reference/external-connections/retrieve-a-log-message"},{"title":"Refresh Operator Connect integration","deprecated":null,"version":null,"openapi":"/openapi/source/external/external-voice-integrations/external-voice-integrations.json post /operator_connect/actions/refresh","href":"/api-reference/external-connections/refresh-operator-connect-integration"}]},{"group":"Call Recordings","pages":[{"title":"List all call recordings","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json get /recordings","href":"/api-reference/call-recordings/list-all-call-recordings"},{"title":"Delete a call recording","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json delete /recordings/{recording_id}","href":"/api-reference/call-recordings/delete-a-call-recording"},{"title":"Retrieve a call recording","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json get /recordings/{recording_id}","href":"/api-reference/call-recordings/retrieve-a-call-recording"},{"title":"Delete a list of call recordings","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json post /recordings/actions/delete","href":"/api-reference/call-recordings/delete-a-list-of-call-recordings"},{"title":"List all recording transcriptions","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json get /recording_transcriptions","href":"/api-reference/call-recordings/list-all-recording-transcriptions"},{"title":"Delete a recording transcription","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json delete /recording_transcriptions/{recording_transcription_id}","href":"/api-reference/call-recordings/delete-a-recording-transcription"},{"title":"Retrieve a recording transcription","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json get /recording_transcriptions/{recording_transcription_id}","href":"/api-reference/call-recordings/retrieve-a-recording-transcription"},{"title":"Delete a stored credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json delete /custom_storage_credentials/{connection_id}","href":"/api-reference/call-recordings/delete-a-stored-credential"},{"title":"Retrieve a stored credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json get /custom_storage_credentials/{connection_id}","href":"/api-reference/call-recordings/retrieve-a-stored-credential"},{"title":"Create a custom storage credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json post /custom_storage_credentials/{connection_id}","href":"/api-reference/call-recordings/create-a-custom-storage-credential"},{"title":"Update a stored credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/call-recordings/call-recordings.json put /custom_storage_credentials/{connection_id}","href":"/api-reference/call-recordings/update-a-stored-credential"}]},{"group":"Media Storage","pages":[{"title":"List uploaded media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json get /media","href":"/api-reference/media-storage-api/list-uploaded-media"},{"title":"Upload media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json post /media","href":"/api-reference/media-storage-api/upload-media"},{"title":"Deletes stored media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json delete /media/{media_name}","href":"/api-reference/media-storage-api/deletes-stored-media"},{"title":"Retrieve stored media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json get /media/{media_name}","href":"/api-reference/media-storage-api/retrieve-stored-media"},{"title":"Update stored media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json put /media/{media_name}","href":"/api-reference/media-storage-api/update-stored-media"},{"title":"Download stored media","deprecated":null,"version":null,"openapi":"/openapi/source/external/media-storage/media-storage.json get /media/{media_name}/download","href":"/api-reference/media-storage-api/download-stored-media"}]}]},{"group":"For AI Agents","pages":[{"title":"SIP Trunking llms.txt","sidebarTitle":"SIP Trunking llms txt","href":"/docs/development/llms/calling-sip-trunking-llms-txt/index"},{"title":"SIP Trunking llms-full.txt","sidebarTitle":"SIP Trunking llms full txt","href":"/docs/development/llms/calling-sip-trunking-llms-full-txt/index"}]}]},{"tab":"UAC Connections","icon":"plug","groups":[{"group":"UAC Connections","pages":[{"title":"SIP Attach (UAC SIP Connections)","sidebarTitle":"UAC Connections","href":"/docs/voice/uac-connections"}]},{"group":"API Reference","pages":[{"group":"UAC Connections","pages":[{"title":"List UAC connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /uac_connections","href":"/api-reference/uac-connections/list-uac-connections"},{"title":"Create a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json post /uac_connections","href":"/api-reference/uac-connections/create-a-uac-connection"},{"title":"Delete a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json delete /uac_connections/{id}","href":"/api-reference/uac-connections/delete-a-uac-connection"},{"title":"Retrieve a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json get /uac_connections/{id}","href":"/api-reference/uac-connections/retrieve-a-uac-connection"},{"title":"Update a UAC connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/connections/connections.json patch /uac_connections/{id}","href":"/api-reference/uac-connections/update-a-uac-connection"},{"title":"SIP UAC registration status","deprecated":null,"version":null,"sidebarTitle":"SIP UAC registration status","openapi":"/openapi/playground/sip-registration-status/uac.json get /sip_registration_status","href":"/api-reference/uac-connections/sip-registration-status"}]}]},{"group":"For AI Agents","pages":[{"title":"UAC Connections llms.txt","sidebarTitle":"UAC Connections llms txt","href":"/docs/development/llms/calling-uac-connections-llms-txt/index"},{"title":"UAC Connections llms-full.txt","sidebarTitle":"UAC Connections llms full txt","href":"/docs/development/llms/calling-uac-connections-llms-full-txt/index"}]}]},{"tab":"WebRTC","icon":"browser","groups":[{"group":"Getting Started","pages":[{"title":"WebRTC Voice SDKs Fundamentals","sidebarTitle":"Fundamentals","href":"/docs/voice/webrtc/fundamentals"},{"title":"WebRTC Voice SDKs Architecture","sidebarTitle":"Architecture","href":"/docs/voice/webrtc/architecture/index"},{"title":"WebRTC Voice SDKs Commonalities","sidebarTitle":"SDK Commonalities","href":"/docs/voice/webrtc/sdk-commonalities/index"}]},{"group":"Authentication","pages":[{"title":"Voice SDK authentication with credential SIP connections","sidebarTitle":"Credential Connections","href":"/docs/voice/webrtc/auth/credential-connections/index"},{"title":"Voice SDK Authentication via Telephony Credentials","sidebarTitle":"Telephony Credentials","href":"/docs/voice/webrtc/auth/telephony-credentials/index"},{"title":"Voice SDK Authentication via JWTs","sidebarTitle":"JWTs","href":"/docs/voice/webrtc/auth/jwt/index"}]},{"group":"Push Notifications","pages":[{"title":"Push Notifications Overview","sidebarTitle":"Overview","href":"/docs/voice/webrtc/push-notifications/index"},{"title":"Android Push Notifications","sidebarTitle":"Android","href":"/docs/voice/webrtc/push-notifications/android/index"},{"title":"iOS Push Notifications","sidebarTitle":"iOS","href":"/docs/voice/webrtc/push-notifications/ios/index"},{"title":"Flutter Push Notifications","sidebarTitle":"Flutter","href":"/docs/voice/webrtc/push-notifications/flutter/index"},{"title":"React Native Push Notifications","sidebarTitle":"React Native","href":"/docs/voice/webrtc/push-notifications/react-native/index"},{"title":"Push Notification Debugging","sidebarTitle":"Debugging","href":"/docs/voice/webrtc/push-notifications/debugging/index"}]},{"group":"Tutorials","pages":[{"title":"JS SDK Demo App","sidebarTitle":"JS SDK Demo App","href":"/docs/voice/webrtc/js-sdk/demo-app/index"},{"title":"Anatomy of a JS SDK Client \u0026 Call","sidebarTitle":"JS SDK Anatomy","href":"/docs/voice/webrtc/js-sdk/anatomy/index"}]},{"group":"Use Cases","pages":[{"title":"Contact center (CCaaS) implementation","sidebarTitle":"Contact Center (CCaaS)","href":"/docs/voice/webrtc/use-cases/contact-center/index"},{"title":"Outbound dialer implementation","sidebarTitle":"Outbound Dialer","href":"/docs/voice/webrtc/use-cases/outbound-dialer/index"}]},{"group":"Troubleshooting","pages":[{"title":"WebRTC Voice SDKs Call Detail Records","sidebarTitle":"Call Detail Records","href":"/docs/voice/webrtc/troubleshooting/detail-records/index"},{"title":"WebRTC Voice SDKs Debug Data","sidebarTitle":"Debug Logs","href":"/docs/voice/webrtc/troubleshooting/debug-logs/index"},{"title":"Interpreting WebRTC Voice SDKs Debug Data","sidebarTitle":"Interpreting Debug Data","href":"/docs/voice/webrtc/troubleshooting/interpreting-debug-data/index"}]},{"group":"Migration","pages":[{"title":"Migration from Twilio","href":"/docs/voice/webrtc/migration-from-twilio/index"}]},{"group":"SDKs","pages":[{"group":"JavaScript SDK","pages":[{"group":"Tutorials","pages":[{"title":"WebRTC JS SDK quickstart","href":"/docs/development/webrtc/js-sdk/tutorials/make-your-first-call/index"},{"title":"Build a Call Center Agent","href":"/docs/development/webrtc/js-sdk/tutorials/build-call-center-agent/index"}]},{"group":"How-to Guides","pages":[{"title":"WebRTC JS SDK authentication","href":"/docs/development/webrtc/js-sdk/how-to/authenticating-your-app/index"},{"title":"Network Connectivity Requirements","href":"/docs/development/webrtc/js-sdk/how-to/configure-network-firewall/index"},{"title":"Device Management","href":"/docs/development/webrtc/js-sdk/how-to/switch-audio-devices/index"},{"title":"Manage Multiple Calls","href":"/docs/development/webrtc/js-sdk/how-to/manage-multiple-calls/index"},{"title":"Call Report Stats","href":"/docs/development/webrtc/js-sdk/how-to/monitor-call-quality/index"},{"title":"Reconnection \u0026 Call Recovery","href":"/docs/development/webrtc/js-sdk/how-to/handle-reconnection/index"},{"title":"Framework Integration","href":"/docs/development/webrtc/js-sdk/how-to/integrate-with-frameworks/index"},{"title":"Debug Data \u0026 Call Quality Analysis","href":"/docs/development/webrtc/js-sdk/how-to/debug-call-issues/index"},{"title":"WebRTC JS SDK error handling","href":"/docs/development/webrtc/js-sdk/how-to/error-handling/index"},{"title":"Production Best Practices","href":"/docs/development/webrtc/js-sdk/how-to/production-best-practices/index"}]},{"group":"Reference","pages":[{"group":"Classes","pages":[{"title":"TelnyxRTC Class","href":"/docs/development/webrtc/js-sdk/reference/telnyxrtc/index"},{"title":"Call Class","href":"/docs/development/webrtc/js-sdk/reference/call/index"}]},{"group":"Interfaces","pages":[{"title":"IClientOptions","href":"/docs/development/webrtc/js-sdk/reference/iclientoptions/index"},{"title":"ICallOptions","href":"/docs/development/webrtc/js-sdk/reference/icalloptions/index"},{"title":"INotification","href":"/docs/development/webrtc/js-sdk/reference/inotification/index"}]},{"title":"Switch/Server Events","href":"/docs/development/webrtc/js-sdk/reference/sw-events/index"}]},{"group":"Explanation","pages":[{"title":"How WebRTC Signaling Works","href":"/docs/development/webrtc/js-sdk/explanation/webrtc-signaling/index"},{"title":"How ICE \u0026 TURN Work","href":"/docs/development/webrtc/js-sdk/explanation/ice-and-turn/index"},{"title":"Authentication Architecture","href":"/docs/development/webrtc/js-sdk/explanation/authentication-architecture/index"},{"title":"Call State Lifecycle","href":"/docs/development/webrtc/js-sdk/explanation/call-state-lifecycle/index"}]},{"title":"WebRTC JS ChangeLog","sidebarTitle":"WebRTC JS ChangeLog","href":"/docs/development/webrtc/js-sdk/changelog/index"}]},{"group":"React SDK","pages":[{"title":"React quickstart","sidebarTitle":"React quickstart","href":"/docs/development/webrtc/react-sdk/index"}]},{"group":"iOS SDK","pages":[{"title":"Voice native iOS Client SDK","sidebarTitle":"Voice native iOS Client SDK","href":"/docs/development/webrtc/ios-sdk/index"},{"group":"Classes","pages":[{"title":"WebRTC iOS Client","sidebarTitle":"WebRTC iOS Client","href":"/docs/development/webrtc/ios-sdk/classes/txclient/index"},{"title":"WebRTC iOS Call","sidebarTitle":"WebRTC iOS Call","href":"/docs/development/webrtc/ios-sdk/classes/call/index"},{"title":"WebRTC iOS Call","sidebarTitle":"WebRTC iOS Call","href":"/docs/development/webrtc/ios-sdk/classes/call-extensions/index"},{"title":"WebRTC iOS Client","sidebarTitle":"WebRTC iOS Client","href":"/docs/development/webrtc/ios-sdk/classes/txclient-extensions/index"}]},{"group":"Enums","pages":[{"title":"WebRTC iOS Call State","sidebarTitle":"WebRTC iOS Call State","href":"/docs/development/webrtc/ios-sdk/enums/call-state/index"}]},{"group":"Protocols","pages":[{"title":"WebRTC iOS TxClientDelegate","sidebarTitle":"WebRTC iOS TxClientDelegate","href":"/docs/development/webrtc/ios-sdk/protocols/tx-client-delegate/index"}]},{"group":"Structs","pages":[{"title":"WebRTC iOS Call Info","sidebarTitle":"WebRTC iOS Call Info","href":"/docs/development/webrtc/ios-sdk/structs/tx-call-info/index"},{"title":"WebRTC iOS Client Configuration","sidebarTitle":"WebRTC iOS Client Configuration","href":"/docs/development/webrtc/ios-sdk/structs/tx-config/index"},{"title":"WebRTC iOS Client Push Notifications Configuration","sidebarTitle":"WebRTC iOS Client Push Notifications Configuration","href":"/docs/development/webrtc/ios-sdk/structs/tx-push-config/index"},{"title":"WebRTC iOS Client Push IP Notifications Configuration","sidebarTitle":"WebRTC iOS Client Push IP Notifications Configuration","href":"/docs/development/webrtc/ios-sdk/structs/tx-push-ip-config/index"}]},{"group":"Push Notifications","pages":[{"title":"iOS Portal Setup","sidebarTitle":"iOS Portal Setup","href":"/docs/development/webrtc/ios-sdk/push-notification/portal-setup/index"},{"title":"iOS Push Notification Setup","sidebarTitle":"iOS Push Notification Setup","href":"/docs/development/webrtc/ios-sdk/push-notification/app-setup/index"},{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/development/webrtc/ios-sdk/push-notification/troubleshooting/index"}]},{"group":"AI Voice Assistant","pages":[{"title":"WebRTC iOS SDK AI Voice Assistant Introduction","sidebarTitle":"WebRTC iOS SDK AI Voice Assistant Introduction","href":"/docs/development/webrtc/ios-sdk/ai-voice-assistant/introduction/index"},{"title":"WebRTC iOS SDK AI Voice Assistant Anonymous Login","sidebarTitle":"WebRTC iOS SDK AI Voice Assistant Anonymous Login","href":"/docs/development/webrtc/ios-sdk/ai-voice-assistant/anonymous-login/index"},{"title":"WebRTC iOS SDK AI Voice Assistant Starting Conversations","sidebarTitle":"WebRTC iOS SDK AI Voice Assistant Starting Conversations","href":"/docs/development/webrtc/ios-sdk/ai-voice-assistant/starting-conversations/index"},{"title":"WebRTC iOS SDK AI Voice Assistant Text Messaging","sidebarTitle":"WebRTC iOS SDK AI Voice Assistant Text Messaging","href":"/docs/development/webrtc/ios-sdk/ai-voice-assistant/text-messaging/index"},{"title":"WebRTC iOS SDK AI Voice Assistant Transcript Updates","sidebarTitle":"WebRTC iOS SDK AI Voice Assistant Transcript Updates","href":"/docs/development/webrtc/ios-sdk/ai-voice-assistant/transcript-updates/index"}]},{"title":"WebRTC Stats","sidebarTitle":"WebRTC Stats","href":"/docs/development/webrtc/ios-sdk/stats/index"},{"title":"WebRTC iOS SDK Error Handling","sidebarTitle":"WebRTC iOS SDK Error Handling","href":"/docs/development/webrtc/ios-sdk/error-handling/index"},{"title":"WebRTC iOS ChangeLog","sidebarTitle":"WebRTC iOS ChangeLog","href":"/docs/development/webrtc/ios-sdk/changelog/index"}]},{"group":"Android SDK","pages":[{"title":"WebRTC Android Quickstart","sidebarTitle":"WebRTC Android Quickstart","href":"/docs/development/webrtc/android-sdk/quickstart/index"},{"title":"Android Voice Client SDK","sidebarTitle":"Android Voice Client SDK","href":"/docs/development/webrtc/android-sdk/index"},{"group":"Classes","pages":[{"title":"WebRTC Android Client","sidebarTitle":"WebRTC Android Client","href":"/docs/development/webrtc/android-sdk/classes/txclient/index"},{"title":"WebRTC Android Call","sidebarTitle":"WebRTC Android Call","href":"/docs/development/webrtc/android-sdk/classes/call/index"}]},{"group":"Config","pages":[{"title":"WebRTC Android Config","sidebarTitle":"WebRTC Android Config","href":"/docs/development/webrtc/android-sdk/config/txconfig/index"}]},{"group":"Socket","pages":[{"title":"WebRTC Android ReceivedMessageBody","sidebarTitle":"WebRTC Android ReceivedMessageBody","href":"/docs/development/webrtc/android-sdk/socket/receivedmessagebody/index"},{"title":"WebRTC Android SocketResponse","sidebarTitle":"WebRTC Android SocketResponse","href":"/docs/development/webrtc/android-sdk/socket/socketresponse/index"}]},{"group":"Push Notifications","pages":[{"title":"Android Portal Setup","sidebarTitle":"Android Portal Setup","href":"/docs/development/webrtc/android-sdk/push-notification/portal-setup/index"},{"title":"Notification Quickstart for Android","sidebarTitle":"Notification Quickstart for Android","href":"/docs/development/webrtc/android-sdk/push-notification/quickstart/index"},{"title":"Android Push Notification Setup","sidebarTitle":"Android Push Notification Setup","href":"/docs/development/webrtc/android-sdk/push-notification/app-setup/index"},{"title":"Android Push Troubleshooting","sidebarTitle":"Android Push Troubleshooting","href":"/docs/development/webrtc/android-sdk/push-notification/troubleshooting/index"}]},{"group":"AI Voice Assistant","pages":[{"title":"WebRTC Android SDK AI Voice Assistant Introduction","sidebarTitle":"WebRTC Android SDK AI Voice Assistant Introduction","href":"/docs/development/webrtc/android-sdk/ai-voice-assistant/introduction/index"},{"title":"WebRTC Android SDK AI Voice Assistant Anonymous Login","sidebarTitle":"WebRTC Android SDK AI Voice Assistant Anonymous Login","href":"/docs/development/webrtc/android-sdk/ai-voice-assistant/anonymous-login/index"},{"title":"WebRTC Android SDK AI Voice Assistant Starting Conversations","sidebarTitle":"WebRTC Android SDK AI Voice Assistant Starting Conversations","href":"/docs/development/webrtc/android-sdk/ai-voice-assistant/starting-conversations/index"},{"title":"WebRTC Android SDK AI Voice Assistant Text Messaging","sidebarTitle":"WebRTC Android SDK AI Voice Assistant Text Messaging","href":"/docs/development/webrtc/android-sdk/ai-voice-assistant/text-messaging/index"},{"title":"WebRTC Android SDK AI Voice Assistant Transcript Updates","sidebarTitle":"WebRTC Android SDK AI Voice Assistant Transcript Updates","href":"/docs/development/webrtc/android-sdk/ai-voice-assistant/transcript-updates/index"}]},{"title":"WebRTC Stats","sidebarTitle":"WebRTC Stats","href":"/docs/development/webrtc/android-sdk/stats/index"},{"title":"WebRTC Call Reports","href":"/docs/development/webrtc/android-sdk/call-reports/index"},{"title":"WebRTC Android SDK Error Handling","sidebarTitle":"WebRTC Android SDK Error Handling","href":"/docs/development/webrtc/android-sdk/error-handling/index"},{"title":"WebRTC Android ChangeLog","sidebarTitle":"WebRTC Android ChangeLog","href":"/docs/development/webrtc/android-sdk/changelog/index"}]},{"group":"React Native SDK","pages":[{"title":"React Native SDK","sidebarTitle":"React Native SDK","href":"/docs/development/webrtc/react-native-sdk/index"},{"title":"React Native SDK Quickstart","sidebarTitle":"React Native SDK Quickstart","href":"/docs/development/webrtc/react-native-sdk/quickstart/index"},{"group":"Classes","pages":[{"title":"Call","sidebarTitle":"Call","href":"/docs/development/webrtc/react-native-sdk/classes/call/index"},{"title":"TelnyxVoipClient","sidebarTitle":"TelnyxVoipClient","href":"/docs/development/webrtc/react-native-sdk/classes/telnyxvoipclient/index"}]},{"group":"Interfaces","pages":[{"title":"CredentialConfig","sidebarTitle":"CredentialConfig","href":"/docs/development/webrtc/react-native-sdk/interfaces/credentialconfig/index"},{"title":"TokenConfig","sidebarTitle":"TokenConfig","href":"/docs/development/webrtc/react-native-sdk/interfaces/tokenconfig/index"},{"title":"TelnyxVoipClientOptions","sidebarTitle":"TelnyxVoipClientOptions","href":"/docs/development/webrtc/react-native-sdk/interfaces/telnyxvoipclientoptions/index"},{"title":"TelnyxVoiceAppOptions","sidebarTitle":"TelnyxVoiceAppOptions","href":"/docs/development/webrtc/react-native-sdk/interfaces/telnyxvoiceappoptions/index"}]},{"group":"Push Notifications","pages":[{"title":"Portal Setup","sidebarTitle":"Portal Setup","href":"/docs/development/webrtc/react-native-sdk/push-notification/portal-setup/index"},{"title":"App Setup","sidebarTitle":"App Setup","href":"/docs/development/webrtc/react-native-sdk/push-notification/app-setup/index"}]},{"title":"WebRTC React Native SDK error handling","sidebarTitle":"Error Handling","href":"/docs/development/webrtc/react-native-sdk/error-handling/index"},{"title":"Changelog","sidebarTitle":"Changelog","href":"/docs/development/webrtc/react-native-sdk/changelog/index"}]},{"group":"Flutter SDK","pages":[{"title":"Flutter Voice Client SDK","sidebarTitle":"Flutter Voice Client SDK","href":"/docs/development/webrtc/flutter-sdk/index"},{"group":"Classes","pages":[{"title":"WebRTC Flutter Client","sidebarTitle":"WebRTC Flutter Client","href":"/docs/development/webrtc/flutter-sdk/classes/txclient/index"},{"title":"WebRTC Flutter Call","sidebarTitle":"WebRTC Flutter Call","href":"/docs/development/webrtc/flutter-sdk/classes/call/index"},{"group":"Messages","pages":[{"title":"Flutter WebRTC SDK Message","sidebarTitle":"Flutter WebRTC SDK Message","href":"/docs/development/webrtc/flutter-sdk/classes/messages/telnyx-message/index"},{"title":"Flutter WebRTC SDK Socket Error Message","sidebarTitle":"Flutter WebRTC SDK Socket Error Message","href":"/docs/development/webrtc/flutter-sdk/classes/messages/telnyx-socket-error/index"}]}]},{"group":"Enums","pages":[{"title":"WebRTC Flutter Call State","sidebarTitle":"WebRTC Flutter Call State","href":"/docs/development/webrtc/flutter-sdk/enums/call-state/index"}]},{"group":"Event Handlers","pages":[{"title":"Flutter WebRTC SDK Socket Message Handler","sidebarTitle":"Flutter WebRTC SDK Socket Message Handler","href":"/docs/development/webrtc/flutter-sdk/event-handlers/on-socket-message-received/index"},{"title":"Flutter WebRTC SDK Socket Error Handler","sidebarTitle":"Flutter WebRTC SDK Socket Error Handler","href":"/docs/development/webrtc/flutter-sdk/event-handlers/on-socket-error-received/index"}]},{"group":"Method Objects","pages":[{"title":"WebRTC Flutter Client Configuration","sidebarTitle":"WebRTC Flutter Client Configuration","href":"/docs/development/webrtc/flutter-sdk/method-objects/config/index"},{"title":"WebRTC Flutter Incoming Invite Object","sidebarTitle":"WebRTC Flutter Incoming Invite Object","href":"/docs/development/webrtc/flutter-sdk/method-objects/incoming-invite-params/index"},{"title":"WebRTC Flutter Client Push Notifications Configuration","sidebarTitle":"WebRTC Flutter Client Push Notifications Configuration","href":"/docs/development/webrtc/flutter-sdk/method-objects/push-metadata/index"}]},{"group":"Push Notifications","pages":[{"title":"Flutter Push Notification Portal Setup","sidebarTitle":"Flutter Push Notification Portal Setup","href":"/docs/development/webrtc/flutter-sdk/push-notification/portal-setup/index"},{"title":"Flutter Push Notification App Setup","sidebarTitle":"Flutter Push Notification App Setup","href":"/docs/development/webrtc/flutter-sdk/push-notification/app-setup/index"},{"title":"Flutter Push Troubleshooting","sidebarTitle":"Flutter Push Troubleshooting","href":"/docs/development/webrtc/flutter-sdk/push-notification/troubleshooting/index"}]},{"group":"AI Voice Assistant","pages":[{"title":"WebRTC Flutter SDK AI Voice Assistant Introduction","sidebarTitle":"WebRTC Flutter SDK AI Voice Assistant Introduction","href":"/docs/development/webrtc/flutter-sdk/ai-voice-assistant/introduction/index"},{"title":"WebRTC Flutter SDK AI Voice Assistant Anonymous Login","sidebarTitle":"WebRTC Flutter SDK AI Voice Assistant Anonymous Login","href":"/docs/development/webrtc/flutter-sdk/ai-voice-assistant/anonymous-login/index"},{"title":"WebRTC Flutter SDK AI Voice Assistant Starting Conversations","sidebarTitle":"WebRTC Flutter SDK AI Voice Assistant Starting Conversations","href":"/docs/development/webrtc/flutter-sdk/ai-voice-assistant/starting-conversations/index"},{"title":"WebRTC Flutter SDK AI Voice Assistant Text Messaging","sidebarTitle":"WebRTC Flutter SDK AI Voice Assistant Text Messaging","href":"/docs/development/webrtc/flutter-sdk/ai-voice-assistant/text-messaging/index"},{"title":"WebRTC Flutter SDK AI Voice Assistant Transcript Updates","sidebarTitle":"WebRTC Flutter SDK AI Voice Assistant Transcript Updates","href":"/docs/development/webrtc/flutter-sdk/ai-voice-assistant/transcript-updates/index"}]},{"title":"WebRTC Stats","sidebarTitle":"WebRTC Stats","href":"/docs/development/webrtc/flutter-sdk/stats/index"},{"title":"WebRTC Flutter SDK Error Handling","sidebarTitle":"WebRTC Flutter SDK Error Handling","href":"/docs/development/webrtc/flutter-sdk/error-handling/index"},{"title":"WebRTC Flutter ChangeLog","sidebarTitle":"WebRTC Flutter ChangeLog","href":"/docs/development/webrtc/flutter-sdk/changelog/index"}]}]},{"group":"API Reference","pages":[{"group":"SDK Client Credentials","pages":[{"group":"Credentials API","pages":[{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json get /telephony_credentials","href":"/api-reference/credentials/list-all-credentials"},{"title":"Create a credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json post /telephony_credentials","href":"/api-reference/credentials/create-a-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json delete /telephony_credentials/{id}","href":"/api-reference/credentials/delete-a-credential"},{"title":"Get a credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json get /telephony_credentials/{id}","href":"/api-reference/credentials/get-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json patch /telephony_credentials/{id}","href":"/api-reference/credentials/update-a-credential"}]},{"group":"Access Tokens API","pages":[{"title":"Create an Access Token.","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json post /telephony_credentials/{id}/token","href":"/api-reference/access-tokens/create-an-access-token"},{"title":"Retrieve token material.","deprecated":null,"version":null,"openapi":"/openapi/source/external/telephony-credentials/telephony-credentials.json get /telephony_credentials/{id}/token_material","href":"/api-reference/access-tokens/retrieve-token-material"}]}]},{"group":"Mobile Push Credentials","pages":[{"title":"List mobile push credentials","deprecated":null,"version":null,"openapi":"/openapi/source/external/push-notifications/push-notifications.json get /mobile_push_credentials","href":"/api-reference/push-credentials/list-mobile-push-credentials"},{"title":"Creates a new mobile push credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/push-notifications/push-notifications.json post /mobile_push_credentials","href":"/api-reference/push-credentials/creates-a-new-mobile-push-credential"},{"title":"Deletes a mobile push credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/push-notifications/push-notifications.json delete /mobile_push_credentials/{push_credential_id}","href":"/api-reference/push-credentials/deletes-a-mobile-push-credential"},{"title":"Retrieves a mobile push credential","deprecated":null,"version":null,"openapi":"/openapi/source/external/push-notifications/push-notifications.json get /mobile_push_credentials/{push_credential_id}","href":"/api-reference/push-credentials/retrieves-a-mobile-push-credential"}]},{"group":"Voice SDK Call Reports","pages":[{"title":"List Voice SDK call reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-sdk-debug/voice-sdk-debug.json get /voice_sdk_call_reports","href":"/api-reference/voice-sdk-stats/list-voice-sdk-call-reports"},{"title":"Retrieve Voice SDK call reports by call ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-sdk-debug/voice-sdk-debug.json get /voice_sdk_call_reports/{call_id}","href":"/api-reference/voice-sdk-stats/retrieve-voice-sdk-call-reports-by-call-id"}]}]},{"group":"Guides","hidden":true,"searchable":true,"pages":[{"title":"WebRTC SDKs","sidebarTitle":"WebRTC SDKs","href":"/docs/development/webrtc/index"},{"title":"Demo Call with Telnyx WebRTC","href":"/docs/voice/webrtc/making-demo-call/index"},{"title":"Make a call to a web browser","href":"/docs/voice/webrtc/make-a-call-to-a-web-browser/index"},{"title":"Make a call to a mobile app","href":"/docs/voice/webrtc/make-a-call-to-a-mobile-app/index"},{"title":"Android Precompiled WebRTC Library","sidebarTitle":"Android Precompiled WebRTC Library","href":"/docs/development/webrtc/android-sdk/precompiled-library/index"}]},{"group":"For AI Agents","pages":[{"title":"WebRTC llms.txt","sidebarTitle":"WebRTC llms txt","href":"/docs/development/llms/calling-webrtc-llms-txt/index"},{"title":"WebRTC llms-full.txt","sidebarTitle":"WebRTC llms full txt","href":"/docs/development/llms/calling-webrtc-llms-full-txt/index"}]}]},{"tab":"Trusted Calling","icon":"shield-check","groups":[{"group":"Branded Calling","tag":"BETA","pages":[{"title":"Branded Calling","sidebarTitle":"Overview","href":"/docs/branded-calling/overview"},{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/docs/branded-calling/quickstart"},{"title":"Pricing","sidebarTitle":"Pricing","href":"/docs/branded-calling/pricing"},{"group":"Enterprises","pages":[{"title":"Register an enterprise for Branded Calling","sidebarTitle":"Overview","href":"/docs/branded-calling/enterprises/index"}]},{"group":"Display Identity Records","pages":[{"title":"Create and manage Display Identity Records (DIRs)","sidebarTitle":"Overview","href":"/docs/branded-calling/brands/index"}]},{"group":"BPO (Business Process Outsourcer)","pages":[{"title":"BPO (Business Process Outsourcer) support","sidebarTitle":"Overview","href":"/docs/branded-calling/bpo/index"}]},{"group":"Phone Numbers","pages":[{"title":"Phone Numbers","sidebarTitle":"Overview","href":"/docs/branded-calling/bc-phone-numbers/index"}]},{"group":"Call Reasons","pages":[{"title":"Call Reasons","sidebarTitle":"Overview","href":"/docs/branded-calling/call-reasons/index"}]},{"group":"Terms of Service","pages":[{"title":"Terms of Service","sidebarTitle":"Overview","href":"/docs/branded-calling/terms-of-service/index"}]},{"group":"Infringement Claims","pages":[{"title":"Contest and resolve DIR infringement claims","sidebarTitle":"Overview","href":"/docs/branded-calling/infringement-claims/index"}]},{"group":"API Reference","pages":[{"group":"Enterprises","pages":[{"group":"Enterprises API","pages":[{"title":"List enterprises","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /enterprises","href":"/api-reference/enterprises/list-enterprises"},{"title":"Create an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises","href":"/api-reference/enterprises/create-an-enterprise"},{"title":"Delete an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json delete /enterprises/{enterprise_id}","href":"/api-reference/enterprises/delete-an-enterprise"},{"title":"Get an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /enterprises/{enterprise_id}","href":"/api-reference/enterprises/get-an-enterprise"},{"title":"Replace an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json put /enterprises/{enterprise_id}","href":"/api-reference/enterprises/replace-an-enterprise"},{"title":"Activate Branded Calling on an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises/{enterprise_id}/branded_calling","href":"/api-reference/enterprises/activate-branded-calling-on-an-enterprise"}]},{"group":"Email Verification API","pages":[{"title":"Send an email-ownership verification code to an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises/{enterprise_id}/verify_email","href":"/api-reference/email-verification/send-an-email-ownership-verification-code-to-an-enterprise"},{"title":"Confirm an enterprise email-ownership verification code","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises/{enterprise_id}/verify_email/confirm","href":"/api-reference/email-verification/confirm-an-enterprise-email-ownership-verification-code"}]},{"group":"Display Identity Records API","pages":[{"title":"List DIRs in an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /enterprises/{enterprise_id}/dir","href":"/api-reference/display-identity-records/list-dirs-in-an-enterprise"},{"title":"Create a Display Identity Record (DIR)","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises/{enterprise_id}/dir","href":"/api-reference/display-identity-records/create-a-display-identity-record-dir"}]}]},{"group":"Display Identity Records","pages":[{"group":"Display Identity Records API","pages":[{"title":"List all DIRs across your enterprises","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir","href":"/api-reference/display-identity-records/list-all-dirs-across-your-enterprises"},{"title":"Request deletion of a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json delete /dir/{dir_id}","href":"/api-reference/display-identity-records/request-deletion-of-a-dir"},{"title":"Get a DIR by id","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}","href":"/api-reference/display-identity-records/get-a-dir-by-id"},{"title":"Update a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json patch /dir/{dir_id}","href":"/api-reference/display-identity-records/update-a-dir"},{"title":"Submit a DIR for vetting","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/submit","href":"/api-reference/display-identity-records/submit-a-dir-for-vetting"},{"title":"Render the Branded Calling LOA for a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/loa","href":"/api-reference/display-identity-records/render-the-branded-calling-loa-for-a-dir"},{"title":"Render the BPO Authorization LOA for a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/bpo_loa","href":"/api-reference/display-identity-records/render-the-bpo-authorization-loa-for-a-dir"},{"title":"List a DIR's authorized BPOs","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/bpo_authorizations","href":"/api-reference/display-identity-records/list-a-dirs-authorized-bpos"}]},{"group":"Email Verification API","pages":[{"title":"Send an email-ownership verification code","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/verify_email","href":"/api-reference/email-verification/send-an-email-ownership-verification-code"},{"title":"Confirm an email-ownership verification code","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/verify_email/confirm","href":"/api-reference/email-verification/confirm-an-email-ownership-verification-code"},{"title":"Get email-ownership verification status","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/verify_email","href":"/api-reference/email-verification/get-email-ownership-verification-status"}]},{"group":"DIR References API","pages":[{"title":"List a DIR's references","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/references","href":"/api-reference/dir-references/list-a-dirs-references"},{"title":"Submit a DIR's references","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/references","href":"/api-reference/dir-references/submit-a-dirs-references"},{"title":"Update a DIR reference","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json patch /dir/{dir_id}/references/{ref_type}/{slot}","href":"/api-reference/dir-references/update-a-dir-reference"}]},{"group":"Reference Data API","pages":[{"title":"List supported DIR document types","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/document_types","href":"/api-reference/reference-data/list-supported-dir-document-types"}]},{"group":"Comments API","pages":[{"title":"List comments on a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/comments","href":"/api-reference/comments/list-comments-on-a-dir"},{"title":"Post a comment on a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/comments","href":"/api-reference/comments/post-a-comment-on-a-dir"}]}]},{"group":"Phone Numbers","pages":[{"group":"Phone Numbers API","pages":[{"title":"Remove phone numbers from a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json delete /dir/{dir_id}/phone_numbers","href":"/api-reference/phone-numbers/remove-phone-numbers-from-a-dir"},{"title":"List phone numbers attached to a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/phone_numbers","href":"/api-reference/phone-numbers/list-phone-numbers-attached-to-a-dir"},{"title":"Add phone numbers to a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /dir/{dir_id}/phone_numbers","href":"/api-reference/phone-numbers/add-phone-numbers-to-a-dir"}]},{"group":"Phone Number Batches API","pages":[{"title":"List phone-number batches for a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/phone_number_batches","href":"/api-reference/phone-number-batches/list-phone-number-batches-for-a-dir"},{"title":"Get a phone-number batch","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/phone_number_batches/{batch_id}","href":"/api-reference/phone-number-batches/get-a-phone-number-batch"}]}]},{"group":"Call Reasons","pages":[{"title":"List standard call reasons","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /call_reasons","href":"/api-reference/reference-data/list-standard-call-reasons"},{"title":"Validate a list of call reasons","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /call_reasons/validate","href":"/api-reference/reference-data/validate-a-list-of-call-reasons"}]},{"group":"Infringement Claims","pages":[{"title":"List infringement claims for a DIR","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /dir/{dir_id}/infringement_claims","href":"/api-reference/infringement-claims/list-infringement-claims-for-a-dir"},{"title":"Update a DIR to resolve an infringement concern","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json put /dir/{dir_id}/infringement_update","href":"/api-reference/infringement-claims/update-a-dir-to-resolve-an-infringement-concern"},{"title":"Get an infringement claim","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /infringement_claims/{claim_id}","href":"/api-reference/infringement-claims/get-an-infringement-claim"},{"title":"Contest an infringement claim","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /infringement_claims/{claim_id}/contest","href":"/api-reference/infringement-claims/contest-an-infringement-claim"}]},{"group":"Terms of Service","pages":[{"title":"Agree to the Branded Calling Terms of Service","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /terms_of_service/branded_calling/agree","href":"/api-reference/terms-of-service/agree-to-the-branded-calling-terms-of-service"},{"title":"Get Terms of Service information","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /terms_of_service/info","href":"/api-reference/terms-of-service/get-terms-of-service-information"},{"title":"Get the calling user's Terms of Service status","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /terms_of_service/status","href":"/api-reference/terms-of-service/get-the-calling-users-terms-of-service-status"},{"title":"List the calling user's Terms of Service agreements","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /terms_of_service/agreements","href":"/api-reference/terms-of-service/list-the-calling-users-terms-of-service-agreements"},{"title":"Get a Terms of Service agreement by id","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /terms_of_service/agreements/{agreement_id}","href":"/api-reference/terms-of-service/get-a-terms-of-service-agreement-by-id"}]}]}]},{"group":"For AI Agents","pages":[{"title":"Trusted Calling llms.txt","sidebarTitle":"Trusted Calling llms txt","href":"/docs/development/llms/calling-trusted-calling-llms-txt/index"},{"title":"Trusted Calling llms-full.txt","sidebarTitle":"Trusted Calling llms full txt","href":"/docs/development/llms/calling-trusted-calling-llms-full-txt/index"}]}]}]},{"product":"Messaging","icon":"message","tabs":[{"tab":"SMS \u0026 MMS","icon":"comment-sms","groups":[{"group":"Sending Messages","pages":[{"group":"Getting Started","pages":[{"title":"Send Your First Message","sidebarTitle":"Send Your First Message","href":"/docs/messaging/messages/send-message"},{"title":"Receive SMS and MMS Messages","sidebarTitle":"Receive Messages","href":"/docs/messaging/messages/receive-message/index"},{"title":"Receiving Webhooks for Messaging","sidebarTitle":"Webhooks","href":"/docs/messaging/messages/receiving-webhooks/index"},{"title":"Choosing a Sender Type","sidebarTitle":"Choosing a Sender Type","href":"/docs/messaging/getting-started/choosing-your-sender-type/index"},{"title":"Message Encoding","sidebarTitle":"Message Encoding","href":"/docs/messaging/messages/message-encoding/index"},{"title":"SMS messaging rate limits","sidebarTitle":"Rate Limiting","href":"/docs/messaging/messages/rate-limiting/index"},{"title":"Messaging Error Code Reference","sidebarTitle":"Error Codes","href":"/docs/messaging/messages/error-codes/index"}]},{"group":"Advanced Features","pages":[{"title":"Smart Encoding","sidebarTitle":"Smart Encoding","href":"/docs/messaging/messages/smart-encoding/index"},{"title":"SMS Chunking","sidebarTitle":"SMS Chunking","href":"/docs/messaging/messages/sms-chunking/index"},{"title":"Group Messaging","sidebarTitle":"Group Messaging","href":"/docs/messaging/messages/group-messaging/index"},{"title":"Alphanumeric Sender ID","sidebarTitle":"Alphanumeric Sender ID","href":"/docs/messaging/messages/alphanumeric-sender-id/index"},{"title":"International SMS Compliance Guide","sidebarTitle":"International Compliance","href":"/docs/messaging/messages/international-sms-compliance/index"},{"title":"MMS converter","sidebarTitle":"MMS Converter","href":"/docs/messaging/messages/mms-converter/index"},{"title":"MMS Media \u0026 Transcoding","sidebarTitle":"MMS Media \u0026 Transcoding","href":"/docs/messaging/messages/mms-transcoding/index"},{"title":"Schedule SMS and MMS Messages","sidebarTitle":"Schedule Messages","href":"/docs/messaging/messages/schedule-message/index"},{"sidebarTitle":"Specifying SMIL Template","title":"Modifying MMS SMIL Template","href":"/docs/messaging/messages/smil-template/index"},{"title":"MM7 Gateway","sidebarTitle":"MM7 Gateway","href":"/docs/messaging/messages/mm7-gateway/index"}]},{"group":"Use Cases \u0026 Integrations","pages":[{"title":"Two-Factor Authentication (2FA) via SMS","sidebarTitle":"Two-Factor Authentication (2FA)","href":"/docs/messaging/messages/2fa/index"},{"title":"Appointment Reminders via SMS","sidebarTitle":"Appointment Reminders","href":"/docs/messaging/messages/appointment-reminder/index"},{"title":"Send \u0026 Receive MMS","sidebarTitle":"Send \u0026 Receive MMS","href":"/docs/messaging/messages/send-receive-mms/index"},{"title":"Zapier Integration","sidebarTitle":"Zapier Integration","href":"/docs/messaging/messages/zapier-integration/index"},{"title":"Vercel Chat SDK Adapter","sidebarTitle":"Vercel Chat SDK","href":"/docs/messaging/messages/chat-sdk-adapter/index"}]},{"group":"Management \u0026 Analytics","pages":[{"title":"Configurable Spend Limits","sidebarTitle":"Spend Limits","href":"/docs/messaging/messages/configurable-spend-limits/index"},{"title":"Message Detail Records","sidebarTitle":"Message Detail Records","href":"/docs/messaging/messages/message-detail-records/index"},{"title":"Message Redaction","sidebarTitle":"Message Redaction","href":"/docs/messaging/messages/message-redaction/index"}]},{"group":"Sending Messages API","pages":[{"group":"Messages API","pages":[{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages","href":"/api-reference/messages/send-a-message"},{"title":"Cancel a scheduled message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messages/{id}","href":"/api-reference/messages/cancel-a-scheduled-message"},{"title":"Retrieve a message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messages/{id}","href":"/api-reference/messages/retrieve-a-message"},{"title":"Send a group MMS message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/group_mms","href":"/api-reference/messages/send-a-group-mms-message"},{"title":"Send a long code message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/long_code","href":"/api-reference/messages/send-a-long-code-message"},{"title":"Send a message using number pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/number_pool","href":"/api-reference/messages/send-a-message-using-number-pool"},{"title":"Schedule a message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/schedule","href":"/api-reference/messages/schedule-a-message"},{"title":"Send a short code message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/short_code","href":"/api-reference/messages/send-a-short-code-message"},{"title":"Send a message using an alphanumeric sender ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/messages.json post /messages/alphanumeric/sender/id","href":"/api-reference/messages/send-a-message-using-an-alphanumeric-sender-id"},{"title":"Retrieve group MMS messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messages/group/{message_id}","href":"/api-reference/messages/retrieve-group-mms-messages"}]},{"group":"Whatsapp messaging API","pages":[{"title":"Send a Whatsapp message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/whatsapp","href":"/api-reference/whatsapp-messaging/send-a-whatsapp-message"}]},{"group":"Callbacks API","pages":[{"title":"Delivery update","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook deliveryUpdate","href":"/api-reference/callbacks/delivery-update"},{"title":"Inbound message","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook inboundMessage","href":"/api-reference/callbacks/inbound-message"},{"title":"Replaced link click","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook replacedLinkClick","href":"/api-reference/callbacks/replaced-link-click"}]}]}]},{"group":"Messaging Profiles","pages":[{"title":"Messaging Profiles Overview","sidebarTitle":"Overview","href":"/docs/messaging/messages/messaging-profiles-overview/index"},{"title":"Number Pool","sidebarTitle":"Number Pool","href":"/docs/messaging/messages/number-pool/index"},{"title":"Sticky Sender","sidebarTitle":"Sticky Sender","href":"/docs/messaging/messages/sticky-sender/index"},{"title":"Geomatch","sidebarTitle":"Geomatch","href":"/docs/messaging/messages/geomatch/index"},{"group":"Messaging Profiles API","pages":[{"group":"Profiles API","pages":[{"title":"List messaging profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles","href":"/api-reference/profiles/list-messaging-profiles"},{"title":"Create a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_profiles","href":"/api-reference/profiles/create-a-messaging-profile"},{"title":"Delete a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messaging_profiles/{id}","href":"/api-reference/profiles/delete-a-messaging-profile"},{"title":"Retrieve a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles/{id}","href":"/api-reference/profiles/retrieve-a-messaging-profile"},{"title":"Update a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json patch /messaging_profiles/{id}","href":"/api-reference/profiles/update-a-messaging-profile"},{"title":"List phone numbers associated with a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles/{id}/phone_numbers","href":"/api-reference/profiles/list-phone-numbers-associated-with-a-messaging-profile"},{"title":"List short codes associated with a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles/{id}/short_codes","href":"/api-reference/profiles/list-short-codes-associated-with-a-messaging-profile"}]},{"group":"Opt-Out Management API","pages":[{"title":"List Auto-Response Settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles/{profile_id}/autoresp_configs","href":"/api-reference/opt-out-management/list-auto-response-settings"},{"title":"Create auto-response setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_profiles/{profile_id}/autoresp_configs","href":"/api-reference/opt-out-management/create-auto-response-setting"},{"title":"Delete Auto-Response Setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}","href":"/api-reference/opt-out-management/delete-auto-response-setting"},{"title":"Get Auto-Response Setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}","href":"/api-reference/opt-out-management/get-auto-response-setting"},{"title":"Update Auto-Response Setting","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json put /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}","href":"/api-reference/opt-out-management/update-auto-response-setting"}]},{"group":"Messaging API","pages":[{"title":"Regenerate messaging profile secret","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/profiles.json post /messaging/profiles/{id}/actions/regenerate/secret","href":"/api-reference/messaging/regenerate-messaging-profile-secret"},{"title":"List alphanumeric sender IDs for a messaging profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/profiles.json get /messaging/profiles/{id}/alphanumeric/sender/ids","href":"/api-reference/messaging/list-alphanumeric-sender-ids-for-a-messaging-profile"},{"title":"Get detailed messaging profile metrics","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/profiles.json get /messaging/profiles/{id}/metrics","href":"/api-reference/messaging/get-detailed-messaging-profile-metrics"}]}]}]},{"group":"Short Code","pages":[{"title":"Short Codes","sidebarTitle":"Short Codes","href":"/docs/messaging/messages/short-code/index"},{"group":"Short Code API","pages":[{"title":"List short codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /short_codes","href":"/api-reference/short-codes/list-short-codes"},{"title":"Retrieve a short code","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /short_codes/{id}","href":"/api-reference/short-codes/retrieve-a-short-code"},{"title":"Update short code","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json patch /short_codes/{id}","href":"/api-reference/short-codes/update-short-code"}]}]},{"group":"Hosted Numbers","pages":[{"title":"Hosted SMS","sidebarTitle":"Hosted SMS","href":"/docs/messaging/messages/hosted-sms/index"},{"title":"Internal Hosted SMS Transfer","sidebarTitle":"Internal Transfer","href":"/docs/messaging/messages/hosted-sms/internal-transfer/index"},{"group":"Hosted Numbers API","pages":[{"group":"Hosted Numbers API","pages":[{"title":"List messaging hosted number orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_hosted_number_orders","href":"/api-reference/hosted-numbers/list-messaging-hosted-number-orders"},{"title":"Create a messaging hosted number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_hosted_number_orders","href":"/api-reference/hosted-numbers/create-a-messaging-hosted-number-order"},{"title":"Delete a messaging hosted number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messaging_hosted_number_orders/{id}","href":"/api-reference/hosted-numbers/delete-a-messaging-hosted-number-order"},{"title":"Retrieve a messaging hosted number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_hosted_number_orders/{id}","href":"/api-reference/hosted-numbers/retrieve-a-messaging-hosted-number-order"},{"title":"Upload hosted number document","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_hosted_number_orders/{id}/actions/file_upload","href":"/api-reference/hosted-numbers/upload-hosted-number-document"},{"title":"Validate hosted number codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_hosted_number_orders/{id}/validation_codes","href":"/api-reference/hosted-numbers/validate-hosted-number-codes"},{"title":"Create hosted number verification codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_hosted_number_orders/{id}/verification_codes","href":"/api-reference/hosted-numbers/create-hosted-number-verification-codes"},{"title":"Check hosted messaging eligibility","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging_hosted_number_orders/eligibility_numbers_check","href":"/api-reference/hosted-numbers/check-hosted-messaging-eligibility"},{"title":"Delete a messaging hosted number","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messaging_hosted_numbers/{id}","href":"/api-reference/hosted-numbers/delete-a-messaging-hosted-number"}]},{"group":"Messaging API","pages":[{"title":"Retrieve a messaging hosted number","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_hosted_numbers/{id}","href":"/api-reference/messaging/retrieve-a-messaging-hosted-number"},{"title":"Update a messaging hosted number","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json patch /messaging_hosted_numbers/{id}","href":"/api-reference/messaging/update-a-messaging-hosted-number"},{"title":"List messaging hosted numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/hosted-numbers.json get /messaging/hosted/numbers","href":"/api-reference/messaging/list-messaging-hosted-numbers"}]},{"group":"Callbacks API","pages":[{"title":"Hosted number order event","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook hostedNumberOrderEvent","href":"/api-reference/callbacks/hosted-number-order-event"}]}]}]},{"group":"Opt Outs","pages":[{"title":"Advanced Opt-In/Out Management","sidebarTitle":"Opt-In/Out Management","href":"/docs/messaging/messages/advanced-opt-in-out/index"},{"group":"Opt Outs API","pages":[{"title":"List opt-outs","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging_optouts","href":"/api-reference/opt-out-management/list-opt-outs"}]}]},{"group":"Phone Numbers","pages":[{"title":"Phone Number Messaging Configuration","sidebarTitle":"Number Configuration","href":"/docs/messaging/messages/phone-number-configuration/index"},{"group":"Phone Numbers API","pages":[{"title":"Retrieve a phone number with messaging settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /phone_numbers/{id}/messaging","href":"/api-reference/number-settings/retrieve-a-phone-number-with-messaging-settings"},{"title":"Update the messaging profile and/or messaging product of a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json patch /phone_numbers/{id}/messaging","href":"/api-reference/number-settings/update-the-messaging-profile-andor-messaging-product-of-a-phone-number"},{"title":"List phone numbers with messaging settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /phone_numbers/messaging","href":"/api-reference/number-settings/list-phone-numbers-with-messaging-settings"},{"title":"Bulk update phone number profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/phone-numbers.json post /messaging_numbers/bulk_updates","href":"/api-reference/number-settings/bulk-update-phone-number-profiles"},{"title":"Retrieve bulk update status","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/phone-numbers.json get /messaging_numbers/bulk_updates/{order_id}","href":"/api-reference/number-settings/retrieve-bulk-update-status"}]}]},{"group":"Toll Free Verification","pages":[{"title":"Toll-Free Verification with Business Registration Fields","sidebarTitle":"Toll-Free Verification","href":"/docs/messaging/toll-free-verification/index"},{"title":"Toll-Free Verification Troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/messaging/toll-free-verification/troubleshooting/index"},{"group":"Toll Free Verification API","pages":[{"title":"List Verification Requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/toll-free-verification.json get /messaging_tollfree/verification/requests","href":"/api-reference/verification-requests/list-verification-requests"},{"title":"Submit Verification Request","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/toll-free-verification.json post /messaging_tollfree/verification/requests","href":"/api-reference/verification-requests/submit-verification-request"},{"title":"Delete Verification Request","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/toll-free-verification.json delete /messaging_tollfree/verification/requests/{id}","href":"/api-reference/verification-requests/delete-verification-request"},{"title":"Get Verification Request","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/toll-free-verification.json get /messaging_tollfree/verification/requests/{id}","href":"/api-reference/verification-requests/get-verification-request"},{"title":"Update Verification Request","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/toll-free-verification.json patch /messaging_tollfree/verification/requests/{id}","href":"/api-reference/verification-requests/update-verification-request"},{"title":"Get Verification Request Status History","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/toll-free-verification.json get /messaging/tollfree/verification/requests/{id}/status/history","href":"/api-reference/verification-requests/get-verification-request-status-history"}]}]},{"group":"10 DLC","pages":[{"group":"Getting Started","pages":[{"title":"Getting Started with 10DLC","sidebarTitle":"Quickstart","href":"/docs/messaging/10dlc/quickstart/index"},{"title":"Sole Proprietor 10DLC Registration","sidebarTitle":"Sole Proprietor","href":"/docs/messaging/10dlc/sole-proprietor/index"}]},{"group":"Registration","pages":[{"title":"10DLC Brand Registration","sidebarTitle":"Brand Registration","href":"/docs/messaging/10dlc/brand-registration/index"},{"title":"10DLC Campaign Registration","sidebarTitle":"Campaign Registration","href":"/docs/messaging/10dlc/campaign-registration/index"},{"title":"Campaign Use Case Examples \u0026 Sample Messages","sidebarTitle":"Use Case Examples","href":"/docs/messaging/10dlc/campaign-use-cases/index"},{"title":"ISV \u0026 Reseller 10DLC Onboarding","sidebarTitle":"ISV/Reseller Onboarding","href":"/docs/messaging/10dlc/isv-reseller-onboarding/index"}]},{"group":"Operations","pages":[{"title":"10DLC Rate Limits \u0026 Throughput","sidebarTitle":"Rate Limits \u0026 Scores","href":"/docs/messaging/10dlc/10dlc-rate-limits/index"},{"title":"10DLC Phone Number Assignment","sidebarTitle":"Phone Number Assignment","href":"/docs/messaging/10dlc/phone-number-assignment/index"},{"title":"10DLC event notifications","sidebarTitle":"Event Notifications","href":"/docs/messaging/10dlc/event-notifications/index"}]},{"group":"Troubleshooting","pages":[{"title":"10DLC Troubleshooting Guide","sidebarTitle":"Troubleshooting","href":"/docs/messaging/10dlc/troubleshooting/index"}]},{"group":"Campaign Builder API","pages":[{"title":"Submit Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/campaignBuilder","href":"/api-reference/campaign/submit-campaign"},{"title":"Qualify By Usecase","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}","href":"/api-reference/campaign/qualify-by-usecase"}]},{"group":"Brands API","pages":[{"group":"Brands API","pages":[{"title":"List Brands","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/brand","href":"/api-reference/brands/list-brands"},{"title":"Create Brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/brand","href":"/api-reference/brands/create-brand"},{"title":"Delete Brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json delete /10dlc/brand/{brandId}","href":"/api-reference/brands/delete-brand"},{"title":"Get Brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/brand/{brandId}","href":"/api-reference/brands/get-brand"},{"title":"Update Brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/brand/{brandId}","href":"/api-reference/brands/update-brand"},{"title":"Resend brand 2FA email","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/brand/{brandId}/2faEmail","href":"/api-reference/brands/resend-brand-2fa-email"},{"title":"List External Vettings","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/brand/{brandId}/externalVetting","href":"/api-reference/brands/list-external-vettings"},{"title":"Order Brand External Vetting","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/brand/{brandId}/externalVetting","href":"/api-reference/brands/order-brand-external-vetting"},{"title":"Import External Vetting Record","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/brand/{brandId}/externalVetting","href":"/api-reference/brands/import-external-vetting-record"},{"title":"Revet Brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/brand/{brandId}/revet","href":"/api-reference/brands/revet-brand"},{"title":"Get Brand SMS OTP Status by Brand ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/brand/{brandId}/smsOtp","href":"/api-reference/brands/get-brand-sms-otp-status-by-brand-id"},{"title":"Trigger Brand SMS OTP","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/brand/{brandId}/smsOtp","href":"/api-reference/brands/trigger-brand-sms-otp"},{"title":"Verify Brand SMS OTP","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/brand/{brandId}/smsOtp","href":"/api-reference/brands/verify-brand-sms-otp"},{"title":"Get Brand SMS OTP Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/brand/smsOtp/{referenceId}","href":"/api-reference/brands/get-brand-sms-otp-status"},{"title":"Get Brand Feedback By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging-10dlc/brands.json get /10dlc/brand_feedback/{brandId}","href":"/api-reference/brands/get-brand-feedback-by-id"}]},{"group":"Enum API","pages":[{"title":"Get Enum","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/enum/{endpoint}","href":"/api-reference/enum/get-enum"}]}]},{"group":"Campaigns API","pages":[{"group":"Campaign API","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaign","href":"/api-reference/campaign/list-campaigns"},{"title":"Deactivate campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json delete /10dlc/campaign/{campaignId}","href":"/api-reference/campaign/deactivate-campaign"},{"title":"Get campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaign/{campaignId}","href":"/api-reference/campaign/get-campaign"},{"title":"Update campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/campaign/{campaignId}","href":"/api-reference/campaign/update-campaign"},{"title":"Submit campaign appeal for manual review","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/campaign/{campaignId}/appeal","href":"/api-reference/campaign/submit-campaign-appeal-for-manual-review"},{"title":"Get Campaign Mno Metadata","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaign/{campaignId}/mnoMetadata","href":"/api-reference/campaign/get-campaign-mno-metadata"},{"title":"Get campaign operation status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaign/{campaignId}/operationStatus","href":"/api-reference/campaign/get-campaign-operation-status"},{"title":"Get OSR campaign attributes","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging-10dlc/campaigns.json get /10dlc/campaign/{campaignId}/osr_attributes","href":"/api-reference/campaign/get-osr-campaign-attributes"},{"title":"Get Sharing Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/campaign/{campaignId}/sharing","href":"/api-reference/campaign/get-sharing-status"},{"title":"Accept Shared Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/campaign/acceptSharing/{campaignId}","href":"/api-reference/campaign/accept-shared-campaign"},{"title":"Get Campaign Cost","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging-10dlc/campaigns.json get /10dlc/campaign/usecase_cost","href":"/api-reference/campaign/get-campaign-cost"}]},{"group":"Callbacks API","pages":[{"title":"Campaign status update","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/10dlc.json webhook campaignStatusUpdate","href":"/api-reference/callbacks/campaign-status-update"}]}]},{"group":"Partner Campaigns API","pages":[{"title":"List Shared Campaigns","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/partner_campaigns","href":"/api-reference/shared-campaigns/list-shared-campaigns"},{"title":"Get Single Shared Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/partner_campaigns/{campaignId}","href":"/api-reference/shared-campaigns/get-single-shared-campaign"},{"title":"Update Single Shared Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json patch /10dlc/partner_campaigns/{campaignId}","href":"/api-reference/shared-campaigns/update-single-shared-campaign"},{"title":"Get Sharing Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/partnerCampaign/{campaignId}/sharing","href":"/api-reference/shared-campaigns/get-sharing-status"},{"title":"List shared partner campaigns","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/partnerCampaign/sharedByMe","href":"/api-reference/shared-campaigns/list-shared-partner-campaigns"}]},{"group":"Phone Number Campaigns API","pages":[{"group":"Phone Number Campaigns API","pages":[{"title":"List phone number campaigns","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/phone_number_campaigns","href":"/api-reference/phone-number-campaigns/list-phone-number-campaigns"},{"title":"Create New Phone Number Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/phone_number_campaigns","href":"/api-reference/phone-number-campaigns/create-new-phone-number-campaign"},{"title":"Delete Phone Number Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json delete /10dlc/phone_number_campaigns/{phoneNumber}","href":"/api-reference/phone-number-campaigns/delete-phone-number-campaign"},{"title":"Get Single Phone Number Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/phone_number_campaigns/{phoneNumber}","href":"/api-reference/phone-number-campaigns/get-single-phone-number-campaign"},{"title":"Update Phone Number Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json put /10dlc/phone_number_campaigns/{phoneNumber}","href":"/api-reference/phone-number-campaigns/update-phone-number-campaign"}]},{"group":"Bulk Phone Number Campaigns API","pages":[{"title":"Assign Messaging Profile To Campaign","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json post /10dlc/phoneNumberAssignmentByProfile","href":"/api-reference/bulk-phone-number-campaigns/assign-messaging-profile-to-campaign"},{"title":"Get Assignment Task Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/phoneNumberAssignmentByProfile/{taskId}","href":"/api-reference/bulk-phone-number-campaigns/get-assignment-task-status"},{"title":"Get Phone Number Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/10dlc.json get /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers","href":"/api-reference/bulk-phone-number-campaigns/get-phone-number-status"}]}]}]},{"group":"Guides","hidden":true,"searchable":true,"pages":[{"title":"Messaging configuration and usage","href":"/docs/messaging/messages/configuration-and-usage/index"},{"title":"Custom URL Shortening with Telnyx Messaging","href":"/docs/messaging/messages/url-shortening/index"}]},{"group":"For AI Agents","pages":[{"title":"SMS \u0026 MMS llms.txt","sidebarTitle":"SMS \u0026 MMS llms txt","href":"/docs/development/llms/messaging-sms-mms-llms-txt/index"},{"title":"SMS \u0026 MMS llms-full.txt","sidebarTitle":"SMS \u0026 MMS llms full txt","href":"/docs/development/llms/messaging-sms-mms-llms-full-txt/index"}]}]},{"tab":"Email","icon":"envelope","groups":[{"group":"Getting Started","pages":[{"title":"Email API Overview","sidebarTitle":"Overview","href":"/docs/messaging/email/overview/index"},{"title":"Send Your First Email","sidebarTitle":"Send Your First Email","href":"/docs/messaging/email/quickstart/index"}]},{"group":"Sending Email","pages":[{"title":"Sending Email with the Telnyx API","sidebarTitle":"Email API Guide","href":"/docs/messaging/email/send-email/index"},{"title":"SMTP Protocol Contract","sidebarTitle":"SMTP Protocol Contract","href":"/docs/messaging/email/smtp-protocol-contract/index"},{"title":"Batch Sending","sidebarTitle":"Batch Sending","href":"/docs/messaging/email/batch-sending/index"},{"title":"Migrate to Telnyx Email","sidebarTitle":"Migrate to Telnyx","href":"/docs/messaging/email/migrate-to-telnyx/index"},{"title":"SMTP Migration Guides","sidebarTitle":"SMTP Migration","href":"/docs/messaging/email/smtp-migration-guides/index"},{"title":"Rate Limits \u0026 Quotas","sidebarTitle":"Rate Limits","href":"/docs/messaging/email/rate-limits/index"},{"title":"Error Codes","sidebarTitle":"Error Codes","href":"/docs/messaging/email/error-codes/index"},{"group":"Email API","pages":[{"title":"Delete email messages by address","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_messages","href":"/api-reference/email-messages/delete-email-messages-by-address"},{"title":"List email messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_messages","href":"/api-reference/email-messages/list-email-messages"},{"title":"Create or send an email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_messages","href":"/api-reference/email-messages/create-or-send-an-email-message"},{"title":"Create a batch of email messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_messages/batch","href":"/api-reference/email-messages/create-a-batch-of-email-messages"},{"title":"List events for an email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_messages/{email_id}/events","href":"/api-reference/email-messages/list-events-for-an-email-message"},{"title":"Cancel a scheduled email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_messages/{email_id}/schedule","href":"/api-reference/email-messages/cancel-a-scheduled-email-message"},{"title":"Reschedule a scheduled email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_messages/{email_id}/schedule","href":"/api-reference/email-messages/reschedule-a-scheduled-email-message"},{"title":"Delete an email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_messages/{id}","href":"/api-reference/email-messages/delete-an-email-message"},{"title":"Get an email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_messages/{id}","href":"/api-reference/email-messages/get-an-email-message"},{"title":"List recipients for an email message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_messages/{email_id}/recipients","href":"/api-reference/email-messages/list-recipients-for-an-email-message"},{"title":"Get a single recipient's delivery state","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_messages/{email_id}/recipients/{recipient_id}","href":"/api-reference/email-messages/get-a-single-recipients-delivery-state"}]}]},{"group":"Inboxes","pages":[{"title":"Manage Inboxes","sidebarTitle":"Manage Inboxes","href":"/docs/messaging/email/inboxes/index"},{"group":"Email Inboxes API","pages":[{"group":"Email Inboxes API","pages":[{"title":"List email inboxes","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes","href":"/api-reference/email-inboxes/list-email-inboxes"},{"title":"Create an email inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes","href":"/api-reference/email-inboxes/create-an-email-inbox"},{"title":"Delete an email inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_inboxes/{id}","href":"/api-reference/email-inboxes/delete-an-email-inbox"},{"title":"Get an email inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{id}","href":"/api-reference/email-inboxes/get-an-email-inbox"},{"title":"Remove sender filter entries from an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_inboxes/{inbox_id}/filters","href":"/api-reference/email-inboxes/remove-sender-filter-entries-from-an-inbox"},{"title":"List sender filters for an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/filters","href":"/api-reference/email-inboxes/list-sender-filters-for-an-inbox"},{"title":"Add sender filter entries to an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/filters","href":"/api-reference/email-inboxes/add-sender-filter-entries-to-an-inbox"},{"title":"Replace sender filters for an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json put /email_inboxes/{inbox_id}/filters","href":"/api-reference/email-inboxes/replace-sender-filters-for-an-inbox"},{"title":"List and search messages in an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/messages","href":"/api-reference/email-inboxes/list-and-search-messages-in-an-inbox"},{"title":"Update an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_inboxes/{inbox_id}/messages/{message_id}","href":"/api-reference/email-inboxes/update-an-inbox-message"},{"title":"Forward an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/messages/{message_id}/actions/forward","href":"/api-reference/email-inboxes/forward-an-inbox-message"},{"title":"Reply to an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/messages/{message_id}/actions/reply","href":"/api-reference/email-inboxes/reply-to-an-inbox-message"},{"title":"Reply all to an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/messages/{message_id}/actions/reply_all","href":"/api-reference/email-inboxes/reply-all-to-an-inbox-message"},{"title":"Remove labels from an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_inboxes/{inbox_id}/messages/{message_id}/labels","href":"/api-reference/email-inboxes/remove-labels-from-an-inbox-message"},{"title":"Add labels to an inbox message","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/messages/{message_id}/labels","href":"/api-reference/email-inboxes/add-labels-to-an-inbox-message"},{"title":"List threads in an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/threads","href":"/api-reference/email-inboxes/list-threads-in-an-inbox"},{"title":"Get a thread and a page of its messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/threads/{thread_id}","href":"/api-reference/email-inboxes/get-a-thread-and-a-page-of-its-messages"},{"title":"Remove labels from an inbox thread","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_inboxes/{inbox_id}/threads/{thread_id}/labels","href":"/api-reference/email-inboxes/remove-labels-from-an-inbox-thread"},{"title":"Add labels to an inbox thread","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/threads/{thread_id}/labels","href":"/api-reference/email-inboxes/add-labels-to-an-inbox-thread"}]},{"group":"Email Drafts API","pages":[{"title":"List drafts in an inbox","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/drafts","href":"/api-reference/email-drafts/list-drafts-in-an-inbox"},{"title":"Create a draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/drafts","href":"/api-reference/email-drafts/create-a-draft"},{"title":"Delete a draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_inboxes/{inbox_id}/drafts/{draft_id}","href":"/api-reference/email-drafts/delete-a-draft"},{"title":"Retrieve a draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_inboxes/{inbox_id}/drafts/{draft_id}","href":"/api-reference/email-drafts/retrieve-a-draft"},{"title":"Update a draft (alias)","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_inboxes/{inbox_id}/drafts/{draft_id}","href":"/api-reference/email-drafts/update-a-draft-alias"},{"title":"Update a draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json put /email_inboxes/{inbox_id}/drafts/{draft_id}","href":"/api-reference/email-drafts/update-a-draft"},{"title":"Send a draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/drafts/{draft_id}/send","href":"/api-reference/email-drafts/send-a-draft"},{"title":"Create a reply draft","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_inboxes/{inbox_id}/messages/{message_id}/drafts","href":"/api-reference/email-drafts/create-a-reply-draft"}]},{"group":"Email Threads API","pages":[{"title":"List threads across every inbox in the account","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_threads","href":"/api-reference/email-threads/list-threads-across-every-inbox-in-the-account"},{"title":"Get an account-wide thread and a page of its messages","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_threads/{thread_id}","href":"/api-reference/email-threads/get-an-account-wide-thread-and-a-page-of-its-messages"}]}]}]},{"group":"Domains \u0026 Validation","pages":[{"title":"Email Domains \u0026 DKIM","sidebarTitle":"Email Domains \u0026 DKIM","href":"/docs/messaging/email/domains/index"},{"group":"Email Domains API","pages":[{"group":"Email Domains API","pages":[{"title":"List email domains","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains","href":"/api-reference/email-domains/list-email-domains"},{"title":"Create an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_domains","href":"/api-reference/email-domains/create-an-email-domain"},{"title":"Delete an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_domains/{id}","href":"/api-reference/email-domains/delete-an-email-domain"},{"title":"Retrieve an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains/{id}","href":"/api-reference/email-domains/retrieve-an-email-domain"},{"title":"Update an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_domains/{id}","href":"/api-reference/email-domains/update-an-email-domain"},{"title":"Get domain health summary","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains/{id}/health","href":"/api-reference/email-domains/get-domain-health-summary"},{"title":"Rotate the DKIM key for an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_domains/{domain_id}/rotate_dkim","href":"/api-reference/email-domains/rotate-the-dkim-key-for-an-email-domain"}]},{"group":"Email Domain DNS Records API","pages":[{"title":"List DNS records for an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains/{domain_id}/dns_records","href":"/api-reference/email-domain-dns-records/list-dns-records-for-an-email-domain"},{"title":"Verify DNS records for an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_domains/{domain_id}/verify","href":"/api-reference/email-domain-dns-records/verify-dns-records-for-an-email-domain"}]},{"group":"Email Webhooks API","pages":[{"title":"List webhooks for an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains/{domain_id}/webhooks","href":"/api-reference/email-webhooks/list-webhooks-for-an-email-domain"},{"title":"Create a webhook for an email domain","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_domains/{domain_id}/webhooks","href":"/api-reference/email-webhooks/create-a-webhook-for-an-email-domain"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_domains/{domain_id}/webhooks/{id}","href":"/api-reference/email-webhooks/delete-a-webhook"},{"title":"Retrieve a webhook","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_domains/{domain_id}/webhooks/{id}","href":"/api-reference/email-webhooks/retrieve-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_domains/{domain_id}/webhooks/{id}","href":"/api-reference/email-webhooks/update-a-webhook"}]}]},{"title":"Email Validation","sidebarTitle":"Email Validation","href":"/docs/messaging/email/validation/index"},{"group":"Email Validations API","pages":[{"title":"Validate a single email address","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_validations","href":"/api-reference/email-validations/validate-a-single-email-address"},{"title":"Create a batch email validation job","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_validations/batch","href":"/api-reference/email-validations/create-a-batch-email-validation-job"},{"title":"Get a batch email validation job","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_validations/batch/{id}","href":"/api-reference/email-validations/get-a-batch-email-validation-job"}]}]},{"group":"Deliverability","pages":[{"title":"Deliverability and Domain Warm-up","sidebarTitle":"Deliverability \u0026 Warm-up","href":"/docs/messaging/email/deliverability/index"},{"title":"Email Deliverability Best Practices","sidebarTitle":"Deliverability Best Practices","href":"/docs/messaging/email/deliverability-best-practices/index"},{"title":"Dedicated IPs","href":"/docs/messaging/email/dedicated-ips/index"},{"group":"Dedicated IPs API","pages":[{"title":"Purchase a dedicated IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/dedicated_ips","href":"/api-reference/dedicated-ips/purchase-a-dedicated-ip"},{"title":"List dedicated IPs","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email/dedicated_ips","href":"/api-reference/dedicated-ips/list-dedicated-ips"},{"title":"Retrieve a dedicated IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email/dedicated_ips/{id}","href":"/api-reference/dedicated-ips/retrieve-a-dedicated-ip"},{"title":"Update a dedicated IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email/dedicated_ips/{id}","href":"/api-reference/dedicated-ips/update-a-dedicated-ip"},{"title":"Release a dedicated IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email/dedicated_ips/{id}","href":"/api-reference/dedicated-ips/release-a-dedicated-ip"},{"title":"Start warmup for a dedicated IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/dedicated_ips/{id}/actions/start_warmup","href":"/api-reference/dedicated-ips/start-warmup-for-a-dedicated-ip"},{"title":"Manually complete warmup","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/dedicated_ips/{id}/actions/complete_warmup","href":"/api-reference/dedicated-ips/manually-complete-warmup"},{"title":"Pause warmup","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/dedicated_ips/{id}/actions/pause_warmup","href":"/api-reference/dedicated-ips/pause-warmup"},{"title":"Resume warmup","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/dedicated_ips/{id}/actions/resume_warmup","href":"/api-reference/dedicated-ips/resume-warmup"}]},{"group":"IP Pools API","pages":[{"title":"List IP pools","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email/ip_pools","href":"/api-reference/ip-pools/list-ip-pools"},{"title":"Create an IP pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/ip_pools","href":"/api-reference/ip-pools/create-an-ip-pool"},{"title":"Retrieve an IP pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email/ip_pools/{id}","href":"/api-reference/ip-pools/retrieve-an-ip-pool"},{"title":"Update an IP pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email/ip_pools/{id}","href":"/api-reference/ip-pools/update-an-ip-pool"},{"title":"Delete an IP pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email/ip_pools/{id}","href":"/api-reference/ip-pools/delete-an-ip-pool"},{"title":"Add a dedicated IP to a pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email/ip_pools/{id}/ips","href":"/api-reference/ip-pools/add-a-dedicated-ip-to-a-pool"},{"title":"Remove a dedicated IP from a pool","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email/ip_pools/{id}/ips/{ip_id}","href":"/api-reference/ip-pools/remove-a-dedicated-ip-from-a-pool"}]}]},{"group":"Templates \u0026 Suppression","pages":[{"title":"Email Templates","sidebarTitle":"Templates","href":"/docs/messaging/email/templates/index"},{"group":"Email Templates API","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_templates","href":"/api-reference/email-templates/list-email-templates"},{"title":"Create an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_templates","href":"/api-reference/email-templates/create-an-email-template"},{"title":"Delete an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_templates/{id}","href":"/api-reference/email-templates/delete-an-email-template"},{"title":"Get an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_templates/{id}","href":"/api-reference/email-templates/get-an-email-template"},{"title":"Update an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_templates/{id}","href":"/api-reference/email-templates/update-an-email-template"},{"title":"Replace an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json put /email_templates/{id}","href":"/api-reference/email-templates/replace-an-email-template"},{"title":"Render an email template","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_templates/{id}/render","href":"/api-reference/email-templates/render-an-email-template"}]},{"title":"Suppressions \u0026 Unsubscribes","sidebarTitle":"Suppressions \u0026 Unsubscribes","href":"/docs/messaging/email/suppressions/index"},{"title":"Unsubscribe Groups","sidebarTitle":"Unsubscribe Groups","href":"/docs/messaging/email/unsubscribe-groups/index"},{"group":"Email Suppressions API","pages":[{"group":"Email Suppressions API","pages":[{"title":"List suppressions","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_blocks","href":"/api-reference/email-suppressions/list-suppressions"},{"title":"Create a manual suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_blocks","href":"/api-reference/email-suppressions/create-a-manual-suppression"},{"title":"Export suppressions as CSV","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_blocks/export","href":"/api-reference/email-suppressions/export-suppressions-as-csv"},{"title":"Soft-delete a suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_blocks/{id}","href":"/api-reference/email-suppressions/soft-delete-a-suppression"},{"title":"Retrieve a suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_blocks/{id}","href":"/api-reference/email-suppressions/retrieve-a-suppression"},{"title":"List audit events for a suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_blocks/{id}/events","href":"/api-reference/email-suppressions/list-audit-events-for-a-suppression"}]},{"group":"Email Suppression Imports API","pages":[{"title":"Create an async CSV import job","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_blocks/import","href":"/api-reference/email-suppression-imports/create-an-async-csv-import-job"},{"title":"Poll an import job","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_blocks/import/{id}","href":"/api-reference/email-suppression-imports/poll-an-import-job"}]}]},{"group":"Unsubscribe Groups API","pages":[{"title":"List unsubscribe groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_unsubscribe_groups","href":"/api-reference/email-unsubscribe-groups/list-unsubscribe-groups"},{"title":"Create an unsubscribe group","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_unsubscribe_groups","href":"/api-reference/email-unsubscribe-groups/create-an-unsubscribe-group"},{"title":"Delete an unsubscribe group","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_unsubscribe_groups/{id}","href":"/api-reference/email-unsubscribe-groups/delete-an-unsubscribe-group"},{"title":"Retrieve an unsubscribe group","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_unsubscribe_groups/{id}","href":"/api-reference/email-unsubscribe-groups/retrieve-an-unsubscribe-group"},{"title":"Update an unsubscribe group","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json patch /email_unsubscribe_groups/{id}","href":"/api-reference/email-unsubscribe-groups/update-an-unsubscribe-group"},{"title":"List suppressions in a group","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_unsubscribe_groups/{id}/suppressions","href":"/api-reference/email-unsubscribe-groups/list-suppressions-in-a-group"},{"title":"Add a group suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json post /email_unsubscribe_groups/{id}/suppressions","href":"/api-reference/email-unsubscribe-groups/add-a-group-suppression"},{"title":"Remove a group suppression","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json delete /email_unsubscribe_groups/{id}/suppressions/{email}","href":"/api-reference/email-unsubscribe-groups/remove-a-group-suppression"}]}]},{"group":"Events \u0026 Webhooks","pages":[{"title":"Email Webhooks \u0026 Events","sidebarTitle":"Webhooks \u0026 Events","href":"/docs/messaging/email/webhooks-events/index"},{"title":"Email Event Lifecycle","sidebarTitle":"Event Lifecycle","href":"/docs/messaging/email/event-lifecycle/index"},{"group":"Email Events API","pages":[{"title":"List account email events","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_events","href":"/api-reference/email-events/list-account-email-events"},{"title":"Get email event statistics","deprecated":null,"version":null,"openapi":"/openapi/source/external/email/email.json get /email_events/stats","href":"/api-reference/email-events/get-email-event-statistics"}]}]},{"group":"For AI Agents","pages":[{"title":"Email llms.txt","sidebarTitle":"Email llms txt","href":"/docs/development/llms/messaging-email-llms-txt/index"},{"title":"Email llms-full.txt","sidebarTitle":"Email llms full txt","href":"/docs/development/llms/messaging-email-llms-full-txt/index"}]}]},{"tab":"RCS","icon":"message-dots","groups":[{"group":"Getting Started","pages":[{"title":"Quickstart: Register an RCS Agent","sidebarTitle":"Agent Registration Quickstart","href":"/docs/messaging/rcs/agent-registration/index"},{"title":"RCS Getting Started","sidebarTitle":"RCS Getting Started","href":"/docs/messaging/messages/rcs-getting-started/index"},{"title":"RCS with AI Assistant","sidebarTitle":"RCS with AI Assistant","href":"/docs/messaging/messages/rcs-ai-assistant/index"}]},{"group":"RCS Brands API","pages":[{"title":"Create an RCS brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/brands","href":"/api-reference/rcs-brands/create-an-rcs-brand"},{"title":"List RCS brands","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/brands","href":"/api-reference/rcs-brands/list-rcs-brands"},{"title":"Retrieve an RCS brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/brands/{id}","href":"/api-reference/rcs-brands/retrieve-an-rcs-brand"},{"title":"Update an RCS brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json patch /rcs/brands/{id}","href":"/api-reference/rcs-brands/update-an-rcs-brand"},{"title":"Submit an RCS brand","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/brands/{id}/submit","href":"/api-reference/rcs-brands/submit-an-rcs-brand"}]},{"group":"RCS Agents API","pages":[{"title":"Create an RCS agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/agents","href":"/api-reference/rcs-agents/create-an-rcs-agent"},{"title":"List RCS agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/agents","href":"/api-reference/rcs-agents/list-rcs-agents"},{"title":"Retrieve an RCS agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/agents/{id}","href":"/api-reference/rcs-agents/retrieve-an-rcs-agent"},{"title":"Update an RCS agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json patch /rcs/agents/{id}","href":"/api-reference/rcs-agents/update-an-rcs-agent"},{"title":"Submit RCS agent basics","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/agents/{id}/submit","href":"/api-reference/rcs-agents/submit-rcs-agent-basics"},{"title":"Submit an RCS agent for launch","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/agents/{id}/launch","href":"/api-reference/rcs-agents/submit-an-rcs-agent-for-launch"},{"title":"Add an RCS agent test device","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json post /rcs/agents/{id}/test_devices","href":"/api-reference/rcs-agents/add-an-rcs-agent-test-device"},{"title":"List RCS agent test devices","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/agents/{id}/test_devices","href":"/api-reference/rcs-agents/list-rcs-agent-test-devices"},{"title":"Remove an RCS agent test device","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json delete /rcs/agents/{id}/test_devices/{test_device_id}","href":"/api-reference/rcs-agents/remove-an-rcs-agent-test-device"},{"title":"List RCS agent carrier approvals","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/rcs-registration.json get /rcs/agents/{id}/carrier_approvals","href":"/api-reference/rcs-agents/list-rcs-agent-carrier-approvals"}]},{"group":"Sending Messages","pages":[{"title":"Send RCS Messages","sidebarTitle":"Send RCS Messages","href":"/docs/messaging/messages/send-an-rcs-message/index"},{"title":"RCS Capabilities \u0026 Deeplinks","sidebarTitle":"Capabilities \u0026 Deeplinks","href":"/docs/messaging/messages/rcs-capabilities/index"},{"title":"RCS Deeplinks","sidebarTitle":"RCS Deeplinks","href":"/docs/messaging/messages/rcs-deeplinks/index"}]},{"group":"Receiving Messages","pages":[{"title":"Receiving RCS Webhooks","sidebarTitle":"RCS Webhooks","href":"/docs/messaging/messages/receiving-rcs-webhooks/index"}]},{"group":"RCS API","pages":[{"title":"Send an RCS message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/rcs","href":"/api-reference/rcs/send-an-rcs-message"},{"title":"List all RCS agents","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging/rcs/agents","href":"/api-reference/rcs/list-all-rcs-agents"},{"title":"Retrieve an RCS agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging/rcs/agents/{id}","href":"/api-reference/rcs/retrieve-an-rcs-agent"},{"title":"Modify an RCS agent","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json patch /messaging/rcs/agents/{id}","href":"/api-reference/rcs/modify-an-rcs-agent"},{"title":"Check RCS capabilities (batch)","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messaging/rcs/bulk_capabilities","href":"/api-reference/rcs/check-rcs-capabilities-batch"},{"title":"Check RCS capabilities","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json get /messaging/rcs/capabilities/{agent_id}/{phone_number}","href":"/api-reference/rcs/check-rcs-capabilities"},{"title":"Add RCS test number","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json put /messaging/rcs/test_number_invite/{id}/{phone_number}","href":"/api-reference/rcs/add-rcs-test-number"},{"title":"Generate RCS deeplink","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/messaging/rcs.json get /messages/rcs_deeplinks/{agent_id}","href":"/api-reference/rcs/generate-rcs-deeplink"}]},{"group":"For AI Agents","pages":[{"title":"RCS llms.txt","sidebarTitle":"RCS llms txt","href":"/docs/development/llms/messaging-rcs-llms-txt/index"},{"title":"RCS llms-full.txt","sidebarTitle":"RCS llms full txt","href":"/docs/development/llms/messaging-rcs-llms-full-txt/index"}]}]},{"tab":"WhatsApp","icon":"whatsapp","groups":[{"group":"Getting Started","pages":[{"title":"Quickstart: Send Your First WhatsApp Message","sidebarTitle":"Quickstart","href":"/docs/messaging/whatsapp/quickstart/index"},{"title":"WhatsApp Embedded Signup","sidebarTitle":"Embedded Signup","href":"/docs/messaging/whatsapp/embedded-signup/index"},{"title":"WhatsApp Tech Provider Embedded Signup","sidebarTitle":"Tech Provider Embedded Signup","href":"/docs/messaging/whatsapp/embedded-signup/tech-provider/index"},{"group":"Webhook API","pages":[{"title":"Whatsapp waba added","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook whatsappWabaAdded","href":"/api-reference/callbacks/whatsapp-waba-added"}]}]},{"group":"Sending Messages","pages":[{"title":"Send WhatsApp Messages","sidebarTitle":"Send Messages","href":"/docs/messaging/whatsapp/send-messages/index"},{"title":"Manage WhatsApp Message Templates","sidebarTitle":"Manage Templates","href":"/docs/messaging/whatsapp/manage-templates/index"},{"title":"Start WhatsApp Conversations with an AI Assistant","sidebarTitle":"AI Assistant Conversations","href":"/docs/messaging/whatsapp/ai-assistant-conversations/index"}]},{"group":"Coexistence","pages":[{"title":"WhatsApp Coexistence","sidebarTitle":"Overview and onboarding","href":"/docs/messaging/whatsapp/coexistence/index"},{"title":"WhatsApp Coexistence Webhooks","sidebarTitle":"Webhooks","href":"/docs/messaging/whatsapp/coexistence/webhooks"},{"group":"Webhook API","pages":[{"title":"Whatsapp business app message echo","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook whatsappMessageEcho","href":"/api-reference/callbacks/whatsapp-business-app-message-echo"},{"title":"Whatsapp account update","version":null,"deprecated":null,"openapi":"/openapi/source/external/messaging/messaging.json webhook whatsappAccountUpdate","href":"/api-reference/callbacks/whatsapp-account-update"}]}]},{"group":"Calling","pages":[{"title":"WhatsApp Business Calling","sidebarTitle":"Business Calling","href":"/docs/messaging/whatsapp/business-calling/index"}]},{"group":"Management API","pages":[{"group":"Whatsapp Business Accounts API","pages":[{"title":"List Whatsapp Business Accounts","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/business_accounts","href":"/api-reference/whatsapp-business-accounts/list-whatsapp-business-accounts"},{"title":"Delete a Whatsapp Business Account","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json delete /whatsapp/business_accounts/{id}","href":"/api-reference/whatsapp-business-accounts/delete-a-whatsapp-business-account"},{"title":"Get a single Whatsapp Business Account","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/business_accounts/{id}","href":"/api-reference/whatsapp-business-accounts/get-a-single-whatsapp-business-account"},{"title":"List phone numbers for a WABA","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/business_accounts/{id}/phone_numbers","href":"/api-reference/whatsapp-business-accounts/list-phone-numbers-for-a-waba"},{"title":"Get WABA settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/business_accounts/{id}/settings","href":"/api-reference/whatsapp-business-accounts/get-waba-settings"},{"title":"Update WABA settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/business_accounts/{id}/settings","href":"/api-reference/whatsapp-business-accounts/update-waba-settings"}]},{"group":"Whatsapp Signup API","pages":[{"title":"List Whatsapp signup sessions","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/signup","href":"/api-reference/whatsapp-signup/list-whatsapp-signup-sessions"},{"title":"Get Whatsapp signup session status","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/signup/{id}/status","href":"/api-reference/whatsapp-signup/get-whatsapp-signup-session-status"},{"title":"Create a Whatsapp hosted signup","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/hosted_signups","href":"/api-reference/whatsapp-signup/create-a-whatsapp-hosted-signup"},{"title":"List Whatsapp hosted signups","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/hosted_signups","href":"/api-reference/whatsapp-signup/list-whatsapp-hosted-signups"},{"title":"Get a Whatsapp hosted signup","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/hosted_signups/{id}","href":"/api-reference/whatsapp-signup/get-a-whatsapp-hosted-signup"}]},{"group":"Whatsapp Phone Numbers API","pages":[{"title":"Initialize Whatsapp phone number verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/business_accounts/{id}/phone_numbers","href":"/api-reference/whatsapp-phone-numbers/initialize-whatsapp-phone-number-verification"},{"title":"List Whatsapp phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers","href":"/api-reference/whatsapp-phone-numbers/list-whatsapp-phone-numbers"},{"title":"Retrieve a WhatsApp phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}","href":"/api-reference/whatsapp-phone-numbers/retrieve-a-whatsapp-phone-number"},{"title":"Delete a Whatsapp phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json delete /whatsapp/phone_numbers/{phone_number}","href":"/api-reference/whatsapp-phone-numbers/delete-a-whatsapp-phone-number"},{"title":"Get calling settings for a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}/calling_settings","href":"/api-reference/whatsapp-phone-numbers/get-calling-settings-for-a-phone-number"},{"title":"Enable or disable Whatsapp calling for a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/phone_numbers/{phone_number}/calling_settings","href":"/api-reference/whatsapp-phone-numbers/enable-or-disable-whatsapp-calling-for-a-phone-number"},{"title":"Get Connection ID for a WhatsApp Calling BYON number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{id}/calling_routing","href":"/api-reference/whatsapp-phone-numbers/get-connection-id-for-a-whatsapp-calling-byon-number"},{"title":"Update Connection ID for a WhatsApp Calling BYON number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/phone_numbers/{id}/calling_routing","href":"/api-reference/whatsapp-phone-numbers/update-connection-id-for-a-whatsapp-calling-byon-number"},{"title":"Get phone number business profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}/profile","href":"/api-reference/whatsapp-phone-numbers/get-phone-number-business-profile"},{"title":"Update phone number business profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/phone_numbers/{phone_number}/profile","href":"/api-reference/whatsapp-phone-numbers/update-phone-number-business-profile"},{"title":"Delete Whatsapp profile photo","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json delete /whatsapp/phone_numbers/{phone_number}/profile/photo","href":"/api-reference/whatsapp-phone-numbers/delete-whatsapp-profile-photo"},{"title":"Get Whatsapp profile photo","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}/profile/photo","href":"/api-reference/whatsapp-phone-numbers/get-whatsapp-profile-photo"},{"title":"Upload Whatsapp profile photo","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/phone_numbers/{phone_number}/profile/photo","href":"/api-reference/whatsapp-phone-numbers/upload-whatsapp-profile-photo"},{"title":"Resend verification code","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/phone_numbers/{phone_number}/resend_verification","href":"/api-reference/whatsapp-phone-numbers/resend-verification-code"},{"title":"Submit verification code for a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/phone_numbers/{phone_number}/verify","href":"/api-reference/whatsapp-phone-numbers/submit-verification-code-for-a-phone-number"},{"title":"Get conversation window status for a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}/conversation_window","href":"/api-reference/whatsapp-phone-numbers/get-conversation-window-status-for-a-phone-number"},{"title":"Get phone number conversational components","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/phone_numbers/{phone_number}/conversational_components","href":"/api-reference/whatsapp-phone-numbers/get-phone-number-conversational-components"},{"title":"Update phone number conversational components","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/phone_numbers/{phone_number}/conversational_components","href":"/api-reference/whatsapp-phone-numbers/update-phone-number-conversational-components"}]},{"group":"Whatsapp Message Templates API","pages":[{"title":"List Whatsapp message templates","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/message_templates","href":"/api-reference/whatsapp-message-templates/list-whatsapp-message-templates"},{"title":"Create a Whatsapp message template","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json post /whatsapp/message_templates","href":"/api-reference/whatsapp-message-templates/create-a-whatsapp-message-template"},{"title":"Delete a Whatsapp message template","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json delete /whatsapp/message_templates/{id}","href":"/api-reference/whatsapp-message-templates/delete-a-whatsapp-message-template"},{"title":"Get a Whatsapp message template by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json get /whatsapp/message_templates/{id}","href":"/api-reference/whatsapp-message-templates/get-a-whatsapp-message-template-by-id"},{"title":"Update a Whatsapp message template","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/whatsapp/management.json patch /whatsapp/message_templates/{id}","href":"/api-reference/whatsapp-message-templates/update-a-whatsapp-message-template"}]}]},{"group":"Sending API","pages":[{"title":"Send a Whatsapp message","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json post /messages/whatsapp","href":"/api-reference/whatsapp-messaging/send-a-whatsapp-message"}]},{"group":"For AI Agents","pages":[{"title":"WhatsApp llms.txt","sidebarTitle":"WhatsApp llms txt","href":"/docs/development/llms/messaging-whatsapp-llms-txt/index"},{"title":"WhatsApp llms-full.txt","sidebarTitle":"WhatsApp llms full txt","href":"/docs/development/llms/messaging-whatsapp-llms-full-txt/index"}]}]}]},{"product":"Numbers","icon":"hashtag","tabs":[{"tab":"Global Phone Numbers","icon":"globe","groups":[{"group":"Coverage","pages":[{"title":"Fundamentals - Searching + Ordering Phone Numbers","sidebarTitle":"Getting started with Telnyx phone number APIs","href":"/docs/numbers/phone-numbers/getting-started"},{"group":"Coverage API","pages":[{"group":"Country Coverage API","pages":[{"title":"Get country coverage","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /country_coverage","href":"/api-reference/country-coverage/get-country-coverage"},{"title":"Get coverage for a specific country","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /country_coverage/countries/{country_code}","href":"/api-reference/country-coverage/get-coverage-for-a-specific-country"}]},{"group":"Inventory Level API","pages":[{"title":"Create an inventory coverage request","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /inventory_coverage","href":"/api-reference/inventory-level/create-an-inventory-coverage-request"}]}]}]},{"group":"Searching","pages":[{"title":"Number Search","sidebarTitle":"Number search","href":"/docs/numbers/phone-numbers/number-search/index"},{"group":"Searching API","pages":[{"group":"Phone Number Search API","pages":[{"title":"List available phone number blocks","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /available_phone_number_blocks","href":"/api-reference/phone-number-search/list-available-phone-number-blocks"},{"title":"List available phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /available_phone_numbers","href":"/api-reference/phone-number-search/list-available-phone-numbers"}]},{"group":"numbers features API","pages":[{"title":"Retrieve the features for a list of numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /numbers_features","href":"/api-reference/numbers-features/retrieve-the-features-for-a-list-of-numbers"}]}]}]},{"group":"Ordering","pages":[{"title":"Number Reservations","sidebarTitle":"Number reservations","href":"/docs/numbers/phone-numbers/number-reservations/index"},{"title":"Number Orders","sidebarTitle":"Number orders","href":"/docs/numbers/phone-numbers/number-orders/index"},{"title":"Advanced Orders","sidebarTitle":"Advanced Orders","href":"/docs/numbers/phone-numbers/advanced-orders/index"},{"title":"Bulk number orders","sidebarTitle":"Bulk orders","href":"/docs/numbers/phone-numbers/bulk-ordering/index"},{"group":"Ordering API","pages":[{"group":"Phone Number Reservations API","pages":[{"title":"List number reservations","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_reservations","href":"/api-reference/phone-number-reservations/list-number-reservations"},{"title":"Create a number reservation","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /number_reservations","href":"/api-reference/phone-number-reservations/create-a-number-reservation"},{"title":"Retrieve a number reservation","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_reservations/{number_reservation_id}","href":"/api-reference/phone-number-reservations/retrieve-a-number-reservation"},{"title":"Extend a number reservation","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /number_reservations/{number_reservation_id}/actions/extend","href":"/api-reference/phone-number-reservations/extend-a-number-reservation"}]},{"group":"Phone Number Orders API","pages":[{"title":"List number orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_orders","href":"/api-reference/phone-number-orders/list-number-orders"},{"title":"Create a number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /number_orders","href":"/api-reference/phone-number-orders/create-a-number-order"},{"title":"Retrieve a number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_orders/{number_order_id}","href":"/api-reference/phone-number-orders/retrieve-a-number-order"},{"title":"Update a number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /number_orders/{number_order_id}","href":"/api-reference/phone-number-orders/update-a-number-order"},{"title":"Retrieve a list of phone numbers associated to orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_order_phone_numbers","href":"/api-reference/phone-number-orders/retrieve-a-list-of-phone-numbers-associated-to-orders"},{"title":"Retrieve a single phone number within a number order.","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_order_phone_numbers/{number_order_phone_number_id}","href":"/api-reference/phone-number-orders/retrieve-a-single-phone-number-within-a-number-order"},{"title":"Update requirements for a single phone number within a number order.","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /number_order_phone_numbers/{number_order_phone_number_id}","href":"/api-reference/phone-number-orders/update-requirements-for-a-single-phone-number-within-a-number-order"},{"title":"List sub number orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /sub_number_orders","href":"/api-reference/phone-number-orders/list-sub-number-orders"},{"title":"Retrieve a sub number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /sub_number_orders/{sub_number_order_id}","href":"/api-reference/phone-number-orders/retrieve-a-sub-number-order"},{"title":"Update a sub number order's requirements","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /sub_number_orders/{sub_number_order_id}","href":"/api-reference/phone-number-orders/update-a-sub-number-orders-requirements"},{"title":"Cancel a sub number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /sub_number_orders/{sub_number_order_id}/cancel","href":"/api-reference/phone-number-orders/cancel-a-sub-number-order"},{"title":"Create a sub number orders report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/numbers-identity/ordering.json post /sub_number_orders/report","href":"/api-reference/phone-number-orders/create-a-sub-number-orders-report"},{"title":"Retrieve a sub number orders report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/numbers-identity/ordering.json get /sub_number_orders/report/{report_id}","href":"/api-reference/phone-number-orders/retrieve-a-sub-number-orders-report"},{"title":"Download a sub number orders report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/numbers-identity/ordering.json get /sub_number_orders/report/{report_id}/download","href":"/api-reference/phone-number-orders/download-a-sub-number-orders-report"},{"title":"Retrieve all comments","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /comments","href":"/api-reference/phone-number-orders/retrieve-all-comments"},{"title":"Create a comment","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /comments","href":"/api-reference/phone-number-orders/create-a-comment"},{"title":"Retrieve a comment","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /comments/{id}","href":"/api-reference/phone-number-orders/retrieve-a-comment"},{"title":"Mark a comment as read","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /comments/{id}/read","href":"/api-reference/phone-number-orders/mark-a-comment-as-read"}]},{"group":"Phone Number Block Orders API","pages":[{"title":"List number block orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_block_orders","href":"/api-reference/phone-number-block-orders/list-number-block-orders"},{"title":"Create a number block order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /number_block_orders","href":"/api-reference/phone-number-block-orders/create-a-number-block-order"},{"title":"Retrieve a number block order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /number_block_orders/{number_block_order_id}","href":"/api-reference/phone-number-block-orders/retrieve-a-number-block-order"}]},{"group":"Requirement Groups API","pages":[{"title":"Update requirement group for a phone number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /number_order_phone_numbers/{id}/requirement_group","href":"/api-reference/requirement-groups/update-requirement-group-for-a-phone-number-order"},{"title":"Update requirement group for a sub number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /sub_number_orders/{id}/requirement_group","href":"/api-reference/requirement-groups/update-requirement-group-for-a-sub-number-order"},{"title":"Get action requirement details for a sub number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id}","href":"/api-reference/requirement-groups/get-action-requirement-details-for-a-sub-number-order"},{"title":"Fulfill an action requirement for a sub number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /external_requirements/{regulatory_requirement_id}/sub_number_orders/{sub_number_order_id}","href":"/api-reference/requirement-groups/fulfill-an-action-requirement-for-a-sub-number-order"}]},{"group":"Advanced Number Orders API","pages":[{"title":"List Advanced Orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /advanced_orders","href":"/api-reference/advanced-number-orders/list-advanced-orders"},{"title":"Create Advanced Order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /advanced_orders","href":"/api-reference/advanced-number-orders/create-advanced-order"},{"title":"Update Advanced Order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /advanced_orders/{advanced-order-id}/requirement_group","href":"/api-reference/advanced-number-orders/update-advanced-order"},{"title":"Get Advanced Order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /advanced_orders/{order_id}","href":"/api-reference/advanced-number-orders/get-advanced-order"}]},{"group":"Inexplicit Number Orders API","pages":[{"title":"List inexplicit number orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /inexplicit_number_orders","href":"/api-reference/inexplicit-number-orders/list-inexplicit-number-orders"},{"title":"Create an inexplicit number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /inexplicit_number_orders","href":"/api-reference/inexplicit-number-orders/create-an-inexplicit-number-order"},{"title":"Retrieve an inexplicit number order","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /inexplicit_number_orders/{id}","href":"/api-reference/inexplicit-number-orders/retrieve-an-inexplicit-number-order"}]},{"group":"Callbacks API","pages":[{"title":"Number order status update","version":null,"deprecated":null,"openapi":"/openapi/source/external/numbers/numbers.json webhook numberOrderStatusUpdate","href":"/api-reference/callbacks/number-order-status-update"}]}]}]},{"group":"Management \u0026 Configurations","pages":[{"group":"Management \u0026 Configurations API","pages":[{"group":"Phone Number Blocks Background Jobs API","pages":[{"title":"Lists the phone number blocks jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_number_blocks/jobs","href":"/api-reference/phone-number-blocks-background-jobs/lists-the-phone-number-blocks-jobs"},{"title":"Retrieves a phone number blocks job","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_number_blocks/jobs/{id}","href":"/api-reference/phone-number-blocks-background-jobs/retrieves-a-phone-number-blocks-job"},{"title":"Deletes all numbers associated with a phone number block","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_number_blocks/jobs/delete_phone_number_block","href":"/api-reference/phone-number-blocks-background-jobs/deletes-all-numbers-associated-with-a-phone-number-block"}]},{"group":"Phone Number Configurations API","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers","href":"/api-reference/phone-number-configurations/list-phone-numbers"},{"title":"Delete a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json delete /phone_numbers/{id}","href":"/api-reference/phone-number-configurations/delete-a-phone-number"},{"title":"Retrieve a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/{id}","href":"/api-reference/phone-number-configurations/retrieve-a-phone-number"},{"title":"Update a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /phone_numbers/{id}","href":"/api-reference/phone-number-configurations/update-a-phone-number"},{"title":"Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /phone_numbers/{id}/actions/bundle_status_change","href":"/api-reference/phone-number-configurations/change-the-bundle-status-for-a-phone-number-set-to-being-in-a-bundle-or-remove-from-a-bundle"},{"title":"Enable emergency for a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/{id}/actions/enable_emergency","href":"/api-reference/phone-number-configurations/enable-emergency-for-a-phone-number"},{"title":"Retrieve a phone number with voice settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/{id}/voice","href":"/api-reference/phone-number-configurations/retrieve-a-phone-number-with-voice-settings"},{"title":"Update a phone number with voice settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /phone_numbers/{id}/voice","href":"/api-reference/phone-number-configurations/update-a-phone-number-with-voice-settings"},{"title":"Verify ownership of phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/actions/verify_ownership","href":"/api-reference/phone-number-configurations/verify-ownership-of-phone-numbers"},{"title":"Slim List phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/slim","href":"/api-reference/phone-number-configurations/slim-list-phone-numbers"},{"title":"List phone numbers with voice settings","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/voice","href":"/api-reference/phone-number-configurations/list-phone-numbers-with-voice-settings"}]},{"group":"CSV Downloads API","pages":[{"title":"List CSV downloads","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/csv_downloads","href":"/api-reference/csv-downloads/list-csv-downloads"},{"title":"Create a CSV download","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/csv_downloads","href":"/api-reference/csv-downloads/create-a-csv-download"},{"title":"Retrieve a CSV download","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/csv_downloads/{id}","href":"/api-reference/csv-downloads/retrieve-a-csv-download"}]},{"group":"Bulk Phone Number Operations API","pages":[{"title":"Lists the phone numbers jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/jobs","href":"/api-reference/bulk-phone-number-operations/lists-the-phone-numbers-jobs"},{"title":"Retrieve a phone numbers job","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /phone_numbers/jobs/{id}","href":"/api-reference/bulk-phone-number-operations/retrieve-a-phone-numbers-job"},{"title":"Delete a batch of numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/jobs/delete_phone_numbers","href":"/api-reference/bulk-phone-number-operations/delete-a-batch-of-numbers"},{"title":"Update the emergency settings from a batch of numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/jobs/update_emergency_settings","href":"/api-reference/bulk-phone-number-operations/update-the-emergency-settings-from-a-batch-of-numbers"},{"title":"Update a batch of numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /phone_numbers/jobs/update_phone_numbers","href":"/api-reference/bulk-phone-number-operations/update-a-batch-of-numbers"}]},{"group":"Regulatory Requirements API","pages":[{"title":"Retrieve regulatory requirements for a list of phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/numbers-identity/management-config.json get /phone_numbers/regulatory_requirements","href":"/api-reference/regulatory-requirements/retrieve-regulatory-requirements-for-a-list-of-phone-numbers"}]}]}]},{"group":"For AI Agents","pages":[{"title":"Global Phone Numbers llms.txt","sidebarTitle":"Global Phone Numbers llms txt","href":"/docs/development/llms/numbers-global-phone-numbers-llms-txt/index"},{"title":"Global Phone Numbers llms-full.txt","sidebarTitle":"Global Phone Numbers llms full txt","href":"/docs/development/llms/numbers-global-phone-numbers-llms-full-txt/index"}]}]},{"tab":"Porting","icon":"right-left","groups":[{"group":"Port In","pages":[{"group":"Getting Started","pages":[{"title":"Getting started with port-in orders","sidebarTitle":"Port in orders","href":"/docs/numbers/porting/getting-started/index"},{"title":"Port-in requirements","sidebarTitle":"Port-in requirements","href":"/docs/numbers/porting/port-in-requirements/index"},{"title":"Allowed FOC dates","sidebarTitle":"Allowed FOC dates","href":"/docs/numbers/porting/allowed-foc-dates/index"},{"title":"Cancel port order","sidebarTitle":"Cancel port order","href":"/docs/numbers/porting/cancel-port-order/index"},{"title":"On-demand activations","sidebarTitle":"On-demand activations","href":"/docs/numbers/porting/on-demand-activations/index"},{"title":"Port-in order notifications","sidebarTitle":"Port-in order notifications","href":"/docs/numbers/porting/port-in-notifications/index"},{"title":"Port-in events","sidebarTitle":"Port-in events","href":"/docs/numbers/porting/port-in-events/index"}]},{"group":"Additional Topics","pages":[{"title":"Porting additional steps","sidebarTitle":"Porting additional steps","href":"/docs/numbers/porting/porting-additional-steps/index"},{"title":"Port in extended numbers","sidebarTitle":"Extensions","href":"/docs/numbers/porting/extensions/index"},{"title":"Messaging + Porting","sidebarTitle":"Messaging + porting","href":"/docs/numbers/porting/messaging-porting/index"},{"title":"Bundles with porting orders","sidebarTitle":"Bundles with porting","href":"/docs/numbers/porting/bundles-porting/index"},{"title":"Port-in blocks","sidebarTitle":"Port-in blocks","href":"/docs/numbers/porting/port-in-blocks/index"}]},{"group":"Portability Check API","pages":[{"title":"Run a portability check","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/portability-check.json post /portability_checks","href":"/api-reference/phone-number-porting/run-a-portability-check"}]},{"group":"Customer Service Record API","pages":[{"title":"Verify CSR phone number coverage","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/customer_service_record.json post /customer_service_records/phone_number_coverages","href":"/api-reference/customer-service-record/verify-csr-phone-number-coverage"},{"title":"Create a customer service record","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/customer_service_record.json post /customer_service_records","href":"/api-reference/customer-service-record/create-a-customer-service-record"},{"title":"List customer service records","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/customer_service_record.json get /customer_service_records","href":"/api-reference/customer-service-record/list-customer-service-records"},{"title":"Get a customer service record","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/customer_service_record.json get /customer_service_records/{customer_service_record_id}","href":"/api-reference/customer-service-record/get-a-customer-service-record"}]},{"group":"Porting Orders API","pages":[{"group":"Porting Orders","pages":[{"title":"List all porting orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders","href":"/api-reference/porting-orders/list-all-porting-orders"},{"title":"Create a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders","href":"/api-reference/porting-orders/create-a-porting-order"},{"title":"Delete a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting_orders/{id}","href":"/api-reference/porting-orders/delete-a-porting-order"},{"title":"Retrieve a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}","href":"/api-reference/porting-orders/retrieve-a-porting-order"},{"title":"Edit a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json patch /porting_orders/{id}","href":"/api-reference/porting-orders/edit-a-porting-order"},{"title":"Submit a porting order.","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/actions/confirm","href":"/api-reference/porting-orders/submit-a-porting-order"},{"title":"Cancel a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/actions/cancel","href":"/api-reference/porting-orders/cancel-a-porting-order"},{"title":"Activate every number in a porting order asynchronously.","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/actions/activate","href":"/api-reference/porting-orders/activate-every-number-in-a-porting-order-asynchronously"},{"title":"Share a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/actions/share","href":"/api-reference/porting-orders/share-a-porting-order"},{"title":"List allowed FOC dates","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/allowed_foc_windows","href":"/api-reference/porting-orders/list-allowed-foc-dates"},{"title":"List all comments of a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/comments","href":"/api-reference/porting-orders/list-all-comments-of-a-porting-order"},{"title":"Create a comment for a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/comments","href":"/api-reference/porting-orders/create-a-comment-for-a-porting-order"}]},{"group":"Porting Phone Numbers","pages":[{"title":"List all porting phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_phone_numbers","href":"/api-reference/porting-orders/list-all-porting-phone-numbers"},{"title":"List all associated phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{porting_order_id}/associated_phone_numbers","href":"/api-reference/porting-orders/list-all-associated-phone-numbers"},{"title":"Create an associated phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{porting_order_id}/associated_phone_numbers","href":"/api-reference/porting-orders/create-an-associated-phone-number"},{"title":"Delete an associated phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting_orders/{porting_order_id}/associated_phone_numbers/{id}","href":"/api-reference/porting-orders/delete-an-associated-phone-number"},{"title":"List all phone number blocks","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{porting_order_id}/phone_number_blocks","href":"/api-reference/porting-orders/list-all-phone-number-blocks"},{"title":"Create a phone number block","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{porting_order_id}/phone_number_blocks","href":"/api-reference/porting-orders/create-a-phone-number-block"},{"title":"Delete a phone number block","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting_orders/{porting_order_id}/phone_number_blocks/{id}","href":"/api-reference/porting-orders/delete-a-phone-number-block"},{"title":"List all phone number extensions","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{porting_order_id}/phone_number_extensions","href":"/api-reference/porting-orders/list-all-phone-number-extensions"},{"title":"Create a phone number extension","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{porting_order_id}/phone_number_extensions","href":"/api-reference/porting-orders/create-a-phone-number-extension"},{"title":"Delete a phone number extension","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting_orders/{porting_order_id}/phone_number_extensions/{id}","href":"/api-reference/porting-orders/delete-a-phone-number-extension"},{"title":"List all phone number configurations","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/phone_number_configurations","href":"/api-reference/porting-orders/list-all-phone-number-configurations"},{"title":"Create a list of phone number configurations","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/phone_number_configurations","href":"/api-reference/porting-orders/create-a-list-of-phone-number-configurations"}]},{"group":"Porting Documents \u0026 LOA","pages":[{"title":"List LOA configurations","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/loa_configurations","href":"/api-reference/porting-orders/list-loa-configurations"},{"title":"Create a LOA configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting/loa_configurations","href":"/api-reference/porting-orders/create-a-loa-configuration"},{"title":"Delete a LOA configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting/loa_configurations/{id}","href":"/api-reference/porting-orders/delete-a-loa-configuration"},{"title":"Retrieve a LOA configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/loa_configurations/{id}","href":"/api-reference/porting-orders/retrieve-a-loa-configuration"},{"title":"Update a LOA configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json patch /porting/loa_configurations/{id}","href":"/api-reference/porting-orders/update-a-loa-configuration"},{"title":"Preview a LOA configuration","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/loa_configurations/{id}/preview","href":"/api-reference/porting-orders/preview-a-loa-configuration"},{"title":"Preview the LOA configuration parameters","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting/loa_configurations/preview","href":"/api-reference/porting-orders/preview-the-loa-configuration-parameters"},{"title":"Download a porting order loa template","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/loa_template","href":"/api-reference/porting-orders/download-a-porting-order-loa-template"},{"title":"List additional documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/additional_documents","href":"/api-reference/porting-orders/list-additional-documents"},{"title":"Create a list of additional documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/additional_documents","href":"/api-reference/porting-orders/create-a-list-of-additional-documents"},{"title":"Delete an additional document","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json delete /porting_orders/{id}/additional_documents/{additional_document_id}","href":"/api-reference/porting-orders/delete-an-additional-document"}]},{"group":"Porting Requirements","pages":[{"title":"List porting order requirements","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/requirements","href":"/api-reference/porting-orders/list-porting-order-requirements"},{"title":"List verification codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/verification_codes","href":"/api-reference/porting-orders/list-verification-codes"},{"title":"Send the verification codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/verification_codes/send","href":"/api-reference/porting-orders/send-the-verification-codes"},{"title":"Verify the verification code for a list of phone numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{id}/verification_codes/verify","href":"/api-reference/porting-orders/verify-the-verification-code-for-a-list-of-phone-numbers"},{"title":"List action requirements for a porting order","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{porting_order_id}/action_requirements","href":"/api-reference/porting-orders/list-action-requirements-for-a-porting-order"},{"title":"Initiate an action requirement","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting_orders/{porting_order_id}/action_requirements/{id}/initiate","href":"/api-reference/porting-orders/initiate-an-action-requirement"},{"title":"List available carriers in the UK","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/uk_carriers","href":"/api-reference/porting-orders/list-available-carriers-in-the-uk"}]},{"group":"Porting Events \u0026 Reports","pages":[{"title":"List all porting events","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/events","href":"/api-reference/porting-orders/list-all-porting-events"},{"title":"Show a porting event","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/events/{id}","href":"/api-reference/porting-orders/show-a-porting-event"},{"title":"Republish a porting event","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting/events/{id}/republish","href":"/api-reference/porting-orders/republish-a-porting-event"},{"title":"List porting related reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/reports","href":"/api-reference/porting-orders/list-porting-related-reports"},{"title":"Create a porting related report","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json post /porting/reports","href":"/api-reference/porting-orders/create-a-porting-related-report"},{"title":"Retrieve a report","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting/reports/{id}","href":"/api-reference/porting-orders/retrieve-a-report"}]},{"group":"Porting Activation \u0026 Exceptions","pages":[{"title":"List all porting activation jobs","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/activation_jobs","href":"/api-reference/porting-orders/list-all-porting-activation-jobs"},{"title":"Retrieve a porting activation job","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/activation_jobs/{activationJobId}","href":"/api-reference/porting-orders/retrieve-a-porting-activation-job"},{"title":"Update a porting activation job","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json patch /porting_orders/{id}/activation_jobs/{activationJobId}","href":"/api-reference/porting-orders/update-a-porting-activation-job"},{"title":"List all exception types","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/exception_types","href":"/api-reference/porting-orders/list-all-exception-types"},{"title":"Retrieve the associated V1 sub_request_id and port_request_id","deprecated":null,"version":null,"openapi":"/openapi/source/external/porting/porting-order.json get /porting_orders/{id}/sub_request","href":"/api-reference/porting-orders/retrieve-the-associated-v1-sub_request_id-and-port_request_id"}]}]}]},{"group":"Port Out","pages":[{"title":"Port-out orders","sidebarTitle":"Port-out orders","href":"/docs/numbers/porting/port-out-quickstart/index"},{"title":"Port-Out Order Notifications","sidebarTitle":"Port out order notifications","href":"/docs/numbers/porting/port-out-notifications/index"},{"title":"Port-out events","sidebarTitle":"Port-out events","href":"/docs/numbers/porting/port-out-events/index"},{"group":"Portout API","pages":[{"title":"List portout requests","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts","href":"/api-reference/number-portout/list-portout-requests"},{"title":"Get a portout request","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/{id}","href":"/api-reference/number-portout/get-a-portout-request"},{"title":"List all comments for a portout request","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/{id}/comments","href":"/api-reference/number-portout/list-all-comments-for-a-portout-request"},{"title":"Create a comment on a portout request","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json post /portouts/{id}/comments","href":"/api-reference/number-portout/create-a-comment-on-a-portout-request"},{"title":"List supporting documents on a portout request","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/{id}/supporting_documents","href":"/api-reference/number-portout/list-supporting-documents-on-a-portout-request"},{"title":"Create a list of supporting documents on a portout request","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json post /portouts/{id}/supporting_documents","href":"/api-reference/number-portout/create-a-list-of-supporting-documents-on-a-portout-request"},{"title":"Update Status","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json patch /portouts/{id}/{status}","href":"/api-reference/number-portout/update-status"},{"title":"List all port-out events","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/events","href":"/api-reference/number-portout/list-all-port-out-events"},{"title":"Show a port-out event","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/events/{id}","href":"/api-reference/number-portout/show-a-port-out-event"},{"title":"Republish a port-out event","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json post /portouts/events/{id}/republish","href":"/api-reference/number-portout/republish-a-port-out-event"},{"title":"List eligible port-out rejection codes for a specific order","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/rejections/{portout_id}","href":"/api-reference/number-portout/list-eligible-port-out-rejection-codes-for-a-specific-order"},{"title":"List port-out related reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/reports","href":"/api-reference/number-portout/list-port-out-related-reports"},{"title":"Create a port-out related report","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json post /portouts/reports","href":"/api-reference/number-portout/create-a-port-out-related-report"},{"title":"Retrieve a report","deprecated":null,"version":null,"openapi":"/openapi/source/external/portout/portout.json get /portouts/reports/{id}","href":"/api-reference/number-portout/retrieve-a-report"}]}]},{"group":"For AI Agents","pages":[{"title":"Porting llms.txt","sidebarTitle":"Porting llms txt","href":"/docs/development/llms/numbers-porting-llms-txt/index"},{"title":"Porting llms-full.txt","sidebarTitle":"Porting llms full txt","href":"/docs/development/llms/numbers-porting-llms-full-txt/index"}]}]},{"tab":"Regulatory \u0026 Documents","icon":"file-certificate","groups":[{"group":"Regulatory","pages":[{"title":"Regulatory Requirements","href":"/docs/numbers/phone-numbers/regulatory-requirements/index"},{"title":"Requirement groups","sidebarTitle":"Requirement groups","href":"/docs/numbers/phone-numbers/requirement-groups/index"},{"title":"Action ordering requirements","sidebarTitle":"Action requirements","href":"/docs/numbers/phone-numbers/action-ordering-requirement/index"},{"group":"Regulatory API","pages":[{"group":"Requirements API","pages":[{"title":"List all requirements","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /requirements","href":"/api-reference/requirements/list-all-requirements"},{"title":"Retrieve a document requirement","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /requirements/{id}","href":"/api-reference/requirements/retrieve-a-document-requirement"}]},{"group":"Requirement Types API","pages":[{"title":"List all requirement types","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /requirement_types","href":"/api-reference/requirement-types/list-all-requirement-types"},{"title":"Retrieve a requirement types","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /requirement_types/{id}","href":"/api-reference/requirement-types/retrieve-a-requirement-types"}]},{"group":"Regulatory Requirements API","pages":[{"title":"Retrieve regulatory requirements","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /regulatory_requirements","href":"/api-reference/regulatory-requirements/retrieve-regulatory-requirements"}]},{"group":"Requirement Groups API","pages":[{"title":"List requirement groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /requirement_groups","href":"/api-reference/requirement-groups/list-requirement-groups"},{"title":"Create a new requirement group","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /requirement_groups","href":"/api-reference/requirement-groups/create-a-new-requirement-group"},{"title":"Delete a requirement group by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json delete /requirement_groups/{id}","href":"/api-reference/requirement-groups/delete-a-requirement-group-by-id"},{"title":"Get a single requirement group by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json get /requirement_groups/{id}","href":"/api-reference/requirement-groups/get-a-single-requirement-group-by-id"},{"title":"Update requirement values in requirement group","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json patch /requirement_groups/{id}","href":"/api-reference/requirement-groups/update-requirement-values-in-requirement-group"},{"title":"Submit a Requirement Group for Approval","deprecated":null,"version":null,"openapi":"/openapi/source/external/numbers/numbers.json post /requirement_groups/{id}/submit_for_approval","href":"/api-reference/requirement-groups/submit-a-requirement-group-for-approval"}]}]},{"group":"Verified Numbers","pages":[{"title":"List all Verified Numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/verified-numbers/verified-numbers.json get /verified_numbers","href":"/api-reference/verified-numbers/list-all-verified-numbers"},{"title":"Request phone number verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verified-numbers/verified-numbers.json post /verified_numbers","href":"/api-reference/verified-numbers/request-phone-number-verification"},{"title":"Delete a verified number","deprecated":null,"version":null,"openapi":"/openapi/source/external/verified-numbers/verified-numbers.json delete /verified_numbers/{phone_number}","href":"/api-reference/verified-numbers/delete-a-verified-number"},{"title":"Retrieve a verified number","deprecated":null,"version":null,"openapi":"/openapi/source/external/verified-numbers/verified-numbers.json get /verified_numbers/{phone_number}","href":"/api-reference/verified-numbers/retrieve-a-verified-number"},{"title":"Submit verification code","deprecated":null,"version":null,"openapi":"/openapi/source/external/verified-numbers/verified-numbers.json post /verified_numbers/{phone_number}/actions/verify","href":"/api-reference/verified-numbers/submit-verification-code"}]}]},{"group":"Documents","pages":[{"title":"Documents","sidebarTitle":"Documents","href":"/docs/numbers/phone-numbers/documents/index"},{"group":"Documents API","pages":[{"title":"List all document links","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /document_links","href":"/api-reference/documents/list-all-document-links"},{"title":"List all documents","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /documents","href":"/api-reference/documents/list-all-documents"},{"title":"Upload a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json post /documents","href":"/api-reference/documents/upload-a-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json delete /documents/{id}","href":"/api-reference/documents/delete-a-document"},{"title":"Retrieve a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /documents/{id}","href":"/api-reference/documents/retrieve-a-document"},{"title":"Update a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json patch /documents/{id}","href":"/api-reference/documents/update-a-document"},{"title":"Download a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /documents/{id}/download","href":"/api-reference/documents/download-a-document"},{"title":"Generate a temporary download link for a document","deprecated":null,"version":null,"openapi":"/openapi/source/external/documents/documents.json get /documents/{id}/download_link","href":"/api-reference/documents/generate-a-temporary-download-link-for-a-document"}]}]},{"group":"All Others","pages":[{"group":"Bundles API","pages":[{"group":"Bundles API","pages":[{"title":"Retrieve Bundles","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/billing_bundles","href":"/api-reference/bundles/retrieve-bundles"},{"title":"Get Bundle By Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/billing_bundles/{bundle_id}","href":"/api-reference/bundles/get-bundle-by-id"}]},{"group":"User Bundles API","pages":[{"title":"Get User Bundles","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/user_bundles","href":"/api-reference/user-bundles/get-user-bundles"},{"title":"Create User Bundles","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json post /bundle_pricing/user_bundles/bulk","href":"/api-reference/user-bundles/create-user-bundles"},{"title":"Get Unused User Bundles","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/user_bundles/unused","href":"/api-reference/user-bundles/get-unused-user-bundles"},{"title":"Deactivate User Bundle","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json delete /bundle_pricing/user_bundles/{user_bundle_id}","href":"/api-reference/user-bundles/deactivate-user-bundle"},{"title":"Get User Bundle by Id","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/user_bundles/{user_bundle_id}","href":"/api-reference/user-bundles/get-user-bundle-by-id"},{"title":"Get User Bundle Resources","deprecated":null,"version":null,"openapi":"/openapi/source/external/bundle-pricing/bundle-pricing.json get /bundle_pricing/user_bundles/{user_bundle_id}/resources","href":"/api-reference/user-bundles/get-user-bundle-resources"}]}]},{"group":"Voicemail","pages":[{"title":"Get voicemail","deprecated":null,"version":null,"openapi":"/openapi/source/external/voicemail/voicemail.json get /phone_numbers/{phone_number_id}/voicemail","href":"/api-reference/voicemail/get-voicemail"},{"title":"Update voicemail","deprecated":null,"version":null,"openapi":"/openapi/source/external/voicemail/voicemail.json patch /phone_numbers/{phone_number_id}/voicemail","href":"/api-reference/voicemail/update-voicemail"},{"title":"Create voicemail","deprecated":null,"version":null,"openapi":"/openapi/source/external/voicemail/voicemail.json post /phone_numbers/{phone_number_id}/voicemail","href":"/api-reference/voicemail/create-voicemail"}]},{"group":"Voice Channels","pages":[{"title":"List your voice channels for non-US zones","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json get /channel_zones","href":"/api-reference/voice-channels/list-your-voice-channels-for-non-us-zones"},{"title":"Update voice channels for non-US Zones","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json put /channel_zones/{channel_zone_id}","href":"/api-reference/voice-channels/update-voice-channels-for-non-us-zones"},{"title":"List your voice channels for US Zone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json get /inbound_channels","href":"/api-reference/voice-channels/list-your-voice-channels-for-us-zone"},{"title":"Update voice channels for US Zone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json patch /inbound_channels","href":"/api-reference/voice-channels/update-voice-channels-for-us-zone"},{"title":"List All Numbers using Channel Billing","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json get /list","href":"/api-reference/voice-channels/list-all-numbers-using-channel-billing"},{"title":"List Numbers using Channel Billing for a specific Zone","deprecated":null,"version":null,"openapi":"/openapi/source/external/voice-channels/voice-channels.json get /list/{channel_zone_id}","href":"/api-reference/voice-channels/list-numbers-using-channel-billing-for-a-specific-zone"}]},{"group":"Emergency","pages":[{"group":"Dynamic Emergency Addresses API","pages":[{"title":"List dynamic emergency addresses","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json get /dynamic_emergency_addresses","href":"/api-reference/dynamic-emergency-addresses/list-dynamic-emergency-addresses"},{"title":"Create a dynamic emergency address.","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json post /dynamic_emergency_addresses","href":"/api-reference/dynamic-emergency-addresses/create-a-dynamic-emergency-address"},{"title":"Delete a dynamic emergency address","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json delete /dynamic_emergency_addresses/{id}","href":"/api-reference/dynamic-emergency-addresses/delete-a-dynamic-emergency-address"},{"title":"Get a dynamic emergency address","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json get /dynamic_emergency_addresses/{id}","href":"/api-reference/dynamic-emergency-addresses/get-a-dynamic-emergency-address"}]},{"group":"Dynamic Emergency Endpoints API","pages":[{"title":"List dynamic emergency endpoints","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json get /dynamic_emergency_endpoints","href":"/api-reference/dynamic-emergency-endpoints/list-dynamic-emergency-endpoints"},{"title":"Create a dynamic emergency endpoint.","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json post /dynamic_emergency_endpoints","href":"/api-reference/dynamic-emergency-endpoints/create-a-dynamic-emergency-endpoint"},{"title":"Delete a dynamic emergency endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json delete /dynamic_emergency_endpoints/{id}","href":"/api-reference/dynamic-emergency-endpoints/delete-a-dynamic-emergency-endpoint"},{"title":"Get a dynamic emergency endpoint","deprecated":null,"version":null,"openapi":"/openapi/source/external/emergency/emergency.json get /dynamic_emergency_endpoints/{id}","href":"/api-reference/dynamic-emergency-endpoints/get-a-dynamic-emergency-endpoint"}]}]}]},{"group":"For AI Agents","pages":[{"title":"Regulatory \u0026 Documents llms.txt","sidebarTitle":"Regulatory \u0026 Documents llms txt","href":"/docs/development/llms/numbers-regulatory-documents-llms-txt/index"},{"title":"Regulatory \u0026 Documents llms-full.txt","sidebarTitle":"Regulatory \u0026 Documents llms full txt","href":"/docs/development/llms/numbers-regulatory-documents-llms-full-txt/index"}]}]},{"tab":"Identity","icon":"fingerprint","groups":[{"group":"Number Lookup","pages":[{"title":"Telnyx Number Lookup API","sidebarTitle":"Overview","href":"/docs/identity/number-lookup/index"},{"title":"Quickstart for Number Lookup","sidebarTitle":"Quickstart","href":"/docs/identity/number-lookup/quickstart/index"},{"group":"Number Lookup API","pages":[{"title":"Lookup phone number data","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-lookup/number-lookup.json get /number_lookup/{phone_number}","href":"/api-reference/number-lookup/lookup-phone-number-data"}]}]},{"group":"Verify","pages":[{"title":"Telnyx Verify API","href":"/docs/identity/verify/index"},{"group":"Tutorials","pages":[{"title":"Quickstart for Telnyx Verify","sidebarTitle":"Telnyx verify quickstart","href":"/docs/identity/verify/quickstart/index"},{"title":"DTMF Confirmation Verification","sidebarTitle":"DTMF confirmation","href":"/docs/identity/verify/dtmf-confirm/index"},{"title":"Custom templates for Telnyx Verify","sidebarTitle":"Custom templates","href":"/docs/identity/verify/custom-templates/index"},{"title":"Receiving Webhooks for Telnyx Verify","sidebarTitle":"Webhooks","href":"/docs/identity/verify/receiving-webhooks/index"},{"title":"Verify Security Best Practices","sidebarTitle":"Security Best Practices","href":"/docs/identity/verify/security-best-practices/index"},{"title":"Rate Limiting and Fraud Prevention for Verify","sidebarTitle":"Rate Limiting \u0026 Fraud Prevention","href":"/docs/identity/verify/rate-limiting-fraud-prevention/index"},{"title":"Verify Integration Examples","sidebarTitle":"Integration Examples","href":"/docs/identity/verify/integration-examples/index"}]},{"group":"Verify API","pages":[{"title":"Trigger Call verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/call","href":"/api-reference/verify/trigger-call-verification"},{"title":"Trigger Flash call verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/flashcall","href":"/api-reference/verify/trigger-flash-call-verification"},{"title":"Trigger SMS verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/sms","href":"/api-reference/verify/trigger-sms-verification"},{"title":"Trigger WhatsApp verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/whatsapp","href":"/api-reference/verify/trigger-whatsapp-verification"},{"title":"Retrieve verification","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json get /verifications/{verification_id}","href":"/api-reference/verify/retrieve-verification"},{"title":"Verify verification code by ID","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/{verification_id}/actions/verify","href":"/api-reference/verify/verify-verification-code-by-id"},{"title":"List verifications by phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json get /verifications/by_phone_number/{phone_number}","href":"/api-reference/verify/list-verifications-by-phone-number"},{"title":"Verify verification code by phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verifications/by_phone_number/{phone_number}/actions/verify","href":"/api-reference/verify/verify-verification-code-by-phone-number"},{"title":"List all Verify profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json get /verify_profiles","href":"/api-reference/verify/list-all-verify-profiles"},{"title":"Create a Verify profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verify_profiles","href":"/api-reference/verify/create-a-verify-profile"},{"title":"Delete Verify profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json delete /verify_profiles/{verify_profile_id}","href":"/api-reference/verify/delete-verify-profile"},{"title":"Retrieve Verify profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json get /verify_profiles/{verify_profile_id}","href":"/api-reference/verify/retrieve-verify-profile"},{"title":"Update Verify profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json patch /verify_profiles/{verify_profile_id}","href":"/api-reference/verify/update-verify-profile"},{"title":"Retrieve Verify profile message templates","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json get /verify_profiles/templates","href":"/api-reference/verify/retrieve-verify-profile-message-templates"},{"title":"Create message template","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json post /verify_profiles/templates","href":"/api-reference/verify/create-message-template"},{"title":"Update message template","deprecated":null,"version":null,"openapi":"/openapi/source/external/verify/verify.json patch /verify_profiles/templates/{template_id}","href":"/api-reference/verify/update-message-template"}]}]},{"group":"For AI Agents","pages":[{"title":"Identity llms.txt","sidebarTitle":"Identity llms txt","href":"/docs/development/llms/numbers-identity-llms-txt/index"},{"title":"Identity llms-full.txt","sidebarTitle":"Identity llms full txt","href":"/docs/development/llms/numbers-identity-llms-full-txt/index"}]}]},{"tab":"Number Reputation","icon":"shield-check","groups":[{"group":"Guides","pages":[{"title":"Number Reputation","sidebarTitle":"Overview","href":"/docs/number-reputation/overview"},{"title":"Number Reputation Quickstart","sidebarTitle":"Quickstart","href":"/docs/number-reputation/quickstart"},{"title":"Pricing","sidebarTitle":"Pricing","href":"/docs/number-reputation/pricing"},{"title":"Letter of Authorization (LOA)","sidebarTitle":"Letter of Authorization","href":"/docs/number-reputation/loa"},{"title":"Number Reputation Settings","sidebarTitle":"Reputation Settings","href":"/docs/number-reputation/settings"},{"title":"Phone Number Reputation","sidebarTitle":"Phone Numbers","href":"/docs/number-reputation/phone-numbers"},{"title":"Numbers Hosted With Another Provider","sidebarTitle":"Non-Telnyx Numbers","href":"/docs/number-reputation/non-telnyx-numbers"},{"title":"Reputation Remediation","sidebarTitle":"Remediation","href":"/docs/number-reputation/remediation"}]},{"group":"Enterprises API","pages":[{"group":"Enterprises API","pages":[{"title":"List enterprises","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /enterprises","href":"/api-reference/enterprises/list-enterprises"},{"title":"Create an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json post /enterprises","href":"/api-reference/enterprises/create-an-enterprise"},{"title":"Delete an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json delete /enterprises/{enterprise_id}","href":"/api-reference/enterprises/delete-an-enterprise"},{"title":"Get an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json get /enterprises/{enterprise_id}","href":"/api-reference/enterprises/get-an-enterprise"},{"title":"Replace an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/branded-calling/branded-calling.json put /enterprises/{enterprise_id}","href":"/api-reference/enterprises/replace-an-enterprise"}]},{"group":"Terms of Service API","pages":[{"title":"Agree to the Phone Number Reputation Terms of Service","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /terms_of_service/number_reputation/agree","href":"/api-reference/terms-of-service/agree-to-the-phone-number-reputation-terms-of-service"}]}]},{"group":"Reputation Settings API","pages":[{"group":"Reputation API","pages":[{"title":"Disable phone-number reputation for an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json delete /enterprises/{enterprise_id}/reputation","href":"/api-reference/reputation/disable-phone-number-reputation-for-an-enterprise"},{"title":"Get phone-number reputation settings for an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation","href":"/api-reference/reputation/get-phone-number-reputation-settings-for-an-enterprise"},{"title":"Enable phone-number reputation for an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation","href":"/api-reference/reputation/enable-phone-number-reputation-for-an-enterprise"},{"title":"Change the reputation refresh frequency","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json patch /enterprises/{enterprise_id}/reputation/frequency","href":"/api-reference/reputation/change-the-reputation-refresh-frequency"},{"title":"Replace the reputation Letter of Authorization document","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json patch /enterprises/{enterprise_id}/reputation/loa","href":"/api-reference/reputation/replace-the-reputation-letter-of-authorization-document"},{"title":"Render a phone-number reputation Letter of Authorization","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation/loa","href":"/api-reference/reputation/render-a-phone-number-reputation-letter-of-authorization"},{"title":"Set the number-ownership webhook URL","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json patch /enterprises/{enterprise_id}/reputation/webhook","href":"/api-reference/reputation/set-the-number-ownership-webhook-url"},{"title":"Get the ownership-proof review status","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/external_verification","href":"/api-reference/reputation/get-the-ownership-proof-review-status"},{"title":"Submit ownership proof for numbers hosted elsewhere","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation/external_verification","href":"/api-reference/reputation/submit-ownership-proof-for-numbers-hosted-elsewhere"}]},{"group":"Terms of Service API","pages":[{"title":"Agree to the Phone Number Reputation Terms of Service","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /terms_of_service/number_reputation/agree","href":"/api-reference/terms-of-service/agree-to-the-phone-number-reputation-terms-of-service"}]}]},{"group":"Phone Number Reputation API","pages":[{"title":"List reputation-monitored phone numbers for an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/numbers","href":"/api-reference/reputation/list-reputation-monitored-phone-numbers-for-an-enterprise"},{"title":"Register phone numbers for reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation/numbers","href":"/api-reference/reputation/register-phone-numbers-for-reputation-monitoring"},{"title":"Remove a phone number from reputation monitoring","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json delete /enterprises/{enterprise_id}/reputation/numbers/{phone_number}","href":"/api-reference/reputation/remove-a-phone-number-from-reputation-monitoring"},{"title":"Get a single reputation-monitored phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/numbers/{phone_number}","href":"/api-reference/reputation/get-a-single-reputation-monitored-phone-number"},{"title":"Get a phone number's ownership tracking detail","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/numbers/{phone_number}/ownership","href":"/api-reference/reputation/get-a-phone-numbers-ownership-tracking-detail"},{"title":"Confirm or give up ownership of a phone number","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation/numbers/{phone_number}/ownership_confirm","href":"/api-reference/reputation/confirm-or-give-up-ownership-of-a-phone-number"},{"title":"List reputation-monitored phone numbers across all enterprises","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /reputation/numbers","href":"/api-reference/reputation/list-reputation-monitored-phone-numbers-across-all-enterprises"},{"title":"Remove a phone number from reputation monitoring (no enterprise_id required)","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json delete /reputation/numbers/{phone_number}","href":"/api-reference/reputation/remove-a-phone-number-from-reputation-monitoring-no-enterprise_id-required"},{"title":"Get a reputation-monitored number (no enterprise_id required)","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /reputation/numbers/{phone_number}","href":"/api-reference/reputation/get-a-reputation-monitored-number-no-enterprise_id-required"}]},{"group":"Remediation API","pages":[{"title":"List reputation remediation requests for an enterprise","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/remediation","href":"/api-reference/reputation/list-reputation-remediation-requests-for-an-enterprise"},{"title":"Submit phone numbers for reputation remediation","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json post /enterprises/{enterprise_id}/reputation/remediation","href":"/api-reference/reputation/submit-phone-numbers-for-reputation-remediation"},{"title":"Get a reputation remediation request","deprecated":null,"version":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json get /enterprises/{enterprise_id}/reputation/remediation/{remediation_id}","href":"/api-reference/reputation/get-a-reputation-remediation-request"}]},{"group":"Ownership Webhooks","pages":[{"title":"Number ownership needs confirmation","version":null,"deprecated":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json webhook numberReputationNumberFlagged","href":"/api-reference/phone-numbers/number-ownership-needs-confirmation"},{"title":"Number removed for an ownership reason","version":null,"deprecated":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json webhook numberReputationNumberRemoved","href":"/api-reference/phone-numbers/number-removed-for-an-ownership-reason"},{"title":"Ownership verification reviewed","version":null,"deprecated":null,"openapi":"/openapi/source/external/number-reputation/number-reputation.json webhook numberReputationExternalVerificationStatusChanged","href":"/api-reference/phone-numbers/ownership-verification-reviewed"}]},{"group":"For AI Agents","pages":[{"title":"Number Reputation llms.txt","sidebarTitle":"Number Reputation llms txt","href":"/docs/development/llms/numbers-number-reputation-llms-txt/index"},{"title":"Number Reputation llms-full.txt","sidebarTitle":"Number Reputation llms full txt","href":"/docs/development/llms/numbers-number-reputation-llms-full-txt/index"}]}]}]},{"product":"Wireless","icon":"broadcast-tower","tabs":[{"tab":"Overview","icon":"globe","groups":[{"group":" ","pages":[{"title":"Wireless","sidebarTitle":"Overview","href":"/docs/iot-sim/wireless-overview"}]},{"group":"For AI Agents","pages":[{"title":"Overview llms.txt","sidebarTitle":"Overview llms txt","href":"/docs/development/llms/wireless-overview-llms-txt/index"},{"title":"Overview llms-full.txt","sidebarTitle":"Overview llms full txt","href":"/docs/development/llms/wireless-overview-llms-full-txt/index"}]}]},{"tab":"SIMs \u0026 eSIMs","icon":"sim-card","groups":[{"group":"Overview","pages":[{"title":"SIMs \u0026 eSIMs","sidebarTitle":"Overview","href":"/docs/iot-sim/get-started/index"}]},{"group":"SIM Cards","pages":[{"title":"SIM Cards","sidebarTitle":"SIM Cards","href":"/docs/iot-sim/ordering-sims/index"},{"title":"SIM Lifecycle","sidebarTitle":"Lifecycle","href":"/docs/iot-sim/sim-lifecycle/index"},{"group":"API Reference","pages":[{"group":"SIM Cards","pages":[{"title":"Get all SIM cards","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_cards","href":"/api-reference/sim-cards/get-all-sim-cards"},{"title":"Deletes a SIM card","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json delete /sim_cards/{id}","href":"/api-reference/sim-cards/deletes-a-sim-card"},{"title":"Get SIM card","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_cards/{id}","href":"/api-reference/sim-cards/get-sim-card"},{"title":"Update a SIM card","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json patch /sim_cards/{id}","href":"/api-reference/sim-cards/update-a-sim-card"}]},{"group":"Provisioning","pages":[{"group":"SIM Card Orders API","pages":[{"title":"Get all SIM card orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_orders","href":"/api-reference/sim-card-orders/get-all-sim-card-orders"},{"title":"Create a SIM card order","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_orders","href":"/api-reference/sim-card-orders/create-a-sim-card-order"},{"title":"Get a single SIM card order","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_orders/{id}","href":"/api-reference/sim-card-orders/get-a-single-sim-card-order"},{"title":"Preview SIM card orders","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_order_preview","href":"/api-reference/sim-card-orders/preview-sim-card-orders"}]},{"group":"SIM Cards API","pages":[{"title":"Register SIM cards","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /actions/register/sim_cards","href":"/api-reference/sim-cards/register-sim-cards"},{"title":"Purchase eSIMs","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /actions/purchase/esims","href":"/api-reference/sim-cards/purchase-esims"},{"title":"Request a SIM card enable","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/enable","href":"/api-reference/sim-cards/request-a-sim-card-enable"},{"title":"Request a SIM card disable","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/disable","href":"/api-reference/sim-cards/request-a-sim-card-disable"},{"title":"Request setting a SIM card to standby","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/set_standby","href":"/api-reference/sim-cards/request-setting-a-sim-card-to-standby"},{"title":"Request enabling voice on a SIM card","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/enable_voice","href":"/api-reference/sim-cards/request-enabling-voice-on-a-sim-card"},{"title":"Request disabling voice on a SIM card","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/disable_voice","href":"/api-reference/sim-cards/request-disabling-voice-on-a-sim-card"}]}]},{"group":"SIM Card Actions","pages":[{"title":"List SIM card actions","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_actions","href":"/api-reference/sim-card-actions/list-sim-card-actions"},{"title":"Get SIM card action details","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_actions/{id}","href":"/api-reference/sim-card-actions/get-sim-card-action-details"}]}]}]},{"group":"SIM Card Groups","pages":[{"title":"SIM Card Groups","sidebarTitle":"SIM Card Groups","href":"/docs/iot-sim/sim-card-groups/index"},{"group":"API Reference","pages":[{"group":"SIM Card Groups API","pages":[{"title":"Get all SIM card groups","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_groups","href":"/api-reference/sim-card-groups/get-all-sim-card-groups"},{"title":"Create a SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_groups","href":"/api-reference/sim-card-groups/create-a-sim-card-group"},{"title":"Delete a SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json delete /sim_card_groups/{id}","href":"/api-reference/sim-card-groups/delete-a-sim-card-group"},{"title":"Get SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_groups/{id}","href":"/api-reference/sim-card-groups/get-sim-card-group"},{"title":"Update a SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json patch /sim_card_groups/{id}","href":"/api-reference/sim-card-groups/update-a-sim-card-group"},{"title":"Request Private Wireless Gateway removal from SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_groups/{id}/actions/remove_private_wireless_gateway","href":"/api-reference/sim-card-groups/request-private-wireless-gateway-removal-from-sim-card-group"},{"title":"Request Private Wireless Gateway assignment for SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_groups/{id}/actions/set_private_wireless_gateway","href":"/api-reference/sim-card-groups/request-private-wireless-gateway-assignment-for-sim-card-group"}]},{"group":"SIM Card Group Actions API","pages":[{"title":"List SIM card group actions","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_group_actions","href":"/api-reference/sim-card-group-actions/list-sim-card-group-actions"},{"title":"Get SIM card group action details","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_group_actions/{id}","href":"/api-reference/sim-card-group-actions/get-sim-card-group-action-details"}]}]}]},{"group":"Bulk Operations","pages":[{"title":"Bulk Operations","sidebarTitle":"Bulk Operations","href":"/docs/iot-sim/bulk-sim-actions/index"},{"group":"API Reference","pages":[{"group":"SIM Card Actions API","pages":[{"title":"List bulk SIM card actions","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /bulk_sim_card_actions","href":"/api-reference/sim-card-actions/list-bulk-sim-card-actions"},{"title":"Get bulk SIM card action details","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /bulk_sim_card_actions/{id}","href":"/api-reference/sim-card-actions/get-bulk-sim-card-action-details"}]},{"group":"SIM Cards API","pages":[{"title":"Request bulk disabling voice on SIM cards.","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/actions/bulk_disable_voice","href":"/api-reference/sim-cards/request-bulk-disabling-voice-on-sim-cards"},{"title":"Request bulk enabling voice on SIM cards.","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/actions/bulk_enable_voice","href":"/api-reference/sim-cards/request-bulk-enabling-voice-on-sim-cards"},{"title":"Request bulk setting SIM card public IPs.","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/actions/bulk_set_public_ips","href":"/api-reference/sim-cards/request-bulk-setting-sim-card-public-ips"},{"title":"Validate SIM cards registration codes","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/actions/validate_registration_codes","href":"/api-reference/sim-cards/validate-sim-cards-registration-codes"}]}]}]},{"group":"For AI Agents","pages":[{"title":"SIMs \u0026 eSIMs llms.txt","sidebarTitle":"SIMs \u0026 eSIMs llms txt","href":"/docs/development/llms/wireless-sims-esims-llms-txt/index"},{"title":"SIMs \u0026 eSIMs llms-full.txt","sidebarTitle":"SIMs \u0026 eSIMs llms full txt","href":"/docs/development/llms/wireless-sims-esims-llms-full-txt/index"}]}]},{"tab":"Data","icon":"signal","groups":[{"group":"Configuration","pages":[{"title":"Public IPs","sidebarTitle":"Public IPs","href":"/docs/iot-sim/public-ips/index"},{"title":"Private Wireless Gateways","sidebarTitle":"Private Wireless Gateways","href":"/docs/iot-sim/private-wireless-gateways/index"},{"title":"Private Wireless Gateway (PGW)","sidebarTitle":"Private Wireless Gateway (PGW)","href":"/docs/network/gateways/private-wireless-gateway/index"},{"title":"How to set up a Private Wireless Gateway","sidebarTitle":"Private Gateway Setup","href":"/docs/iot-sim/private-wireless-gateway-how-to/index"},{"title":"Traffic Policy Profiles","sidebarTitle":"Traffic Policies","href":"/docs/iot-sim/traffic-policy-profiles/index"},{"title":"Data Usage Notifications","sidebarTitle":"Usage Alerts","href":"/docs/iot-sim/data-usage-notifications/index"},{"group":"API Reference","pages":[{"group":"SIM Cards API","pages":[{"title":"Get SIM card public IP definition","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_cards/{id}/public_ip","href":"/api-reference/sim-cards/get-sim-card-public-ip-definition"},{"title":"Request setting a SIM card public IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/set_public_ip","href":"/api-reference/sim-cards/request-setting-a-sim-card-public-ip"},{"title":"Request removing a SIM card public IP","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_cards/{id}/actions/remove_public_ip","href":"/api-reference/sim-cards/request-removing-a-sim-card-public-ip"},{"title":"List SIM card data usage notifications","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_data_usage_notifications","href":"/api-reference/sim-cards/list-sim-card-data-usage-notifications"},{"title":"Create a new SIM card data usage notification","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_data_usage_notifications","href":"/api-reference/sim-cards/create-a-new-sim-card-data-usage-notification"},{"title":"Delete SIM card data usage notifications","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json delete /sim_card_data_usage_notifications/{id}","href":"/api-reference/sim-cards/delete-sim-card-data-usage-notifications"},{"title":"Get a single SIM card data usage notification","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_card_data_usage_notifications/{id}","href":"/api-reference/sim-cards/get-a-single-sim-card-data-usage-notification"},{"title":"Updates information for a SIM Card Data Usage Notification","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json patch /sim_card_data_usage_notifications/{id}","href":"/api-reference/sim-cards/updates-information-for-a-sim-card-data-usage-notification"}]},{"group":"Private Wireless Gateways API","pages":[{"title":"Get all Private Wireless Gateways","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /private_wireless_gateways","href":"/api-reference/private-wireless-gateways/get-all-private-wireless-gateways"},{"title":"Create a Private Wireless Gateway","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /private_wireless_gateways","href":"/api-reference/private-wireless-gateways/create-a-private-wireless-gateway"},{"title":"Delete a Private Wireless Gateway","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json delete /private_wireless_gateways/{id}","href":"/api-reference/private-wireless-gateways/delete-a-private-wireless-gateway"},{"title":"Get a Private Wireless Gateway","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /private_wireless_gateways/{id}","href":"/api-reference/private-wireless-gateways/get-a-private-wireless-gateway"}]},{"group":"Traffic Policy Profiles API","pages":[{"title":"Get all traffic policy profiles","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json get /traffic/policy/profiles","href":"/api-reference/traffic-policy-profiles/get-all-traffic-policy-profiles"},{"title":"Create a traffic policy profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json post /traffic/policy/profiles","href":"/api-reference/traffic-policy-profiles/create-a-traffic-policy-profile"},{"title":"Delete a traffic policy profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json delete /traffic/policy/profiles/{id}","href":"/api-reference/traffic-policy-profiles/delete-a-traffic-policy-profile"},{"title":"Get a traffic policy profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json get /traffic/policy/profiles/{id}","href":"/api-reference/traffic-policy-profiles/get-a-traffic-policy-profile"},{"title":"Update a traffic policy profile","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json patch /traffic/policy/profiles/{id}","href":"/api-reference/traffic-policy-profiles/update-a-traffic-policy-profile"},{"title":"Get all available traffic policy profile services","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-configuration.json get /traffic/policy/profiles/services","href":"/api-reference/traffic-policy-profiles/get-all-available-traffic-policy-profile-services"}]}]}]},{"group":"Roaming Control","pages":[{"title":"Blocklists","sidebarTitle":"Blocklists","href":"/docs/iot-sim/wireless-blocklists/index"},{"group":"API Reference","pages":[{"group":"Blocklist Values","pages":[{"title":"Get all possible wireless blocklist values","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /wireless_blocklist_values","href":"/api-reference/wireless-blocklists/get-all-possible-wireless-blocklist-values"}]},{"group":"Blocklist Management","pages":[{"title":"Get all Wireless Blocklists","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /wireless_blocklists","href":"/api-reference/wireless-blocklists/get-all-wireless-blocklists"},{"title":"Create a Wireless Blocklist","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /wireless_blocklists","href":"/api-reference/wireless-blocklists/create-a-wireless-blocklist"},{"title":"Delete a Wireless Blocklist","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json delete /wireless_blocklists/{id}","href":"/api-reference/wireless-blocklists/delete-a-wireless-blocklist"},{"title":"Get a Wireless Blocklist","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /wireless_blocklists/{id}","href":"/api-reference/wireless-blocklists/get-a-wireless-blocklist"},{"title":"Update a Wireless Blocklist","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json patch /wireless_blocklists/{id}","href":"/api-reference/wireless-blocklists/update-a-wireless-blocklist"}]},{"group":"SIM Card Group Assignment","pages":[{"title":"Request Wireless Blocklist assignment for SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_groups/{id}/actions/set_wireless_blocklist","href":"/api-reference/sim-card-groups/request-wireless-blocklist-assignment-for-sim-card-group"},{"title":"Request Wireless Blocklist removal from SIM card group","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json post /sim_card_groups/{id}/actions/remove_wireless_blocklist","href":"/api-reference/sim-card-groups/request-wireless-blocklist-removal-from-sim-card-group"}]}]}]},{"group":"Monitoring \u0026 Troubleshooting","pages":[{"title":"Wireless API errors","sidebarTitle":"API errors","href":"/docs/iot-sim/api-errors/index"},{"title":"SIM Connectivity Troubleshooting","sidebarTitle":"Troubleshooting","href":"/docs/iot-sim/connectivity-troubleshooting/index"},{"title":"Wireless Detail Records","sidebarTitle":"Detail Records","href":"/docs/iot-sim/wireless-detail-records/index"},{"title":"OTA Updates","sidebarTitle":"OTA Updates","href":"/docs/iot-sim/ota-updates/index"},{"group":"API Reference","pages":[{"group":"SIM Cards API","pages":[{"title":"List wireless connectivity logs","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /sim_cards/{id}/wireless_connectivity_logs","href":"/api-reference/sim-cards/list-wireless-connectivity-logs"}]},{"group":"Reporting API","pages":[{"title":"Get all Wireless Detail Records (WDRs) Reports","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-monitoring.json get /wireless/detail/records/reports","href":"/api-reference/reporting/get-all-wireless-detail-records-wdrs-reports"},{"title":"Create a Wireless Detail Records (WDRs) Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-monitoring.json post /wireless/detail/records/reports","href":"/api-reference/reporting/create-a-wireless-detail-records-wdrs-report"},{"title":"Delete a Wireless Detail Record (WDR) Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-monitoring.json delete /wireless/detail/records/reports/{id}","href":"/api-reference/reporting/delete-a-wireless-detail-record-wdr-report"},{"title":"Get a Wireless Detail Record (WDR) Report","deprecated":null,"version":null,"openapi":"/openapi/source/external/legacy-published/wireless/sim-cards-monitoring.json get /wireless/detail/records/reports/{id}","href":"/api-reference/reporting/get-a-wireless-detail-record-wdr-report"}]},{"group":"OTA updates API","pages":[{"title":"List OTA updates","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /ota_updates","href":"/api-reference/ota-updates/list-ota-updates"},{"title":"Get OTA update","deprecated":null,"version":null,"openapi":"/openapi/source/external/wireless/wireless.json get /ota_updates/{id}","href":"/api-reference/ota-updates/get-ota-update"}]}]}]},{"group":"Device Guides","pages":[{"group":"AT Commands","pages":[{"title":"AT Commands","sidebarTitle":"AT Commands","href":"/docs/iot-sim/at-commands/index"}]},{"group":"Development Boards","pages":[{"title":"SIM7600-A Raspberry Pi 4G Hat Setup","sidebarTitle":"Raspberry Pi 4G Hat (SIM7600-A)","href":"/docs/iot-sim/sim7600-a-rasp-pui-hat/index"},{"title":"Sixfab Raspberry Pi 3G/4G Hat","sidebarTitle":"Sixfab Raspberry Pi 3G/4G Hat","href":"/docs/iot-sim/sixfab-rasp-pi-hat/index"},{"title":"Sixfab Cellular IoT HAT Setup","sidebarTitle":"Sixfab Cellular IoT HAT","href":"/docs/iot-sim/sixfab-cellular-iot-hat/index"},{"title":"Particle Boron LTE Kit Setup Guid","sidebarTitle":"Particle Boron LTE Kit","href":"/docs/iot-sim/particle-boron-lte-kit/index"},{"title":"Nordic Semiconductor nRF9160 DK Setup Guide","sidebarTitle":"Nordic nRF9160 DK","href":"/docs/iot-sim/nordic-semiconductor/index"}]},{"group":"Routers \u0026 Gateways","pages":[{"title":"Cradlepoint IBR200 Cellular Router Setup Guide","sidebarTitle":"Cradlepoint IBR200","href":"/docs/iot-sim/cradlepoint-ibr200-cellular/index"},{"title":"Pepwave Max BR1 Mini LTE Setup Guide","sidebarTitle":"Pepwave Max BR1 Mini LTE","href":"/docs/iot-sim/pepwave-max-br1-mini-lte/index"},{"title":"GL-MiFi 4G Smart Router Setup Guide","sidebarTitle":"GL-MiFi 4G Smart Router","href":"/docs/iot-sim/glmifi-router/index"},{"title":"Mikrotik wAP LTE Kit - US Tutorial","sidebarTitle":"Mikrotik wAP LTE Kit","href":"/docs/iot-sim/mikrotik-wap-lte/index"}]},{"group":"Edge Deployment","pages":[{"title":"Deploy a Cradlepoint edge device with an IoT SIM","sidebarTitle":"Edge Device Deployment","href":"/docs/iot-sim/edge-deployment/index"}]}]},{"group":"For AI Agents","pages":[{"title":"Data llms.txt","sidebarTitle":"Data llms txt","href":"/docs/development/llms/wireless-data-llms-txt/index"},{"title":"Data llms-full.txt","sidebarTitle":"Data llms full txt","href":"/docs/development/llms/wireless-data-llms-full-txt/index"}]}]},{"tab":"VoLTE","icon":"phone","groups":[{"group":"Overview","pages":[{"title":"VoLTE","sidebarTitle":"Overview","href":"/docs/iot-sim/voice-enabled-iot/index"}]},{"group":"Configuration","pages":[{"title":"Mobile Phone Numbers","sidebarTitle":"Phone Numbers","href":"/docs/iot-sim/mobile-phone-numbers/index"},{"title":"Call Forwarding, Recording \u0026 Screening","sidebarTitle":"Forwarding, Recording \u0026 Screening","href":"/docs/iot-sim/call-forwarding-recording/index"}]},{"group":"API Reference","pages":[{"group":"Mobile Phone Numbers API","pages":[{"title":"List Mobile Phone Numbers","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_phone_numbers/mobile_phone_numbers.json get /v2/mobile_phone_numbers","href":"/api-reference/mobile-phone-numbers/list-mobile-phone-numbers"},{"title":"Retrieve a Mobile Phone Number","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_phone_numbers/mobile_phone_numbers.json get /v2/mobile_phone_numbers/{id}","href":"/api-reference/mobile-phone-numbers/retrieve-a-mobile-phone-number"},{"title":"Update a Mobile Phone Number","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_phone_numbers/mobile_phone_numbers.json patch /v2/mobile_phone_numbers/{id}","href":"/api-reference/mobile-phone-numbers/update-a-mobile-phone-number"}]},{"group":"Mobile Voice Connections API","pages":[{"title":"List Mobile Voice Connections","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_voice_connections/mobile_voice_connections.json get /v2/mobile_voice_connections","href":"/api-reference/mobile-voice-connections/list-mobile-voice-connections"},{"title":"Create a Mobile Voice Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_voice_connections/mobile_voice_connections.json post /v2/mobile_voice_connections","href":"/api-reference/mobile-voice-connections/create-a-mobile-voice-connection"},{"title":"Retrieve a Mobile Voice Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_voice_connections/mobile_voice_connections.json get /v2/mobile_voice_connections/{id}","href":"/api-reference/mobile-voice-connections/retrieve-a-mobile-voice-connection"},{"title":"Update a Mobile Voice Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_voice_connections/mobile_voice_connections.json patch /v2/mobile_voice_connections/{id}","href":"/api-reference/mobile-voice-connections/update-a-mobile-voice-connection"},{"title":"Delete a Mobile Voice Connection","deprecated":null,"version":null,"openapi":"/openapi/source/external/mobile_voice_connections/mobile_voice_connections.json delete /v2/mobile_voice_connections/{id}","href":"/api-reference/mobile-voice-connections/delete-a-mobile-voice-connection"}]}]},{"group":"For AI Agents","pages":[{"title":"VoLTE llms.txt","sidebarTitle":"VoLTE llms txt","href":"/docs/development/llms/wireless-volte-llms-txt/index"},{"title":"VoLTE llms-full.txt","sidebarTitle":"VoLTE llms full txt","href":"/docs/development/llms/wireless-volte-llms-full-txt/index"}]}]},{"tab":"Messaging","icon":"message","groups":[{"group":"Configuration","pages":[{"title":"Messaging","sidebarTitle":"Overview","href":"/docs/iot-sim/messaging-settings/index"}]},{"group":"For AI Agents","pages":[{"title":"Messaging llms.txt","sidebarTitle":"Messaging llms txt","href":"/docs/development/llms/wireless-messaging-llms-txt/index"},{"title":"Messaging llms-full.txt","sidebarTitle":"Messaging llms full txt","href":"/docs/development/llms/wireless-messaging-llms-full-txt/index"}]}]}]}]},"basePath":"","title":"Deprecated - Bring Your Own Carrier Guides - Telnyx","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["10e4515597"],"chunks":["BannerMarkdown-DIeMibn4.js","dist-DJnKvr0g.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2v50t8t.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}