Learn how to integrate our APIs into your application.
Basics
Our API is organised around using HTTP verbs and REST. Our API accepts and returns JSON formatted payload.
We provide sample code snippets and API calls that can serve as guide during your integration process.We also advice running some tests using Postman. Postman is a collaboration platform for API development which makes testing endpoints easy. We have also provided a Postman Collection. you can easily import to your postman and start testing.
SDKs
Ship your products faster & in any language you are proficient in by using SDKs provided by our community of open source developers. You can submit & view available ones here.
Your Termii account has its own base URL, which you should use in all API requests.
Your base URL can be found on your dashboard.The base URL is used to route your request to the appropriate “regulatory region” and to optimize traffic between data centers in the region.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"API Documentation","colors":{"primary":"#365899","light":"#0dcbe5","dark":"#365899"},"logo":{"light":"https://developers.termii.com/termii-logo.svg","dark":"https://res.cloudinary.com/dgdteyucq/image/upload/v1737967276/termii/termii-logo-white_nrmqfq.svg"},"favicon":"/favicon.svg","api":{"playground":{}},"navbar":{"links":[{"label":"Login","href":"https://app.termii.com/login"}],"primary":{"type":"button","label":"Signup","href":"https://app.termii.com/register"}},"footer":{"socials":{"facebook":"https://web.facebook.com/termiinetworks/?_rdc=1\u0026_rdr#","x":"https://x.com/termii_network?mx=2","linkedin":"https://web.facebook.com/termiinetworks/?_rdc=1\u0026_rdr#","instagram":"https://www.instagram.com/termii_network/"}},"navigation":{"global":{"anchors":[{"anchor":"Join Loop","icon":"slack","href":"https://termii-loop.slack.com/join/shared_invite/zt-imbqlf68-w4lsPkOzibBXSQohu8_8dQ#/shared-invite/email"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"termiigroup-59c834bb","hasAudioNarration":false,"actualSubdomain":"termiigroup-59c834bb","customDomains":["docs-staging.termii.com"],"gitSource":{"type":"github","owner":"termii-inc","repo":"public-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae922c66d1bf6cfff60570a:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":24},{"language":"default","tag":"Switch","count":20},{"language":"default","tag":"Messaging","count":10},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"Token","count":7},{"language":"default","tag":"Insights","count":6},{"language":"default","tag":"Endpoints","count":5},{"language":"default","tag":"Introduction","count":3},{"language":"default","tag":"Campaign API","count":3},{"language":"default","tag":"Conversations","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/global.css","content":"/* latin-ext */\n@font-face {\n font-family: 'Karla';\n font-style: italic;\n font-weight: 200 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/karla/v33/qkBVXvYC6trAT7RQHtCe4YZO.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Karla';\n font-style: italic;\n font-weight: 200 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/karla/v33/qkBVXvYC6trAT7RQHt6e4Q.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Karla';\n font-style: normal;\n font-weight: 200 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/karla/v33/qkBbXvYC6trAT7RbLtyG5Q.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Karla';\n font-style: normal;\n font-weight: 200 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/karla/v33/qkBbXvYC6trAT7RVLtw.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nbody{font-family:\"Karla\", serif;font-size:1.25rem}.heading{font-size:1.25rem}#header div div{font-size:1rem}ul{font-size:1.25rem}li{font-size:1rem}p{font-size:1rem}span{font-size:1rem}table tr{font-size:1rem}table th{font-size:1rem}a{font-size:1rem}"}],"page":{"pagePath":"api-reference/welcome","slug":"/api-reference/welcome","pageMetadata":{"title":"Welcome","description":"Learn how to integrate our APIs into your application.","icon":"house","href":"/api-reference/welcome"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn how to integrate our APIs into your application.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`basics`,children:`Basics`}),`\n`,_jsx(_components.p,{children:`Our API is organised around using HTTP verbs and REST. Our API accepts and returns JSON formatted payload.\nWe provide sample code snippets and API calls that can serve as guide during your integration process.`}),`\n`,_jsxs(_components.p,{children:[`We also advice running some tests using Postman. Postman is a collaboration platform for API development which makes testing endpoints easy. We have also provided a `,_jsx(_components.a,{href:`https://termii.s3.us-west-1.amazonaws.com/upload/files/UozvGXj5czYEeY4OmE2f.json`,children:`Postman Collection`}),`. you can easily import to your postman and start testing.`]}),`\n`,_jsx(Heading,{level:`2`,id:`sdks`,children:`SDKs`}),`\n`,_jsx(_components.p,{children:`Ship your products faster \u0026 in any language you are proficient in by using SDKs provided by our community of open source developers. You can submit \u0026 view available ones here.`}),`\n`,_jsx(Heading,{level:`2`,id:`api-endpoint`,children:`API Endpoint`}),`\n`,_jsxs(_components.p,{children:[`In order to use Termii’s APIs, you need to first create an account for free at `,_jsx(_components.a,{href:`https://app.termii.com/register`,children:`https://app.termii.com/register.`})]}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base Url`}),`\n`,_jsxs(_components.p,{children:[`Your Termii account has its own base URL, which you should use in all API requests.\nYour base URL can be found on your `,_jsx(_components.a,{href:`https://app.termii.com`,children:`dashboard`}),`.`]}),`\n`,_jsx(_components.p,{children:`The base URL is used to route your request to the appropriate “regulatory region” and to optimize traffic between data centers in the region.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome","description":"Learn how to integrate our APIs into your application.","icon":"house","href":"/api-reference/welcome"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Basics","slug":"basics","depth":2,"children":[]},{"title":"SDKs","slug":"sdks","depth":2,"children":[]},{"title":"API Endpoint","slug":"api-endpoint","depth":2,"children":[]},{"title":"Base Url","slug":"base-url","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/termiigroup-59c834bb/d32ac579c2168b4b/script/support.js"],"subdomain":"termiigroup-59c834bb","siteName":"API Documentation","title":"Welcome - API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:43:49.691Z","originalFileLocation":"api-reference/welcome.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=\"Learn how to integrate our APIs into your application.\">\u003cmeta data-mint-head name=\"application-name\" content=\"API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome - API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to integrate our APIs into your application.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-staging.termii.com/api-reference/welcome\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://termiigroup-59c834bb.mintlify.site/_mintlify/api/og/v2?division=Introduction\u0026amp;title=Welcome\u0026amp;description=Learn+how+to+integrate+our+APIs+into+your+application.\u0026amp;theme=adbe1a4bb33910445def8617\u0026amp;signature=15a987ec86156f47aa7b173c5f221c9f590809b7d8668e2cf7f8636bfa826e20\">\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=\"Welcome - API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to integrate our APIs into your application.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://termiigroup-59c834bb.mintlify.site/_mintlify/api/og/v2?division=Introduction\u0026amp;title=Welcome\u0026amp;description=Learn+how+to+integrate+our+APIs+into+your+application.\u0026amp;theme=adbe1a4bb33910445def8617\u0026amp;signature=15a987ec86156f47aa7b173c5f221c9f590809b7d8668e2cf7f8636bfa826e20\">\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/termiigroup-59c834bb/ARhXvWabvyBbFUuU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#365899\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-staging.termii.com/api-reference/welcome\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/welcome.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs-staging.termii.com/#organization\",\"name\":\"API Documentation\",\"url\":\"https://docs-staging.termii.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://developers.termii.com/termii-logo.svg\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs-staging.termii.com#website\",\"name\":\"API Documentation\",\"url\":\"https://docs-staging.termii.com\",\"publisher\":{\"@id\":\"https://docs-staging.termii.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs-staging.termii.com/api-reference/welcome#webpage\",\"url\":\"https://docs-staging.termii.com/api-reference/welcome\",\"name\":\"Welcome\",\"description\":\"Learn how to integrate our APIs into your application.\",\"dateModified\":\"2026-01-07T04:43:49.691Z\",\"isPartOf\":{\"@id\":\"https://docs-staging.termii.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs-staging.termii.com/api-reference/welcome#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs-staging.termii.com/api-reference/welcome#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Documentation\",\"item\":\"https://docs-staging.termii.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Welcome\",\"item\":\"https://docs-staging.termii.com/api-reference/welcome\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs-staging.termii.com/api-reference/welcome#article\",\"headline\":\"Welcome\",\"name\":\"Welcome\",\"description\":\"Learn how to integrate our APIs into your application.\",\"url\":\"https://docs-staging.termii.com/api-reference/welcome\",\"mainEntityOfPage\":{\"@id\":\"https://docs-staging.termii.com/api-reference/welcome#webpage\"},\"dateModified\":\"2026-01-07T04:43:49.691Z\",\"publisher\":{\"@id\":\"https://docs-staging.termii.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs-staging.termii.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/welcome.md","siteName":"API Documentation","nav":{"global":{"anchors":[{"anchor":"Join Loop","icon":"slack","href":"https://termii-loop.slack.com/join/shared_invite/zt-imbqlf68-w4lsPkOzibBXSQohu8_8dQ#/shared-invite/email"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Welcome","icon":"house","href":"/api-reference/welcome"},{"title":"Authentication","description":"The Termii API uses API keys to authenticate requests. You can view and manage your API keys in the [Termii Dashboard](https://app.termii.com/). API calls are authenticated by including your API key in the body of the request you make. If you do not include your API key when making an API request or use a valid API key, Termii returns a http error.","icon":"lock-keyhole","href":"/api-reference/authentication"},{"title":"Error","icon":"triangle-exclamation","href":"/api-reference/error"}]},{"group":"Endpoints","pages":[{"group":"Messaging","pages":[{"title":"Request a sender id","deprecated":null,"version":null,"openapi":"https://res.cloudinary.com/dgdteyucq/raw/upload/v1744131377/termii/test_kdae1u.json post /api/sender-id/request","href":"/api-reference/messaging/request-a-sender-id"},{"title":"Get_sender_id_just_created","deprecated":null,"version":null,"openapi":"https://res.cloudinary.com/dgdteyucq/raw/upload/v1744131377/termii/test_kdae1u.json get /api/sender-id","href":"/api-reference/messaging/get_sender_id_just_created"},{"title":"Send (number)","deprecated":null,"version":null,"openapi":"https://res.cloudinary.com/dgdteyucq/raw/upload/v1744131377/termii/test_kdae1u.json post /api/sms/send","href":"/api-reference/messaging/send-number"}]},{"group":"Insight","pages":[{"title":"Get Balance","deprecated":null,"version":null,"openapi":"https://res.cloudinary.com/dgdteyucq/raw/upload/v1744131377/termii/test_kdae1u.json get /api/get-balance","href":"/api-reference/insight/get-balance"}]},{"group":"Templates","pages":[{"title":"Template","deprecated":null,"version":null,"openapi":"https://res.cloudinary.com/dgdteyucq/raw/upload/v1744131377/termii/test_kdae1u.json post /api/send/template","href":"/api-reference/templates/template"}]}]}]}]},"basePath":"","title":"Welcome - API Documentation","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}