Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Notifique","description":"API multicanal para WhatsApp, SMS, e-mail, push e mais. Integre, teste no sandbox e use IA com llms.txt e MCP.","colors":{"primary":"#fbbf24","light":"#fbbf24","dark":"#fbbf24"},"logo":{"light":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/logo/light.png?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=64d67c9a1c52ec357777b5632f714882","dark":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/logo/dark.png?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=2df6ca04be3fb36c080492c1c205975f"},"favicon":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/favicon.svg?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=3ea7b1631da416de0c1a7ee57d439c56","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","go"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"href":"welcome/welcome"},{"language":"en","href":"en/welcome/welcome"},{"language":"es","href":"es/welcome/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tribus","hasAudioNarration":false,"actualSubdomain":"tribus","customDomains":["docs.notifique.dev"],"gitSource":{"type":"github","owner":"notifique-dev","repo":"notifique-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad52bcc29f358e945e24eef","collectionId":"53455186-1186-4cb7-b9b1-ff28dfb2c0ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad52bcc29f358e945e24eef"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad52bcc29f358e945e24eef","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Guias","count":56},{"language":"default","tag":"Automações","count":53},{"language":"en","tag":"WhatsApp","count":50},{"language":"default","tag":"Contatos","count":49},{"language":"pt-BR","tag":"WhatsApp","count":46},{"language":"es","tag":"WhatsApp","count":46},{"language":"pt-BR","tag":"Guias","count":40},{"language":"en","tag":"Guides","count":40},{"language":"es","tag":"Guías","count":40},{"language":"pt-BR","tag":"Automações","count":38},{"language":"en","tag":"Add-ons","count":37},{"language":"en","tag":"Automations","count":35},{"language":"es","tag":"Add-ons","count":35},{"language":"pt-BR","tag":"Add-ons","count":34},{"language":"en","tag":"Instagram","count":33},{"language":"pt-BR","tag":"Instagram","count":32},{"language":"es","tag":"Automatizaciones","count":32},{"language":"es","tag":"Instagram","count":32},{"language":"en","tag":"Contacts","count":29},{"language":"pt-BR","tag":"Contatos","count":28},{"language":"en","tag":"Telegram","count":28},{"language":"es","tag":"Contactos","count":28},{"language":"es","tag":"Telegram","count":27},{"language":"pt-BR","tag":"Telegram","count":25},{"language":"pt-BR","tag":"Instâncias","count":25},{"language":"default","tag":"Voz","count":23},{"language":"en","tag":"Instâncias","count":22},{"language":"es","tag":"Instâncias","count":21},{"language":"default","tag":"Chat","count":21},{"language":"default","tag":"WhatsApp","count":19},{"language":"en","tag":"Mensagens","count":18},{"language":"en","tag":"Voice","count":17},{"language":"es","tag":"Mensagens","count":17},{"language":"pt-BR","tag":"Voz","count":15},{"language":"pt-BR","tag":"Mensagens","count":15},{"language":"es","tag":"Voz","count":15},{"language":"default","tag":"Assistentes","count":14},{"language":"default","tag":"Add-ons","count":14},{"language":"default","tag":"Mensagens","count":13},{"language":"default","tag":"Push","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"byok-sep-25","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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"welcome-hero.css","content":"@keyframes welcome-line-flow{0%{stroke-dashoffset:0}to{stroke-dashoffset:-240}}@keyframes welcome-node-pulse{0%,to{opacity:.55;transform:scale(1)}50%{opacity:1;transform:scale(1.35)}}@keyframes welcome-ring-expand{0%{opacity:.5;transform:scale(.6)}70%,to{opacity:0;transform:scale(2.2)}}@keyframes welcome-glow-drift{0%,to{transform:translate(0,0) scale(1)}33%{transform:translate(24px,-16px) scale(1.05)}66%{transform:translate(-18px,12px) scale(.95)}}@keyframes welcome-grid-pulse{0%,to{opacity:.35}50%{opacity:.9}}.welcome-hero{position:relative;overflow:hidden;text-align:center;padding:96px 24px;margin-bottom:-16px;background:#09090b;-webkit-mask-image:linear-gradient(to bottom,#000 0,#000 calc(100% - 56px),rgba(0,0,0,.98) calc(100% - 49px),rgba(0,0,0,.96) calc(100% - 44px),rgba(0,0,0,.93) calc(100% - 39px),rgba(0,0,0,.89) calc(100% - 34px),rgba(0,0,0,.84) calc(100% - 29px),rgba(0,0,0,.78) calc(100% - 25px),rgba(0,0,0,.71) calc(100% - 21px),rgba(0,0,0,.63) calc(100% - 17px),rgba(0,0,0,.54) calc(100% - 13px),rgba(0,0,0,.44) calc(100% - 10px),rgba(0,0,0,.34) calc(100% - 7px),rgba(0,0,0,.24) calc(100% - 5px),rgba(0,0,0,.15) calc(100% - 3px),rgba(0,0,0,.08) calc(100% - 1px),transparent 100%);mask-image:linear-gradient(to bottom,#000 0,#000 calc(100% - 56px),rgba(0,0,0,.98) calc(100% - 49px),rgba(0,0,0,.96) calc(100% - 44px),rgba(0,0,0,.93) calc(100% - 39px),rgba(0,0,0,.89) calc(100% - 34px),rgba(0,0,0,.84) calc(100% - 29px),rgba(0,0,0,.78) calc(100% - 25px),rgba(0,0,0,.71) calc(100% - 21px),rgba(0,0,0,.63) calc(100% - 17px),rgba(0,0,0,.54) calc(100% - 13px),rgba(0,0,0,.44) calc(100% - 10px),rgba(0,0,0,.34) calc(100% - 7px),rgba(0,0,0,.24) calc(100% - 5px),rgba(0,0,0,.15) calc(100% - 3px),rgba(0,0,0,.08) calc(100% - 1px),transparent 100%);-webkit-mask-size:100% 100%;mask-size:100% 100%}.welcome-hero-bg{position:absolute;inset:0;pointer-events:none;overflow:hidden}.welcome-hero-glow{position:absolute;border-radius:50%;filter:blur(72px);opacity:.45;animation:welcome-glow-drift 18s ease-in-out infinite}.welcome-hero-glow-1{width:420px;height:420px;top:-120px;left:8%;background:rgba(251,191,36,.22);animation-delay:0s}.welcome-hero-glow-2{width:360px;height:360px;top:10%;right:5%;background:rgba(245,158,11,.14);animation-delay:-6s}.welcome-hero-glow-3{width:280px;height:280px;bottom:-40px;left:42%;background:rgba(251,191,36,.1);animation-delay:-12s}.welcome-hero-svg{position:absolute;inset:0;width:100%;height:100%;opacity:.9}.welcome-hero-grid line{stroke:rgba(251,191,36,.06);stroke-width:1}.welcome-hero-grid line:nth-child(odd){animation:welcome-grid-pulse 8s ease-in-out infinite}.welcome-hero-grid line:nth-child(even){animation:welcome-grid-pulse 8s ease-in-out infinite reverse;animation-delay:-4s}.welcome-hero-path{fill:none;stroke:url(#welcome-line-gradient);stroke-width:1.5;stroke-linecap:round;stroke-dasharray:6 14;animation:welcome-line-flow 22s linear infinite}.welcome-hero-path-2{animation-duration:28s;animation-direction:reverse;stroke-dasharray:4 18;opacity:.7}.welcome-hero-path-3{animation-duration:18s;stroke-dasharray:8 10;opacity:.55}.welcome-hero-node{fill:#fbbf24;filter:drop-shadow(0 0 8px rgba(251,191,36,.65));animation:welcome-node-pulse 4s ease-in-out infinite}.welcome-hero-node-2{animation-delay:-1.2s}.welcome-hero-node-3{animation-delay:-2.4s}.welcome-hero-node-4{animation-delay:-.6s}.welcome-hero-node-5{animation-delay:-1.8s}.welcome-hero-node-6{animation-delay:-3s}.welcome-hero-ring{fill:none;stroke:rgba(251,191,36,.2);stroke-width:1;transform-origin:center;animation:welcome-ring-expand 5s ease-out infinite}.welcome-hero-ring-2{animation-delay:-2.5s}.welcome-hero-content{position:relative;z-index:2}@media (prefers-reduced-motion:reduce){.welcome-hero-glow,.welcome-hero-grid line,.welcome-hero-node,.welcome-hero-path,.welcome-hero-ring{animation:none!important}}"}],"page":{"pagePath":"api-reference/calls/start-a-whatsapp-call","slug":"/api-reference/calls/start-a-whatsapp-call","pageMetadata":{"title":"Start a WhatsApp call","description":"Dials the number, speaks text (or plays audio), then hangs up. Available today on **unofficial (QR)** connections. **Official** support is coming soon with the same shape. Types: `speak` (TTS), `play` (audio URL), or `template` (template text/voice).","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/calls","href":"/api-reference/calls/start-a-whatsapp-call","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 strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Dials the number, speaks text (or plays audio), then hangs up. Available today on \", _jsx(_components.strong, {\n children: \"unofficial (QR)\"\n }), \" connections. \", _jsx(_components.strong, {\n children: \"Official\"\n }), \" support is coming soon with the same shape. Types: \", _jsx(_components.code, {\n children: \"speak\"\n }), \" (TTS), \", _jsx(_components.code, {\n children: \"play\"\n }), \" (audio URL), or \", _jsx(_components.code, {\n children: \"template\"\n }), \" (template text/voice).\"]\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":"Start a WhatsApp call","description":"Dials the number, speaks text (or plays audio), then hangs up. Available today on **unofficial (QR)** connections. **Official** support is coming soon with the same shape. Types: `speak` (TTS), `play` (audio URL), or `template` (template text/voice).","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/calls","href":"/api-reference/calls/start-a-whatsapp-call","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Calls"],"summary":"Start a WhatsApp call","description":"Dials the number, speaks text (or plays audio), then hangs up. Available today on **unofficial (QR)** connections. **Official** support is coming soon with the same shape. Types: `speak` (TTS), `play` (audio URL), or `template` (template text/voice).","operationId":"ntfWa_postV1WhatsappCalls","parameters":["1937b65a-be9a-499c-a9da-9b239beec161","a6039cc4-49a4-4cd2-9313-a551604a7829"],"requestBody":"fdb48d0a-e71e-4599-b418-ccd548c62767","responses":{"202":"64ecda80-6a5d-44b2-b317-885ee08a3c83","400":"557d0636-e32f-4879-9029-9b5d67c7d96d","401":"8d0bd630-87a4-4398-928e-e5a92006b30d","402":"dcb57a41-6997-4c13-9e09-12c4f2b64ba8","403":"861ea412-6d26-4743-ab0d-bab724c7d35d"},"method":"post","type":"path","servers":["3d3e488d-9bbb-4a12-a4be-c390fd016d0f"],"security":["800b6fb5-27a3-4c4a-bfd3-a4480ddbd27e","82b67ac3-f2f3-46dd-a43f-15dd83deca0e"],"path":"/v1/whatsapp/calls","baseUrlOptions":["https://api.notifique.dev"],"title":"Start a WhatsApp call","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.type":"speak","body.payload.voice":"female","body.payload.text":"Hi! Your verification code is 1 2 3 4.","body.to.items.0":"5511999999999","body.from":"clxx..."},{"body.type":"play","body.payload.mediaUrl":"https://example.com/notice.mp3","body.to.items.0":"5511999999999","body.from":"clxx..."},{"body.type":"template","body.payload.templateId":"clxx_template...","body.payload.variables.1":"1234","body.payload.variables.name":"Ana","body.to.items.0":"5511999999999","body.from":"clxx..."}]},"dependencies":{"parameters":{"1937b65a-be9a-499c-a9da-9b239beec161":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Idempotency key. Alternative: x-idempotency-key.","uniqueKey":"","typeLabel":"string"},"description":"Idempotency key. Alternative: x-idempotency-key."},"a6039cc4-49a4-4cd2-9313-a551604a7829":{"name":"x-idempotency-key","in":"header","required":false,"schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from","to","type","payload"],"properties":{"type":{"type":"string","enum":["speak","play","template"],"description":"Call content type. Default: speak.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"payload":{"type":"object","additionalProperties":true,"properties":{"voice":{"type":"string","description":"TTS voice hint (female, male, nova, onyx, …).","uniqueKey":"payload.voice","typeLabel":"string"},"mediaUrl":{"type":"string","description":"Public audio URL (type=play).","uniqueKey":"payload.mediaUrl","typeLabel":"string"},"templateId":{"type":"string","description":"Template id (type=template).","uniqueKey":"payload.templateId","typeLabel":"string"},"variables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.variables.additionalProperties","typeLabel":"string"},"description":"Template variables.","properties":{"1":{"type":"string","example":"1234","uniqueKey":"payload.variables.1","typeLabel":"string"},"name":{"type":"string","example":"Ana","uniqueKey":"payload.variables.name","typeLabel":"string"}},"uniqueKey":"payload.variables","typeLabel":"object"},"text":{"type":"string","example":"Hi! Your verification code is 1 2 3 4.","uniqueKey":"payload.text","typeLabel":"string"}},"description":"speak: `text`, opcional `voice`/`language`. play: `audioUrl`. gather: objeto `gather`. template: `templateId`, `variables`.","isRequired":true,"uniqueKey":"payload","typeLabel":"object"},"to":{"type":"array","items":{"type":"string","uniqueKey":"to.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":500,"description":"Destinos E.164 sem `+` (ex.: 5511999887766).","isRequired":true,"uniqueKey":"to","typeLabel":"string[]"},"from":{"type":"string","description":"Instância WhatsApp: id, telefone E.164 ou nome (não use pool).","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"options":{"type":"object","properties":{"maxRingSecs":{"type":"number","uniqueKey":"options.maxRingSecs","typeLabel":"number"},"maxPlaySecs":{"type":"number","uniqueKey":"options.maxPlaySecs","typeLabel":"number"},"autoHangup":{"type":"boolean","uniqueKey":"options.autoHangup","typeLabel":"boolean"}},"uniqueKey":"options","typeLabel":"object"},"clientState":{"type":"string","uniqueKey":"clientState","typeLabel":"string"}},"description":"Chamada de voz: `from`, `to`, `type` e conteúdo em `payload`.","example":{"to":["5511999999999"],"type":"speak","payload":{"voice":"string","mediaUrl":"https://example.com/resource","templateId":"clxx...","variables":{}},"options":{"maxRingSecs":1,"maxPlaySecs":1,"autoHangup":true},"clientState":"string","from":"clxx..."},"uniqueKey":"","typeLabel":"object"},"examples":{"speak":{"title":"speak","description":"Dials, synthesizes speech, hangs up.","value":{"to":["5511999999999"],"type":"speak","payload":{"text":"Hi! Your verification code is 1 2 3 4.","voice":"female"},"from":"clxx..."}},"play":{"title":"play","description":"Dials and plays a public audio URL, then hangs up.","value":{"to":["5511999999999"],"type":"play","payload":{"mediaUrl":"https://example.com/notice.mp3"},"from":"clxx..."}},"template":{"title":"template","description":"Uses a whatsapp_call channel template (text + voice).","value":{"to":["5511999999999"],"type":"template","payload":{"templateId":"clxx_template...","variables":{"1":"1234","name":"Ana"}},"from":"clxx..."}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"64ecda80-6a5d-44b2-b317-885ee08a3c83":{"description":"Call queued.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"messageIds":{"type":"array","items":{"type":"string","uniqueKey":"data.messageIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.messageIds","typeLabel":"string[]"},"messageId":{"type":"string","uniqueKey":"data.messageId","typeLabel":"string"},"status":{"type":"string","example":"QUEUED","uniqueKey":"data.status","typeLabel":"string"},"count":{"type":"integer","uniqueKey":"data.count","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"example":{"success":true,"data":{"messageIds":["clxx..."],"status":"QUEUED","count":1}},"uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"messageIds":["clxx..."],"status":"QUEUED","count":1}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"messageIds":["clxx..."],"status":"QUEUED","count":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"557d0636-e32f-4879-9029-9b5d67c7d96d":{"description":"Invalid parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Message legível para exibir ao usuário (localizada via Accept-Language / x-locale quando aplicável).","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Código estável da API v1 (enum). Sempre presente em erros. Use com o status HTTP para decidir retry ou correção. Ver [Responses de erro](/guides/conceitos/resposta-de-erros).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"}},"required":["success","error","message","code"],"example":{"success":false,"error":"string","message":"string","code":"string","details":[{"field":"string","message":"string"}],"note":"string"},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."}}},"exampleType":"examples"}},"exampleType":"examples"},"8d0bd630-87a4-4398-928e-e5a92006b30d":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Message legível para exibir ao usuário (localizada via Accept-Language / x-locale quando aplicável).","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Código estável da API v1 (enum). Sempre presente em erros. Use com o status HTTP para decidir retry ou correção. Ver [Responses de erro](/guides/conceitos/resposta-de-erros).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"}},"required":["success","error","message","code"],"example":{"success":false,"error":"string","message":"string","code":"string","details":[{"field":"string","message":"string"}],"note":"string"},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."}}},"exampleType":"examples"}},"exampleType":"examples"},"dcb57a41-6997-4c13-9e09-12c4f2b64ba8":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Message legível para exibir ao usuário (localizada via Accept-Language / x-locale quando aplicável).","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Código estável da API v1 (enum). Sempre presente em erros. Use com o status HTTP para decidir retry ou correção. Ver [Responses de erro](/guides/conceitos/resposta-de-erros).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"}},"required":["success","error","message","code"],"example":{"success":false,"error":"string","message":"string","code":"string","details":[{"field":"string","message":"string"}],"note":"string"},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."}}},"exampleType":"examples"}},"exampleType":"examples"},"861ea412-6d26-4743-ab0d-bab724c7d35d":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","description":"Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Message legível para exibir ao usuário (localizada via Accept-Language / x-locale quando aplicável).","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Código estável da API v1 (enum). Sempre presente em erros. Use com o status HTTP para decidir retry ou correção. Ver [Responses de erro](/guides/conceitos/resposta-de-erros).","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"note":{"type":"string","uniqueKey":"note","typeLabel":"string"}},"required":["success","error","message","code"],"example":{"success":false,"error":"string","message":"string","code":"string","details":[{"field":"string","message":"string"}],"note":"string"},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"Bad Request","code":"VALIDATION_ERROR","message":"Campo inválido ou ausente."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"800b6fb5-27a3-4c4a-bfd3-a4480ddbd27e":{"ntfWaBearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API Key no header Authorization. Exemplo: `Authorization: Bearer sk_live_xxxxx`","scopes":[],"schemeName":"ntfWaBearerAuth"}},"82b67ac3-f2f3-46dd-a43f-15dd83deca0e":{"ntfWaApiKeyHeader":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key no header x-api-key.","scopes":[],"schemeName":"ntfWaApiKeyHeader"}}},"servers":{"3d3e488d-9bbb-4a12-a4be-c390fd016d0f":{"url":"https://api.notifique.dev","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"API Key no header Authorization. Exemplo: `Authorization: Bearer sk_live_xxxxx`","scopes":[],"schemeName":"ntfWaBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API Key no header Authorization. Exemplo: `Authorization: Bearer sk_live_xxxxx`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ntfWaBearerAuth","name":"Authorization"}],"title":"ntfWaBearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key no header x-api-key.","scopes":[],"schemeName":"ntfWaApiKeyHeader"},"schema":{"title":"x-api-key","type":"string","description":"API Key no header x-api-key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ntfWaApiKeyHeader","name":"x-api-key"}],"title":"ntfWaApiKeyHeader"}]},"originalFileLocation":"en/whatsapp-api/api-reference/openapi-whatsapp.json"},"subdomain":"tribus","siteName":"Notifique","title":"Start a WhatsApp call - Notifique","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/welcome/welcome","matchLevel":4},"en":{"href":"/api-reference/calls/start-a-whatsapp-call","matchLevel":0},"es":{"href":"/es/welcome/welcome","matchLevel":4}}},"lastModified":"2026-10-18T20:28:29.441Z","originalFileLocation":"api-reference/calls/start-a-whatsapp-call.mdx","locale":"en"},"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=\"Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Notifique\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_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/tribus/lrSzNckWGT07xfjB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start a WhatsApp call - Notifique\">\u003cmeta data-mint-head property=\"og:description\" content=\"Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Notifique\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tribus.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Start+a+WhatsApp+call\u0026amp;description=Dials+the+number%2C+speaks+text+%28or+plays+audio%29%2C+then+hangs+up.+Available+today+on+**unofficial+%28QR%29**+connections.+**Official**+support+is+coming+soon+with+the+\u0026amp;theme=8c9a8f58518c7b0a360dbb49\u0026amp;signature=c0f0aa180bbccde817d38b3940e15569912b3b13f31cfddd787b4d1ad5fca8b4\">\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=\"Start a WhatsApp call - Notifique\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tribus.mintlify.app/_mintlify/api/og/v2?division=Calls\u0026amp;title=Start+a+WhatsApp+call\u0026amp;description=Dials+the+number%2C+speaks+text+%28or+plays+audio%29%2C+then+hangs+up.+Available+today+on+**unofficial+%28QR%29**+connections.+**Official**+support+is+coming+soon+with+the+\u0026amp;theme=8c9a8f58518c7b0a360dbb49\u0026amp;signature=c0f0aa180bbccde817d38b3940e15569912b3b13f31cfddd787b4d1ad5fca8b4\">\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/tribus/lrSzNckWGT07xfjB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Notifique\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#fbbf24\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/calls/start-a-whatsapp-call.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.notifique.dev/#organization\",\"name\":\"Notifique\",\"url\":\"https://docs.notifique.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/logo/light.png?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=64d67c9a1c52ec357777b5632f714882\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.notifique.dev#website\",\"name\":\"Notifique\",\"url\":\"https://docs.notifique.dev\",\"publisher\":{\"@id\":\"https://docs.notifique.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call#webpage\",\"url\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call\",\"name\":\"Start a WhatsApp call\",\"description\":\"Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).\",\"dateModified\":\"2026-10-18T20:28:29.441Z\",\"isPartOf\":{\"@id\":\"https://docs.notifique.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Calls\",\"item\":\"https://docs.notifique.dev/api-reference/calls/list-whatsapp-calls\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start a WhatsApp call\",\"item\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call#apireference\",\"headline\":\"Start a WhatsApp call\",\"name\":\"Start a WhatsApp call\",\"description\":\"Dials the number, speaks text (or plays audio), then hangs up. Available today on unofficial (QR) connections. Official support is coming soon with the same shape. Types: speak (TTS), play (audio URL), or template (template text/voice).\",\"url\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call\",\"mainEntityOfPage\":{\"@id\":\"https://docs.notifique.dev/api-reference/calls/start-a-whatsapp-call#webpage\"},\"dateModified\":\"2026-10-18T20:28:29.441Z\",\"publisher\":{\"@id\":\"https://docs.notifique.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.notifique.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Notifique\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Notifique","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"pages":[{"title":"pt-BR","href":"/welcome/welcome"}]},{"language":"en","tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":"/en/welcome/welcome"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/en/guides/introducao/comece-aqui"}]},{"tab":"WhatsApp","groups":[{"group":"WhatsApp API","pages":[{"title":"Introduction","icon":"whatsapp","href":"/en/whatsapp-api/como-funciona/introducao"},{"title":"Typing indicator","icon":"message-circle","href":"/en/whatsapp-api/como-funciona/presenca"},{"title":"Quick Start","icon":"bolt","href":"/en/whatsapp-api/como-funciona/quick-start"},{"title":"Groups","sidebarTitle":"Groups","icon":"users","href":"/en/whatsapp-api/grupos/introducao"},{"title":"Calls","sidebarTitle":"Calls","icon":"phone","href":"/en/whatsapp-api/chamadas/introducao"},{"title":"Connection modes","icon":"split","href":"/en/whatsapp-api/como-funciona/modos-de-conexao"},{"title":"Anti-ban policy","icon":"lock-hashtag","href":"/en/whatsapp-api/como-funciona/politica-anti-banimento"},{"title":"API Key Scopes","icon":"key","href":"/en/whatsapp-api/como-funciona/escopos-api-key"},{"title":"Webhook Events","icon":"code-merge","href":"/en/whatsapp-api/como-funciona/eventos-do-webhooks"},{"title":"Sending Pools (multiple numbers)","icon":"shuffle","href":"/en/whatsapp-api/como-funciona/sending-pools"}]},{"group":"Instances","pages":[{"title":"Update WhatsApp instance","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instances/update-whatsapp-instance"},{"title":"Sync Meta templates","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/meta/sync-templates","href":"/api-reference/instances/sync-meta-templates"},{"title":"Push template to Meta","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/meta/push-template","href":"/api-reference/instances/push-template-to-meta"}]},{"group":"Groups","pages":[{"title":"Join group via invite link","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/join","href":"/api-reference/groups/join-group-via-invite-link"},{"title":"Group details","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/{groupId}","href":"/api-reference/groups/group-details"},{"title":"Update group","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}/groups/{groupId}","href":"/api-reference/groups/update-group"},{"title":"Create group (legacy)","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/groups","href":"/api-reference/groups/create-group-legacy"},{"title":"Send group message","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/groups/messages","href":"/api-reference/groups/send-group-message"},{"title":"List groups (legacy)","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/{instanceId}/groups","href":"/api-reference/groups/list-groups-legacy"},{"title":"Update groups (legacy)","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/{instanceId}/groups","href":"/api-reference/groups/update-groups-legacy"},{"title":"Create group (legacy path)","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/{instanceId}/groups","href":"/api-reference/groups/create-group-legacy-path"},{"title":"List participants (legacy)","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/{instanceId}/groups/participants","href":"/api-reference/groups/list-participants-legacy"}]},{"group":"Calls","pages":[{"title":"List WhatsApp calls","description":"Shows WhatsApp call history for the workspace. Filter by `instanceId`.","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/calls","href":"/api-reference/calls/list-whatsapp-calls"},{"title":"Start a WhatsApp call","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/calls","href":"/api-reference/calls/start-a-whatsapp-call"},{"title":"Get WhatsApp call","description":"Returns status, duration, hangup reason, and optional call events.","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/calls/{id}","href":"/api-reference/calls/get-whatsapp-call"}]},{"group":"Sending pools","pages":[{"title":"Listar pools","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools","href":"/api-reference/sending-pools/listar-pools"},{"title":"Criar pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/sending-pools","href":"/api-reference/sending-pools/criar-pool"},{"title":"Obter pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools/{id}","href":"/api-reference/sending-pools/obter-pool"},{"title":"Atualizar pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json put /v1/sending-pools/{id}","href":"/api-reference/sending-pools/atualizar-pool"},{"title":"Excluir pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/sending-pools/{id}","href":"/api-reference/sending-pools/excluir-pool"},{"title":"Adicionar membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/sending-pools/{id}/members","href":"/api-reference/sending-pools/adicionar-membro"},{"title":"Atualizar membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json put /v1/sending-pools/{id}/members/{memberId}","href":"/api-reference/sending-pools/atualizar-membro"},{"title":"Remover membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/sending-pools/{id}/members/{memberId}","href":"/api-reference/sending-pools/remover-membro"},{"title":"Stats do pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools/{id}/stats","href":"/api-reference/sending-pools/stats-do-pool"}]},{"group":"Mensagens","pages":[{"title":"List WhatsApp messages","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages","href":"/api-reference/mensagens/list-whatsapp-messages"},{"title":"Send WhatsApp message","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages","href":"/api-reference/mensagens/send-whatsapp-message"},{"title":"Listar recebidos WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound","href":"/api-reference/mensagens/listar-recebidos-whatsapp"},{"title":"Consultar recebido WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound/{id}","href":"/api-reference/mensagens/consultar-recebido-whatsapp"},{"title":"Baixar mídia recebida (base64)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/inbound/{id}/media","href":"/api-reference/mensagens/baixar-mídia-recebida-base64"},{"title":"Baixar mídia recebida (arquivo)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound/{id}/media/download","href":"/api-reference/mensagens/baixar-mídia-recebida-arquivo"},{"title":"Send WhatsApp chat presence","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/presence","href":"/api-reference/mensagens/send-whatsapp-chat-presence"},{"title":"Get WhatsApp status","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/{messageId}","href":"/api-reference/mensagens/get-whatsapp-status"},{"title":"Delete WhatsApp message","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/whatsapp/messages/{messageId}","href":"/api-reference/mensagens/delete-whatsapp-message"},{"title":"Edit WhatsApp message","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/messages/{messageId}/edit","href":"/api-reference/mensagens/edit-whatsapp-message"},{"title":"Cancel scheduled WhatsApp","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/{messageId}/cancel","href":"/api-reference/mensagens/cancel-scheduled-whatsapp"}]},{"group":"Instâncias","pages":[{"title":"List WhatsApp instances","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances","href":"/api-reference/instâncias/list-whatsapp-instances"},{"title":"Create WhatsApp instance","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances","href":"/api-reference/instâncias/create-whatsapp-instance"},{"title":"Get WhatsApp instance","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instâncias/get-whatsapp-instance"},{"title":"Remove WhatsApp instance","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instâncias/remove-whatsapp-instance"},{"title":"WhatsApp connect link status","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/connect-page","href":"/api-reference/instâncias/whatsapp-connect-link-status"},{"title":"Enable WhatsApp connect link","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/enable","href":"/api-reference/instâncias/enable-whatsapp-connect-link"},{"title":"Rotate WhatsApp link secret","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/rotate-secret","href":"/api-reference/instâncias/rotate-whatsapp-link-secret"},{"title":"Disable WhatsApp connect link","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/disable","href":"/api-reference/instâncias/disable-whatsapp-connect-link"},{"title":"Get pairing code","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/pairing-code","href":"/api-reference/instâncias/get-pairing-code"},{"title":"Get WhatsApp QR code","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/qr","href":"/api-reference/instâncias/get-whatsapp-qr-code"},{"title":"Disconnect WhatsApp","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/disconnect","href":"/api-reference/instâncias/disconnect-whatsapp"}]},{"group":"Grupos","pages":[{"title":"List WhatsApp groups","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups","href":"/api-reference/grupos/list-whatsapp-groups"},{"title":"Create WhatsApp group","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups","href":"/api-reference/grupos/create-whatsapp-group"},{"title":"List group participants","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/{groupId}/participants","href":"/api-reference/grupos/list-group-participants"},{"title":"Update group participants","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/participants","href":"/api-reference/grupos/update-group-participants"},{"title":"Send group invite","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/invite","href":"/api-reference/grupos/send-group-invite"},{"title":"Revoke group invite","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/invite/revoke","href":"/api-reference/grupos/revoke-group-invite"},{"title":"Get group invite code","deprecated":null,"version":null,"openapi":"/en/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/invite-code","href":"/api-reference/grupos/get-group-invite-code"}]},{"group":"Chamadas","pages":[{"title":"Settings de chamada","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/calling/settings","href":"/api-reference/chamadas/settings-de-chamada"},{"title":"Atualizar settings","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}/calling/settings","href":"/api-reference/chamadas/atualizar-settings"},{"title":"Permissão de chamada","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/calling/permissions","href":"/api-reference/chamadas/permissão-de-chamada"},{"title":"Solicitar permissão","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/calling/permissions/request","href":"/api-reference/chamadas/solicitar-permissão"}]}]},{"tab":"SMS","pages":[{"title":"SMS","href":"/en/sms-api/como-funciona/introducao"}]},{"tab":"Telegram","pages":[{"title":"Telegram","href":"/en/telegram-api/como-funciona/introducao"}]},{"tab":"Instagram","pages":[{"title":"Instagram","href":"/en/instagram-api/como-funciona/introducao"}]},{"tab":"Email","pages":[{"title":"Email","href":"/en/emails-api/como-funciona/introducao"}]},{"tab":"Push","pages":[{"title":"Push","href":"/en/push-api/como-funciona/introducao"}]},{"tab":"Chat","pages":[{"title":"Chat","href":"/en/chat-api/como-funciona/introducao"}]},{"tab":"RCS","pages":[{"title":"RCS","href":"/en/rcs-api/como-funciona/introducao"}]},{"tab":"Voice","pages":[{"title":"Voice","href":"/en/voice-api/como-funciona/introducao"}]},{"tab":"Web chat","pages":[{"title":"Web chat","href":"/en/ai-web-widget"}]},{"tab":"Templates","pages":[{"title":"Templates","href":"/en/template-api/como-funciona/introducao"}]},{"tab":"Contacts","pages":[{"title":"Contacts","href":"/en/contacts-api/como-funciona/introducao"}]},{"tab":"Automations","pages":[{"title":"Automations","href":"/en/automations-api/como-funciona/introducao"}]},{"tab":"Add-ons","pages":[{"title":"Add-ons","href":"/en/addons"}]}]},{"language":"es","pages":[{"title":"es","href":"/es/welcome/welcome"}]}]},"basePath":"","title":"Start a WhatsApp call - Notifique","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}