Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled.
DELETE
/
messages
/
{id}
JavaScript
import Telnyx from 'telnyx';const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted});const response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');console.log(response.id);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.messages.cancel_scheduled(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.id)
Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled
Indicates whether smart encoding was applied to this message. When true, one or more Unicode characters were automatically replaced with GSM-7 equivalents to reduce segment count and cost. The original message text is preserved in webhooks.
Was this page helpful?
JavaScript
import Telnyx from 'telnyx';const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted});const response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');console.log(response.id);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
response = client.messages.cancel_scheduled(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.id)
{"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":"6aecc1177e2a3b454e46ab4a","collectionId":"e89de448-4ed6-4586-a5dc-1bb465c580ba","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aecc1177e2a3b454e46ab4a"},"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":"6aedfbb495ef9065731d8b76","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":601},{"language":"default","tag":"Calling","count":592},{"language":"default","tag":"Other APIs","count":406},{"language":"default","tag":"AI","count":395},{"language":"default","tag":"Messaging","count":353},{"language":"default","tag":"Numbers","count":287},{"language":"default","tag":"Agent Platform","count":282},{"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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"[class*=\"sidebar\"] [class*=\"tag\"],[class*=\"sidebar\"] [class*=\"badge\"],nav [class*=\"tag\"],nav [class*=\"badge\"]{font-size:0.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\"]){display:none}.nav-tabs a.nav-tabs-item:not([aria-current=\"location\"]){display:none}#navbar div:has(>div>.nav-tabs>a.nav-tabs-item:first-child:last-child){display:none}@media (width >= 64rem){.txd-side{display:block}button[data-component-part=\"products-selector-trigger\"],button.tx-product-switcher{display:none!important}}#mobile-nav [data-component-part=\"products-selector-trigger\"],#mobile-nav #navigation-items>div:has(>div>button[aria-haspopup=\"menu\"]),#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 a,#mobile-nav .tx-mobile-directory .tx-dir-suite-head{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}}@media (width \u003c 64rem){.txd-shell{display:block;padding:2rem 1.5rem 5rem}.txd-side{display:none}.txd-main{margin-left:0}}:is(#tx-directory,.tx-mobile-directory){margin:0 0 0.5rem;padding:0 0.5rem 0 1rem}:is(#tx-directory,.tx-mobile-directory) .tx-dir-label{font-size:0.72rem;font-weight:600;letter-spacing:0.06em;text-transform:uppercase;opacity:0.55;margin:0 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:0.875rem;line-height:1.25rem;padding:0.35rem 0.5rem;border-radius:0.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 / 0.04)}:is(#tx-directory,.tx-mobile-directory) .tx-dir-link[aria-current=\"page\"]{color:#00b688;background:transparent;box-shadow:none;font-weight:400;text-shadow:-0.2px 0 0 currentColor, 0.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 / 0.06)}html.dark :is(#tx-directory,.tx-mobile-directory) .tx-dir-link[aria-current=\"page\"]{color:#5eead4;background:transparent;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:0.45;background:transparent;color:inherit}:is(#tx-directory,.tx-mobile-directory) .tx-dir-soon sup{font-size:0.6rem;line-height:1;letter-spacing:0.05em;text-transform:uppercase;margin-left:0.4rem;vertical-align:super}:is(#tx-directory,.tx-mobile-directory) .tx-dir-suite{margin-bottom:0.15rem}:is(#tx-directory,.tx-mobile-directory) .tx-dir-suite-head{display:flex;align-items:center;cursor:pointer;user-select:none;font-size:0.875rem;line-height:1.25rem;font-weight:500;padding:0.35rem 0.5rem;border-radius:0.375rem;color:rgb(55 65 81)}html.dark :is(#tx-directory,.tx-mobile-directory) .tx-dir-suite-head{color:rgb(156 163 175)}:is(#tx-directory,.tx-mobile-directory) .tx-dir-suite-head:hover{color:rgb(17 24 39);background:rgb(0 0 0 / 0.04)}html.dark :is(#tx-directory,.tx-mobile-directory) .tx-dir-suite-head:hover{color:rgb(229 231 235);background:rgb(255 255 255 / 0.06)}:is(#tx-directory,.tx-mobile-directory) .tx-dir-suite-head::after{content:'';width:0.42rem;height:0.42rem;margin-left:auto;border-right:1.5px solid currentColor;border-bottom:1.5px solid currentColor;transform:rotate(-45deg);transition:transform 0.15s;flex-shrink:0;opacity:0.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 / 0.04);font-weight:600}html.dark :is(#tx-directory,.tx-mobile-directory) .tx-dir-suite.open>.tx-dir-suite-head{color:rgb(229 231 235);background:rgb(255 255 255 / 0.06)}: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:0.15rem 0 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:0.875rem;line-height:1.25rem;padding:0.3rem 0.5rem 0.3rem 1.6rem;border-radius:0.375rem;color:rgb(107 114 128);text-decoration:none}:is(#tx-directory,.tx-mobile-directory) .tx-dir-section-item{font-weight:500}html.dark :is(#tx-directory,.tx-mobile-directory) li a{color:rgb(156 163 175)}:is(#tx-directory,.tx-mobile-directory) li a:hover{color:rgb(17 24 39);background:rgb(0 0 0 / 0.04)}html.dark :is(#tx-directory,.tx-mobile-directory) li a:hover{color:rgb(229 231 235);background:rgb(255 255 255 / 0.06)}:is(#tx-directory,.tx-mobile-directory) .tx-dir-icon{display:inline-block;width:1rem;height:1rem;flex-shrink:0;margin-right:0.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-door-open{-webkit-mask-image:url(\"https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/door-open.svg\");mask-image:url(\"https://d3gk2c5xim1je2.cloudfront.net/fontawesome/v7.2.0/regular/door-open.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:-0.01em;margin:1.2rem 0 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:0.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 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 0.2rem;opacity:0.85}.txd-main .txd-p{margin:0.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-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 .txd-follow-up a:hover{text-decoration:underline}.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-search input,.rm-area-select,.rm-collapse,.rm-clear,.rm-empty button{min-height:2.5rem;color:inherit;background:transparent;border:1px solid var(--rm-border);border-radius:.5rem;font:inherit;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,.rm-clear,.rm-empty button{padding:.5rem .75rem;font-weight:650;cursor:pointer}.rm-search input:focus-visible,.rm-area-select:focus-visible,.rm-collapse:focus-visible,.rm-clear:focus-visible,.rm-empty button:focus-visible{outline:2px solid #00b688;outline-offset:2px;border-color:#00b688;box-shadow:none!important}.rm-collapse:hover,.rm-clear:hover,.rm-empty button:hover{color:#08785d;background:var(--rm-soft)}.dark .rm-collapse:hover,.dark .rm-clear: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-resource-list tbody tr[hidden],.rm-explorer h2[hidden],.rm-resource-list[hidden],.rm-empty[hidden],.rm-collapse[hidden],.rm-clear[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:transparent;border:0;cursor:pointer}.rm-section-toggle:hover,.rm-section-toggle:focus-visible{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-shortcut{display:none}.rm-area-wrap,.rm-area-select{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 thead{display:none}.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 code,.rm-resource-list tbody td a{min-width:0;white-space:normal!important;overflow-wrap:anywhere}}@media (prefers-reduced-motion: reduce){.rm-explorer *,.rm-explorer *::before,.rm-explorer *::after{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%}}@media (min-width: 768px){.tx-table-grid-3 table{table-layout:fixed}.tx-table-grid-3 table :is(th,td):first-child{width:22%}.tx-table-grid-3 table :is(th,td):last-child{width:18%}}.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":"api-reference/messages/cancel-a-scheduled-message","slug":"/api-reference/messages/cancel-a-scheduled-message","pageMetadata":{"title":"Cancel a scheduled message","description":"Cancel a scheduled message that has not yet been sent. Only messages with `status=scheduled` and `send_at` more than a minute from now can be cancelled.","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messages/{id}","href":"/api-reference/messages/cancel-a-scheduled-message","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Cancel a scheduled message that has not yet been sent. Only messages with \", _jsx(_components.code, {\n children: \"status=scheduled\"\n }), \" and \", _jsx(_components.code, {\n children: \"send_at\"\n }), \" more than a minute from now can be cancelled.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel a scheduled message","description":"Cancel a scheduled message that has not yet been sent. Only messages with `status=scheduled` and `send_at` more than a minute from now can be cancelled.","deprecated":null,"version":null,"openapi":"/openapi/source/external/messaging/messaging.json delete /messages/{id}","href":"/api-reference/messages/cancel-a-scheduled-message","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"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/9ffa8f6166445a46/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/660ec334a362cf1c/home-directory.js","/_mintlify/custom/telnyx/33d3f1dbdec08735/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"],"openApiReferenceData":{"operation":{"summary":"Cancel a scheduled message","description":"Cancel a scheduled message that has not yet been sent. Only messages with `status=scheduled` and `send_at` more than a minute from now can be cancelled.","operationId":"CancelMessage","tags":["Messages"],"parameters":["6098572f-8881-4908-9135-dfccf71708ae"],"responses":{"200":"4e981dcd-a211-4924-89e6-ebf93fc2e164","403":"1c247c34-79d8-4a3e-bd88-ca3bb12cc1a7","404":"7ecd5612-61dc-42a8-a4a5-431fa511818d","4XX":"aedb6d0a-e303-450d-ae1c-51932303fe4c"},"x-codeSamples":[{"lang":"JavaScript","source":"import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response.id);"},{"lang":"Python","source":"import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get(\"TELNYX_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.messages.cancel_scheduled(\n \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n)\nprint(response.id)\n"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Messages.CancelScheduled(context.TODO(), \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n"},{"lang":"Java","source":"package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.messages.MessageCancelScheduledParams;\nimport com.telnyx.sdk.models.messages.MessageCancelScheduledResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n MessageCancelScheduledResponse response = client.messages().cancelScheduled(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\");\n }\n}"},{"lang":"Ruby","source":"require \"telnyx\"\n\ntelnyx = Telnyx::Client.new(api_key: \"My API Key\")\n\nresponse = telnyx.messages.cancel_scheduled(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n\nputs(response)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Telnyx\\Client;\nuse Telnyx\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');\n\ntry {\n $response = $client->messages->cancelScheduled(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n );\n\n var_dump($response);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"},{"lang":"CLI","source":"telnyx messages cancel-scheduled \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],"method":"delete","type":"path","servers":["4ac8a221-7703-4fe2-b882-63d6e90dec3e"],"security":["7544fab7-727a-47a6-8a6f-08c73de6eb9f"],"path":"/messages/{id}","baseUrlOptions":["https://api.telnyx.com/v2"],"title":"Cancel a scheduled message","codeSamples":[{"lang":"JavaScript","source":"import Telnyx from 'telnyx';\n\nconst client = new Telnyx({\n apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted\n});\n\nconst response = await client.messages.cancelScheduled('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');\n\nconsole.log(response.id);"},{"lang":"Python","source":"import os\nfrom telnyx import Telnyx\n\nclient = Telnyx(\n api_key=os.environ.get(\"TELNYX_API_KEY\"), # This is the default and can be omitted\n)\nresponse = client.messages.cancel_scheduled(\n \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n)\nprint(response.id)\n"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tresponse, err := client.Messages.CancelScheduled(context.TODO(), \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.ID)\n}\n"},{"lang":"Java","source":"package com.telnyx.sdk.example;\n\nimport com.telnyx.sdk.client.TelnyxClient;\nimport com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;\nimport com.telnyx.sdk.models.messages.MessageCancelScheduledParams;\nimport com.telnyx.sdk.models.messages.MessageCancelScheduledResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n TelnyxClient client = TelnyxOkHttpClient.fromEnv();\n\n MessageCancelScheduledResponse response = client.messages().cancelScheduled(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\");\n }\n}"},{"lang":"Ruby","source":"require \"telnyx\"\n\ntelnyx = Telnyx::Client.new(api_key: \"My API Key\")\n\nresponse = telnyx.messages.cancel_scheduled(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n\nputs(response)"},{"lang":"PHP","source":"\u003c?php\n\nrequire_once dirname(__DIR__) . '/vendor/autoload.php';\n\nuse Telnyx\\Client;\nuse Telnyx\\Core\\Exceptions\\APIException;\n\n$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');\n\ntry {\n $response = $client->messages->cancelScheduled(\n '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'\n );\n\n var_dump($response);\n} catch (APIException $e) {\n echo $e->getMessage();\n}"},{"lang":"CLI","source":"telnyx messages cancel-scheduled \\\n --api-key 'My API Key' \\\n --id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"6098572f-8881-4908-9135-dfccf71708ae":{"name":"id","in":"path","description":"The id of the message to cancel","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"The id of the message to cancel","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"4e981dcd-a211-4924-89e6-ebf93fc2e164":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"record_type":{"type":"string","example":"message","enum":["message"],"description":"Identifies the type of the resource.","uniqueKey":"record_type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","example":"outbound","enum":["outbound"],"description":"The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.","uniqueKey":"direction","typeLabel":"enum\u003cstring>"},"id":{"type":"string","format":"uuid","description":"Identifies the type of resource.","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["SMS","MMS"],"description":"The type of message.","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"messaging_profile_id":{"type":"string","description":"Unique identifier for a messaging profile.","uniqueKey":"messaging_profile_id","typeLabel":"string"},"organization_id":{"type":"string","format":"uuid","description":"The id of the organization the messaging profile belongs to.","uniqueKey":"organization_id","typeLabel":"string\u003cuuid>"},"from":{"type":"object","properties":{"phone_number":{"type":"string","description":"Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).","x-format":"address","uniqueKey":"from.phone_number","typeLabel":"string"},"carrier":{"type":"string","description":"The carrier of the receiver.","uniqueKey":"from.carrier","typeLabel":"string"},"line_type":{"type":"string","description":"The line-type of the receiver.","enum":["Wireline","Wireless","VoWiFi","VoIP","Pre-Paid Wireless",""],"uniqueKey":"from.line_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"from","typeLabel":"object"},"to":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Receiving address (+E.164 formatted phone number or short code).","x-format":"address","uniqueKey":"to.items.[INDEX].phone_number","typeLabel":"string"},"status":{"type":"string","description":"The delivery status of the message.","enum":["scheduled","queued","sending","sent","cancelled","expired","sending_failed","delivery_unconfirmed","delivered","delivery_failed"],"uniqueKey":"to.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"carrier":{"type":"string","description":"The carrier of the receiver.","uniqueKey":"to.items.[INDEX].carrier","typeLabel":"string"},"line_type":{"type":"string","description":"The line-type of the receiver.","enum":["Wireline","Wireless","VoWiFi","VoIP","Pre-Paid Wireless",""],"uniqueKey":"to.items.[INDEX].line_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"to.items.[INDEX]","typeLabel":"object"},"uniqueKey":"to","typeLabel":"object[]"},"cc":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","description":"Receiving address (+E.164 formatted phone number or short code).","x-format":"address","uniqueKey":"cc.items.[INDEX].phone_number","typeLabel":"string"},"status":{"type":"string","description":"The delivery status of the message.","enum":["scheduled","queued","sending","sent","cancelled","expired","sending_failed","delivery_unconfirmed","delivered","delivery_failed"],"uniqueKey":"cc.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"carrier":{"type":"string","description":"The carrier of the receiver.","uniqueKey":"cc.items.[INDEX].carrier","typeLabel":"string"},"line_type":{"type":"string","description":"The line-type of the receiver.","enum":["Wireline","Wireless","VoWiFi","VoIP","Pre-Paid Wireless",""],"uniqueKey":"cc.items.[INDEX].line_type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cc.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cc","typeLabel":"object[]"},"text":{"type":"string","description":"Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**","uniqueKey":"text","typeLabel":"string"},"num_chars":{"type":"integer","description":"The number of characters in the message text","uniqueKey":"num_chars","typeLabel":"integer"},"subject":{"oneOf":[{"type":"string","description":"Subject of multimedia message","uniqueKey":"subject.oneOf.0","typeLabel":"string"},{"type":"null","description":"Subject of multimedia message","uniqueKey":"subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"subject","typeLabel":"string | null"},"media":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"url","description":"The url of the media requested to be sent.","uniqueKey":"media.items.[INDEX].url","typeLabel":"string\u003curl>"},"content_type":{"oneOf":[{"type":"string","x-format":"mime-type","description":"The MIME type of the requested media.","uniqueKey":"media.items.[INDEX].content_type.oneOf.0","typeLabel":"string"},{"type":"null","x-format":"mime-type","description":"The MIME type of the requested media.","uniqueKey":"media.items.[INDEX].content_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"media.items.[INDEX].content_type","typeLabel":"string | null"},"sha256":{"oneOf":[{"type":"string","description":"The SHA256 hash of the requested media.","uniqueKey":"media.items.[INDEX].sha256.oneOf.0","typeLabel":"string"},{"type":"null","description":"The SHA256 hash of the requested media.","uniqueKey":"media.items.[INDEX].sha256.oneOf.1","typeLabel":"null"}],"uniqueKey":"media.items.[INDEX].sha256","typeLabel":"string | null"},"size":{"oneOf":[{"type":"integer","description":"The size of the requested media.","uniqueKey":"media.items.[INDEX].size.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The size of the requested media.","uniqueKey":"media.items.[INDEX].size.oneOf.1","typeLabel":"null"}],"uniqueKey":"media.items.[INDEX].size","typeLabel":"integer | null"}},"uniqueKey":"media.items.[INDEX]","typeLabel":"object"},"uniqueKey":"media","typeLabel":"object[]"},"webhook_url":{"oneOf":[{"type":"string","format":"url","description":"The URL where webhooks related to this message will be sent.","uniqueKey":"webhook_url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","description":"The URL where webhooks related to this message will be sent.","uniqueKey":"webhook_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_url","typeLabel":"string\u003curl> | null"},"webhook_failover_url":{"oneOf":[{"type":"string","format":"url","description":"The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.","uniqueKey":"webhook_failover_url.oneOf.0","typeLabel":"string\u003curl>"},{"type":"null","format":"url","description":"The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.","uniqueKey":"webhook_failover_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_failover_url","typeLabel":"string\u003curl> | null"},"encoding":{"type":"string","description":"Encoding scheme used for the message body.","uniqueKey":"encoding","typeLabel":"string"},"parts":{"type":"integer","minimum":1,"maximum":10,"description":"Number of parts into which the message's body must be split.","uniqueKey":"parts","typeLabel":"integer"},"tags":{"type":"array","description":"Tags associated with the resource.","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags","typeLabel":"string[]"},"cost":{"oneOf":[{"type":"object","properties":{"amount":{"type":"string","description":"The amount deducted from your account.","x-format":"decimal","uniqueKey":"cost.oneOf.0.amount","typeLabel":"string"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217","uniqueKey":"cost.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"cost.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"amount":{"type":"string","description":"The amount deducted from your account.","x-format":"decimal"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217"}},"uniqueKey":"cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"cost","typeLabel":"object | null"},"cost_breakdown":{"oneOf":[{"type":"object","properties":{"carrier_fee":{"type":"object","properties":{"amount":{"type":"string","description":"The carrier fee amount.","x-format":"decimal","uniqueKey":"cost_breakdown.oneOf.0.carrier_fee.amount","typeLabel":"string"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217","uniqueKey":"cost_breakdown.oneOf.0.carrier_fee.currency","typeLabel":"string"}},"uniqueKey":"cost_breakdown.oneOf.0.carrier_fee","typeLabel":"object"},"rate":{"type":"object","properties":{"amount":{"type":"string","description":"The rate amount applied.","x-format":"decimal","uniqueKey":"cost_breakdown.oneOf.0.rate.amount","typeLabel":"string"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217","uniqueKey":"cost_breakdown.oneOf.0.rate.currency","typeLabel":"string"}},"uniqueKey":"cost_breakdown.oneOf.0.rate","typeLabel":"object"}},"description":"Detailed breakdown of the message cost components.","uniqueKey":"cost_breakdown.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"carrier_fee":{"type":"object","properties":{"amount":{"type":"string","description":"The carrier fee amount.","x-format":"decimal"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217"}}},"rate":{"type":"object","properties":{"amount":{"type":"string","description":"The rate amount applied.","x-format":"decimal"},"currency":{"type":"string","description":"The ISO 4217 currency identifier.","x-format":"iso4217"}}}},"description":"Detailed breakdown of the message cost components.","uniqueKey":"cost_breakdown.oneOf.1","typeLabel":"null"}],"uniqueKey":"cost_breakdown","typeLabel":"object | null"},"tcr_campaign_id":{"oneOf":[{"type":"string","description":"The Campaign Registry (TCR) campaign ID associated with the message.","uniqueKey":"tcr_campaign_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Campaign Registry (TCR) campaign ID associated with the message.","uniqueKey":"tcr_campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tcr_campaign_id","typeLabel":"string | null"},"tcr_campaign_billable":{"type":"boolean","description":"Indicates whether the TCR campaign is billable.","uniqueKey":"tcr_campaign_billable","typeLabel":"boolean"},"tcr_campaign_registered":{"oneOf":[{"type":"string","description":"The registration status of the TCR campaign.","example":"REGISTERED","uniqueKey":"tcr_campaign_registered.oneOf.0","typeLabel":"string"},{"type":"null","description":"The registration status of the TCR campaign.","example":"REGISTERED","uniqueKey":"tcr_campaign_registered.oneOf.1","typeLabel":"null"}],"uniqueKey":"tcr_campaign_registered","typeLabel":"string | null"},"received_at":{"type":"string","format":"date-time","description":"ISO 8601 formatted date indicating when the message request was received.","uniqueKey":"received_at","typeLabel":"string\u003cdate-time>"},"sent_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 formatted date indicating when the message was sent.","uniqueKey":"sent_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 formatted date indicating when the message was sent.","uniqueKey":"sent_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"sent_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","description":"ISO 8601 formatted date indicating when the message was finalized.","uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"ISO 8601 formatted date indicating when the message was finalized.","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"valid_until":{"oneOf":[{"type":"string","description":"Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled","format":"date-time","uniqueKey":"valid_until.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled","format":"date-time","uniqueKey":"valid_until.oneOf.1","typeLabel":"null"}],"uniqueKey":"valid_until","typeLabel":"string\u003cdate-time> | null"},"errors":{"type":"array","description":"These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.","items":{"required":["code","title"],"properties":{"code":{"type":"string","x-format":"integer","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"object","properties":{"pointer":{"description":"JSON pointer (RFC6901) to the offending entity.","type":"string","format":"json-pointer","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string\u003cjson-pointer>"},"parameter":{"description":"Indicates which query parameter caused the error.","type":"string","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"smart_encoding_applied":{"type":"boolean","description":"Indicates whether smart encoding was applied to this message. When `true`, one or more Unicode characters were automatically replaced with GSM-7 equivalents to reduce segment count and cost. The original message text is preserved in webhooks.","uniqueKey":"smart_encoding_applied","typeLabel":"boolean"}},"example":{"record_type":"message","direction":"outbound","id":"40385f64-5717-4562-b3fc-2c963f66afa6","type":"SMS","messaging_profile_id":"4000eba1-a0c0-4563-9925-b25e842a7cb6","organization_id":"b448f9cc-a842-4784-98e9-03c1a5872950","from":{"phone_number":"+18445550001","carrier":"TELNYX LLC","line_type":"VoIP"},"to":[{"phone_number":"+18665550001","status":"cancelled","carrier":"T-MOBILE USA, INC.","line_type":"Wireless"}],"cc":[],"text":"Hello, World!","num_chars":13,"subject":"From Telnyx!","media":[],"webhook_url":"https://www.example.com/hooks","webhook_failover_url":"https://backup.example.com/hooks","encoding":"GSM-7","parts":1,"tags":["Greetings"],"cost":{"amount":"0.0","currency":"USD"},"cost_breakdown":null,"tcr_campaign_id":"TCPA3X7","tcr_campaign_billable":true,"tcr_campaign_registered":"REGISTERED","received_at":"2019-01-23T18:10:02.574Z","sent_at":null,"completed_at":null,"valid_until":null,"errors":[]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"record_type":"message","direction":"outbound","id":"40385f64-5717-4562-b3fc-2c963f66afa6","type":"SMS","messaging_profile_id":"4000eba1-a0c0-4563-9925-b25e842a7cb6","organization_id":"b448f9cc-a842-4784-98e9-03c1a5872950","from":{"phone_number":"+18445550001","carrier":"TELNYX LLC","line_type":"VoIP"},"to":[{"phone_number":"+18665550001","status":"cancelled","carrier":"T-MOBILE USA, INC.","line_type":"Wireless"}],"cc":[],"text":"Hello, World!","num_chars":13,"subject":"From Telnyx!","media":[],"webhook_url":"https://www.example.com/hooks","webhook_failover_url":"https://backup.example.com/hooks","encoding":"GSM-7","parts":1,"tags":["Greetings"],"cost":{"amount":"0.0","currency":"USD"},"cost_breakdown":null,"tcr_campaign_id":"TCPA3X7","tcr_campaign_billable":true,"tcr_campaign_registered":"REGISTERED","received_at":"2019-01-23T18:10:02.574Z","sent_at":null,"completed_at":null,"valid_until":null,"errors":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"1c247c34-79d8-4a3e-bd88-ca3bb12cc1a7":{"description":"Forbidden","content":{"application/json":{"schema":{"required":["code","title"],"properties":{"code":{"type":"string","x-format":"integer","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"source":{"type":"object","properties":{"pointer":{"description":"JSON pointer (RFC6901) to the offending entity.","type":"string","format":"json-pointer","uniqueKey":"source.pointer","typeLabel":"string\u003cjson-pointer>"},"parameter":{"description":"Indicates which query parameter caused the error.","type":"string","uniqueKey":"source.parameter","typeLabel":"string"}},"uniqueKey":"source","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"meta","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>"},"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"7ecd5612-61dc-42a8-a4a5-431fa511818d":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","title"],"properties":{"code":{"type":"string","x-format":"integer","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"source":{"type":"object","properties":{"pointer":{"description":"JSON pointer (RFC6901) to the offending entity.","type":"string","format":"json-pointer","uniqueKey":"source.pointer","typeLabel":"string\u003cjson-pointer>"},"parameter":{"description":"Indicates which query parameter caused the error.","type":"string","uniqueKey":"source.parameter","typeLabel":"string"}},"uniqueKey":"source","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"meta","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","title":"\u003cstring>","detail":"\u003cstring>","source":{"pointer":"\u003cstring>","parameter":"\u003cstring>"},"meta":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"aedb6d0a-e303-450d-ae1c-51932303fe4c":{"description":"Unexpected error","content":{"application/json":{"schema":{"properties":{"errors":{"type":"array","items":{"required":["code","title"],"properties":{"code":{"type":"string","x-format":"integer","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"source":{"type":"object","properties":{"pointer":{"description":"JSON pointer (RFC6901) to the offending entity.","type":"string","format":"json-pointer","uniqueKey":"errors.items.[INDEX].source.pointer","typeLabel":"string\u003cjson-pointer>"},"parameter":{"description":"Indicates which query parameter caused the error.","type":"string","uniqueKey":"errors.items.[INDEX].source.parameter","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].source","typeLabel":"object"},"meta":{"type":"object","uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"type":"object","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"string","title":"string","detail":"string","source":{"pointer":"/data/attributes/phone_number","parameter":"string"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"string","title":"string","detail":"string","source":{"pointer":"/data/attributes/phone_number","parameter":"string"}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7544fab7-727a-47a6-8a6f-08c73de6eb9f":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"4ac8a221-7703-4fe2-b882-63d6e90dec3e":{"url":"https://api.telnyx.com/v2","description":"Version 2.0.0 of the Telnyx API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/source/external/messaging/messaging.json"},"subdomain":"telnyx","siteName":"Telnyx","title":"Cancel a scheduled message - Telnyx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T13:57:22.096Z","originalFileLocation":"api-reference/messages/cancel-a-scheduled-message.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=\"Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled.\">\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=\"Cancel a scheduled message - 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/api-reference/messages/cancel-a-scheduled-message\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://telnyx.mintlify.site/_mintlify/api/og/v2?division=Messages+API\u0026amp;title=Cancel+a+scheduled+message\u0026amp;description=Cancel+a+scheduled+message+that+has+not+yet+been+sent.+Only+messages+with+%60status%3Dscheduled%60+and+%60send_at%60+more+than+a+minute+from+now+can+be+cancelled.\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=d45d2b8312064f55396de1285ac49acc3ffb6e171aae798caf50e3708ff5535f\">\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=\"Cancel a scheduled message - 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.site/_mintlify/api/og/v2?division=Messages+API\u0026amp;title=Cancel+a+scheduled+message\u0026amp;description=Cancel+a+scheduled+message+that+has+not+yet+been+sent.+Only+messages+with+%60status%3Dscheduled%60+and+%60send_at%60+more+than+a+minute+from+now+can+be+cancelled.\u0026amp;theme=0dd46d2166d1a00e34819206\u0026amp;signature=d45d2b8312064f55396de1285ac49acc3ffb6e171aae798caf50e3708ff5535f\">\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/api-reference/messages/cancel-a-scheduled-message\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/messages/cancel-a-scheduled-message.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://telnyx.com/#organization\",\"name\":\"Telnyx\",\"url\":\"https://telnyx.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://telnyx.com/favicon.ico\"},\"sameAs\":[\"https://x.com/telnyx\",\"https://www.linkedin.com/company/telnyx/\",\"https://github.com/team-telnyx\"]},{\"@type\":\"WebSite\",\"@id\":\"https://developers.telnyx.com#website\",\"name\":\"Telnyx\",\"url\":\"https://developers.telnyx.com\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message#webpage\",\"url\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message\",\"name\":\"Cancel a scheduled message\",\"description\":\"Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled.\",\"dateModified\":\"2026-10-29T13:57:22.096Z\",\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sending Messages\",\"item\":\"https://developers.telnyx.com/docs/messaging/messages/send-message/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sending Messages API\",\"item\":\"https://developers.telnyx.com/api-reference/messages/send-a-message\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Messages API\",\"item\":\"https://developers.telnyx.com/api-reference/messages/send-a-message\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Cancel a scheduled message\",\"item\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message#apireference\",\"headline\":\"Cancel a scheduled message\",\"name\":\"Cancel a scheduled message\",\"description\":\"Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled.\",\"url\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message\",\"mainEntityOfPage\":{\"@id\":\"https://developers.telnyx.com/api-reference/messages/cancel-a-scheduled-message#webpage\"},\"dateModified\":\"2026-10-29T13:57:22.096Z\",\"publisher\":{\"@id\":\"https://telnyx.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.telnyx.com#website\"}}]}\u003c/script>","siteName":"Telnyx","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/docs/overview"}]},"products":[{"product":"Home","icon":"house","pages":[{"title":"Home","href":"/docs/overview"}]},{"product":"Other APIs","icon":"ellipsis","pages":[{"title":"Other APIs","href":"/docs/other-apis"}]},{"product":"Agent Platform","icon":"circle-nodes","pages":[{"title":"Agent Platform","href":"/docs/agent-platform"}]},{"product":"AI","icon":"microchip-ai","pages":[{"title":"AI","href":"/docs/inference/models"}]},{"product":"Voice","icon":"waveform","pages":[{"title":"Voice","href":"/docs/voice/overview"}]},{"product":"Compute","icon":"server","pages":[{"title":"Compute","href":"/docs/edge-compute/platform-overview"}]},{"product":"Storage","icon":"hard-drive","pages":[{"title":"Storage","href":"/docs/cloud-storage/overview"}]},{"product":"Virtual Private Cloud","icon":"cloud","pages":[{"title":"Virtual Private Cloud","href":"/docs/virtual-private-cloud"}]},{"product":"Calling","icon":"phone","pages":[{"title":"Calling","href":"/docs/voice/programmable-voice/voice-api-fundamentals"}]},{"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","description":"Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.\n\nThis endpoint allows you to send a message with any messaging resource.\nCurrent messaging resources include: long-code, short-code, number-pool, and\nalphanumeric-sender-id.\n","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","description":"Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an [MDR report.](https://developers.telnyx.com/api-reference/mdr-usage-reports/create-mdr-usage-report)","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","pages":[{"title":"Email","href":"/docs/messaging/email/overview"}]},{"tab":"RCS","icon":"message-dots","pages":[{"title":"RCS","href":"/docs/messaging/rcs/agent-registration"}]},{"tab":"WhatsApp","icon":"whatsapp","pages":[{"title":"WhatsApp","href":"/docs/messaging/whatsapp/quickstart"}]}]},{"product":"Numbers","icon":"hashtag","pages":[{"title":"Numbers","href":"/docs/numbers/phone-numbers/getting-started"}]},{"product":"Wireless","icon":"broadcast-tower","pages":[{"title":"Wireless","href":"/docs/iot-sim/wireless-overview"}]}]},"basePath":"","title":"Cancel a scheduled message - Telnyx","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DcUtcwZ_.js","dist-CJ9Oly2E.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C5EfhVm0.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CxAy5y67.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","AssistantPageLink-Mk6P3qvh.js"]}