Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
The ringing event fires when an outgoing call is in progress and the remote partyโs phone is ringing.
Emitted when an outgoing call is ringing (progress). This event means the call is in progress and the remote party hasnโt answered. While the call is ringing, getCurrentSession() returns null. You canโt end or mute the call.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Cognigy Documentation","colors":{"primary":"#4A0D8F","light":"#0066FF","dark":"#2E0459"},"logo":{"light":"https://mintcdn.com/cognigy-15abf2ba/nRSdAucuLUeDXgwa/_assets/NiCE-Cognigy-black-blue.svg?fit=max\u0026auto=format\u0026n=nRSdAucuLUeDXgwa\u0026q=85\u0026s=cbef35aa255935ab747a98d2eb4eead4","dark":"https://mintcdn.com/cognigy-15abf2ba/nRSdAucuLUeDXgwa/_assets/NiCE-Cognigy-white-blue.svg?fit=max\u0026auto=format\u0026n=nRSdAucuLUeDXgwa\u0026q=85\u0026s=33646ad2cfa417ada7987372f8b50a8b"},"favicon":"https://mintcdn.com/cognigy-15abf2ba/Tr3483fnN5xY5EFS/_assets/favicon.webp?fit=max\u0026auto=format\u0026n=Tr3483fnN5xY5EFS\u0026q=85\u0026s=3dc93a88956746e5b4c996fdbf97cd3f","background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://support.cognigy.com/hc/en-us/requests/new","label":"Support"},{"href":"https://docs.cognigy.com/help/cognigy-academy","label":"Cognigy Academy"},{"href":"https://trial.cognigy.ai/","label":"Cognigy Trial"}]},"footer":{"socials":{"youtube":"https://www.youtube.com/c/Cognigy","github":"https://github.com/Cognigy","linkedin":"https://www.linkedin.com/company/cognigy"}},"seo":{"metatags":{"canonical":"https://docs.cognigy.com/"}},"fonts":{"heading":{"family":"Roboto","format":"woff2"},"body":{"family":"Roboto","format":"woff2"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","latex":false},"integrations":{"clarity":{"projectId":"rysaqo5y4v"},"ga4":{"measurementId":"G-DQ0NQDZTS1"},"gtm":{"tagId":"GTM-MKVC98WK"},"telemetry":{"enabled":true},"cookies":{"key":"docs_cookie_consent","value":"accepted"}},"banner":{"content":"Help us improve our product documentation on `docs.cognigy.com` by sharing your thoughts in a [quick survey](https://forms.office.com/e/xnqneVasp2). Your feedback shapes the future of our content!","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cognigy-15abf2ba","hasAudioNarration":false,"actualSubdomain":"cognigy-15abf2ba","customDomains":["docs.cognigy.com"],"gitSource":{"type":"github","owner":"cognigy","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb5010dc817acd47c1b8a3","collectionId":"c7a1a231-53cd-49ef-9ca9-cf72c5a0f45a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb5010dc817acd47c1b8a3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED","enabled":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adb5010dc817acd47c1b8a3","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Cognigy API","count":417},{"language":"default","tag":"Core Resources","count":379},{"language":"default","tag":"Cognigy","count":352},{"language":"default","tag":"AI Agents","count":225},{"language":"default","tag":"Build","count":151},{"language":"default","tag":"Nodes","count":121},{"language":"default","tag":"Release Notes","count":114},{"language":"default","tag":"Tools and Fulfillment","count":112},{"language":"default","tag":"Product Versions","count":112},{"language":"default","tag":"Node Reference","count":107}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true,"maxResults":6}},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"privacy":{"consentBanner":{"enabled":false}},"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":".hero-container{display:grid;grid-template-columns:1fr 1fr 1fr;gap:20px;align-items:start;margin-bottom:2rem}.hero-content{grid-column:1/3}.hero-video{grid-column:3;display:flex;align-items:stretch}@media (max-width:767px){.hero-container{display:flex;flex-direction:column;gap:1rem}.hero-content,.hero-video{grid-column:unset;order:1}.hero-video{order:2;justify-content:center}}.responsive-video-container{position:relative;width:100%;max-width:540px;min-width:320px;aspect-ratio:16/9;margin:0 auto}@media (max-width:767px){.responsive-video-container{width:100%;max-width:400px;min-width:280px;aspect-ratio:16/9;margin:0 auto}}.responsive-video-container iframe{position:absolute;top:0;left:0;width:100%;height:100%;border:0;border-radius:12px;box-shadow:0 2px 16px rgba(0,0,0,.08)}#content-side-layout{margin-left:auto}#content-side-layout #content-area{justify-content:center;padding-right:0;margin-right:3rem;margin-left:3rem;max-width:960px!important;width:100%!important}#content-area{max-width:800px!important;overflow-x:auto;-webkit-overflow-scrolling:touch}img[src*=\"/_assets/icons/\"]{display:inline!important;height:1em!important;vertical-align:text-top!important;margin:0 .1em!important;filter:none!important}.image-center{display:block!important}#content-area,.image-center,table .image-center{margin:0 auto!important}table td .image-center,table th .image-center{margin:0 auto .25rem!important}table thead .image-center{margin:0 auto .1rem!important}.tabs{margin-bottom:1rem}.tabs .tabs{margin-top:.5rem;margin-right:.5rem;margin-left:.5rem;padding:1rem;border-radius:.3rem;box-shadow:0 2px 4px rgba(0,0,0,.185)}.tabs .tabs [data-component-part=tabs-list]{border-bottom:none;margin-bottom:1rem}.tabs .tabs [data-component-part=tab-button]{font-size:.875rem;padding:.75rem 0 .625rem;margin-bottom:-1px;border-bottom:1px solid transparent;color:rgb(var(--gray-600));transition:all .2s ease;font-weight:600;line-height:1.5rem;white-space:nowrap;max-width:max-content}.tabs .tabs [data-component-part=tab-button]:hover{border-bottom-color:rgb(var(--gray-300));color:rgb(var(--gray-900))}.tabs .tabs [data-component-part=tab-button][data-active=true]{border-bottom-color:rgb(var(--primary));color:rgb(var(--primary))}.dark .tabs .tabs{box-shadow:0 2px 4px rgba(255,255,255,.2)}.dark .tabs .tabs [data-component-part=tabs-list]{border-bottom:none;margin-bottom:1rem}.dark .tabs .tabs [data-component-part=tab-button]{font-size:.875rem;padding:.75rem 0 .625rem;margin-bottom:-1px;border-bottom:1px solid transparent;color:rgb(var(--gray-400));transition:all .2s ease;font-weight:600;line-height:1.5rem;white-space:nowrap;max-width:max-content}.dark .tabs .tabs [data-component-part=tab-button]:hover{border-bottom-color:rgb(var(--gray-500));color:rgb(var(--gray-200))}.dark .tabs .tabs [data-component-part=tab-button][data-active=true]{border-bottom-color:rgb(var(--primary-light));color:rgb(var(--primary-light))}#content-area table img[src*=\".svg\"],#content-area td img[src*=\".svg\"],#content-area th img[src*=\".svg\"],#left-side-menu img[src*=\".svg\"],#left-side-menu table img[src*=\".svg\"],#left-side-menu td img[src*=\".svg\"],#left-side-menu th img[src*=\".svg\"]{display:inline!important;height:auto!important;vertical-align:text-top!important;margin:0!important;max-width:none!important;filter:none!important}html.dark #content-area img[src*=\"/deploy/endpoint-reference/a2a.svg\"],html.dark #content-area img[src*=\"/deploy/endpoint-reference/mcp.svg\"],html.dark #content-area img[src*=\"/deploy/endpoint-reference/socket-io.svg\"],html.dark #content-area img[src*=\"/icons/black-and-white/\"],html.dark #content-area table img[src*=\"/icons/black-and-white/\"],html.dark #content-area td img[src*=\"/icons/black-and-white/\"],html.dark #content-area th img[src*=\"/icons/black-and-white/\"],html.dark #left-side-menu img[src*=\"/icons/black-and-white/\"],html.dark #left-side-menu table img[src*=\"/icons/black-and-white/\"],html.dark #left-side-menu td img[src*=\"/icons/black-and-white/\"],html.dark #left-side-menu th img[src*=\"/icons/black-and-white/\"]{filter:invert(1)!important}.dark .nav-dropdown-item-icon img[src*=\"/_assets/icons/dropdown/\"],html.dark #content-area img[src*=\"/icons/blue/\"],html.dark #content-area table img[src*=\"/icons/blue/\"],html.dark #content-area td img[src*=\"/icons/blue/\"],html.dark #content-area th img[src*=\"/icons/blue/\"],html.dark #left-side-menu img[src*=\"/icons/blue/\"],html.dark #left-side-menu table img[src*=\"/icons/blue/\"],html.dark #left-side-menu td img[src*=\"/icons/blue/\"],html.dark #left-side-menu th img[src*=\"/icons/blue/\"]{filter:brightness(0) saturate(100%) invert(27%) sepia(51%) saturate(2878%) hue-rotate(199deg) brightness(104%) contrast(97%)!important}#content-area img[src*=\"/deploy/endpoint-reference/nice-dark.svg\"],#content-area img[src*=\"/escalate/handover-reference/genesys-dark.svg\"],html.dark #content-area img[src*=\"/deploy/endpoint-reference/nice.svg\"]{display:none!important}html.dark #content-area img[src*=\"/deploy/endpoint-reference/nice-dark.svg\"]{display:initial!important}html.dark #content-area img[src*=\"/escalate/handover-reference/genesys.svg\"]{display:none!important}html.dark #content-area img[src*=\"/escalate/handover-reference/genesys-dark.svg\"]{display:initial!important}#content-area table{display:table!important;border-collapse:separate;border-spacing:0;border:.5px solid #d1d5db;border-radius:8px;overflow:visible;margin:.5rem 0;table-layout:fixed;width:auto}#content-area table th{background-color:#f9fafb;font-weight:600}#content-area table td,#content-area table th{border-right:none;border-bottom:.5px solid #d1d5db;padding:.75rem .75rem 1.25rem;overflow-wrap:break-word;word-break:break-word;line-height:1.4}#content-area table td:last-child,#content-area table th:last-child{border-right:none}#content-area table tr:last-child td{border-bottom:none}#content-area table tbody tr:hover{background-color:#f3f4f6;transition:background-color .2s ease}html.dark #content-area table{border-color:#374151}html.dark #content-area table td,html.dark #content-area table th{border-right-color:#374151;border-bottom-color:#374151}html.dark #content-area table th{background-color:#1f2937}html.dark #content-area table tbody tr:hover{background-color:#374151;transition:background-color .2s ease}@media screen and (min-width:60em){.md-search__input{color:inherit;font-size:.65rem}.md-search__suggest{font-size:.65rem}}.mdx-content .frame,.mdx-content div[data-name=frame]{margin-bottom:1.5rem;display:block;width:fit-content;max-width:100%;margin-left:auto;margin-right:auto}.mdx-content .frame>div.relative.rounded-xl.flex.justify-center,.mdx-content div[data-name=frame]>div.relative.rounded-xl.flex.justify-center{display:flex;width:auto;justify-content:center;align-self:flex-start}.mdx-content div.relative.rounded-xl.overflow-hidden.flex.justify-center{align-self:center!important}div.relative.rounded-xl.overflow-hidden.flex.justify-center{align-self:center!important;justify-content:center!important}.mdx-content kbd{display:inline-block;padding:.2em .4em;font-size:.85em;color:#333;background-color:#fafafa;border:1px solid #b8b8b8;border-bottom:2px solid #b8b8b8;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.1);font-family:inherit;font-weight:600;white-space:nowrap}html.dark .mdx-content kbd{color:#e5e5e5;background-color:#374151;border-color:#6b7280}.mdx-content .keys{display:inline-flex;gap:.2em;align-items:center}.mdx-content .keys kbd{margin:0}.centered-iframe{display:block;margin:0 auto}#header{position:relative}#page-context-menu-button,button.group.bg-background-light{position:relative;top:8px}#content-area>div.mdx-content.relative.mt-8.prose.prose-gray.dark\\:prose-invert>a:nth-child(1)>img{margin:.5em!important}#content-area h5{font-variant:small-caps!important;text-transform:lowercase!important;font-weight:700!important;font-size:1.25rem!important;color:#6b7280!important}#content-area h5+p{margin-top:0!important}[data-banner-state=visible] #sidebar{top:2.5rem!important;transition:top .3s ease-in-out}[data-banner-state=visible] #content-area{margin-top:0!important;transition:margin-top .3s ease-in-out}[data-banner-state=hidden] #sidebar{top:0!important;transition:top .3s ease-in-out}[data-banner-state=hidden] #content-area{margin-top:0!important;transition:margin-top .3s ease-in-out}#content-area,#sidebar{transition:top .3s ease-in-out,margin-top .3s ease-in-out}#sidebar{top:0!important}#content-area{margin-top:0!important}.flex.justify-center:has(img[src*=\"img.shields.io\"]),.flex.justify-center:has(img[src*=\"shields.io\"]){justify-content:flex-start!important}a:has(.version-badge),a:has(.version-badge):hover{border-bottom:none!important}.sticky-first-column{position:relative;z-index:1;isolation:isolate;overflow:visible!important}#content-area:has(.sticky-first-column),#content-area:has(.sticky-header-column){overflow-x:visible!important}.sticky-first-column [data-table-wrapper=true]{overflow-x:auto;-webkit-overflow-scrolling:touch}.sticky-first-column table,.sticky-header-column table{border-collapse:separate;border-spacing:0;display:table!important;overflow:visible!important}.sticky-first-column table thead,.sticky-header-column table thead{display:table-header-group}.sticky-first-column table tbody,.sticky-header-column table tbody{display:table-row-group}.sticky-first-column table tr,.sticky-header-column table tr{display:table-row}.sticky-first-column table td,.sticky-first-column table th,.sticky-header-column table td,.sticky-header-column table th{display:table-cell}.sticky-first-column table td .link,.sticky-first-column table td a,.sticky-first-column table td sup,.sticky-header-column table td .link,.sticky-header-column table td a,.sticky-header-column table td sup{position:relative;z-index:auto}.sticky-first-column table td:first-child,.sticky-first-column table th:first-child{position:sticky;left:0!important;background:#fff!important;box-shadow:2px 0 4px rgba(0,0,0,.1)!important;border-left:.5px solid #d1d5db}.sticky-first-column table th:first-child{background:#f9fafb!important;z-index:11;border-top-left-radius:0;border-top:.5px solid #d1d5db}.sticky-first-column table td:first-child{z-index:10}.sticky-first-column table tbody tr:last-child td:first-child,.sticky-header-column table tbody tr:last-child td:first-child{border-bottom-left-radius:0;border-bottom:.5px solid #d1d5db}html.dark .sticky-first-column table th:first-child{background:#1f2937;border-top-color:#374151}html.dark .sticky-first-column table td:first-child,html.dark .sticky-first-column table th:first-child{background:#111827;border-left-color:#374151;box-shadow:2px 0 4px rgba(0,0,0,.3)}html.dark .sticky-first-column table tbody tr:last-child td:first-child,html.dark .sticky-header-column table tbody tr:last-child td:first-child{border-bottom-color:#374151}.sticky-header-column{position:relative;z-index:1;isolation:isolate;overflow:visible!important;--table-max-height:90vh}.sticky-header-column [data-table-wrapper=true]{overflow:auto;max-height:var(--table-max-height);-webkit-overflow-scrolling:touch;padding-top:0!important;padding-bottom:0!important;scrollbar-width:none;-ms-overflow-style:none}.sticky-header-column [data-table-wrapper=true]::-webkit-scrollbar{display:none}.sticky-header-column [data-table-wrapper=true]>div{padding-top:0!important;padding-bottom:0!important}.sticky-header-column table thead th{position:sticky;top:0;background:#f9fafb!important;z-index:10;box-shadow:0 2px 4px rgba(0,0,0,.05)}.sticky-header-column table td:first-child,.sticky-header-column table th:first-child{position:sticky;left:0!important;background:#fff!important;z-index:11;box-shadow:2px 0 4px rgba(0,0,0,.1)!important}.sticky-header-column table thead th:first-child{background:#f9fafb!important;z-index:12;border-top-left-radius:0;border-left:.5px solid #d1d5db;border-top:.5px solid #d1d5db;box-shadow:2px 0 4px rgba(0,0,0,.1),0 2px 4px rgba(0,0,0,.05)!important}.sticky-header-column table thead th:not(:first-child){border-top:.5px solid #d1d5db}.sticky-header-column table thead th:last-child{border-top-right-radius:0;border-right:.5px solid #d1d5db}.sticky-header-column table td:first-child{border-left:.5px solid #d1d5db}html.dark .sticky-header-column table thead th{background:#1f2937!important;border-top-color:#374151;box-shadow:0 2px 4px rgba(0,0,0,.2)}html.dark .sticky-header-column table td:first-child,html.dark .sticky-header-column table th:first-child{background:#111827!important;border-left-color:#374151;box-shadow:2px 0 4px rgba(0,0,0,.3)}html.dark .sticky-header-column table thead th:first-child{background:#1f2937!important;border-top-color:#374151;box-shadow:2px 0 4px rgba(0,0,0,.3),0 2px 4px rgba(0,0,0,.2)}html.dark .sticky-header-column table thead th:last-child{border-right-color:#374151}[data-table-wrapper=true]{margin-top:.25em!important;margin-bottom:.25em!important;padding-top:.5em!important;padding-bottom:.5em!important}html[data-widget-state=open] #banner{right:var(--cognigy-widget-width)!important}html[data-widget-state=open] .cognigy-page-shell{scrollbar-gutter:stable}html[data-widget-state=open] #cognigy-unified-widget-root[data-layout=dock] .unified-widget{border-radius:var(--radius, 16px)!important;border:0!important;box-shadow:0 0 0 1px var(--widget-border, rgba(0,0,0,.08))!important}.video-pause-btn{position:absolute;bottom:8px;right:8px;background:0 0;border:0;border-radius:50%;width:20px;height:20px;cursor:pointer;font-size:14px;display:flex;align-items:center;justify-content:center;padding:0;opacity:.5;transition:opacity .2s ease;color:rgba(0,0,0,.6)}.video-pause-btn:hover{opacity:1}.dark .video-pause-btn{color:rgba(255,255,255,.8)}"},{"filePath":"cognigy.css","content":"html.dark [data-cognigy-webchat-root] .webchat-rating-widget-title,html.dark [data-cognigy-webchat-root] [data-cognigy-webchat].webchat .webchat-privacy-notice-markdown-container{color:#000}html.dark [data-cognigy-webchat-root] [data-cognigy-webchat].webchat #webchatInputMessageInputInTextMode{color:#000!important}html.dark [data-cognigy-webchat-root] [data-cognigy-webchat].webchat #webchatRatingInput{background-color:#fff!important}"},{"filePath":"custom-cookie-banner.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3GUBGEe.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3iUBGEe.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3CUBGEe.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3-UBGEe.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* math */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMawCUBGEe.woff2) format('woff2');\n unicode-range: U+0302-0303, U+0305, U+0307-0308, U+0310, U+0312, U+0315, U+031A, U+0326-0327, U+032C, U+032F-0330, U+0332-0333, U+0338, U+033A, U+0346, U+034D, U+0391-03A1, U+03A3-03A9, U+03B1-03C9, U+03D1, U+03D5-03D6, U+03F0-03F1, U+03F4-03F5, U+2016-2017, U+2034-2038, U+203C, U+2040, U+2043, U+2047, U+2050, U+2057, U+205F, U+2070-2071, U+2074-209F, U+20D0-20DC, U+20E1, U+20E5-20EF, U+2100-2112, U+2114-2115, U+2117-2121, U+2123-214F, U+2190, U+2192, U+2194-21AE, U+21B0-21E5, U+21F1-21F2, U+21F4-2211, U+2213-2214, U+2216-22FF, U+2308-230B, U+2310, U+2319, U+231C-2321, U+2336-237A, U+237C, U+2395, U+239B-23B7, U+23D0, U+23DC-23E1, U+2474-2475, U+25AF, U+25B3, U+25B7, U+25BD, U+25C1, U+25CA, U+25CC, U+25FB, U+266D-266F, U+27C0-27FF, U+2900-2AFF, U+2B0E-2B11, U+2B30-2B4C, U+2BFE, U+3030, U+FF5B, U+FF5D, U+1D400-1D7FF, U+1EE00-1EEFF;\n}\n/* symbols */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMaxKUBGEe.woff2) format('woff2');\n unicode-range: U+0001-000C, U+000E-001F, U+007F-009F, U+20DD-20E0, U+20E2-20E4, U+2150-218F, U+2190, U+2192, U+2194-2199, U+21AF, U+21E6-21F0, U+21F3, U+2218-2219, U+2299, U+22C4-22C6, U+2300-243F, U+2440-244A, U+2460-24FF, U+25A0-27BF, U+2800-28FF, U+2921-2922, U+2981, U+29BF, U+29EB, U+2B00-2BFF, U+4DC0-4DFF, U+FFF9-FFFB, U+10140-1018E, U+10190-1019C, U+101A0, U+101D0-101FD, U+102E0-102FB, U+10E60-10E7E, U+1D2C0-1D2D3, U+1D2E0-1D37F, U+1F000-1F0FF, U+1F100-1F1AE, U+1F1E6-1F1FF, U+1F30D-1F30F, U+1F315, U+1F31C, U+1F31E, U+1F320-1F32C, U+1F336, U+1F378, U+1F37D, U+1F382, U+1F393-1F39F, U+1F3A7-1F3A8, U+1F3AC-1F3AF, U+1F3C2, U+1F3C4-1F3C6, U+1F3CA-1F3CE, U+1F3D4-1F3E0, U+1F3ED, U+1F3F1-1F3F3, U+1F3F5-1F3F7, U+1F408, U+1F415, U+1F41F, U+1F426, U+1F43F, U+1F441-1F442, U+1F444, U+1F446-1F449, U+1F44C-1F44E, U+1F453, U+1F46A, U+1F47D, U+1F4A3, U+1F4B0, U+1F4B3, U+1F4B9, U+1F4BB, U+1F4BF, U+1F4C8-1F4CB, U+1F4D6, U+1F4DA, U+1F4DF, U+1F4E3-1F4E6, U+1F4EA-1F4ED, U+1F4F7, U+1F4F9-1F4FB, U+1F4FD-1F4FE, U+1F503, U+1F507-1F50B, U+1F50D, U+1F512-1F513, U+1F53E-1F54A, U+1F54F-1F5FA, U+1F610, U+1F650-1F67F, U+1F687, U+1F68D, U+1F691, U+1F694, U+1F698, U+1F6AD, U+1F6B2, U+1F6B9-1F6BA, U+1F6BC, U+1F6C6-1F6CF, U+1F6D3-1F6D7, U+1F6E0-1F6EA, U+1F6F0-1F6F3, U+1F6F7-1F6FC, U+1F700-1F80B, U+1F810-1F847, U+1F850-1F859, U+1F860-1F887, U+1F890-1F8AD, U+1F8B0-1F8BB, U+1F8C0-1F8C1, U+1F8D0-1F8D8, U+1F900-1F90B, U+1F93B, U+1F946, U+1F984, U+1F996, U+1F9E9, U+1FA00-1FA6F, U+1FA70-1FA7C, U+1FA80-1FAC6, U+1FAC8, U+1FACC-1FADD, U+1FADF-1FAEB, U+1FAEF-1FAFA, U+1FB00-1FBFF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3OUBGEe.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3KUBGEe.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: 'Roboto';\n font-style: normal;\n font-weight: 400;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3yUBA.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/* cyrillic-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3GUBGEe.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3iUBGEe.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3CUBGEe.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3-UBGEe.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* math */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMawCUBGEe.woff2) format('woff2');\n unicode-range: U+0302-0303, U+0305, U+0307-0308, U+0310, U+0312, U+0315, U+031A, U+0326-0327, U+032C, U+032F-0330, U+0332-0333, U+0338, U+033A, U+0346, U+034D, U+0391-03A1, U+03A3-03A9, U+03B1-03C9, U+03D1, U+03D5-03D6, U+03F0-03F1, U+03F4-03F5, U+2016-2017, U+2034-2038, U+203C, U+2040, U+2043, U+2047, U+2050, U+2057, U+205F, U+2070-2071, U+2074-209F, U+20D0-20DC, U+20E1, U+20E5-20EF, U+2100-2112, U+2114-2115, U+2117-2121, U+2123-214F, U+2190, U+2192, U+2194-21AE, U+21B0-21E5, U+21F1-21F2, U+21F4-2211, U+2213-2214, U+2216-22FF, U+2308-230B, U+2310, U+2319, U+231C-2321, U+2336-237A, U+237C, U+2395, U+239B-23B7, U+23D0, U+23DC-23E1, U+2474-2475, U+25AF, U+25B3, U+25B7, U+25BD, U+25C1, U+25CA, U+25CC, U+25FB, U+266D-266F, U+27C0-27FF, U+2900-2AFF, U+2B0E-2B11, U+2B30-2B4C, U+2BFE, U+3030, U+FF5B, U+FF5D, U+1D400-1D7FF, U+1EE00-1EEFF;\n}\n/* symbols */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMaxKUBGEe.woff2) format('woff2');\n unicode-range: U+0001-000C, U+000E-001F, U+007F-009F, U+20DD-20E0, U+20E2-20E4, U+2150-218F, U+2190, U+2192, U+2194-2199, U+21AF, U+21E6-21F0, U+21F3, U+2218-2219, U+2299, U+22C4-22C6, U+2300-243F, U+2440-244A, U+2460-24FF, U+25A0-27BF, U+2800-28FF, U+2921-2922, U+2981, U+29BF, U+29EB, U+2B00-2BFF, U+4DC0-4DFF, U+FFF9-FFFB, U+10140-1018E, U+10190-1019C, U+101A0, U+101D0-101FD, U+102E0-102FB, U+10E60-10E7E, U+1D2C0-1D2D3, U+1D2E0-1D37F, U+1F000-1F0FF, U+1F100-1F1AE, U+1F1E6-1F1FF, U+1F30D-1F30F, U+1F315, U+1F31C, U+1F31E, U+1F320-1F32C, U+1F336, U+1F378, U+1F37D, U+1F382, U+1F393-1F39F, U+1F3A7-1F3A8, U+1F3AC-1F3AF, U+1F3C2, U+1F3C4-1F3C6, U+1F3CA-1F3CE, U+1F3D4-1F3E0, U+1F3ED, U+1F3F1-1F3F3, U+1F3F5-1F3F7, U+1F408, U+1F415, U+1F41F, U+1F426, U+1F43F, U+1F441-1F442, U+1F444, U+1F446-1F449, U+1F44C-1F44E, U+1F453, U+1F46A, U+1F47D, U+1F4A3, U+1F4B0, U+1F4B3, U+1F4B9, U+1F4BB, U+1F4BF, U+1F4C8-1F4CB, U+1F4D6, U+1F4DA, U+1F4DF, U+1F4E3-1F4E6, U+1F4EA-1F4ED, U+1F4F7, U+1F4F9-1F4FB, U+1F4FD-1F4FE, U+1F503, U+1F507-1F50B, U+1F50D, U+1F512-1F513, U+1F53E-1F54A, U+1F54F-1F5FA, U+1F610, U+1F650-1F67F, U+1F687, U+1F68D, U+1F691, U+1F694, U+1F698, U+1F6AD, U+1F6B2, U+1F6B9-1F6BA, U+1F6BC, U+1F6C6-1F6CF, U+1F6D3-1F6D7, U+1F6E0-1F6EA, U+1F6F0-1F6F3, U+1F6F7-1F6FC, U+1F700-1F80B, U+1F810-1F847, U+1F850-1F859, U+1F860-1F887, U+1F890-1F8AD, U+1F8B0-1F8BB, U+1F8C0-1F8C1, U+1F8D0-1F8D8, U+1F900-1F90B, U+1F93B, U+1F946, U+1F984, U+1F996, U+1F9E9, U+1FA00-1FA6F, U+1FA70-1FA7C, U+1FA80-1FAC6, U+1FAC8, U+1FACC-1FADD, U+1FADF-1FAEB, U+1FAEF-1FAFA, U+1FB00-1FBFF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3OUBGEe.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3KUBGEe.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: 'Roboto';\n font-style: normal;\n font-weight: 600;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/roboto/v51/KFO7CnqEu92Fr1ME7kSn66aGLdTylUAMa3yUBA.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#cookie-banner{position:fixed;bottom:0;left:0;right:0;background:rgba(144,122,167,.9);color:#fff;padding:12px;font-size:1rem;line-height:1.75;font-family:var(--font-family-body-custom, Roboto, sans-serif);-webkit-font-smoothing:antialiased;display:flex;align-items:center;z-index:9999}.cookie-banner-content{display:flex;align-items:center;padding:1rem;gap:16px;width:100%}.cookie-banner-text{flex:1;min-width:0}.cookie-banner-description,.cookie-banner-title{font-size:1rem;line-height:1.75;-webkit-font-smoothing:antialiased}.cookie-banner-title{margin:0 0 6px;font-weight:600;color:#fff;font-family:var(--font-family-headings-custom, Roboto, sans-serif)}.cookie-banner-description{color:rgba(255,255,255,.95);font-family:var(--font-family-body-custom, Roboto, sans-serif)}.cookie-banner-link{color:#a8d1ff;text-decoration:underline}.cookie-banner-accept-btn{background:#fff;color:#000;border:0;padding:15px 80px;cursor:pointer;font-size:1rem;font-weight:100;line-height:1.75;font-family:var(--font-family-body-custom, Roboto, sans-serif);-webkit-font-smoothing:antialiased;border-radius:4px;margin-top:-3rem}.cookie-banner-accept-btn:hover{background:#f0f0f0}html[data-banner-state=visible] body{padding-bottom:120px}html[data-banner-state=hidden] body{padding-bottom:0;transition:padding-bottom .3s ease}"},{"filePath":"single-page-viewer.css","content":".single-page-viewer-container{position:relative;margin-bottom:1rem;transition:all .3s ease;box-sizing:border-box}.single-page-viewer-wrapper{border:1px solid rgba(0,0,0,.1);border-radius:8px;padding:1rem;background:rgba(255,255,255,.7);backdrop-filter:blur(10px) saturate(180%);-webkit-backdrop-filter:blur(10px) saturate(180%);position:relative;box-sizing:border-box}html.dark .single-page-viewer-wrapper{border-color:rgba(255,255,255,.1);background:rgba(0,0,0,.1)}.single-page-viewer-controls{display:flex;justify-content:flex-end;align-items:center;margin-bottom:.75rem;gap:1rem;flex-wrap:wrap}.single-page-viewer-hint{font-size:.875rem;color:rgba(0,0,0,.6);display:flex;align-items:flex-start;gap:.5rem;margin-right:auto;flex:1 1 0;min-width:200px}html.dark .single-page-viewer-hint{color:rgba(255,255,255,.7)}.single-page-viewer-iframe-wrapper{width:100%;height:25rem!important;position:relative;border-radius:4px;border:1px solid rgba(0,0,0,.1);background-color:#fff;scrollbar-width:none;-ms-overflow-style:none}.single-page-viewer-iframe-wrapper::-webkit-scrollbar{display:none}html.dark .single-page-viewer-iframe-wrapper{border-color:rgba(255,255,255,.15)}.single-page-viewer-scale{transform-origin:top left;transition:transform .2s ease}.single-page-viewer-iframe{width:100%;height:100%!important;border:0;display:block}.single-page-viewer-click-blocker{position:absolute;top:0;left:0;right:0;bottom:0;z-index:10;pointer-events:none;cursor:default;background:0 0}.single-page-viewer-iframe-wrapper:has(.single-page-viewer-iframe[srcdoc]) .single-page-viewer-click-blocker{display:none}.single-page-viewer-iframe-wrapper{overflow-y:auto;overflow-x:hidden;-webkit-overflow-scrolling:touch;scroll-behavior:smooth}"},{"filePath":"_assets/unified-widget/unified-widget.css","content":"@keyframes warning-slide-in{0%{opacity:0;max-height:0;padding:0 16px}to{opacity:1;max-height:50px;padding:8px 16px}}@keyframes voice-message-in{0%{opacity:0;transform:translateY(12px)}to{opacity:1;transform:translateY(0)}}@keyframes pill-info-in{0%{opacity:0;transform:translateY(4px)}to{opacity:1;transform:translateY(0)}}@keyframes soundwave-bounce{0%{height:3px}to{height:36px}}@keyframes soundwave-bounce-mid{0%{height:3px}to{height:19px}}@keyframes soundwave-bounce-low{0%{height:3px}to{height:10px}}@keyframes pill-input-in{0%{opacity:0;transform:scaleX(.85)}to{opacity:1;transform:scaleX(1)}}@keyframes chat-msg-in{0%{opacity:0;transform:translateY(12px)}to{opacity:1;transform:translateY(0)}}@keyframes chat-dot-bounce{0%,60%,to{transform:translateY(0);opacity:.4}30%{transform:translateY(-5px);opacity:1}}@keyframes antenna-light{0%,to{opacity:0}50%{opacity:1}}@keyframes feedback-slide-up{0%{opacity:0;transform:translateY(8px)}to{opacity:1;transform:translateY(0)}}@keyframes privacy-notice-spin{to{transform:rotate(360deg)}}.unified-widget,.unified-widget-menu-fab{--widget-bg:#ffffff;--widget-surface:#f4f4f5;--widget-elevated:#e4e4e7;--widget-border:rgba(0, 0, 0, .08);--text-primary:#18181b;--text-secondary:#71717a;--close-bg:rgba(0, 0, 0, .06);--close-bg-hover:rgba(0, 0, 0, .12);--close-color:#3f3f46;--float-btn-bg:var(--widget-surface);--float-btn-color:var(--text-primary);--float-btn-border:#4A0D8F;--widget-outline:#4A0D8F;--widget-glass:rgba(255, 255, 255, .45);--widget-glass-border:rgba(0, 0, 0, .08);--bubble-bg:#ffffff;--bubble-shadow-ring:rgba(74, 13, 143, .12);--bubble-shadow-soft:rgba(0, 0, 0, .12);--bubble-shadow-close:rgba(0, 0, 0, .06);--voice-backdrop:rgba(255, 255, 255, .15);--accent-voice:#3b82f6;--accent-chat:#4A0D8F;--tab-icon-color:#4A0D8F;--pill-bg:#ffffff;--pill-border:rgba(0, 0, 0, .1);--pill-shadow:0 2px 8px rgba(0, 0, 0, .08);--soundwave-color:#7C3AED;--radius:16px;--radius-sm:12px;--font:\"Inter\", -apple-system, BlinkMacSystemFont, sans-serif}.unified-widget-menu-fab[data-theme=dark],.unified-widget[data-theme=dark],[data-theme=dark] .unified-widget,[data-theme=dark] .unified-widget-menu-fab{--widget-bg:#1e1e22;--widget-surface:#26262b;--widget-elevated:#2e2e34;--widget-border:rgba(255, 255, 255, .06);--text-primary:#ffffff;--text-secondary:#a1a1aa;--close-bg:#2e2e34;--close-bg-hover:#44444c;--close-color:#ffffff;--float-btn-bg:var(--widget-surface);--float-btn-color:var(--text-primary);--float-btn-border:#0066FF;--widget-outline:#0066FF;--widget-glass:rgba(30, 30, 34, .92);--widget-glass-border:rgba(255, 255, 255, .08);--bubble-bg:#232328;--bubble-shadow-ring:rgba(0, 102, 255, .15);--bubble-shadow-soft:rgba(0, 0, 0, .4);--bubble-shadow-close:rgba(0, 0, 0, .25);--voice-backdrop:rgba(30, 30, 34, .2);--accent-chat:#0066FF;--tab-icon-color:#0066FF;--soundwave-color:var(--accent-chat);--pill-bg:var(--widget-surface);--pill-border:transparent;--pill-shadow:none}#cognigy-unified-widget-root{pointer-events:none}#cognigy-unified-widget-root .unified-widget,#cognigy-unified-widget-root .unified-widget-menu-fab{pointer-events:auto}#cognigy-unified-widget-root[data-layout=dock] .unified-widget,.unified-widget{border-radius:var(--radius);border:0;backdrop-filter:blur(24px) saturate(1.4);-webkit-backdrop-filter:blur(24px) saturate(1.4);background:var(--widget-glass)}.unified-widget{position:relative;font-family:var(--font);color:var(--text-primary);overflow:hidden;box-shadow:0 8px 32px #0000001f,0 2px 8px #0000000f;width:min(400px,calc(100vw - 48px));max-width:400px;height:580px;max-height:90vh;display:flex;flex-direction:column}#cognigy-unified-widget-root[data-layout=dock] .unified-widget{width:calc(100% - 10px);max-width:none;height:calc(100% - 6px);max-height:none;margin:2px 5px 4px;box-shadow:0 0 0 1px var(--widget-border)}.unified-widget[data-theme=dark],[data-theme=dark] .unified-widget{box-shadow:none;border:1px solid rgba(255,255,255,.06)}.unified-widget__tabs{display:flex;align-items:center;justify-content:center;padding:10px 12px 6px;flex-shrink:0;position:relative}.unified-widget__tab-group{display:flex;background:var(--widget-elevated);border-radius:9999px;padding:3px;gap:2px}.unified-widget__tab{display:inline-flex;align-items:center;gap:6px;padding:7px 16px;border-radius:9999px;border:0;background:0 0;color:var(--text-secondary);font-family:var(--font);font-size:.8rem;font-weight:600;cursor:pointer;transition:background .15s,color .15s;white-space:nowrap}.unified-widget__footer a:hover,.unified-widget__tab:hover{color:var(--text-primary)}.unified-widget__tab--active{background:var(--widget-glass);color:var(--text-primary)}.unified-widget__tab svg{flex-shrink:0;opacity:.55;transition:opacity .15s;stroke:var(--tab-icon-color)}.unified-widget__tab--active svg{opacity:1}.unified-widget__tab-close{position:absolute;right:12px;width:30px;height:30px;border-radius:50%;border:0;background:var(--close-bg);color:var(--close-color);cursor:pointer;display:flex;align-items:center;justify-content:center;flex-shrink:0;transition:background .15s}.unified-widget__tab-close:hover{background:var(--close-bg-hover)}.unified-widget__footer,.unified-widget__switch-warning{flex-shrink:0;text-align:center;font-family:var(--font);color:var(--text-secondary)}.unified-widget__switch-warning{font-size:.75rem;background:var(--widget-elevated);padding:8px 16px;cursor:pointer;animation:warning-slide-in .25s ease}.unified-widget__footer{font-size:.7rem;opacity:.6;padding:6px 0}.unified-widget__footer a{color:var(--text-secondary);text-decoration:underline;text-underline-offset:2px}.unified-widget__body{flex:1;min-height:0;flex-direction:column;overflow:hidden}.voice-view--layout,.voice-view__transcript-wrap{flex:1;display:flex;flex-direction:column;min-height:0}.voice-view--layout{position:relative;overflow:clip}.voice-view__transcript-wrap{width:100%;margin:0 auto;overflow-y:auto;padding:28px 16px 8px;background:0 0;color:var(--text-primary);scrollbar-width:none;-ms-overflow-style:none;-webkit-mask-image:linear-gradient(to bottom,transparent 0,#000 24px,#000 calc(100% - 40px),transparent 100%);mask-image:linear-gradient(to bottom,transparent 0,#000 24px,#000 calc(100% - 40px),transparent 100%)}.voice-view__transcript-wrap::-webkit-scrollbar{display:none}.voice-view__hint{font-size:.875rem;color:var(--text-secondary);margin:0}.voice-view__error{font-size:.875rem;color:#dc2626;margin:0 0 12px}.voice-view__transcript-content{margin-top:auto;width:100%}.voice-view__message{display:flex;flex-direction:column;margin-bottom:12px;animation:voice-message-in .34s cubic-bezier(.22,1,.36,1)}.voice-view__message--user{align-items:flex-end}.voice-view__message-agent{font-size:.6rem;font-weight:600;letter-spacing:.06em;color:var(--text-secondary);margin-bottom:3px;padding-left:2px}.voice-view__message--user .voice-view__message-agent{padding-left:0;padding-right:2px}.voice-view__message--bot .voice-view__message-agent{font-size:.65rem;letter-spacing:.05em;text-transform:uppercase;color:var(--accent-chat)}.voice-view__message-bubble{display:inline-block;max-width:min(85%,320px);padding:10px 14px;border-radius:16px 16px 16px 4px;background:var(--widget-surface);color:var(--text-primary);font-size:.875rem;line-height:1.5;overflow-wrap:anywhere}.voice-view__message--user .voice-view__message-bubble{background:var(--accent-chat);color:#fff;border-radius:16px 16px 4px}.voice-view__message-text{margin:0;font-size:inherit;line-height:inherit;color:inherit;overflow-wrap:anywhere}.voice-view__message-text>:first-child{margin-top:0}.chat-view__bubble--bot p:last-child,.privacy-notice__text p:last-child,.voice-view__message-text>:last-child{margin-bottom:0}.voice-view__message-text p{margin:0 0 .5em}.voice-view__message-text ol,.voice-view__message-text ul{margin:.35em 0;padding-left:1.25em}.voice-view__message-text li{margin:.15em 0}.voice-view__message-text a{color:var(--accent-chat);text-decoration:underline;text-underline-offset:2px;overflow-wrap:anywhere;word-break:break-word}.voice-view__message-text a:hover{opacity:.85}.voice-view__message-text strong{font-weight:700}.voice-view__message-text code{padding:1px 4px;border-radius:4px;background:#0000001a;font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;font-size:.9em;overflow-wrap:anywhere}.voice-view__pill{position:relative;width:calc(100% - 32px);padding:8px;margin:0 auto 16px;background:var(--pill-bg, var(--float-btn-bg));border:1px solid var(--pill-border, transparent);border-radius:9999px;box-shadow:var(--pill-shadow, none)}.voice-view__pill,.voice-view__pill-left{flex-shrink:0;display:flex;align-items:center;gap:10px}.voice-view__pill-avatar-wrap{padding:2px;border-radius:50%;background:var(--accent-chat);flex-shrink:0}.voice-view__pill-avatar-wrap--no-border{background:0 0}.voice-view__pill-avatar,.voice-view__pill-avatar-wrap--in-call{background:linear-gradient(135deg,var(--accent-voice),var(--accent-chat))}.voice-view__pill-avatar{width:42px;height:42px;border-radius:50%;display:flex;align-items:center;justify-content:center;font-size:.7rem;font-weight:700;color:#fff;letter-spacing:.04em}.voice-view__pill-avatar--in-call{background:#18181b}.voice-view__pill-info{flex:1;min-width:0;display:flex;flex-direction:column;gap:2px;animation:pill-info-in .3s ease}.voice-view__pill-name{font-size:1rem;font-weight:600;color:var(--text-primary);line-height:1.1}.voice-view__pill-status{font-size:.7rem;color:var(--text-secondary);letter-spacing:.04em}.voice-view__pill-right{display:flex;align-items:center;gap:8px;flex-shrink:0}.voice-view__pill-btn,.voice-view__pill-call{border-radius:50%;border:0;cursor:pointer;display:flex;align-items:center;justify-content:center;transition:background .15s,transform .1s}.voice-view__pill-call{width:42px;height:42px;background:#22c55e;color:#fff}.voice-view__pill-call:hover{background:#16a34a}.voice-view__pill-call:active{transform:scale(.96)}.voice-view__pill-call svg{width:20px;height:20px}.voice-view__pill-btn{width:36px;height:36px;background:var(--widget-elevated);color:var(--float-btn-color)}.voice-view__pill-btn:hover{background:var(--widget-border)}.voice-view__pill-btn svg{width:17px;height:17px}.voice-view__pill-btn--muted svg{color:#ef4444}.voice-view__pill-btn--end{width:42px;height:42px;background:#ef4444;color:#fff}.voice-view__pill-btn--end:hover{background:#dc2626}.voice-view__pill-btn-svg--hangup{transform:rotate(135deg)}.voice-view__pill-btn--end svg{width:20px;height:20px}.voice-soundwave{display:flex;align-items:center;justify-content:center;gap:2px;width:100%;height:100%}.voice-soundwave__bar{width:3px;height:3px;border-radius:2px;background:var(--soundwave-color)}.voice-soundwave--js .voice-soundwave__bar{transition:none}.voice-soundwave--active .voice-soundwave__bar{animation:soundwave-bounce .8s ease-in-out infinite alternate}.voice-soundwave--active .voice-soundwave__bar:nth-child(1),.voice-soundwave--active .voice-soundwave__bar:nth-child(5){animation-name:soundwave-bounce-low}.voice-soundwave--active .voice-soundwave__bar:nth-child(2),.voice-soundwave--active .voice-soundwave__bar:nth-child(4){animation-name:soundwave-bounce-mid}.voice-view__pill-timer{font-size:.85rem;font-weight:600;font-variant-numeric:tabular-nums;color:var(--text-primary);white-space:nowrap;min-width:38px}.voice-view__pill-input-wrap{flex:1;min-width:0;display:flex;align-items:center;gap:6px;background:var(--widget-elevated);border-radius:9999px;padding:0 6px 0 14px;height:38px;border:1px solid var(--widget-glass-border);transition:border-color .15s,opacity .3s,transform .3s;animation:pill-input-in .35s cubic-bezier(.22,1,.36,1)}.voice-view__pill-input-wrap:focus-within{border-color:var(--widget-elevated)}.voice-view__pill-input{flex:1;min-width:0;background:0 0;border:0;outline:0;font-family:var(--font);font-size:.8125rem;color:var(--text-primary);padding:0}.voice-view__pill-input::placeholder{color:var(--text-secondary);opacity:.55}.voice-view__pill-send{width:26px;height:26px;border-radius:50%;border:0;background:var(--float-btn-border);color:#fff;cursor:pointer;display:flex;align-items:center;justify-content:center;flex-shrink:0;transition:transform .1s;padding:0}.voice-view__pill-send:hover{transform:scale(1.08)}.voice-view__pill-send:active{transform:scale(.92)}.chat-view,.chat-view__messages{flex:1;display:flex;flex-direction:column}.chat-view{min-height:0}.chat-view__messages{overflow-y:auto;padding:28px 16px 8px;-webkit-mask-image:linear-gradient(to bottom,transparent 0,#000 24px,#000 calc(100% - 40px),transparent 100%);mask-image:linear-gradient(to bottom,transparent 0,#000 24px,#000 calc(100% - 40px),transparent 100%);scrollbar-width:thin;scrollbar-color:var(--widget-elevated) transparent}.chat-view__messages::-webkit-scrollbar{width:4px}.chat-view__messages::-webkit-scrollbar-track{background:0 0}.chat-view__messages::-webkit-scrollbar-thumb{background:var(--widget-elevated);border-radius:4px}.chat-view__empty{flex:1;display:flex;flex-direction:column;align-items:center;justify-content:center;text-align:center;color:var(--text-secondary);font-size:.875rem;padding:40px 24px;gap:12px}.chat-view__empty p{margin:0;opacity:.7}.chat-view__msg-group{animation:chat-msg-in .3s cubic-bezier(.22,1,.36,1)}.chat-view__msg{margin-bottom:16px}.chat-view__msg--user{display:flex;flex-direction:column;align-items:flex-end}.chat-view__msg-label{font-size:.65rem;font-weight:600;letter-spacing:.05em;text-transform:uppercase;color:var(--accent-chat);margin-bottom:3px;padding-left:2px}.chat-view__msg-label--user{text-transform:none;letter-spacing:normal;color:var(--text-secondary);padding-left:0;padding-right:2px}.chat-view__bubble{display:inline-block;max-width:85%;border-radius:18px;padding:11px 16px;font-size:.875rem;line-height:1.55;word-break:break-word}.chat-view__bubble--bot{background:0 0;border:0;color:var(--text-primary);text-align:left;border-top-left-radius:6px;padding-left:0;padding-right:0}.chat-view__bubble--user{background:var(--accent-chat);color:#fff;margin-left:auto;border-bottom-right-radius:6px}.chat-view__bubble--bot p{margin:0 0 .5em}.chat-view__bubble--bot a{color:var(--accent-chat);text-decoration:underline}.chat-view__bubble--bot code{background:var(--widget-elevated);padding:1px 5px;border-radius:4px;font-size:.85em}.chat-view__bubble--bot pre{background:var(--widget-elevated);padding:10px 12px;border-radius:8px;overflow-x:auto;margin:6px 0}.chat-view__bubble--bot pre code{background:0 0;padding:0}.chat-view__image{max-width:85%;max-height:220px;border-radius:12px;margin-top:6px;object-fit:cover}.chat-view__btn-group{display:flex;flex-direction:column;gap:6px;margin-top:8px;max-width:85%}.chat-view__btn{display:block;width:100%;padding:9px 14px;border-radius:10px;border:1.5px solid var(--float-btn-border);background:0 0;color:var(--float-btn-border);font-family:var(--font);font-size:.8125rem;font-weight:600;cursor:pointer;text-align:center;transition:background .15s,color .15s}.chat-view__btn:hover,.chat-view__qr:hover{background:var(--float-btn-border);color:#fff}.chat-view__btn--sm{padding:6px 10px;font-size:.75rem;border-radius:8px;width:auto}.chat-view__gallery{display:flex;gap:10px;overflow-x:auto;padding:8px 0 4px;scrollbar-width:none;-ms-overflow-style:none}.chat-view__gallery::-webkit-scrollbar{display:none}.chat-view__gallery-card{min-width:200px;max-width:220px;border-radius:12px;border:1px solid var(--widget-glass-border);background:var(--bubble-bg);overflow:hidden;flex-shrink:0}.chat-view__gallery-img{width:100%;height:120px;object-fit:cover}.chat-view__gallery-body{padding:10px 12px;display:flex;flex-direction:column;gap:4px}.chat-view__gallery-title{font-size:.85rem;font-weight:600;color:var(--text-primary)}.chat-view__gallery-sub{font-size:.75rem;color:var(--text-secondary);line-height:1.4}.chat-view__list{display:flex;flex-direction:column;gap:1px;background:var(--widget-glass-border);border-radius:12px;overflow:hidden;margin-top:8px;max-width:85%}.chat-view__list-item{display:flex;align-items:center;gap:10px;padding:10px 12px;background:var(--bubble-bg)}.chat-view__list-img{width:44px;height:44px;border-radius:8px;object-fit:cover;flex-shrink:0}.chat-view__list-body{flex:1;min-width:0;display:flex;flex-direction:column;gap:2px}.chat-view__list-title{font-size:.85rem;font-weight:600;color:var(--text-primary)}.chat-view__list-sub{font-size:.75rem;color:var(--text-secondary)}.chat-view__qr-wrap{display:flex;flex-wrap:wrap;gap:6px;padding:4px 0 10px}.chat-view__qr{padding:7px 14px;border-radius:9999px;border:1.5px solid var(--float-btn-border);background:0 0;color:var(--float-btn-border);font-family:var(--font);font-size:.8rem;font-weight:600;cursor:pointer;transition:background .15s,color .15s;white-space:nowrap}.chat-view__typing{display:inline-flex!important;align-items:center;gap:4px;padding:12px 0}.chat-view__dot{width:7px;height:7px;border-radius:50%;background:var(--text-secondary);animation:chat-dot-bounce 1.2s ease-in-out infinite}.chat-view__dot:nth-child(2){animation-delay:.15s}.chat-view__dot:nth-child(3){animation-delay:.3s}.chat-view__input-bar{display:flex;align-items:center;gap:8px;padding:10px 12px 14px;border-top:1px solid var(--widget-border);background:0 0;flex-shrink:0}.chat-view__input-avatar-wrap{padding:2px;border-radius:50%;background:var(--tab-icon-color);flex-shrink:0}.chat-view__input-avatar{width:42px;height:42px;border-radius:50%;background:linear-gradient(135deg,var(--accent-voice),var(--accent-chat));display:flex;align-items:center;justify-content:center;color:#fff}.chat-view__input{width:100%;min-width:0;padding:9px 14px;border-radius:9999px;border:1px solid var(--widget-glass-border);background:var(--widget-elevated);color:var(--text-primary);font-family:var(--font);font-size:.85rem;outline:0;transition:border-color .15s,box-shadow .15s}.chat-view__input:focus{border-color:var(--widget-elevated)}.chat-view__feedback-comment::placeholder,.chat-view__input::placeholder{color:var(--text-secondary);opacity:.55}.chat-view__input:disabled{opacity:.5;cursor:not-allowed}.chat-view__send{width:34px;height:34px;border-radius:50%;border:0;background:var(--float-btn-border);color:#fff;cursor:pointer;display:flex;align-items:center;justify-content:center;flex-shrink:0;transition:transform .15s;padding:0}.chat-view__send:hover{transform:scale(1.08)}.chat-view__send:active{transform:scale(.92)}.chat-view__input-wrap{flex:1;min-width:0;position:relative;display:flex;align-items:center}.unified-widget-menu-fab{position:fixed;bottom:24px;right:24px;z-index:9998;width:72px;height:72px;border-radius:50%;border:0;background:linear-gradient(135deg,var(--accent-voice),var(--accent-chat));color:#fff;cursor:pointer;display:flex;align-items:center;justify-content:center;transition:transform .2s ease;padding:0}.unified-widget-menu-fab:hover{transform:scale(1.1)}.unified-widget-menu-fab:active{transform:scale(.96)}.fab-robot__antenna-glow{animation:antenna-light 2s ease-in-out infinite}.pill-robot-wrap{display:flex;align-items:center;justify-content:center}.chat-view__actions{display:flex;gap:2px;margin-top:4px;opacity:0;transition:opacity .15s}.chat-view__msg-group:hover .chat-view__actions,.chat-view__msg-group:last-child .chat-view__actions{opacity:1}.chat-view__action-btn{background:0 0;border:0;padding:4px;cursor:pointer;color:var(--text-secondary);opacity:.45;border-radius:4px;display:flex;align-items:center;justify-content:center;transition:color .15s,opacity .15s,background .15s}.chat-view__action-btn:hover:not(:disabled){opacity:1;color:var(--accent-chat);background:var(--widget-elevated)}.chat-view__action-btn--active{color:var(--accent-chat);opacity:1}.chat-view__action-btn:disabled{cursor:default}.chat-view__feedback-trigger{display:flex;align-items:center;gap:5px;justify-content:center;background:0 0;border:0;padding:6px 0;color:var(--text-secondary);font-family:var(--font);font-size:.72rem;cursor:pointer;opacity:.6;transition:opacity .15s,color .15s;flex-shrink:0}.chat-view__feedback-trigger:hover{opacity:1;color:var(--accent-chat)}.chat-view__feedback{display:flex;flex-direction:column;gap:12px;padding:16px;border-top:1px solid var(--widget-border);flex-shrink:0;background:var(--widget-surface);animation:feedback-slide-up .25s cubic-bezier(.22,1,.36,1)}.chat-view__feedback-header{display:flex;align-items:center;justify-content:space-between}.chat-view__feedback-title{font-size:.8rem;font-weight:600;color:var(--text-primary)}.chat-view__feedback-close{background:0 0;border:0;padding:4px;cursor:pointer;color:var(--text-secondary);border-radius:4px;display:flex;align-items:center;justify-content:center;transition:color .15s,background .15s}.chat-view__feedback-close:hover{color:var(--text-primary);background:var(--widget-elevated)}.chat-view__feedback-thumbs{display:flex;gap:8px;justify-content:center}.chat-view__feedback-thumb{width:44px;height:44px;border-radius:50%;border:1.5px solid var(--widget-border);background:var(--widget-elevated);color:var(--text-secondary);cursor:pointer;display:flex;align-items:center;justify-content:center;transition:border-color .15s,color .15s,background .15s,transform .1s}.chat-view__feedback-thumb:hover{border-color:var(--accent-chat);color:var(--accent-chat);transform:scale(1.06)}.chat-view__feedback-thumb--active{border-color:var(--accent-chat);color:var(--accent-chat);background:var(--widget-bg)}.chat-view__feedback-comment{width:100%;padding:10px 12px;border-radius:10px;border:1px solid var(--widget-border);background:var(--widget-elevated);color:var(--text-primary);font-family:var(--font);font-size:.8rem;line-height:1.5;resize:none;outline:0;transition:border-color .15s;box-sizing:border-box}.chat-view__feedback-comment:focus{border-color:var(--accent-chat)}.chat-view__feedback-send{align-self:flex-end;padding:8px 20px;border-radius:9999px;border:0;background:var(--widget-elevated);color:var(--text-secondary);font-family:var(--font);font-size:.78rem;font-weight:600;cursor:not-allowed;transition:background .15s,color .15s}.chat-view__feedback-send--active{background:var(--accent-chat);color:#fff;cursor:pointer}.chat-view__feedback-send--active:hover{opacity:.9}.chat-view__feedback-thanks{text-align:center;font-size:.85rem;color:var(--accent-chat);font-weight:600;margin:8px 0;animation:feedback-slide-up .3s ease}.unified-widget.privacy-notice__overlay{position:absolute;top:0;left:0;z-index:20;display:flex;align-items:center;justify-content:center;padding:20px 16px;background:#00000073;backdrop-filter:blur(3px);-webkit-backdrop-filter:blur(3px);border:0;box-shadow:none}.privacy-notice__card{display:flex;flex-direction:column;width:calc(100% - 32px);max-width:340px;max-height:calc(100% - 40px);padding:22px 20px;background:var(--widget-bg);color:var(--text-primary);border:1px solid var(--widget-border);border-radius:var(--radius);box-shadow:0 12px 40px #00000059;font-family:var(--font);animation:feedback-slide-up .25s ease}.privacy-notice__title{flex-shrink:0;margin:0 0 10px;font-size:1.05rem;font-weight:700;color:var(--text-primary)}.privacy-notice__text{flex:1;min-height:0;overflow-y:auto;overscroll-behavior:contain;font-size:.875rem;line-height:1.55;color:var(--text-primary);scrollbar-width:thin;scrollbar-color:var(--widget-elevated) transparent}.privacy-notice__text::-webkit-scrollbar{width:4px}.privacy-notice__text::-webkit-scrollbar-track{background:0 0}.privacy-notice__text::-webkit-scrollbar-thumb{background:var(--widget-elevated);border-radius:4px}.privacy-notice__text p{margin:0 0 10px}.privacy-notice__text a{color:var(--accent-chat);text-decoration:underline;text-underline-offset:2px}.privacy-notice__actions{flex-shrink:0;display:flex;flex-direction:column;gap:10px;padding-top:16px}.privacy-notice__accept,.privacy-notice__decline{width:100%;padding:11px 16px;border:0;border-radius:var(--radius-sm);font-family:var(--font);font-size:.875rem;font-weight:600;cursor:pointer;transition:background .15s,opacity .15s,transform .1s}.privacy-notice__accept{background:var(--accent-chat);color:#fff}.privacy-notice__accept:hover{opacity:.92}.privacy-notice__accept:active{transform:scale(.98)}.privacy-notice__decline{background:var(--widget-elevated);color:var(--float-btn-color)}.privacy-notice__decline:hover{background:var(--widget-border)}.privacy-notice__decline:active{transform:scale(.98)}.privacy-notice__link{text-align:center;font-size:.8125rem;color:var(--accent-chat);text-decoration:underline;text-underline-offset:2px}.privacy-notice__accept:focus-visible,.privacy-notice__decline:focus-visible,.privacy-notice__link:focus-visible{outline:2px solid var(--widget-outline);outline-offset:2px}.privacy-notice__loading{position:absolute;top:50%;left:50%;width:28px;height:28px;margin:-14px 0 0 -14px;border-radius:50%;border:3px solid var(--widget-elevated);border-top-color:var(--accent-chat);animation:privacy-notice-spin .8s linear infinite}"}],"page":{"pagePath":"click-to-call/sdk/event-reference/ringing","slug":"/click-to-call/sdk/event-reference/ringing","pageMetadata":{"title":"ringing","description":"The ringing event fires when an outgoing call is in progress and the remote party's phone is ringing.","keywords":["call ringing","outgoing call","call progress","click to call","sdk event"],"sidebarTitle":"ringing","href":"/click-to-call/sdk/event-reference/ringing"},"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: \"The ringing event fires when an outgoing call is in progress and the remote partyโs phone is ringing.\"\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`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Emitted when an outgoing call is ringing (progress). This event means the call is in progress and the remote party hasnโt answered. While the call is ringing, `,_jsx(_components.a,{href:`/click-to-call/sdk/api-reference/get-current-session`,children:_jsx(_components.code,{children:`getCurrentSession()`})}),` returns `,_jsx(_components.code,{children:`null`}),`. You canโt end or mute the call.`]}),`\n`,_jsx(Heading,{level:`2`,id:`category`,children:`Category`}),`\n`,_jsx(_components.p,{children:`Call`}),`\n`,_jsx(Heading,{level:`2`,id:`callback-parameters`,children:`Callback Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`session`})}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/click-to-call/sdk/api-reference/types#callsession`,children:_jsx(_components.code,{children:`CallSession`})})}),_jsx(_components.td,{children:`The current call session.`})]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`client`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`on`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'ringing'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, (`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`session`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`) `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`=>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` console`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`log`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Call is ringing. Session ID:'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`session`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`id`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`more-information`,children:`More Information`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/click-to-call/sdk/event-reference/answered`,children:`answered`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/click-to-call/sdk/event-reference/failed`,children:`failed`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/click-to-call/sdk/api-reference/start-call`,children:`startCall`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/click-to-call/sdk/api-reference/types#callsession`,children:`CallSession`})}),`\n`]})]})}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":"ringing","description":"The ringing event fires when an outgoing call is in progress and the remote party's phone is ringing.","keywords":["call ringing","outgoing call","call progress","click to call","sdk event"],"sidebarTitle":"ringing","href":"/click-to-call/sdk/event-reference/ringing"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Category","slug":"category","depth":2,"children":[]},{"title":"Callback Parameters","slug":"callback-parameters","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]},{"title":"More Information","slug":"more-information","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cognigy-15abf2ba/e26ea8517c55742b/cognigy.js","/_mintlify/custom/cognigy-15abf2ba/d21fbb25f095fd7a/custom-cookie-banner.js","/_mintlify/custom/cognigy-15abf2ba/36b16c5ea655a69a/custom-footer.js","/_mintlify/custom/cognigy-15abf2ba/3c510baa73b34da1/_docs-cli/cli.js","/_mintlify/custom/cognigy-15abf2ba/6dc2271c48fecc51/_docs-cli/commands/validate-internal-links.js","/_mintlify/custom/cognigy-15abf2ba/77a6f6fef1025f1b/single-page-viewer.js","/_mintlify/custom/cognigy-15abf2ba/d79ae6fcfedc7f1d/_docs-cli/commands/format-tables.js","/_mintlify/custom/cognigy-15abf2ba/1916eb35ae5933b3/_docs-cli/commands/validate-external-links.js","/_mintlify/custom/cognigy-15abf2ba/20ce9f7a800f11bb/_assets/unified-widget/unified-widget.iife.js"],"subdomain":"cognigy-15abf2ba","siteName":"Cognigy Documentation","title":"ringing - Cognigy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T12:17:21.376Z","gitLastModified":"2026-10-23T12:16:12.000Z","originalFileLocation":"click-to-call/sdk/event-reference/ringing.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=\"The ringing event fires when an outgoing call is in progress and the remote party\u0026#x27;s phone is ringing.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cognigy 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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"ringing - Cognigy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"The ringing event fires when an outgoing call is in progress and the remote party\u0026#x27;s phone is ringing.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cognigy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cognigy-15abf2ba.mintlify.app/_mintlify/api/og/v2?division=Call+Events\u0026amp;title=ringing\u0026amp;description=The+ringing+event+fires+when+an+outgoing+call+is+in+progress+and+the+remote+party%27s+phone+is+ringing.\u0026amp;theme=021eab00416a8f01314ec9c5\u0026amp;signature=24e384ab21ec66894be97892ad47019e8304d03bd11011eacc196d5d01e8f733\">\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=\"ringing - Cognigy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The ringing event fires when an outgoing call is in progress and the remote party\u0026#x27;s phone is ringing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cognigy-15abf2ba.mintlify.app/_mintlify/api/og/v2?division=Call+Events\u0026amp;title=ringing\u0026amp;description=The+ringing+event+fires+when+an+outgoing+call+is+in+progress+and+the+remote+party%27s+phone+is+ringing.\u0026amp;theme=021eab00416a8f01314ec9c5\u0026amp;signature=24e384ab21ec66894be97892ad47019e8304d03bd11011eacc196d5d01e8f733\">\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/cognigy-15abf2ba/z4BR7JDXl81k5R_q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cognigy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4A0D8F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/click-to-call/sdk/event-reference/ringing.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cognigy.com/#organization\",\"name\":\"Cognigy Documentation\",\"url\":\"https://docs.cognigy.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cognigy-15abf2ba/nRSdAucuLUeDXgwa/_assets/NiCE-Cognigy-black-blue.svg?fit=max\u0026auto=format\u0026n=nRSdAucuLUeDXgwa\u0026q=85\u0026s=cbef35aa255935ab747a98d2eb4eead4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cognigy.com#website\",\"name\":\"Cognigy Documentation\",\"url\":\"https://docs.cognigy.com\",\"publisher\":{\"@id\":\"https://docs.cognigy.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing#webpage\",\"url\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing\",\"name\":\"ringing\",\"description\":\"The ringing event fires when an outgoing call is in progress and the remote party's phone is ringing.\",\"dateModified\":\"2026-10-23T12:16:12.000Z\",\"isPartOf\":{\"@id\":\"https://docs.cognigy.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Click To Call SDK\",\"item\":\"https://docs.cognigy.com/click-to-call/sdk/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Event Reference\",\"item\":\"https://docs.cognigy.com/click-to-call/sdk/event-reference/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Call Events\",\"item\":\"https://docs.cognigy.com/click-to-call/sdk/event-reference/ringing\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"ringing\",\"item\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing#article\",\"headline\":\"ringing\",\"name\":\"ringing\",\"description\":\"The ringing event fires when an outgoing call is in progress and the remote party's phone is ringing.\",\"url\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cognigy.com//click-to-call/sdk/event-reference/ringing#webpage\"},\"dateModified\":\"2026-10-23T12:16:12.000Z\",\"keywords\":\"call ringing, outgoing call, call progress, click to call, sdk event\",\"publisher\":{\"@id\":\"https://docs.cognigy.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cognigy.com#website\"}}]}\u003c/script>","siteName":"Cognigy Documentation","nav":{"global":null,"dropdowns":[{"dropdown":"Cognigy","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/ai-logo.svg","groups":[{"group":"Overview","pages":[{"title":"Cognigy","sidebarTitle":"Cognigy","mode":"wide","href":""},{"group":"About the Cognigy Platform","root":{"title":"About the Cognigy Platform","sidebarTitle":"Overview","href":"/ai/overview/about-cognigy-ai"},"pages":[{"title":"Key Features","href":"/ai/overview/key-features"},{"title":"Cognigy AI Agents","href":"/ai/overview/ai-workforce"},{"group":"User Interface Guide","pages":[{"title":"Main Page","href":"/ai/overview/user-interface/main-page"},{"title":"Project Page","href":"/ai/overview/user-interface/project-page"},{"title":"Resource Pages","href":"/ai/overview/user-interface/resource-pages"}]},{"title":"Cognigy Glossary","sidebarTitle":"Glossary","href":"/ai/overview/glossary"}]},{"title":"Getting Started with AI Agents","sidebarTitle":"Getting Started","href":"/ai/agents/quickstart"}]},{"group":"AI Agents","pages":[{"title":"Agentic AI","href":"/ai/agents/overview"},{"group":"Build","pages":[{"title":"Persona","sidebarTitle":"Persona","href":"/ai/agents/develop/persona"},{"title":"Manage AI Agents","sidebarTitle":"Manage AI Agents","href":"/ai/agents/develop/manage-ai-agents"},{"group":"Tools and Fulfillment","pages":[{"title":"Projects","href":"/ai/agents/develop/projects-and-flows/projects"},{"group":"Flows","root":{"title":"Flows","href":"/ai/agents/develop/projects-and-flows/overview"},"pages":[{"title":"Flow Editor","href":"/ai/agents/develop/projects-and-flows/editor"},{"title":"Collaborative Editing","href":"/ai/agents/develop/projects-and-flows/collab-editing"}]},{"group":"Nodes","root":{"title":"Nodes","sidebarTitle":"Overview","href":"/ai/agents/develop/nodes/overview"},"pages":[{"title":"Node Search","href":"/ai/agents/develop/nodes/node-search"},{"title":"Channels","href":"/ai/agents/develop/nodes/channels"},{"group":"Node Reference","root":{"title":"Node Reference","sidebarTitle":"Overview","href":"/ai/agents/develop/node-reference/overview"},"pages":[{"group":"Basic","root":{"title":"Basic Nodes","href":"/ai/agents/develop/node-reference/basic/overview"},"pages":[{"title":"Say","href":"/ai/agents/develop/node-reference/basic/say"},{"title":"Question","href":"/ai/agents/develop/node-reference/basic/question"},{"title":"Optional Question","href":"/ai/agents/develop/node-reference/basic/optional-question"},{"title":"Debug Message","href":"/ai/agents/develop/node-reference/basic/debug-message"},{"title":"Code","href":"/ai/agents/develop/node-reference/basic/code"}]},{"group":"Logic","root":{"title":"Logic","sidebarTitle":"Logic Nodes","href":"/ai/agents/develop/node-reference/logic/overview"},"pages":[{"title":"Add To Context","href":"/ai/agents/develop/node-reference/logic/add-to-context"},{"title":"Copy Data To Context","href":"/ai/agents/develop/node-reference/logic/copy-data-to-context"},{"title":"Execute Flow","href":"/ai/agents/develop/node-reference/logic/execute-flow"},{"title":"Go To","href":"/ai/agents/develop/node-reference/logic/go-to"},{"title":"If","href":"/ai/agents/develop/node-reference/logic/if"},{"title":"Interval","href":"/ai/agents/develop/node-reference/logic/interval"},{"title":"Lookup","href":"/ai/agents/develop/node-reference/logic/lookup"},{"title":"Once","href":"/ai/agents/develop/node-reference/logic/once"},{"title":"Remove From Context","href":"/ai/agents/develop/node-reference/logic/remove-from-context"},{"title":"Sleep","href":"/ai/agents/develop/node-reference/logic/sleep"},{"title":"Stop and Return","href":"/ai/agents/develop/node-reference/logic/stop-and-return"},{"title":"Switch Locale","href":"/ai/agents/develop/node-reference/logic/switch-locale"},{"title":"Think","href":"/ai/agents/develop/node-reference/logic/think"},{"title":"Wait for Input","href":"/ai/agents/develop/node-reference/logic/wait-for-input"}]},{"group":"AI","root":{"title":"AI","sidebarTitle":"AI Nodes","href":"/ai/agents/develop/node-reference/ai/overview"},"pages":[{"title":"Add Lexicon Keyphrase","href":"/ai/agents/develop/node-reference/ai/add-lexicon-keyphrase"},{"title":"AI Agent","href":"/ai/agents/develop/node-reference/ai/ai-agent"},{"title":"Load AI Agent","href":"/ai/agents/develop/node-reference/ai/load-ai-agent"},{"title":"AI Agent Handover","href":"/ai/agents/develop/node-reference/ai/ai-agent-handover"},{"title":"Clean Text","href":"/ai/agents/develop/node-reference/ai/clean-text"},{"title":"Copy Slots to Context","href":"/ai/agents/develop/node-reference/ai/copy-slots-to-context"},{"title":"Disable Slot Fillers","href":"/ai/agents/develop/node-reference/ai/disable-slot-fillers"},{"title":"Enable Slot Fillers","href":"/ai/agents/develop/node-reference/ai/enable-slot-fillers"},{"title":"Execute Cognigy NLU","href":"/ai/agents/develop/node-reference/ai/execute-cognigy-nlu"},{"title":"Fuzzy Search","href":"/ai/agents/develop/node-reference/ai/fuzzy-search"},{"title":"Match Pattern","href":"/ai/agents/develop/node-reference/ai/match-pattern"},{"title":"Regex Slot Filler","href":"/ai/agents/develop/node-reference/ai/regex-slot-filler"},{"title":"Resolve Tool Action","href":"/ai/agents/develop/node-reference/ai/resolve-tool-action"}]},{"group":"Voice","root":{"title":"Voice Nodes","href":"/ai/agents/develop/node-reference/voice/overview"},"pages":[{"group":"Generic Voice Nodes","root":{"title":"Generic Voice Nodes","href":"/ai/agents/develop/node-reference/voice/generic/overview"},"pages":[{"title":"Barge In - Config","href":"/ai/agents/develop/node-reference/voice/generic/barge-in-config"},{"title":"Continuous ASR - Config","href":"/ai/agents/develop/node-reference/voice/generic/continuous-asr-config"},{"title":"DTMF Collect - Config","href":"/ai/agents/develop/node-reference/voice/generic/dtmf-collect-config"},{"title":"Hang Up","href":"/ai/agents/develop/node-reference/voice/generic/hang-up"},{"title":"Mute Speech Input","href":"/ai/agents/develop/node-reference/voice/generic/mute-speech-input"},{"title":"Play URL","href":"/ai/agents/develop/node-reference/voice/generic/play-url"},{"title":"Send Metadata","href":"/ai/agents/develop/node-reference/voice/generic/send-metadata"},{"title":"Session Speech Parameters Config","sidebarTitle":"Session Speech Parameters - Config","href":"/ai/agents/develop/node-reference/voice/generic/session-speech-parameters-config"},{"title":"Transfer","href":"/ai/agents/develop/node-reference/voice/generic/transfer"},{"title":"User Input Timeout - Config","href":"/ai/agents/develop/node-reference/voice/generic/user-input-timeout-config"}]},{"group":"Voice Gateway","root":{"title":"Voice Gateway Nodes","href":"/ai/agents/develop/node-reference/voice/voice-gateway/overview"},"pages":[{"title":"Call Recording","href":"/ai/agents/develop/node-reference/voice/voice-gateway/call-recording"},{"title":"DTMF","href":"/ai/agents/develop/node-reference/voice/voice-gateway/dtmf"},{"title":"Hang Up","href":"/ai/agents/develop/node-reference/voice/voice-gateway/hangup"},{"title":"Mute Speech Input","href":"/ai/agents/develop/node-reference/voice/voice-gateway/mute-speech-input"},{"title":"Voice Gateway Parameter Details","sidebarTitle":"Parameter Details","href":"/ai/agents/develop/node-reference/voice/voice-gateway/parameter-details"},{"title":"Play","href":"/ai/agents/develop/node-reference/voice/voice-gateway/play"},{"title":"Send Metadata","href":"/ai/agents/develop/node-reference/voice/voice-gateway/send-metadata"},{"title":"Set Session Config","href":"/ai/agents/develop/node-reference/voice/voice-gateway/set-session-config"},{"title":"Transfer","href":"/ai/agents/develop/node-reference/voice/voice-gateway/transfer"}]},{"group":"AudioCodes","root":{"title":"AudioCodes","sidebarTitle":"AudioCodes Nodes","href":"/ai/agents/develop/node-reference/voice/audiocodes/overview"},"pages":[{"title":"Call Recording","href":"/ai/agents/develop/node-reference/voice/audiocodes/call-recording"},{"title":"Hang Up","href":"/ai/agents/develop/node-reference/voice/audiocodes/hangup"},{"title":"Play URL","href":"/ai/agents/develop/node-reference/voice/audiocodes/play-url"},{"title":"Send Metadata","href":"/ai/agents/develop/node-reference/voice/audiocodes/send-meta-data"},{"title":"Send Message","href":"/ai/agents/develop/node-reference/voice/audiocodes/send-message"},{"title":"Set Session Params","sidebarTitle":"Set Session Parameters","href":"/ai/agents/develop/node-reference/voice/audiocodes/set-session-params"},{"title":"Transfer","href":"/ai/agents/develop/node-reference/voice/audiocodes/transfer-vg"}]}]},{"group":"Analytics","root":{"title":"Analytics","sidebarTitle":"Analytics Nodes","href":"/ai/agents/develop/node-reference/analytics/overview"},"pages":[{"title":"Activate Profile","href":"/ai/agents/develop/node-reference/analytics/activate-profile"},{"title":"Add Memory","href":"/ai/agents/develop/node-reference/analytics/add-memory"},{"title":"Blind Mode","tag":"deprecated","href":"/ai/agents/develop/node-reference/analytics/blind-mode"},{"title":"Complete Task","href":"/ai/agents/develop/node-reference/analytics/complete-task"},{"title":"Deactivate Profile","href":"/ai/agents/develop/node-reference/analytics/deactivate-profile"},{"title":"Delete Profile","href":"/ai/agents/develop/node-reference/analytics/delete-profile"},{"title":"Merge Profile","href":"/ai/agents/develop/node-reference/analytics/merge-profile"},{"title":"Overwrite Analytics","href":"/ai/agents/develop/node-reference/analytics/overwrite-analytics"},{"title":"Request Rating","href":"/ai/agents/develop/node-reference/analytics/request-rating"},{"title":"Set Rating","href":"/ai/agents/develop/node-reference/analytics/set-rating"},{"title":"Track Goal","href":"/ai/agents/develop/node-reference/analytics/track-goal"},{"title":"Update Profile","href":"/ai/agents/develop/node-reference/analytics/update-profile"}]},{"group":"CXone","root":{"title":"CXone","sidebarTitle":"Overview","href":"/ai/agents/develop/node-reference/cxone/overview"},"pages":[{"title":"Retrieve Knowledge","href":"/ai/agents/develop/node-reference/cxone/retrieve-knowledge"},{"title":"Send Status to CXone Copilot Node","href":"/ai/agents/develop/node-reference/cxone/send-copilot-status"}]},{"group":"Service","root":{"title":"Service Overview","sidebarTitle":"Service Nodes","href":"/ai/agents/develop/node-reference/service/overview"},"pages":[{"title":"Add Transcript Step","href":"/ai/agents/develop/node-reference/service/add-transcript-step"},{"title":"Check Agent Availability","href":"/ai/agents/develop/node-reference/service/check-agent-availability"},{"title":"Close Handover","href":"/ai/agents/develop/node-reference/service/close-handover"},{"title":"Get Token","href":"/ai/agents/develop/node-reference/service/get-token"},{"title":"Get Transcript","href":"/ai/agents/develop/node-reference/service/get-transcript"},{"title":"Handover to Human Agent","href":"/ai/agents/develop/node-reference/service/handover-to-agent"},{"title":"HTTP Request","href":"/ai/agents/develop/node-reference/service/http-request"},{"title":"Invalidate Token","href":"/ai/agents/develop/node-reference/service/invalidate-token"},{"title":"LLM Prompt","href":"/ai/agents/develop/node-reference/service/llm-prompt"},{"title":"MongoDB","href":"/ai/agents/develop/node-reference/service/mongo-db"},{"title":"MS SQL","href":"/ai/agents/develop/node-reference/service/ms-sql"},{"title":"Set Handover Inactivity","href":"/ai/agents/develop/node-reference/service/set-handover-inactivity"},{"title":"Token Status","href":"/ai/agents/develop/node-reference/service/token-status"},{"title":"Trigger Function","href":"/ai/agents/develop/node-reference/service/trigger-function"}]},{"group":"Data","root":{"title":"Data","sidebarTitle":"Data Nodes","href":"/ai/agents/develop/node-reference/data/overview"},"pages":[{"title":"Datepicker","href":"/ai/agents/develop/node-reference/data/datepicker"},{"title":"Send SMTP Email","href":"/ai/agents/develop/node-reference/data/send-smtp-email"},{"title":"Email Notification","href":"/ai/agents/develop/node-reference/data/email-notification"}]},{"group":"Copilot","root":{"title":"Agent Copilot Nodes","href":"/ai/agents/develop/node-reference/agent-copilot/overview"},"pages":[{"title":"Copilot: Adaptive Card Tile","href":"/ai/agents/develop/node-reference/agent-copilot/set-adaptive-card-tile"},{"title":"Copilot: HTML Tile","href":"/ai/agents/develop/node-reference/agent-copilot/set-html-tile"},{"title":"Copilot: IFrame Tile","href":"/ai/agents/develop/node-reference/agent-copilot/set-iframe-tile"},{"title":"Copilot: Identity Tile","href":"/ai/agents/develop/node-reference/agent-copilot/identity-tile"},{"title":"Copilot: Knowledge Tile","href":"/ai/agents/develop/node-reference/agent-copilot/knowledge-tile"},{"title":"Copilot: Next Action Tile","href":"/ai/agents/develop/node-reference/agent-copilot/next-action-tile"},{"title":"Copilot: Send Data","href":"/ai/agents/develop/node-reference/agent-copilot/send-data"},{"title":"Copilot: Sentiment Tile","href":"/ai/agents/develop/node-reference/agent-copilot/sentiment-tile"},{"title":"Copilot: Set Grid","href":"/ai/agents/develop/node-reference/agent-copilot/set-grid"},{"title":"Copilot: Transcript Tile","href":"/ai/agents/develop/node-reference/agent-copilot/transcript-tile"}]},{"group":"xApps","root":{"title":"xApp Nodes","href":"/ai/agents/develop/node-reference/xApp/overview"},"pages":[{"title":"xApp: Init Session","href":"/ai/agents/develop/node-reference/xApp/init-xApp-session"},{"title":"xApp: Get Session PIN","href":"/ai/agents/develop/node-reference/xApp/get-xApp-session-PIN"},{"title":"xApp: Show Adaptive Card","href":"/ai/agents/develop/node-reference/xApp/set-AdaptiveCard-xApp-state"},{"title":"xApp: Show HTML","href":"/ai/agents/develop/node-reference/xApp/set-html-xApp-state"}]},{"group":"Other Nodes","root":{"title":"Other Nodes","href":"/ai/agents/develop/node-reference/other-nodes/overview"},"pages":[{"title":"LLM Entity Extract","href":"/ai/agents/develop/node-reference/other-nodes/llm-entity-extract"},{"title":"Log Message","href":"/ai/agents/develop/node-reference/other-nodes/log-message"},{"title":"Search Extract Output","href":"/ai/agents/develop/node-reference/other-nodes/search-extract-output"},{"title":"Set Translation","href":"/ai/agents/develop/node-reference/other-nodes/set-translation"}]}]}]}]},{"group":"Knowledge AI","root":{"title":"Knowledge AI","sidebarTitle":"Overview","href":"/ai/agents/develop/knowledge-ai/overview"},"pages":[{"title":"Activate Knowledge AI","href":"/ai/agents/develop/knowledge-ai/activate"},{"title":"Getting started with Knowledge AI","sidebarTitle":"Getting Started","href":"/ai/agents/develop/knowledge-ai/getting-started"},{"title":"Knowledge Store","href":"/ai/agents/develop/knowledge-ai/knowledge-store"},{"title":"Knowledge Connectors","sidebarTitle":"Knowledge Connectors","href":"/ai/agents/develop/knowledge-ai/knowledge-connectors"},{"group":"Knowledge Source","root":{"title":"Knowledge Source","sidebarTitle":"Overview","href":"/ai/agents/develop/knowledge-ai/knowledge-source/overview"},"pages":[{"group":"Text Formats","pages":[{"title":"Cognigy Text Format","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-formats/ctxt"},{"title":"PDF","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-formats/pdf"},{"title":"Web Page","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-formats/web-page"}]},{"group":"Text Extraction","root":{"title":"Text Extraction with Content Parsers","sidebarTitle":"Overview","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-extraction/overview"},"pages":[{"title":"Basic Parser","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-extraction/basic-parser"},{"title":"Advanced Parser","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-extraction/advanced-parser"},{"title":"Azure AI Document Intelligence","href":"/ai/agents/develop/knowledge-ai/knowledge-source/text-extraction/azure-ai"}]},{"title":"Knowledge Source Tags","href":"/ai/agents/develop/knowledge-ai/knowledge-source/knowledge-source-tags"}]},{"group":"Knowledge Chunk","root":{"title":"Knowledge Chunk","sidebarTitle":"Overview","href":"/ai/agents/develop/knowledge-ai/knowledge-chunk/knowledge-chunk"},"pages":[{"title":"Chunk Editor","sidebarTitle":"Knowledge Chunk Editor","href":"/ai/agents/develop/knowledge-ai/knowledge-chunk/knowledge-chunk-editor"}]},{"group":"Knowledge Search and Extraction","pages":[{"title":"Search Extract Output Node","href":"/ai/agents/develop/knowledge-ai/knowledge-search-and-extraction/search-extract-output"},{"title":"Copilot: Knowledge Tile Node","href":"/ai/agents/develop/knowledge-ai/knowledge-search-and-extraction/agent-copilot-knowledge"}]},{"title":"Migration from Weaviate to Qdrant: Distance Value Change","href":"/ai/agents/develop/knowledge-ai/distance-value-change-after-migration"}]},{"group":"AI Agent Memory","root":{"title":"AI Agent Memory","sidebarTitle":"Overview","href":"/ai/agents/develop/ai-agent-memory/overview"},"pages":[{"title":"Input","href":"/ai/agents/develop/ai-agent-memory/input"},{"title":"Context","href":"/ai/agents/develop/ai-agent-memory/context"},{"title":"Profile","href":"/ai/agents/develop/ai-agent-memory/profile"}]},{"group":"Generative AI and LLMs","pages":[{"title":"Large Language Models (LLMs)","sidebarTitle":"LLMs","href":"/ai/agents/develop/gen-ai-and-llms/llms"},{"title":"Generative AI","href":"/ai/agents/develop/gen-ai-and-llms/generative-ai"},{"title":"Model Support by Feature","mode":"wide","href":"/ai/agents/develop/gen-ai-and-llms/model-support-by-feature"},{"group":"Providers","pages":[{"title":"All LLM Providers","href":"/ai/agents/develop/gen-ai-and-llms/providers/all-providers"},{"title":"Cognigy Platform-Provided LLM","href":"/ai/agents/develop/gen-ai-and-llms/providers/cognigy-platform-provided"},{"title":"Microsoft Azure OpenAI","href":"/ai/agents/develop/gen-ai-and-llms/providers/microsoft-azure-openai"},{"title":"OpenAI","href":"/ai/agents/develop/gen-ai-and-llms/providers/openai"},{"title":"OpenAI-Compatible LLMs","href":"/ai/agents/develop/gen-ai-and-llms/providers/openai-compatible"},{"title":"Anthropic","href":"/ai/agents/develop/gen-ai-and-llms/providers/anthropic"},{"title":"Google Vertex AI","href":"/ai/agents/develop/gen-ai-and-llms/providers/google-vertex-ai"},{"title":"Google Gemini","href":"/ai/agents/develop/gen-ai-and-llms/providers/google-gemini"},{"title":"Google GenAI","hidden":false,"href":"/ai/agents/develop/gen-ai-and-llms/providers/google-genai"},{"title":"Aleph Alpha","href":"/ai/agents/develop/gen-ai-and-llms/providers/aleph-alpha"},{"title":"Amazon Bedrock","href":"/ai/agents/develop/gen-ai-and-llms/providers/amazon-bedrock"},{"title":"Mistral AI","href":"/ai/agents/develop/gen-ai-and-llms/providers/mistral"}]},{"title":"LLM Fallback","href":"/ai/agents/develop/gen-ai-and-llms/fallback"},{"title":"Large Language Model Session Token Counter","href":"/ai/agents/develop/gen-ai-and-llms/llm-session-token-counter"},{"title":"Other LLM Operations","sidebarTitle":"Other Operations","href":"/ai/agents/develop/gen-ai-and-llms/other-operations"}]},{"title":"Getting Started with Voice AI Agents","sidebarTitle":"Voice","href":"/ai/agents/develop/voice"}]},{"group":"Test","pages":[{"title":"Testing your AI Agents","href":"/ai/agents/test/testing-your-ai-agents"},{"group":"Simulator","root":{"title":"Simulator","sidebarTitle":"Overview","href":"/ai/agents/test/simulator/overview"},"pages":[{"title":"Simulator Dashboard","sidebarTitle":"Dashboard","href":"/ai/agents/test/simulator/dashboard"}]},{"group":"Interaction Panel","root":{"title":"Interaction Panel","sidebarTitle":"Overview","href":"/ai/agents/test/interaction-panel/overview"},"pages":[{"title":"Chat","href":"/ai/agents/test/interaction-panel/chat"},{"title":"Voice Call","href":"/ai/agents/test/interaction-panel/voice-call"},{"title":"Live Follow","href":"/ai/agents/test/interaction-panel/live-follow"},{"title":"Simulation","href":"/ai/agents/test/interaction-panel/simulation"}]},{"title":"Mocking","href":"/ai/agents/test/mocking"},{"title":"Demo Webchat","href":"/ai/agents/test/demo-webchat"},{"title":"Logs","href":"/ai/agents/test/logs"},{"group":"Playbooks","root":{"title":"Playbooks","sidebarTitle":"Overview","href":"/ai/agents/test/playbooks"},"pages":[{"title":"Assertions","href":"/ai/agents/test/assertions"}]},{"title":"Voice Preview","href":"/ai/agents/test/voice-preview"}]},{"group":"Deploy","pages":[{"title":"Deploying your AI Agents","href":"/ai/agents/deploy/deploying-your-ai-agents"},{"group":"Endpoint Settings","root":{"title":"Overview","href":"/ai/agents/deploy/endpoints/overview"},"pages":[{"title":"Data Protection \u0026 Analytics","sidebarTitle":"Data Protection and Analytics","href":"/ai/agents/deploy/endpoints/data-protection-and-analytics"},{"title":"Session Management","href":"/ai/agents/deploy/endpoints/session-management"},{"title":"Real-Time Translation Settings","href":"/ai/agents/deploy/endpoints/real-time-translation-settings"},{"title":"File Storage","href":"/ai/agents/deploy/endpoints/file-storage"},{"title":"Content Conversion","mode":"wide","href":"/ai/agents/deploy/endpoints/content-conversion"},{"title":"Test Mode for Endpoints","href":"/ai/agents/deploy/endpoints/test-mode"},{"title":"Inject and Notify API","href":"/ai/agents/deploy/endpoints/inject-and-notify"}]},{"group":"Endpoint Reference","root":{"title":"Endpoint Reference","sidebarTitle":"Overview","href":"/ai/agents/deploy/endpoint-reference/overview"},"pages":[{"title":"Cognigy Webchat","href":"/ai/agents/deploy/endpoint-reference/webchat"},{"title":"Cognigy Voice Gateway","href":"/ai/agents/deploy/endpoint-reference/voice-gateway"},{"title":"WhatsApp","href":"/ai/agents/deploy/endpoint-reference/whatsapp"},{"group":"More Endpoints","pages":[{"title":"8x8","href":"/ai/agents/deploy/endpoint-reference/8x8"},{"title":"A2A Server","sidebarTitle":"A2A Server","tag":"experimental","href":"/ai/agents/deploy/endpoint-reference/a2a-server"},{"title":"Amazon Alexa","tag":"deprecated","href":"/ai/agents/deploy/endpoint-reference/amazon-alexa"},{"title":"Amazon Lex","href":"/ai/agents/deploy/endpoint-reference/amazon-lex"},{"title":"AudioCodes","href":"/ai/agents/deploy/endpoint-reference/audiocodes"},{"title":"Avaya CPaaS","href":"/ai/agents/deploy/endpoint-reference/avaya-cpaas"},{"title":"Azure Bot Services","href":"/ai/agents/deploy/endpoint-reference/azure-bot-services"},{"title":"Bandwidth","href":"/ai/agents/deploy/endpoint-reference/bandwidth"},{"title":"Dialogflow","tag":"deprecated","href":"/ai/agents/deploy/endpoint-reference/dialogflow"},{"title":"Facebook (Meta) Messenger","href":"/ai/agents/deploy/endpoint-reference/facebook-messenger"},{"title":"Genesys","href":"/ai/agents/deploy/endpoint-reference/genesys"},{"title":"Intercom","href":"/ai/agents/deploy/endpoint-reference/intercom"},{"title":"LINE","href":"/ai/agents/deploy/endpoint-reference/line-messenger"},{"title":"MCP Server","sidebarTitle":"MCP Server","tag":"experimental","href":"/ai/agents/deploy/endpoint-reference/mcp-server"},{"title":"Microsoft Teams","href":"/ai/agents/deploy/endpoint-reference/microsoft-teams"},{"title":"NiCE CXone","href":"/ai/agents/deploy/endpoint-reference/nice"},{"title":"NiCE CXone AAH","href":"/ai/agents/deploy/endpoint-reference/nice-aah"},{"title":"REST","href":"/ai/agents/deploy/endpoint-reference/rest"},{"title":"RingCentral Engage","href":"/ai/agents/deploy/endpoint-reference/ringcentral-engage"},{"title":"Socket.IO","href":"/ai/agents/deploy/endpoint-reference/socketio"},{"title":"Slack","href":"/ai/agents/deploy/endpoint-reference/slack"},{"title":"Sunshine Conversations","href":"/ai/agents/deploy/endpoint-reference/sunshine-conversations"},{"title":"Twilio","href":"/ai/agents/deploy/endpoint-reference/twilio"},{"title":"Twilio SMS","href":"/ai/agents/deploy/endpoint-reference/twilio-sms"},{"title":"Userlike","href":"/ai/agents/deploy/endpoint-reference/userlike"},{"title":"Voice Copilot","href":"/ai/agents/deploy/endpoint-reference/voice-copilot"},{"title":"Webhook","href":"/ai/agents/deploy/endpoint-reference/webhook"},{"title":"Workplace by Facebook","sidebarTitle":"Workplace by Facebook (Meta)","href":"/ai/agents/deploy/endpoint-reference/workplace-by-fb"},{"title":"Zoom Contact Center","href":"/ai/agents/deploy/endpoint-reference/zoom"}]}]},{"title":"Snapshots","href":"/ai/agents/deploy/snapshots"}]},{"group":"Analyze","pages":[{"title":"Analytics","sidebarTitle":"Overview","href":"/ai/agents/analyze/overview"},{"group":"Collecting Data","pages":[{"title":"Collecting Data","sidebarTitle":"Overview","href":"/ai/agents/analyze/collecting-data"},{"title":"Analytics Steps","href":"/ai/agents/analyze/analytics-steps"},{"title":"User and Session Identification","href":"/ai/agents/analyze/user-and-session-identification"},{"title":"Data Expiration in Cognigy","sidebarTitle":"Data Expiration","href":"/ai/agents/analyze/data-expiration"}]},{"title":"Insights","href":"/ai/agents/analyze/insights"},{"title":"Cognigy OData Analytics Endpoint","sidebarTitle":"OData","href":"/ai/agents/analyze/odata"},{"title":"Call Tracing","href":"/ai/agents/analyze/call-tracing"},{"title":"Contact Profiles","href":"/ai/agents/analyze/contact-profiles"},{"group":"Goals and Tasks","root":{"title":"Goals and Tasks","sidebarTitle":"Overview","href":"/ai/agents/analyze/goals-and-tasks/overview"},"pages":[{"title":"Tasks","href":"/ai/agents/analyze/goals-and-tasks/tasks"},{"title":"Goals","href":"/ai/agents/analyze/goals-and-tasks/goals"}]}]}]},{"group":"Human Escalation","pages":[{"title":"Handover Providers","href":"/ai/escalate/handovers"},{"title":"Migrate from Endpoint Settings to Handover Provider Settings","sidebarTitle":"Migration from Endpoint to Handover Provider Settings","href":"/ai/escalate/migration"},{"group":"Handover Provider Reference","root":{"title":"Overview","href":"/ai/escalate/handover-reference/overview"},"pages":[{"group":"NiCE CXone","root":{"title":"NiCE CXone","sidebarTitle":"Overview","href":"/ai/escalate/handover-reference/nice-cxone/overview"},"pages":[{"title":"NiCE CXone (Integrated)","sidebarTitle":"Integrated","href":"/ai/escalate/handover-reference/nice-cxone/nice-cxone-integrated"},{"title":"NiCE CXone (Non-Integrated)","sidebarTitle":"Non-Integrated","href":"/ai/escalate/handover-reference/nice-cxone/nice-cxone-non-integrated"}]},{"title":"Live Agent","sidebarTitle":"Cognigy Live Agent","href":"/ai/escalate/handover-reference/live-agent"},{"group":"Genesys Cloud Open Messaging","root":{"title":"Genesys Cloud Open Messaging","sidebarTitle":"Overview","href":"/ai/escalate/handover-reference/genesys-cloud-open-messaging"},"pages":[{"group":"Handover End Detection","root":{"title":"Handover End Detection","href":"/ai/escalate/handover-reference/handover-end-detection"},"pages":[{"title":"Genesys Cloud Open Messaging: Handover End Detection with HTTP webhooks","sidebarTitle":"HTTP Webhooks","href":"/ai/escalate/handover-reference/genesys-cloud-open-messaging-handover-end-detection"},{"title":"Genesys Cloud Open Messaging: Handover End Detection with Amazon EventBridge","sidebarTitle":"Amazon EventBridge","href":"/ai/escalate/handover-reference/genesys-cloud-open-messaging-with-amazon-eventbridge"}]}]},{"title":"Salesforce MIAW","href":"/ai/escalate/handover-reference/salesforce-miaw"},{"title":"RingCentral Engage Integration","sidebarTitle":"RingCentral Engage","href":"/ai/escalate/handover-reference/ring-central-engage"},{"title":"8x8","href":"/ai/escalate/handover-reference/8x8"},{"title":"storm","href":"/ai/escalate/handover-reference/storm"},{"title":"Chatwoot","href":"/ai/escalate/handover-reference/chatwoot"},{"title":"Genesys Cloud Guest Chat","href":"/ai/escalate/handover-reference/genesys-cloud-guest-chat"},{"title":"Salesforce Service Cloud","href":"/ai/escalate/handover-reference/salesforce"}]},{"title":"Agent Copilot","href":"/ai/escalate/agent-copilot"},{"group":"Handover Features","pages":[{"title":"User Inactivity Detection and Handling","href":"/ai/escalate/handover-features/user-inactivity-detection"},{"title":"Handover Status","href":"/ai/escalate/handover-features/handover-status"},{"title":"Real-Time Queue Notifications","href":"/ai/escalate/handover-features/real-time-queue-notifications"}]}]},{"group":"Platform Features","pages":[{"title":"Platform Features","sidebarTitle":"Overview","href":"/ai/platform-features/overview"},{"group":"Natural Language Understanding","root":{"title":"NLU Overview","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/overview"},"pages":[{"group":"Intents","root":{"title":"Intents","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/intents/overview"},"pages":[{"title":"Intent Example Sentences","sidebarTitle":"Example Sentences","href":"/ai/platform-features/nlu/intents/example-sentences"},{"title":"Annotations","href":"/ai/platform-features/nlu/intents/annotations"},{"title":"Intent Conditions","href":"/ai/platform-features/nlu/intents/conditions"},{"title":"Intent Analyzer","href":"/ai/platform-features/nlu/intents/intent-analyzer"},{"group":"Intent Hierarchy","root":{"title":"Intent Hierarchy","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/intents/intent-hierarchy/overview"},"pages":[{"title":"Intent Mapping Priority","href":"/ai/platform-features/nlu/intents/intent-hierarchy/intent-mapping-priority"},{"title":"Inheritance Mechanism","href":"/ai/platform-features/nlu/intents/intent-hierarchy/inherit-child-example-sentences"}]},{"title":"Reject Intent","href":"/ai/platform-features/nlu/intents/reject-intent"},{"title":"Intent Rules","href":"/ai/platform-features/nlu/intents/rules"},{"title":"Trigger Intent","href":"/ai/platform-features/nlu/intents/trigger-intent"},{"title":"Thresholds","href":"/ai/platform-features/nlu/intents/thresholds"},{"title":"Default Reply","href":"/ai/platform-features/nlu/intents/default-reply"},{"title":"Confirmation Words","href":"/ai/platform-features/nlu/intents/confirmation-words"},{"title":"Yes/No Intents","href":"/ai/platform-features/nlu/intents/yes-no-intents"},{"title":"Intent Trainer","href":"/ai/platform-features/nlu/intents/intent-trainer"}]},{"group":"Slots and Lexicons","root":{"title":"Slots","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/slots/overview"},"pages":[{"title":"System-Defined Slots","sidebarTitle":"System-Defined","href":"/ai/platform-features/nlu/slots/system-defined"},{"group":"User-Defined","root":{"title":"User-Defined Slots","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/slots/user-defined/overview"},"pages":[{"title":"Lexicon Slots","href":"/ai/platform-features/nlu/slots/user-defined/lexicon"},{"title":"Regex Slots","href":"/ai/platform-features/nlu/slots/user-defined/regex"}]}]},{"title":"Attachments","href":"/ai/platform-features/nlu/attachments"},{"title":"NLU Languages","href":"/ai/platform-features/nlu/language-support"},{"title":"Slot Fillers","href":"/ai/platform-features/nlu/slot-fillers"},{"title":"Text Cleaner","href":"/ai/platform-features/nlu/text-cleaner"},{"group":"External NLU","root":{"title":"External NLU","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/external/overview"},"pages":[{"title":"Intent Recognition with External Embedding Model","href":"/ai/platform-features/nlu/external/external-nlu-intent-recognition"},{"title":"LLM-Based Intent Reranking","href":"/ai/platform-features/nlu/external/intent-reranking"},{"group":"NLU Connectors","root":{"title":"NLU Connectors","sidebarTitle":"Overview","href":"/ai/platform-features/nlu/external/nlu-connectors/overview"},"pages":[{"title":"NLU Transformers","href":"/ai/platform-features/nlu/external/nlu-connectors/nlu-transformers"}]},{"group":"NLU Connector Reference","root":{"title":"NLU Connector Reference","sidebarTitle":"All NLU Connectors","href":"/ai/platform-features/nlu/external/nlu-connector-reference/all-nlu-connectors"},"pages":[{"title":"Alexa","href":"/ai/platform-features/nlu/external/nlu-connector-reference/alexa"},{"title":"Code","href":"/ai/platform-features/nlu/external/nlu-connector-reference/code"},{"title":"Cognigy NLU","href":"/ai/platform-features/nlu/external/nlu-connector-reference/cognigy-nlu"},{"title":"Dialogflow","sidebarTitle":"Dialog Flow","href":"/ai/platform-features/nlu/external/nlu-connector-reference/dialog-flow"},{"title":"Amazon Lex","href":"/ai/platform-features/nlu/external/nlu-connector-reference/lex"},{"title":"Microsoft LUIS","href":"/ai/platform-features/nlu/external/nlu-connector-reference/luis"},{"title":"No NLU","href":"/ai/platform-features/nlu/external/nlu-connector-reference/no-nlu"},{"title":"Watson Assistant","href":"/ai/platform-features/nlu/external/nlu-connector-reference/watson-assistant"}]}]}]},{"group":"CognigyScript","root":{"title":"CognigyScript","sidebarTitle":"Overview","href":"/ai/platform-features/cognigyscript"},"pages":[{"title":"Tokens","href":"/ai/platform-features/tokens"}]},{"group":"Translation and Localization","root":{"title":"Localization","href":"/ai/platform-features/translation-and-localization/localization"},"pages":[{"title":"Automatic Translation","href":"/ai/platform-features/translation-and-localization/auto-translation"},{"title":"Real-Time Translation","href":"/ai/platform-features/translation-and-localization/real-time-translation"}]},{"title":"Data Redaction","sidebarTitle":"Data Redaction","href":"/ai/platform-features/data-redaction"},{"title":"Connections","href":"/ai/platform-features/connections"},{"title":"Packages","href":"/ai/platform-features/packages"}]},{"group":"For Developers","pages":[{"title":"Extensions","href":"/ai/for-developers/extensions"},{"group":"Node Execution API: Function Reference","root":{"title":"Node Execution API: All Functions","sidebarTitle":"All Functions","href":"/ai/for-developers/function-reference/all-functions"},"pages":[{"group":"CognigyScript","root":{"title":"CognigyScript Functions","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/cognigyscript/overview"},"pages":[{"title":"parseCognigyScriptCondition","href":"/ai/for-developers/function-reference/cognigyscript/parseCognigyScriptCondition"},{"title":"parseCognigyScriptText","href":"/ai/for-developers/function-reference/cognigyscript/parseCognigyScriptText"}]},{"group":"Contact Profiles","root":{"title":"Contact Profiles","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/contact-profiles/overview"},"pages":[{"title":"activateProfile","href":"/ai/for-developers/function-reference/contact-profiles/activateProfile"},{"title":"deactivateProfile","href":"/ai/for-developers/function-reference/contact-profiles/deactivateProfile"},{"title":"mergeProfile","href":"/ai/for-developers/function-reference/contact-profiles/mergeProfile"},{"title":"updateProfile","href":"/ai/for-developers/function-reference/contact-profiles/updateProfile"}]},{"group":"Context Object","root":{"title":"Context Object","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/context-object/overview"},"pages":[{"title":"addToContext","href":"/ai/for-developers/function-reference/context-object/addToContext"},{"title":"deleteContext","href":"/ai/for-developers/function-reference/context-object/deleteContext"},{"title":"getContext","href":"/ai/for-developers/function-reference/context-object/getContext"},{"title":"removeFromContext","href":"/ai/for-developers/function-reference/context-object/removeFromContext"},{"title":"resetContext","href":"/ai/for-developers/function-reference/context-object/resetContext"}]},{"group":"Execution Control","root":{"title":"Execution and Flow Control","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/execution-control/overview"},"pages":[{"title":"addConditionalEntrypoint","href":"/ai/for-developers/function-reference/execution-control/addConditionalEntrypoint"},{"title":"executeFlow","href":"/ai/for-developers/function-reference/execution-control/executeFlow"},{"title":"getExecutionAmount","href":"/ai/for-developers/function-reference/execution-control/getExecutionAmount"},{"title":"resetExecutionAmount","href":"/ai/for-developers/function-reference/execution-control/resetExecutionAmount"},{"title":"resetNextNodes","href":"/ai/for-developers/function-reference/execution-control/resetNextNodes"},{"title":"setExecutionAmount","href":"/ai/for-developers/function-reference/execution-control/setExecutionAmount"},{"title":"setNextNode","href":"/ai/for-developers/function-reference/execution-control/setNextNode"},{"title":"stopExecution","href":"/ai/for-developers/function-reference/execution-control/stopExecution"},{"title":"think (Deprecated)","href":"/ai/for-developers/function-reference/execution-control/think"},{"title":"thinkV2","href":"/ai/for-developers/function-reference/execution-control/thinkV2"}]},{"group":"Input and Output","root":{"title":"Input and Output","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/input-and-output/overview"},"pages":[{"title":"addToInput","href":"/ai/for-developers/function-reference/input-and-output/addToInput"},{"title":"output","href":"/ai/for-developers/function-reference/input-and-output/output"},{"title":"say","href":"/ai/for-developers/function-reference/input-and-output/say"}]},{"group":"Logging and Monitoring","root":{"title":"Logging and Monitoring","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/logging/overview"},"pages":[{"title":"log","href":"/ai/for-developers/function-reference/logging/log"},{"title":"getLLMTokenUsageForSession","href":"/ai/for-developers/function-reference/logging/getLLMTokenUsageForSession"},{"title":"setSensitiveLoggingSettings","href":"/ai/for-developers/function-reference/logging/setSensitiveLoggingSettings"}]},{"group":"xApps","root":{"title":"xApps Functions","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/xApps/overview"},"pages":[{"title":"setAppState","href":"/ai/for-developers/function-reference/xApps/setAppState"}]},{"group":"Other","root":{"title":"Other Functions","sidebarTitle":"Overview","href":"/ai/for-developers/function-reference/other/overview"},"pages":[{"title":"completeGoal","href":"/ai/for-developers/function-reference/other/completeGoal"},{"title":"evaluateRule","href":"/ai/for-developers/function-reference/other/evaluateRule"},{"title":"setRegexSlot","href":"/ai/for-developers/function-reference/other/setRegexSlot"}]}]},{"group":"Knowledge Connector API: Function Reference","root":{"title":"Knowledge Connector API","sidebarTitle":"Overview","href":"/ai/for-developers/knowledge-connector/overview"},"pages":[{"title":"upsertKnowledgeSource","href":"/ai/for-developers/knowledge-connector/upsertKnowledgeSource"},{"title":"createKnowledgeSource","tag":"Deprecated","href":"/ai/for-developers/knowledge-connector/createKnowledgeSource"},{"title":"deleteKnowledgeSource","href":"/ai/for-developers/knowledge-connector/deleteKnowledgeSource"},{"title":"createKnowledgeChunk","href":"/ai/for-developers/knowledge-connector/createKnowledgeChunk"}]},{"title":"Functions","href":"/ai/for-developers/functions"},{"group":"Code Node","root":{"title":"Code","sidebarTitle":"Overview","href":"/ai/for-developers/code/overview"},"pages":[{"title":"API Functions","href":"/ai/for-developers/code/api-functions"},{"title":"Modules","href":"/ai/for-developers/code/modules"},{"title":"Channel Output","href":"/ai/for-developers/code/channel-output"},{"title":"AI Default Channel Formats","href":"/ai/for-developers/code/ai-default-channel-formats"},{"title":"Analytics Data","sidebarTitle":"Analytics data","href":"/ai/for-developers/code/analytics-data"}]},{"group":"Transformers","root":{"title":"Transformers","sidebarTitle":"Overview","href":"/ai/for-developers/transformers/overview"},"pages":[{"title":"Input Transformer","href":"/ai/for-developers/transformers/input-transformer"},{"title":"Output Transformer","href":"/ai/for-developers/transformers/output-transformer"},{"title":"Execution Finished Transformer","href":"/ai/for-developers/transformers/execution-finished-transformer"},{"title":"Notify Transformer","href":"/ai/for-developers/transformers/notify-transformer"},{"title":"Inject Transformer","href":"/ai/for-developers/transformers/inject-transformer"}]},{"group":"Developer Reference","pages":[{"title":"API and CLI","href":"/ai/for-developers/developers/api-and-cli"},{"title":"NiCE Cognigy Plugin","tag":"new","href":"/ai/for-developers/developers/cognigy-plugin"},{"title":"NiCE Cognigy MCP Server","tag":"deprecated","href":"/ai/for-developers/developers/cognigy-mcp-server"},{"title":"Client Libraries","href":"/ai/for-developers/developers/client-libraries"},{"title":"Extension Framework","href":"/ai/for-developers/developers/extension-framework"}]}]},{"group":"Administration and Installation","pages":[{"title":"Quotas and Limits","href":"/ai/administer/limitations"},{"title":"Billing","href":"/ai/administer/billing"},{"group":"Administration","pages":[{"group":"User Menu","root":{"title":"User Menu","sidebarTitle":"Overview","href":"/ai/administer/user-menu/overview"},"pages":[{"title":"My Profile","href":"/ai/administer/user-menu/my-profile"},{"title":"Hotkeys","href":"/ai/administer/hotkeys"}]},{"group":"Access Management","pages":[{"group":"Admin Center","root":{"title":"Admin Center","sidebarTitle":"Overview","href":"/ai/administer/access/admin-center/overview"},"pages":[{"title":"Admin Center Dashboard","href":"/ai/administer/access/admin-center/dashboard"},{"title":"Access Control","href":"/ai/administer/access/admin-center/access-control"},{"title":"Audit Events","href":"/ai/administer/access/admin-center/audit-events"},{"group":"Global Resources","root":{"title":"Global Resources","sidebarTitle":"Overview","href":"/ai/administer/access/admin-center/global-resources/overview"},"pages":[{"title":"Global Large Language Models","href":"/ai/administer/access/admin-center/global-resources/global-llms"},{"title":"Global Connections","href":"/ai/administer/access/admin-center/global-resources/global-connections"}]}]},{"group":"Project and Members","pages":[{"title":"Project Settings","href":"/ai/administer/access/project-settings"},{"title":"Members","href":"/ai/administer/access/members"}]},{"title":"Management UI","href":"/ai/administer/access/management-ui"}]}]},{"group":"Install, Configure, and Migrate","pages":[{"title":"Access to Cognigy","href":"/ai/administer/installation/access-to-cognigy-ai"},{"title":"Installation","sidebarTitle":"About","href":"/ai/administer/installation/about"},{"title":"Cognigy: Browser Requirements","sidebarTitle":"Browser Requirements","href":"/ai/administer/installation/browser-requirements"},{"title":"Cognigy Architecture","sidebarTitle":"Architecture","href":"/ai/administer/installation/architecture"},{"group":"SaaS","pages":[{"title":"Cognigy SaaS Service Health","href":"/ai/administer/installation/saas-service-health"},{"title":"IP Address Ranges for SaaS","href":"/ai/administer/installation/ip-ranges-shared-environments"}]},{"group":"Single Sign-on (SSO)","pages":[{"title":"Single Sign-on with SAML 2.0","sidebarTitle":"Single Sign-on using SAML 2.0","href":"/ai/administer/installation/single-sign-on-saml2"},{"title":"Identity Providers","href":"/ai/administer/installation/identity-providers"}]}]}]}]},{"dropdown":"Cognigy API","icon":"terminal","groups":[{"group":"Overview","pages":[{"title":"Cognigy API","mode":"wide","href":"/api-reference"},{"title":"About Cognigy API","sidebarTitle":"Introduction","href":"/api-reference/about"}]},{"group":"Core Resources","pages":[{"group":"Administration","pages":[{"title":"Get Knowledge Chunk Count","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/organisations/chunkcount","href":"/api-reference/administration/get-knowledge-chunk-count"},{"title":"Get Organization Policies","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/organisations/policy","href":"/api-reference/administration/get-organization-policies"},{"title":"Initiate Organization Deletion","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/organisations/requestdeletion","href":"/api-reference/administration/initiate-organization-deletion"},{"title":"Get the License State for the Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/system/license","href":"/api-reference/administration/get-the-license-state-for-the-organization"},{"title":"Set the License","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/system/license","href":"/api-reference/administration/set-the-license"},{"title":"Get System Maintenance Messages","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/system/message","href":"/api-reference/administration/get-system-maintenance-messages"}]},{"group":"Agent Copilot Configurations","pages":[{"title":"Get Agent Copilot Configurations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aicopilotconfigs","href":"/api-reference/agent-copilot-configurations/get-agent-copilot-configurations"},{"title":"Get an Agent Copilot Configuration","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aicopilotconfigs/{configId}","href":"/api-reference/agent-copilot-configurations/get-an-agent-copilot-configuration"},{"title":"Update an Agent Copilot Configuration","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/aicopilotconfigs/{configId}","href":"/api-reference/agent-copilot-configurations/update-an-agent-copilot-configuration"}]},{"group":"Agent Copilot Configuration","pages":[{"title":"Create an Agent Copilot Configuration","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/aicopilotconfigs","href":"/api-reference/agent-copilot-configuration/create-an-agent-copilot-configuration"},{"title":"Delete an Agent Copilot Configuration","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/aicopilotconfigs/{configId}","href":"/api-reference/agent-copilot-configuration/delete-an-agent-copilot-configuration"}]},{"group":"AI Agents","pages":[{"title":"Get AI Agents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aiagents","href":"/api-reference/ai-agents/get-ai-agents"},{"title":"Create an AI Agent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/aiagents","href":"/api-reference/ai-agents/create-an-ai-agent"},{"title":"Get an AI Agent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aiagents/{aiAgentId}","href":"/api-reference/ai-agents/get-an-ai-agent"},{"title":"Delete an AI Agent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/aiagents/{aiAgentId}","href":"/api-reference/ai-agents/delete-an-ai-agent"},{"title":"Update an AI Agent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/aiagents/{aiAgentId}","href":"/api-reference/ai-agents/update-an-ai-agent"},{"title":"Get AI Agent Jobs and their Tools","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aiagents/{aiAgentId}/jobs","href":"/api-reference/ai-agents/get-ai-agent-jobs-and-their-tools"},{"title":"Hire an AI Agent from the Job Market","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/aiagents/hire","href":"/api-reference/ai-agents/hire-an-ai-agent-from-the-job-market"},{"title":"Get AI Agents from the Job Market","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/aiagents/hire/templates","href":"/api-reference/ai-agents/get-ai-agents-from-the-job-market"},{"title":"Test an A2A agent connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/aiagents/testa2aconnection","href":"/api-reference/ai-agents/test-an-a2a-agent-connection"},{"title":"Check AI Agent Name Availability","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/aiagents/validatename","href":"/api-reference/ai-agents/check-ai-agent-name-availability"}]},{"group":"Alexa","pages":[{"title":"Deploy an Alexa Endpoint to an Alexa Skill","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /external/alexa/skills/{skillId}/deploy","href":"/api-reference/alexa/deploy-an-alexa-endpoint-to-an-alexa-skill"},{"title":"Get Alexa Skills","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/external/alexa/skills","href":"/api-reference/alexa/get-alexa-skills"},{"title":"Create an Amazon User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/external/alexa/users","href":"/api-reference/alexa/create-an-amazon-user"},{"title":"Get Amazon User Details","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/external/alexa/users/me","href":"/api-reference/alexa/get-amazon-user-details"},{"title":"Delete an Amazon User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/external/alexa/users/me","href":"/api-reference/alexa/delete-an-amazon-user"}]},{"group":"Analytics","pages":[{"title":"Update an Analytics Record","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/analytics","href":"/api-reference/analytics/update-an-analytics-record"},{"title":"Delete Analytics Records","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/analytics/{projectId}","href":"/api-reference/analytics/delete-analytics-records"},{"title":"Get Call Counter Metrics for the Organization","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/callcounter","href":"/api-reference/analytics/get-call-counter-metrics-for-the-organization"},{"title":"Get Conversation Counter Metrics for the Organization","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/conversationcounter","href":"/api-reference/analytics/get-conversation-counter-metrics-for-the-organization"},{"title":"Get Knowledge Query Counter Metrics for an Organization.","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgequerycounter","href":"/api-reference/analytics/get-knowledge-query-counter-metrics-for-an-organization"},{"title":"Get Call Counter Metrics for a Project","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/callcounter","href":"/api-reference/analytics/get-call-counter-metrics-for-a-project"},{"title":"Get Conversation Counter Metrics for a Project","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/conversationcounter","href":"/api-reference/analytics/get-conversation-counter-metrics-for-a-project"},{"title":"Get Knowledge Query Counter Metrics for a Project.","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/knowledgequerycounter","href":"/api-reference/analytics/get-knowledge-query-counter-metrics-for-a-project"}]},{"group":"Analytics 3.0","pages":[{"title":"Get Call Counter Metrics for the Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v3.0/callcounter","href":"/api-reference/analytics-30/get-call-counter-metrics-for-the-organization"},{"title":"Get Conversation Counter Metrics for the Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v3.0/conversationcounter","href":"/api-reference/analytics-30/get-conversation-counter-metrics-for-the-organization"},{"title":"Get Call Counter Metrics for a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v3.0/projects/{projectId}/callcounter","href":"/api-reference/analytics-30/get-call-counter-metrics-for-a-project"},{"title":"Get Conversation Counter Metrics for a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v3.0/projects/{projectId}/conversationcounter","href":"/api-reference/analytics-30/get-conversation-counter-metrics-for-a-project"}]},{"group":"Audit Events","pages":[{"title":"Get Audit Events","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/auditevents","href":"/api-reference/audit-events/get-audit-events"},{"title":"Get an Audit Event","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/auditevents/{auditEventId}","href":"/api-reference/audit-events/get-an-audit-event"}]},{"group":"Connections","pages":[{"title":"Get Connections","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/connections","href":"/api-reference/connections/get-connections"},{"title":"Create a Connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/connections","href":"/api-reference/connections/create-a-connection"},{"title":"Perform Batch Operations on Connections","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/connections","href":"/api-reference/connections/perform-batch-operations-on-connections"},{"title":"Get a Connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/connections/{connectionId}","href":"/api-reference/connections/get-a-connection"},{"title":"Delete a Connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/connections/{connectionId}","href":"/api-reference/connections/delete-a-connection"},{"title":"Update a Connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/connections/{connectionId}","href":"/api-reference/connections/update-a-connection"},{"title":"Create a Connection Field","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/connections/{connectionId}/fields","href":"/api-reference/connections/create-a-connection-field"},{"title":"Delete a Connection Field","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/connections/{connectionId}/fields/{fieldName}","href":"/api-reference/connections/delete-a-connection-field"},{"title":"Get Connection Schemas","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/connections/schemas","href":"/api-reference/connections/get-connection-schemas"}]},{"group":"Contact Profiles","pages":[{"title":"Get Contact Profiles","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/profiles","href":"/api-reference/contact-profiles/get-contact-profiles"},{"title":"Create a Contact Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles","href":"/api-reference/contact-profiles/create-a-contact-profile"},{"title":"Get a Contact Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/profiles/{profileId}","href":"/api-reference/contact-profiles/get-a-contact-profile"},{"title":"Delete a Contact Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/profiles/{profileId}","href":"/api-reference/contact-profiles/delete-a-contact-profile"},{"title":"Update a Contact Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/profiles/{profileId}","href":"/api-reference/contact-profiles/update-a-contact-profile"},{"title":"Remove the Contact ID","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles/{profileId}/contactids/remove","href":"/api-reference/contact-profiles/remove-the-contact-id"},{"title":"Export Contact Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles/{profileId}/data/export","href":"/api-reference/contact-profiles/export-contact-profile"},{"title":"Delete Contact Profile Data","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles/{profileId}/data/remove","href":"/api-reference/contact-profiles/delete-contact-profile-data"},{"title":"Merge Contact Profiles","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles/{profileId}/merge","href":"/api-reference/contact-profiles/merge-contact-profiles"},{"title":"Unmerge Contact Profiles","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/profiles/{profileId}/unmerge","href":"/api-reference/contact-profiles/unmerge-contact-profiles"},{"title":"Get Schema","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/profiles/schema/{projectId}","href":"/api-reference/contact-profiles/get-schema"},{"title":"Set Schema","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json put /v2.0/profiles/schema/{projectId}","href":"/api-reference/contact-profiles/set-schema"},{"title":"Get Contact Profiles (performance)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.1/profiles","href":"/api-reference/contact-profiles/get-contact-profiles-performance"}]},{"group":"Conversations","pages":[{"title":"Get Conversations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/conversations","href":"/api-reference/conversations/get-conversations"},{"title":"Deletes a Conversation","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/conversations/{sessionId}","href":"/api-reference/conversations/deletes-a-conversation"}]},{"group":"Conversations v2.0","pages":[{"title":"Get a Conversation","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/conversations/{sessionId}","href":"/api-reference/conversations-v20/get-a-conversation"}]},{"group":"Conversations v2.1","pages":[{"title":"Deletes conversations records for a sessionId.","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.1/conversations/{sessionId}","href":"/api-reference/conversations-v21/deletes-conversations-records-for-a-sessionid"}]},{"group":"Copilot Configs","pages":[{"title":"Get Copilot Configs","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/copilotConfigs","href":"/api-reference/copilot-configs/get-copilot-configs"},{"title":"Create a Copilot Config","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/copilotConfigs","href":"/api-reference/copilot-configs/create-a-copilot-config"},{"title":"Get a Copilot Config","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/copilotConfigs/{copilotConfigId}","href":"/api-reference/copilot-configs/get-a-copilot-config"},{"title":"Update a Copilot Config","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json put /v2.0/copilotConfigs/{copilotConfigId}","href":"/api-reference/copilot-configs/update-a-copilot-config"},{"title":"Delete a Copilot Config","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/copilotConfigs/{copilotConfigId}","href":"/api-reference/copilot-configs/delete-a-copilot-config"},{"title":"Open a test session against a deployed Copilot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/copilotConfigs/{copilotConfigId}/session","href":"/api-reference/copilot-configs/open-a-test-session-against-a-deployed-copilot"},{"title":"Send a test turn to a deployed Copilot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/copilotConfigs/{copilotConfigId}/session/message","href":"/api-reference/copilot-configs/send-a-test-turn-to-a-deployed-copilot"},{"title":"Get the Copilot sample transcript","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/copilotSampleTranscript","href":"/api-reference/copilot-configs/get-the-copilot-sample-transcript"},{"title":"Get the pre-built Copilot widgets","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/copilotWidgets","href":"/api-reference/copilot-configs/get-the-pre-built-copilot-widgets"}]},{"group":"CXOne","pages":[{"title":"List CXOne Knowledge Hubs","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/cxone/knowledgehub","href":"/api-reference/cxone/list-cxone-knowledge-hubs"}]},{"group":"Endpoints","pages":[{"title":"Send a Message as a User Input","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/endpoint/inject","href":"/api-reference/endpoints/send-a-message-as-a-user-input"},{"title":"Send a Message as an AI Agent Output","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/endpoint/notify","href":"/api-reference/endpoints/send-a-message-as-an-ai-agent-output"},{"title":"Get Endpoints","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/endpoints","href":"/api-reference/endpoints/get-endpoints"},{"title":"Create an Endpoint","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/endpoints","href":"/api-reference/endpoints/create-an-endpoint"},{"title":"Perform Batch Operations on Endpoints","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/endpoints","href":"/api-reference/endpoints/perform-batch-operations-on-endpoints"},{"title":"Get an Endpoint","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/endpoints/{endpointId}","href":"/api-reference/endpoints/get-an-endpoint"},{"title":"Delete an Endpoint","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/endpoints/{endpointId}","href":"/api-reference/endpoints/delete-an-endpoint"},{"title":"Update an Endpoint","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/endpoints/{endpointId}","href":"/api-reference/endpoints/update-an-endpoint"},{"title":"List Endpoint API Keys","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/endpoints/{endpointId}/apikeys","href":"/api-reference/endpoints/list-endpoint-api-keys"},{"title":"Create an Endpoint API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/endpoints/{endpointId}/apikeys","href":"/api-reference/endpoints/create-an-endpoint-api-key"},{"title":"Revoke an Endpoint API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/endpoints/{endpointId}/apikeys/{keyId}","href":"/api-reference/endpoints/revoke-an-endpoint-api-key"},{"title":"Get an Endpoint's voice settings","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/endpoints/{endpointId}/voiceSettings","href":"/api-reference/endpoints/get-an-endpoints-voice-settings"}]},{"group":"Example Sentences","pages":[{"title":"Get Example Sentences","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/intents/{intentId}/sentences","href":"/api-reference/example-sentences/get-example-sentences"},{"title":"Create an Example Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/{intentId}/sentences","href":"/api-reference/example-sentences/create-an-example-sentence"},{"title":"Perform Batch Operations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/intents/{intentId}/sentences","href":"/api-reference/example-sentences/perform-batch-operations"},{"title":"Get an Example Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId}","href":"/api-reference/example-sentences/get-an-example-sentence"},{"title":"Delete an Example Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId}","href":"/api-reference/example-sentences/delete-an-example-sentence"},{"title":"Update an Example Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/intents/{intentId}/sentences/{sentenceId}","href":"/api-reference/example-sentences/update-an-example-sentence"},{"title":"Generate Example Sentences","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/{intentId}/sentences/generate","href":"/api-reference/example-sentences/generate-example-sentences"}]},{"group":"Extensions","pages":[{"title":"Get Extensions","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/extensions","href":"/api-reference/extensions/get-extensions"},{"title":"Get an Extension","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/extensions/{extensionId}","href":"/api-reference/extensions/get-an-extension"},{"title":"Delete an Extension","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/extensions/{extensionId}","href":"/api-reference/extensions/delete-an-extension"},{"title":"Update an Extension","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/extensions/update","href":"/api-reference/extensions/update-an-extension"},{"title":"Upload an Extension","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/extensions/upload","href":"/api-reference/extensions/upload-an-extension"}]},{"group":"Files","pages":[{"title":"Get File Metadata","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/files/{fileId}","href":"/api-reference/files/get-file-metadata"},{"title":"Get Binary Data of a File","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/files/{fileToken}","href":"/api-reference/files/get-binary-data-of-a-file"}]},{"group":"Flows","pages":[{"title":"Get Flows","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows","href":"/api-reference/flows/get-flows"},{"title":"Create a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows","href":"/api-reference/flows/create-a-flow"},{"title":"Perform Batch Operations on Flows","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows","href":"/api-reference/flows/perform-batch-operations-on-flows"},{"title":"Get a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}","href":"/api-reference/flows/get-a-flow"},{"title":"Delete a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/flows/{flowId}","href":"/api-reference/flows/delete-a-flow"},{"title":"Update a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}","href":"/api-reference/flows/update-a-flow"},{"title":"Add a Locale to a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/addlocalization","href":"/api-reference/flows/add-a-locale-to-a-flow"},{"title":"Get the Chart of specified Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart","href":"/api-reference/flows/get-the-chart-of-specified-flow"},{"title":"Create a Flow from a Child Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes/childflow","href":"/api-reference/flows/create-a-flow-from-a-child-node"},{"title":"Clone a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/clone","href":"/api-reference/flows/clone-a-flow"},{"title":"Remove a Locale from a Flow","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/removelocalization","href":"/api-reference/flows/remove-a-locale-from-a-flow"},{"title":"Get Flow Settings","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/settings","href":"/api-reference/flows/get-flow-settings"},{"title":"Update Flow Settings","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/settings","href":"/api-reference/flows/update-flow-settings"}]},{"group":"Functions","pages":[{"title":"Get Functions","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/functions","href":"/api-reference/functions/get-functions"},{"title":"Create a Function","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/functions","href":"/api-reference/functions/create-a-function"},{"title":"Get a Function","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/functions/{functionId}","href":"/api-reference/functions/get-a-function"},{"title":"Delete a Function","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/functions/{functionId}","href":"/api-reference/functions/delete-a-function"},{"title":"Update a Function","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/functions/{functionId}","href":"/api-reference/functions/update-a-function"},{"title":"Get Function Instances","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/functions/{functionId}/instances","href":"/api-reference/functions/get-function-instances"},{"title":"Get a Function Instance","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/functions/{functionId}/instances/{functionInstanceId}","href":"/api-reference/functions/get-a-function-instance"},{"title":"Stop a Function Instance","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/functions/{functionId}/instances/{functionInstanceId}/stop","href":"/api-reference/functions/stop-a-function-instance"},{"title":"Create a Function Instance","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/functions/{functionId}/trigger","href":"/api-reference/functions/create-a-function-instance"}]},{"group":"Handover Providers","pages":[{"title":"Get Handover Providers","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/handover/providers","href":"/api-reference/handover-providers/get-handover-providers"},{"title":"Create a Handover Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/handover/providers","href":"/api-reference/handover-providers/create-a-handover-provider"},{"title":"Get a Handover Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/handover/providers/{providerId}","href":"/api-reference/handover-providers/get-a-handover-provider"},{"title":"Delete a Handover Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/handover/providers/{providerId}","href":"/api-reference/handover-providers/delete-a-handover-provider"},{"title":"Update a Handover Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/handover/providers/{providerId}","href":"/api-reference/handover-providers/update-a-handover-provider"}]},{"group":"Handover Services","pages":[{"title":"Get Handover Services","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/handover/services","href":"/api-reference/handover-services/get-handover-services"},{"title":"Get a Handover Service","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/handover/services/{serviceId}","href":"/api-reference/handover-services/get-a-handover-service"}]},{"group":"Identity Providers","pages":[{"title":"Set Up an Identity Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/identityprovider/configure","href":"/api-reference/identity-providers/set-up-an-identity-provider"},{"title":"Reset an Identity Provider Setup","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/identityprovider/reset","href":"/api-reference/identity-providers/reset-an-identity-provider-setup"}]},{"group":"Intent Trainer","pages":[{"title":"Get Trainer Records","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/trainer","href":"/api-reference/intent-trainer/get-trainer-records"},{"title":"Get an Intent Trainer Record","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/trainer/{recordId}","href":"/api-reference/intent-trainer/get-an-intent-trainer-record"},{"title":"Perform Batch Operations on Intent Trainer Records","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/trainer/batch","href":"/api-reference/intent-trainer/perform-batch-operations-on-intent-trainer-records"},{"title":"Create a Download Link for Intent Trainer Records","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/trainer/downloadlink","href":"/api-reference/intent-trainer/create-a-download-link-for-intent-trainer-records"},{"title":"Package Intent Trainer Records","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/trainer/package","href":"/api-reference/intent-trainer/package-intent-trainer-records"},{"title":"Upload an Intent Trainer Records Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/trainer/upload","href":"/api-reference/intent-trainer/upload-an-intent-trainer-records-package"}]},{"group":"Intents","pages":[{"title":"Get Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/intents","href":"/api-reference/intents/get-intents"},{"title":"Create an Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents","href":"/api-reference/intents/create-an-intent"},{"title":"Perform Batch Operations on Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/intents","href":"/api-reference/intents/perform-batch-operations-on-intents"},{"title":"Get an Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/intents/{intentId}","href":"/api-reference/intents/get-an-intent"},{"title":"Delete an Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/flows/{flowId}/intents/{intentId}","href":"/api-reference/intents/delete-an-intent"},{"title":"Update an Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/intents/{intentId}","href":"/api-reference/intents/update-an-intent"},{"title":"Localize an Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/{intentId}/addlocalization","href":"/api-reference/intents/localize-an-intent"},{"title":"Delete Intent Localization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/{intentId}/removelocalization","href":"/api-reference/intents/delete-intent-localization"},{"title":"Export Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/export","href":"/api-reference/intents/export-intents"},{"title":"Upload Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/import","href":"/api-reference/intents/upload-intents"},{"title":"Train Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/intents/train","href":"/api-reference/intents/train-intents"}]},{"group":"Knowledge Chunks","pages":[{"title":"Get Knowledge Chunks","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks","href":"/api-reference/knowledge-chunks/get-knowledge-chunks"},{"title":"Create a Knowledge Chunk","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks","href":"/api-reference/knowledge-chunks/create-a-knowledge-chunk"},{"title":"Get a Knowledge Chunk","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks/{chunkId}","href":"/api-reference/knowledge-chunks/get-a-knowledge-chunk"},{"title":"Delete a Knowledge Chunk","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks/{chunkId}","href":"/api-reference/knowledge-chunks/delete-a-knowledge-chunk"},{"title":"Update a Knowledge Chunk","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks/{chunkId}","href":"/api-reference/knowledge-chunks/update-a-knowledge-chunk"}]},{"group":"Knowledge Connectors","pages":[{"title":"Get Knowledge Connectors","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/connectors","href":"/api-reference/knowledge-connectors/get-knowledge-connectors"},{"title":"Create a Knowledge Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/connectors","href":"/api-reference/knowledge-connectors/create-a-knowledge-connector"},{"title":"Get a Knowledge Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}","href":"/api-reference/knowledge-connectors/get-a-knowledge-connector"},{"title":"Delete a Knowledge Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}","href":"/api-reference/knowledge-connectors/delete-a-knowledge-connector"},{"title":"Update a Knowledge Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}","href":"/api-reference/knowledge-connectors/update-a-knowledge-connector"},{"title":"Run a Knowledge Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/connectors/{connectorId}/run","href":"/api-reference/knowledge-connectors/run-a-knowledge-connector"},{"title":"Get Knowledge Connectors","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/descriptors","href":"/api-reference/knowledge-connectors/get-knowledge-connectors-1"}]},{"group":"Knowledge Sources","pages":[{"title":"Run a Knowledge Extension","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/extensions/run","href":"/api-reference/knowledge-sources/run-a-knowledge-extension"},{"title":"Get Knowledge Sources","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/sources","href":"/api-reference/knowledge-sources/get-knowledge-sources"},{"title":"Create a Knowledge Source","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/sources","href":"/api-reference/knowledge-sources/create-a-knowledge-source"},{"title":"Get a Knowledge Source","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}","href":"/api-reference/knowledge-sources/get-a-knowledge-source"},{"title":"Delete a Knowledge Source","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}","href":"/api-reference/knowledge-sources/delete-a-knowledge-source"},{"title":"Updates a Knowledge Source","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}","href":"/api-reference/knowledge-sources/updates-a-knowledge-source"},{"title":"Create a Knowledge Source from a File","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores/{knowledgeStoreId}/sources/upload","href":"/api-reference/knowledge-sources/create-a-knowledge-source-from-a-file"}]},{"group":"Knowledge Stores","pages":[{"title":"Get Knowledge Stores","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores","href":"/api-reference/knowledge-stores/get-knowledge-stores"},{"title":"Create a Knowledge Store","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/knowledgestores","href":"/api-reference/knowledge-stores/create-a-knowledge-store"},{"title":"Get a Knowledge Store","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/knowledgestores/{knowledgeStoreId}","href":"/api-reference/knowledge-stores/get-a-knowledge-store"},{"title":"Delete a Knowledge Store","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/knowledgestores/{knowledgeStoreId}","href":"/api-reference/knowledge-stores/delete-a-knowledge-store"},{"title":"Update a Knowledge Store","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/knowledgestores/{knowledgeStoreId}","href":"/api-reference/knowledge-stores/update-a-knowledge-store"}]},{"group":"Large Language Models","pages":[{"title":"Get large language models","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/largelanguagemodels","href":"/api-reference/large-language-models/get-large-language-models"},{"title":"Create a large language model","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/largelanguagemodels","href":"/api-reference/large-language-models/create-a-large-language-model"},{"title":"Get a large language model","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/largelanguagemodels/{largeLanguageModelId}","href":"/api-reference/large-language-models/get-a-large-language-model"},{"title":"Delete a large language model","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/largelanguagemodels/{largeLanguageModelId}","href":"/api-reference/large-language-models/delete-a-large-language-model"},{"title":"Update a large language model","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/largelanguagemodels/{largeLanguageModelId}","href":"/api-reference/large-language-models/update-a-large-language-model"},{"title":"Get models for a large language model provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/largelanguagemodels/{largeLanguageModelId}/availablemodels","href":"/api-reference/large-language-models/get-models-for-a-large-language-model-provider"},{"title":"Clone a large language model","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/largelanguagemodels/{largeLanguageModelId}/clone","href":"/api-reference/large-language-models/clone-a-large-language-model"},{"title":"Test large language model connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/largelanguagemodels/{largeLanguageModelId}/test","href":"/api-reference/large-language-models/test-large-language-model-connection"},{"title":"Get large language models together with their credentials summary and Gateway Config Set status (EXPERIMENTAL)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/llmconfigurations","href":"/api-reference/large-language-models/get-large-language-models-together-with-their-credentials-summary-and-gateway-config-set-status-experimental"},{"title":"Create a large language model together with its credentials and Gateway Config Set (EXPERIMENTAL)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/llmconfigurations","href":"/api-reference/large-language-models/create-a-large-language-model-together-with-its-credentials-and-gateway-config-set-experimental"},{"title":"Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/llmconfigurations/{largeLanguageModelId}","href":"/api-reference/large-language-models/get-a-large-language-model-together-with-its-credentials-summary-and-gateway-config-set-status-experimental"},{"title":"Delete a large language model and, optionally, its credentials (EXPERIMENTAL)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/llmconfigurations/{largeLanguageModelId}","href":"/api-reference/large-language-models/delete-a-large-language-model-and-optionally-its-credentials-experimental"},{"title":"Update a large language model together with its credentials and Gateway Config Set (EXPERIMENTAL)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/llmconfigurations/{largeLanguageModelId}","href":"/api-reference/large-language-models/update-a-large-language-model-together-with-its-credentials-and-gateway-config-set-experimental"}]},{"group":"Lexicons","pages":[{"title":"Get Lexicons","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons","href":"/api-reference/lexicons/get-lexicons"},{"title":"Create a New Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons","href":"/api-reference/lexicons/create-a-new-lexicon"},{"title":"Perform Batch Operations on Lexicons","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons","href":"/api-reference/lexicons/perform-batch-operations-on-lexicons"},{"title":"Get a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}","href":"/api-reference/lexicons/get-a-lexicon"},{"title":"Delete a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/lexicons/{lexiconId}","href":"/api-reference/lexicons/delete-a-lexicon"},{"title":"Update a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}","href":"/api-reference/lexicons/update-a-lexicon"},{"title":"Create a Download Link for a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/downloadlink","href":"/api-reference/lexicons/create-a-download-link-for-a-lexicon"},{"title":"Get Lexicon Entries","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/entries","href":"/api-reference/lexicons/get-lexicon-entries"},{"title":"Create a Lexicon Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/entries","href":"/api-reference/lexicons/create-a-lexicon-entry"},{"title":"Perform Batch Operations in a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}/entries","href":"/api-reference/lexicons/perform-batch-operations-in-a-lexicon"},{"title":"Get a Lexicon Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/entries/{entryId}","href":"/api-reference/lexicons/get-a-lexicon-entry"},{"title":"Delete a Lexicon Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/lexicons/{lexiconId}/entries/{entryId}","href":"/api-reference/lexicons/delete-a-lexicon-entry"},{"title":"Update a Lexicon Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}/entries/{entryId}","href":"/api-reference/lexicons/update-a-lexicon-entry"},{"title":"Get Keyphrases from a Lexicon Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/entries/{entryId}/keyphrases","href":"/api-reference/lexicons/get-keyphrases-from-a-lexicon-entry"},{"title":"Add a Keyphrase to a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/entries/{entryId}/keyphrases","href":"/api-reference/lexicons/add-a-keyphrase-to-a-lexicon"},{"title":"Delete a Keyphrase","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/entries/{entryId}/keyphrases/{keyphraseId}","href":"/api-reference/lexicons/delete-a-keyphrase"},{"title":"Add a Slot to a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/entries/{entryId}/slots","href":"/api-reference/lexicons/add-a-slot-to-a-lexicon"},{"title":"Delete a Lexicon Slot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/entries/{entryId}/slots/{slotId}","href":"/api-reference/lexicons/delete-a-lexicon-slot"},{"title":"Export a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/export","href":"/api-reference/lexicons/export-a-lexicon"},{"title":"Import a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/import","href":"/api-reference/lexicons/import-a-lexicon"},{"title":"Get Keyphrases in a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/keyphrases","href":"/api-reference/lexicons/get-keyphrases-in-a-lexicon"},{"title":"Update a Keyphrase","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}/keyphrases/{keyphraseId}","href":"/api-reference/lexicons/update-a-keyphrase"},{"title":"Get Lexicon Slots","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/lexicons/{lexiconId}/slots","href":"/api-reference/lexicons/get-lexicon-slots"},{"title":"Create a Lexicon Slot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/lexicons/{lexiconId}/slots","href":"/api-reference/lexicons/create-a-lexicon-slot"},{"title":"Perform Batch Operations in a Lexicon","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}/slots","href":"/api-reference/lexicons/perform-batch-operations-in-a-lexicon-1"},{"title":"Delete a Lexicon Slot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/lexicons/{lexiconId}/slots/{slotId}","href":"/api-reference/lexicons/delete-a-lexicon-slot-1"},{"title":"Update a Lexicon Slot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/lexicons/{lexiconId}/slots/{slotId}","href":"/api-reference/lexicons/update-a-lexicon-slot"}]},{"group":"Live Agent","pages":[{"title":"Get the Live Agent Account","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/organisations/liveagentaccount","href":"/api-reference/live-agent/get-the-live-agent-account"},{"title":"Set Up Live Agent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/organisations/setupliveagent","href":"/api-reference/live-agent/set-up-live-agent"},{"title":"Get the Default Live Agent Inbox","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/inbox","href":"/api-reference/live-agent/get-the-default-live-agent-inbox"},{"title":"Set Up a Live Agent Inbox","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/setupinbox","href":"/api-reference/live-agent/set-up-a-live-agent-inbox"},{"title":"Update a Live Agent Inbox","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/projects/{projectId}/setupinbox","href":"/api-reference/live-agent/update-a-live-agent-inbox"}]},{"group":"Locales","pages":[{"title":"Get Locales","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/locales","href":"/api-reference/locales/get-locales"},{"title":"Create a Locale","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/locales","href":"/api-reference/locales/create-a-locale"},{"title":"Get a Locale","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/locales/{localeId}","href":"/api-reference/locales/get-a-locale"},{"title":"Delete a Locale","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/locales/{localeId}","href":"/api-reference/locales/delete-a-locale"},{"title":"Update a Locale","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/locales/{localeId}","href":"/api-reference/locales/update-a-locale"}]},{"group":"Management UI","pages":[{"title":"Get Billing Information","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/billing","href":"/api-reference/management-ui/get-billing-information"},{"title":"Get Organizations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/organisations","href":"/api-reference/management-ui/get-organizations"},{"title":"Create an Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/organisations","href":"/api-reference/management-ui/create-an-organization"},{"title":"Get an Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/organisations/{organisationId}","href":"/api-reference/management-ui/get-an-organization"},{"title":"Delete an Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /management/v2.0/organisations/{organisationId}","href":"/api-reference/management-ui/delete-an-organization"},{"title":"Update an Organization","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /management/v2.0/organisations/{organisationId}","href":"/api-reference/management-ui/update-an-organization"},{"title":"Create an API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/organisations/{organisationId}/apikeys","href":"/api-reference/management-ui/create-an-api-key"},{"title":"Enforce Password Policy","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/organisations/{organisationId}/enforcepasswordpolicy","href":"/api-reference/management-ui/enforce-password-policy"},{"title":"Create a System Message","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/system/createsystemmessage","href":"/api-reference/management-ui/create-a-system-message"},{"title":"Get the License via Management UI","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/system/license","href":"/api-reference/management-ui/get-the-license-via-management-ui"},{"title":"Set the License via Management UI","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/system/license","href":"/api-reference/management-ui/set-the-license-via-management-ui"},{"title":"Get Users","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/users","href":"/api-reference/management-ui/get-users"},{"title":"Create a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/users","href":"/api-reference/management-ui/create-a-user"},{"title":"Get a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/users/{userId}","href":"/api-reference/management-ui/get-a-user"},{"title":"Delete a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /management/v2.0/users/{userId}","href":"/api-reference/management-ui/delete-a-user"},{"title":"Update a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /management/v2.0/users/{userId}","href":"/api-reference/management-ui/update-a-user"},{"title":"Impersonate a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /management/v2.0/users/{userId}/impersonate","href":"/api-reference/management-ui/impersonate-a-user"},{"title":"Get Vendor Information","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v2.0/vendor","href":"/api-reference/management-ui/get-vendor-information"},{"title":"Get Billing Information","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /management/v3.0/billing","href":"/api-reference/management-ui/get-billing-information-1"}]},{"group":"NLU Connectors","pages":[{"title":"Get NLU Connectors","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/nluconnectors","href":"/api-reference/nlu-connectors/get-nlu-connectors"},{"title":"Create an NLU Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/nluconnectors","href":"/api-reference/nlu-connectors/create-an-nlu-connector"},{"title":"Perform Batch Operations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/nluconnectors","href":"/api-reference/nlu-connectors/perform-batch-operations"},{"title":"Get an NLU Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/nluconnectors/{nluConnectorId}","href":"/api-reference/nlu-connectors/get-an-nlu-connector"},{"title":"Delete an NLU Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/nluconnectors/{nluConnectorId}","href":"/api-reference/nlu-connectors/delete-an-nlu-connector"},{"title":"Update an NLU Connector","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/nluconnectors/{nluConnectorId}","href":"/api-reference/nlu-connectors/update-an-nlu-connector"}]},{"group":"Nodes","pages":[{"title":"Get all Node Descriptors","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart/descriptors","href":"/api-reference/nodes/get-all-node-descriptors"},{"title":"Get Nodes","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart/nodes","href":"/api-reference/nodes/get-nodes"},{"title":"Create a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes","href":"/api-reference/nodes/create-a-node"},{"title":"Get a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart/nodes/{nodeId}","href":"/api-reference/nodes/get-a-node"},{"title":"Delete a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/flows/{flowId}/chart/nodes/{nodeId}","href":"/api-reference/nodes/delete-a-node"},{"title":"Update a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/chart/nodes/{nodeId}","href":"/api-reference/nodes/update-a-node"},{"title":"Add a New Locale to a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes/{nodeId}/addlocalization","href":"/api-reference/nodes/add-a-new-locale-to-a-node"},{"title":"Move a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes/{nodeId}/move","href":"/api-reference/nodes/move-a-node"},{"title":"Remove a Locale from a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes/{nodeId}/removelocalization","href":"/api-reference/nodes/remove-a-locale-from-a-node"},{"title":"Get AI Agents Nodes","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart/nodes/aiagents","href":"/api-reference/nodes/get-ai-agents-nodes"},{"title":"Generate Output for a Node","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/chart/nodes/output/generate","href":"/api-reference/nodes/generate-output-for-a-node"},{"title":"Search for Nodes","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/chart/nodes/search","href":"/api-reference/nodes/search-for-nodes"}]},{"group":"Options Resolver","pages":[{"title":"Resolve Options for a Field","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/optionsresolver","href":"/api-reference/options-resolver/resolve-options-for-a-field"}]},{"group":"Packages","pages":[{"title":"Get Packages","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/packages","href":"/api-reference/packages/get-packages"},{"title":"Create a Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/packages","href":"/api-reference/packages/create-a-package"},{"title":"Get a Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/packages/{packageId}","href":"/api-reference/packages/get-a-package"},{"title":"Delete a Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/packages/{packageId}","href":"/api-reference/packages/delete-a-package"},{"title":"Create a Download Link","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/packages/{packageId}/downloadlink","href":"/api-reference/packages/create-a-download-link"},{"title":"Merge a Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/packages/{packageId}/merge","href":"/api-reference/packages/merge-a-package"},{"title":"Upload a Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/packages/upload","href":"/api-reference/packages/upload-a-package"}]},{"group":"Playbooks","pages":[{"title":"Get Playbooks","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/playbooks","href":"/api-reference/playbooks/get-playbooks"},{"title":"Create a Playbook","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/playbooks","href":"/api-reference/playbooks/create-a-playbook"},{"title":"Perform Batch Operations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/playbooks","href":"/api-reference/playbooks/perform-batch-operations"},{"title":"Get a Playbook","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/playbooks/{playbookId}","href":"/api-reference/playbooks/get-a-playbook"},{"title":"Delete a Playbook","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/playbooks/{playbookId}","href":"/api-reference/playbooks/delete-a-playbook"},{"title":"Update a Playbook","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/playbooks/{playbookId}","href":"/api-reference/playbooks/update-a-playbook"},{"title":"List Playbook Runs","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/playbooks/{playbookId}/runs","href":"/api-reference/playbooks/list-playbook-runs"},{"title":"Retrieve a Playbook Run","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/playbooks/{playbookId}/runs/{playbookRunId}","href":"/api-reference/playbooks/retrieve-a-playbook-run"},{"title":"Delete a Playbook Run","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/playbooks/{playbookId}/runs/{playbookRunId}","href":"/api-reference/playbooks/delete-a-playbook-run"},{"title":"Schedule a Playbook Run","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/playbooks/{playbookId}/schedule","href":"/api-reference/playbooks/schedule-a-playbook-run"},{"title":"Create a Playbook Step","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/playbooks/{playbookId}/steps","href":"/api-reference/playbooks/create-a-playbook-step"},{"title":"Delete a Playbook Step","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/playbooks/{playbookId}/steps/{stepId}","href":"/api-reference/playbooks/delete-a-playbook-step"},{"title":"Update a Playbook Step","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/playbooks/{playbookId}/steps/{stepId}","href":"/api-reference/playbooks/update-a-playbook-step"},{"title":"Create an Assertion","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/playbooks/{playbookId}/steps/{stepId}/asserts","href":"/api-reference/playbooks/create-an-assertion"},{"title":"Delete a Playbook Step Assertion","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/playbooks/{playbookId}/steps/{stepId}/asserts/{assertId}","href":"/api-reference/playbooks/delete-a-playbook-step-assertion"},{"title":"Update a Playbook Step Assertion","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/playbooks/{playbookId}/steps/{stepId}/asserts/{assertId}","href":"/api-reference/playbooks/update-a-playbook-step-assertion"},{"title":"Change Step Order","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/playbooks/{playbookId}/steps/order","href":"/api-reference/playbooks/change-step-order"}]},{"group":"Projects","pages":[{"title":"Get Projects","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects","href":"/api-reference/projects/get-projects"},{"title":"Create a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}","href":"/api-reference/projects/get-a-project"},{"title":"Delete a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/projects/{projectId}","href":"/api-reference/projects/delete-a-project"},{"title":"Update a Project","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/projects/{projectId}","href":"/api-reference/projects/update-a-project"},{"title":"Get a Graph","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/graph","href":"/api-reference/projects/get-a-graph"},{"title":"Generate NLU Scores","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/nlu/scores","href":"/api-reference/projects/generate-nlu-scores"},{"title":"Get Project Settings","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/settings","href":"/api-reference/projects/get-project-settings"},{"title":"Update Project Settings","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/projects/{projectId}/settings","href":"/api-reference/projects/update-project-settings"},{"title":"Set Up Proactive Follow-Up","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/settings/proactive/setup","href":"/api-reference/projects/set-up-proactive-follow-up"},{"title":"Set Up Cognigy Generative AI","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/settings/setupgenerativeai","href":"/api-reference/projects/set-up-cognigy-generative-ai"},{"title":"Test a Translation Provider Connection","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/settings/translation/test","href":"/api-reference/projects/test-a-translation-provider-connection"},{"title":"Train Flow Models","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/trainallflows","href":"/api-reference/projects/train-flow-models"},{"title":"Create a Project from a Template","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/createbytemplate","href":"/api-reference/projects/create-a-project-from-a-template"},{"title":"Validate a Project Name","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/validateprojectname","href":"/api-reference/projects/validate-a-project-name"}]},{"group":"Search","pages":[{"title":"Search Resources","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/search","href":"/api-reference/search/search-resources"}]},{"group":"Sessions","pages":[{"title":"Inject a Context","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/sessions/{sessionId}/context/inject","href":"/api-reference/sessions/inject-a-context"},{"title":"Reset a Context","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/sessions/{sessionId}/context/reset","href":"/api-reference/sessions/reset-a-context"}]},{"group":"Slot Fillers","pages":[{"title":"Get Slot Fillers","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/slotfillers","href":"/api-reference/slot-fillers/get-slot-fillers"},{"title":"Create a Slot Filler","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/flows/{flowId}/slotfillers","href":"/api-reference/slot-fillers/create-a-slot-filler"},{"title":"Perform Batch Operations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/slotfillers","href":"/api-reference/slot-fillers/perform-batch-operations"},{"title":"Get a Slot Filler","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/flows/{flowId}/slotfillers/{slotFillerId}","href":"/api-reference/slot-fillers/get-a-slot-filler"},{"title":"Delete a Slot Filler","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/flows/{flowId}/slotfillers/{slotFillerId}","href":"/api-reference/slot-fillers/delete-a-slot-filler"},{"title":"Update a Slot Filler","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/flows/{flowId}/slotfillers/{slotFillerId}","href":"/api-reference/slot-fillers/update-a-slot-filler"}]},{"group":"Snapshots","pages":[{"title":"Get Snapshots","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/snapshots","href":"/api-reference/snapshots/get-snapshots"},{"title":"Create a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/snapshots","href":"/api-reference/snapshots/create-a-snapshot"},{"title":"Gets a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/snapshots/{snapshotId}","href":"/api-reference/snapshots/gets-a-snapshot"},{"title":"Delete a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/snapshots/{snapshotId}","href":"/api-reference/snapshots/delete-a-snapshot"},{"title":"Create a Download Link","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/snapshots/{snapshotId}/downloadlink","href":"/api-reference/snapshots/create-a-download-link"},{"title":"Package a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/snapshots/{snapshotId}/package","href":"/api-reference/snapshots/package-a-snapshot"},{"title":"Get Resources in a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/snapshots/{snapshotId}/resources","href":"/api-reference/snapshots/get-resources-in-a-snapshot"},{"title":"Restore a Snapshot","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/snapshots/{snapshotId}/restore","href":"/api-reference/snapshots/restore-a-snapshot"},{"title":"Upload a Snapshot Package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/snapshots/upload","href":"/api-reference/snapshots/upload-a-snapshot-package"}]},{"group":"Tasks","pages":[{"title":"Get Tasks","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/tasks","href":"/api-reference/tasks/get-tasks"},{"title":"Get a Task","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/tasks/{taskId}","href":"/api-reference/tasks/get-a-task"},{"title":"Cancel a Task","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/tasks/{taskId}/cancel","href":"/api-reference/tasks/cancel-a-task"}]},{"group":"Tokens","pages":[{"title":"Get Tokens","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/snippets","href":"/api-reference/tokens/get-tokens"},{"title":"Create a Token","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/snippets","href":"/api-reference/tokens/create-a-token"},{"title":"Delete a Token","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/projects/{projectId}/snippets/{snippetId}","href":"/api-reference/tokens/delete-a-token"}]},{"group":"Users","pages":[{"title":"Remove a Project Member","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0//projects/{projectId}/removeprojectmember","href":"/api-reference/users/remove-a-project-member"},{"title":"Add a Project Member","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/addprojectmember","href":"/api-reference/users/add-a-project-member"},{"title":"Get Project Members","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/members","href":"/api-reference/users/get-project-members"},{"title":"Get a Project Member","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/members/{userId}","href":"/api-reference/users/get-a-project-member"},{"title":"Update a Project Member","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/projects/{projectId}/members/{userId}","href":"/api-reference/users/update-a-project-member"},{"title":"Assign a Project Role","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/members/{userId}/addroletomember","href":"/api-reference/users/assign-a-project-role"},{"title":"Unassign a Project Role","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/members/{userId}/removerolefrommember","href":"/api-reference/users/unassign-a-project-role"},{"title":"Get Users","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users","href":"/api-reference/users/get-users"},{"title":"Create a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users","href":"/api-reference/users/create-a-user"},{"title":"Get a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/{userId}","href":"/api-reference/users/get-a-user"},{"title":"Delete a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/users/{userId}","href":"/api-reference/users/delete-a-user"},{"title":"Update a User Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/users/{userId}","href":"/api-reference/users/update-a-user-profile"},{"title":"Assign a Project to a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/addproject","href":"/api-reference/users/assign-a-project-to-a-user"},{"title":"Assign a Global Role","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/addroletouser","href":"/api-reference/users/assign-a-global-role"},{"title":"Log Out a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/logout","href":"/api-reference/users/log-out-a-user"},{"title":"Unassign a Project from a User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/removeproject","href":"/api-reference/users/unassign-a-project-from-a-user"},{"title":"Unassign a Global Role","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/removerolefromuser","href":"/api-reference/users/unassign-a-global-role"},{"title":"Reset Failed Login Attempts","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/{userId}/resetfailedloginattempts","href":"/api-reference/users/reset-failed-login-attempts"},{"title":"Change a User Password","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/changepassword","href":"/api-reference/users/change-a-user-password"},{"title":"Deprecate User Passwords","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/deprecatepassword","href":"/api-reference/users/deprecate-user-passwords"},{"title":"Gets the Current User's Profile","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me","href":"/api-reference/users/gets-the-current-users-profile"},{"title":"Delete Own User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/users/me","href":"/api-reference/users/delete-own-user"},{"title":"Update Own User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/users/me","href":"/api-reference/users/update-own-user"},{"title":"Accept the Terms of Service","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/me/accepttermsofservice","href":"/api-reference/users/accept-the-terms-of-service"},{"title":"Get Current User's ACL","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me/acl","href":"/api-reference/users/get-current-users-acl"},{"title":"Get API Keys of the Current User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me/apikeys","href":"/api-reference/users/get-api-keys-of-the-current-user"},{"title":"Create an API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/me/apikeys","href":"/api-reference/users/create-an-api-key"},{"title":"Delete an API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/users/me/apikeys/{apiKeyId}","href":"/api-reference/users/delete-an-api-key"},{"title":"Get the Last Login Attempt","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me/lastloginattempt","href":"/api-reference/users/get-the-last-login-attempt"},{"title":"Get Login Attempts of the Current User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me/loginattempts","href":"/api-reference/users/get-login-attempts-of-the-current-user"},{"title":"Pin or Unpin Resources","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/me/pin","href":"/api-reference/users/pin-or-unpin-resources"},{"title":"Get Pinned Resources","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/users/me/pinned","href":"/api-reference/users/get-pinned-resources"},{"title":"Request a Password Reset","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/requestpasswordreset","href":"/api-reference/users/request-a-password-reset"},{"title":"Reset a User Password","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/resetpassword","href":"/api-reference/users/reset-a-user-password"},{"title":"Validate a Password Reset Token","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/users/validatepasswordresettoken","href":"/api-reference/users/validate-a-password-reset-token"}]},{"group":"Users 2.1","pages":[{"title":"Get API Keys of the Current User","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.1/users/me/apikeys","href":"/api-reference/users-21/get-api-keys-of-the-current-user"},{"title":"Create an API Key","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.1/users/me/apikeys","href":"/api-reference/users-21/create-an-api-key"}]},{"group":"Voice Gateway","pages":[{"title":"Get Voice Gateway Account","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/organisations/voicegateway/account","href":"/api-reference/voice-gateway/get-voice-gateway-account"},{"title":"Set Up a Voice Gateway Account","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/organisations/voicegateway/account","href":"/api-reference/voice-gateway/set-up-a-voice-gateway-account"},{"title":"Get Voice Gateway Speech Credentials","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/voicegateway/speechcredentials","href":"/api-reference/voice-gateway/get-voice-gateway-speech-credentials"},{"title":"Get Voice Gateway Supported Voices","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/voicegateway/speechcredentials/voices","href":"/api-reference/voice-gateway/get-voice-gateway-supported-voices"}]},{"group":"Voice Preview","pages":[{"title":"Get Voices","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/audio/preview/languages","href":"/api-reference/voice-preview/get-voices"},{"title":"Validate Speech Provider","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/audio/voiceprovider/test","href":"/api-reference/voice-preview/validate-speech-provider"}]},{"group":"Webfinger","pages":[{"title":"Get User or Organization Info via Webfinger for SSO","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /.well-known/webfinger","href":"/api-reference/webfinger/get-user-or-organization-info-via-webfinger-for-sso"}]},{"group":"Yes/No Intents","pages":[{"title":"Get Yes/No Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/locales/{localeId}/yesnointents","href":"/api-reference/yesno-intents/get-yesno-intents"},{"title":"Delete a Yes/No Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/locales/{localeId}/yesnointents/{intentId}","href":"/api-reference/yesno-intents/delete-a-yesno-intent"},{"title":"Update a Yes/No Intent","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/locales/{localeId}/yesnointents/{intentId}","href":"/api-reference/yesno-intents/update-a-yesno-intent"},{"title":"Get Sentences","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences","href":"/api-reference/yesno-intents/get-sentences"},{"title":"Create a Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences","href":"/api-reference/yesno-intents/create-a-sentence"},{"title":"Get a Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json get /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}","href":"/api-reference/yesno-intents/get-a-sentence"},{"title":"Delete a Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json delete /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}","href":"/api-reference/yesno-intents/delete-a-sentence"},{"title":"Update a Sentence","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json patch /v2.0/locales/{localeId}/yesnointents/{intentId}/sentences/{sentenceId}","href":"/api-reference/yesno-intents/update-a-sentence"},{"title":"Train Yes/No Intents","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/locales/{localeId}/yesnointents/train","href":"/api-reference/yesno-intents/train-yesno-intents"},{"title":"Train Yes/No Intents for All Locales","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/openapi/openapi-viewer.json post /v2.0/projects/{projectId}/yesnointents/train","href":"/api-reference/yesno-intents/train-yesno-intents-for-all-locales"}]}]},{"group":"Simulator","pages":[{"group":"Simulations","pages":[{"title":"Get all scenarios","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations","href":"/api-reference-simulator/simulations/get-all-scenarios"},{"title":"Create scenario","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations","href":"/api-reference-simulator/simulations/create-scenario"},{"title":"Get all simulations","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/batches","href":"/api-reference-simulator/simulations/get-all-simulations"},{"title":"Get scenario by ID","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}","href":"/api-reference-simulator/simulations/get-scenario-by-id"},{"title":"Delete scenario","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json delete /simulations/{simulationReference}","href":"/api-reference-simulator/simulations/delete-scenario"},{"title":"Update scenario","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json patch /simulations/{simulationReference}","href":"/api-reference-simulator/simulations/update-scenario"},{"title":"Run scenario","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations/{simulationReference}/schedule","href":"/api-reference-simulator/simulations/run-scenario"},{"title":"Get simulations by scenarios","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}/batches","href":"/api-reference-simulator/simulations/get-simulations-by-scenarios"},{"title":"Get simulation by ID","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}/batches/{simulationRunBatchReference}","href":"/api-reference-simulator/simulations/get-simulation-by-id"},{"title":"Stop simulation","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations/{simulationReference}/batches/{simulationRunBatchReference}","href":"/api-reference-simulator/simulations/stop-simulation"},{"title":"Clone scenario","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations/{simulationReference}/clone","href":"/api-reference-simulator/simulations/clone-scenario"},{"title":"Get scheduler configuration for a simulation","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}/schedules","href":"/api-reference-simulator/simulations/get-scheduler-configuration-for-a-simulation"},{"title":"Create a scheduler for a simulation","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /simulations/{simulationReference}/schedules","href":"/api-reference-simulator/simulations/create-a-scheduler-for-a-simulation"},{"title":"Update a scheduler by reference","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json patch /simulations/{simulationReference}/schedules/{schedulerReference}","href":"/api-reference-simulator/simulations/update-a-scheduler-by-reference"}]},{"group":"Simulation Runs","pages":[{"title":"Get simulation runs by simulation","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs","href":"/api-reference-simulator/simulation-runs/get-simulation-runs-by-simulation"},{"title":"Get simulation run by ID","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs/{simulationRunReference}","href":"/api-reference-simulator/simulation-runs/get-simulation-run-by-id"}]},{"group":"Personas","pages":[{"title":"Get persona options (mission types and persona types)","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/options","href":"/api-reference-simulator/personas/get-persona-options-mission-types-and-persona-types"},{"title":"Generate persona packages","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/generate","href":"/api-reference-simulator/personas/generate-persona-packages"},{"title":"Regenerate a specific field of a persona package","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/regenerate-field","href":"/api-reference-simulator/personas/regenerate-a-specific-field-of-a-persona-package"},{"title":"Bulk generate separated personas and missions","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/generate-bulk","href":"/api-reference-simulator/personas/bulk-generate-separated-personas-and-missions"},{"title":"Create scenario from transcript","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /personas/from-transcript","href":"/api-reference-simulator/personas/create-scenario-from-transcript"}]},{"group":"Dashboard","pages":[{"title":"Get dashboard overview metrics","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /dashboard/overview","href":"/api-reference-simulator/dashboard/get-dashboard-overview-metrics"},{"title":"Get success rate trend data","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /dashboard/success-rate-trend","href":"/api-reference-simulator/dashboard/get-success-rate-trend-data"},{"title":"Get upcoming scheduled runs","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json get /dashboard/upcoming-scheduled-runs","href":"/api-reference-simulator/dashboard/get-upcoming-scheduled-runs"}]},{"group":"Transcript Scenario Generation","pages":[{"title":"Create transcript upload request","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /v1/transcript-request","href":"/api-reference-simulator/transcript-scenario-generation/create-transcript-upload-request"},{"title":"Upload and parse a transcript file","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /v1/transcript-upload","href":"/api-reference-simulator/transcript-scenario-generation/upload-and-parse-a-transcript-file"},{"title":"Generate scenarios from uploaded transcripts","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/testing/openapi/openapi-viewer.json post /v1/generate-from-transcript","href":"/api-reference-simulator/transcript-scenario-generation/generate-scenarios-from-uploaded-transcripts"}]}]},{"group":"Logs","pages":[{"group":"Logs","pages":[{"title":"Get Log Entries","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/logs","href":"/api-reference-logs/logs/get-log-entries"},{"title":"Get a Log Entry","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/logs/{logEntryId}","href":"/api-reference-logs/logs/get-a-log-entry"},{"title":"Get the Latest Log Entries","deprecated":true,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.0/projects/{projectId}/logs/tail","href":"/api-reference-logs/logs/get-the-latest-log-entries"}]},{"group":"Logs v2.1","pages":[{"title":"Get Log Entries","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.1/projects/{projectId}/logs","href":"/api-reference-logs/logs-v21/get-log-entries"},{"title":"Get a Log Entry","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.1/projects/{projectId}/logs/{logEntryId}","href":"/api-reference-logs/logs-v21/get-a-log-entry"},{"title":"Count Log Entries by Level","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.1/projects/{projectId}/logs/count","href":"/api-reference-logs/logs-v21/count-log-entries-by-level"},{"title":"Package Log Entries into a downloadable file","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json post /v2.1/projects/{projectId}/logs/package","href":"/api-reference-logs/logs-v21/package-log-entries-into-a-downloadable-file"},{"title":"Download a packaged Logs file","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.1/projects/{projectId}/logs/package/{logsFileId}/download","href":"/api-reference-logs/logs-v21/download-a-packaged-logs-file"},{"title":"Get the Latest Log Entries","deprecated":null,"version":null,"openapi":"https://api-trial.cognigy.ai/logs/openapi/openapi-viewer.json get /v2.1/projects/{projectId}/logs/tail","href":"/api-reference-logs/logs-v21/get-the-latest-log-entries"}]}]}]},{"dropdown":"Voice Gateway","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/vg-logo.svg","groups":[{"group":"Overview","pages":[{"title":"Cognigy Voice Gateway","mode":"wide","href":"/voice-gateway"},{"title":"About Voice Gateway","href":"/voice-gateway/overview"},{"title":"Getting Started with Voice Gateway","href":"/voice-gateway/getting-started"},{"title":"Voice Gateway Technical Capabilities","href":"/voice-gateway/technical-capabilities"},{"title":"Migration from AudioCodes to Voice Gateway","href":"/voice-gateway/migrate-from-ac-to-vg"},{"title":"Voice Gateway Glossary","sidebarTitle":"Glossary","href":"/voice-gateway/glossary"},{"title":"Browser Requirements","href":"/voice-gateway/installation/browser-requirements"}]},{"group":"Self-Service Portal","pages":[{"group":"Settings","root":{"title":"Voice Gateway Self-Service Portal","href":"/voice-gateway/webapp/overview"},"pages":[{"title":"Users","href":"/voice-gateway/webapp/users"},{"title":"Accounts","href":"/voice-gateway/webapp/accounts"},{"title":"Applications","href":"/voice-gateway/webapp/applications"},{"title":"Recent Calls","href":"/voice-gateway/webapp/recent-calls"},{"title":"Alerts","href":"/voice-gateway/webapp/alerts"},{"title":"Carriers","href":"/voice-gateway/webapp/carriers"},{"title":"Speech Services","href":"/voice-gateway/webapp/speech-services"},{"title":"Phone Numbers","href":"/voice-gateway/webapp/phone-numbers"},{"title":"Outbound Call Routing","href":"/voice-gateway/webapp/outbound-call-routing"}]}]},{"group":"Outbound Calls","pages":[{"title":"Create Outbound Calls","href":"/voice-gateway/creating-outbound-calls"},{"title":"Outbound Call Statuses","href":"/voice-gateway/call-statuses"}]},{"group":"Features","pages":[{"title":"TTS Streaming","href":"/voice-gateway/streaming"},{"title":"Genesys Audio Connector","tag":"beta","href":"/voice-gateway/genesys-audio-connector"}]},{"group":"References","pages":[{"group":"Voice Gateway Verbs","root":{"title":"Voice Gateway Verbs","sidebarTitle":"Overview","href":"/voice-gateway/references/verbs/overview"},"pages":[{"title":"Answering Machine Detection","sidebarTitle":"Amd","href":"/voice-gateway/references/verbs/amd"},{"title":"Config","href":"/vstoice-gateway/references/verbs/config"},{"title":"Dial","href":"/voice-gateway/references/verbs/dial"},{"title":"Dub","href":"/voice-gateway/references/verbs/dub"},{"title":"DTMF","href":"/voice-gateway/references/verbs/dtmf"},{"title":"Gather","href":"/voice-gateway/references/verbs/gather"},{"title":"Hangup","href":"/voice-gateway/references/verbs/hangup"},{"title":"Listen","href":"/voice-gateway/references/verbs/listen"},{"title":"Play","href":"/voice-gateway/references/verbs/play"},{"title":"Say","href":"/voice-gateway/references/verbs/say"},{"title":"SIP:REFER","href":"/voice-gateway/references/verbs/sip-refer"},{"title":"SIP:Request","href":"/voice-gateway/references/verbs/sip-request"},{"title":"Transcribe","href":"/voice-gateway/references/verbs/transcribe"}]},{"group":"Voice Gateway Events","root":{"title":"Voice Gateway Events","href":"/voice-gateway/references/events/overview"},"pages":[{"title":"ANSWERING_MACHINE_DETECTION","href":"/voice-gateway/references/events/ANSWERING_MACHINE_DETECTION"},{"title":"CALL_CREATED","href":"/voice-gateway/references/events/CALL_CREATED"},{"title":"CALL_COMPLETED","href":"/voice-gateway/references/events/CALL_COMPLETED"},{"title":"CALL_FAILED","href":"/voice-gateway/references/events/CALL_FAILED"},{"title":"CALL_IN_PROGRESS","href":"/voice-gateway/references/events/CALL_IN_PROGRESS"},{"title":"RECOGNIZED_DTMF","href":"/voice-gateway/references/events/RECOGNIZED_DTMF"},{"title":"RECOGNIZED_SPEECH","href":"/voice-gateway/references/events/RECOGNIZED_SPEECH"},{"title":"TRANSFER_DIAL_ERROR","href":"/voice-gateway/references/events/TRANSFER_DIAL_ERROR"},{"title":"TRANSFER_DIAL_SUCCESS","href":"/voice-gateway/references/events/TRANSFER_DIAL_SUCCESS"},{"title":"TRANSFER_REFER_ERROR","href":"/voice-gateway/references/events/TRANSFER_REFER_ERROR"},{"title":"TRANSFER_REFER_SUCCESS","href":"/voice-gateway/references/events/TRANSFER_REFER_SUCCESS"},{"title":"USER_BUSY","href":"/voice-gateway/references/events/USER_BUSY"},{"title":"USER_INPUT_TIMEOUT","href":"/voice-gateway/references/events/USER_INPUT_TIMEOUT"},{"title":"NO_ANSWER","href":"/voice-gateway/references/events/NO_ANSWER"}]},{"title":"SIP Response Codes","href":"/voice-gateway/references/sip-response-codes"},{"title":"TTS and STT Vendors","href":"/voice-gateway/references/tts-and-stt-vendors"},{"title":"SIP Trunk Providers","href":"/voice-gateway/references/sip-trunk-providers"}]}]},{"dropdown":"Click To Call","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/cc-logo.svg","groups":[{"group":"Overview","pages":[{"title":"Click To Call","mode":"wide","href":"/click-to-call"},{"title":"About Click To Call","href":"/click-to-call/overview"},{"title":"Quickstart: Set Up Your First Click To Call Widget","sidebarTitle":"Quickstart","href":"/click-to-call/quickstart"},{"title":"Configure the Click To Call Widget","sidebarTitle":"Endpoint Configuration","href":"/click-to-call/configure"},{"title":"Embed the Click To Call Widget in Your Website","sidebarTitle":"Embedding","href":"/click-to-call/embed"}]},{"group":"Tutorials","pages":[{"title":"Click to Call Tutorials","sidebarTitle":"Overview","href":"/click-to-call/tutorials/overview"},{"title":"Click To Call with a Text Input Field","sidebarTitle":"Add Text Input Field","href":"/click-to-call/tutorials/text-input-field"},{"title":"Click To Call with a Selector Field","sidebarTitle":"Add Selector Field","href":"/click-to-call/tutorials/selector-field"}]},{"group":"Click To Call SDK","pages":[{"title":"Cognigy Click To Call SDK","sidebarTitle":"SDK Overview","href":"/click-to-call/sdk/overview"},{"title":"Getting Started with Click To Call SDK","sidebarTitle":"Getting Started","href":"/click-to-call/sdk/getting-started"},{"title":"Initialization and Authentication","sidebarTitle":"Initialization and Authentication","href":"/click-to-call/sdk/initialization"},{"group":"API Reference","root":{"title":"API Reference","sidebarTitle":"Overview","href":"/click-to-call/sdk/api-reference/overview"},"pages":[{"group":"Factory Functions","pages":[{"title":"createWebRTCClient","sidebarTitle":"createWebRTCClient","href":"/click-to-call/sdk/api-reference/create-click-to-call-client"},{"title":"checkWebRTCSupport","sidebarTitle":"checkWebRTCSupport","href":"/click-to-call/sdk/api-reference/check-click-to-call-support"}]},{"group":"Connection Methods","pages":[{"title":"connect","sidebarTitle":"connect","href":"/click-to-call/sdk/api-reference/connect"},{"title":"disconnect","sidebarTitle":"disconnect","href":"/click-to-call/sdk/api-reference/disconnect"},{"title":"connectAndCall","sidebarTitle":"connectAndCall","href":"/click-to-call/sdk/api-reference/connect-and-call"}]},{"group":"Call Control Methods","pages":[{"title":"startCall","sidebarTitle":"startCall","href":"/click-to-call/sdk/api-reference/start-call"},{"title":"endCall","sidebarTitle":"endCall","href":"/click-to-call/sdk/api-reference/end-call"},{"title":"mute","sidebarTitle":"mute","href":"/click-to-call/sdk/api-reference/mute"},{"title":"unmute","sidebarTitle":"unmute","href":"/click-to-call/sdk/api-reference/unmute"},{"title":"sendInfo","sidebarTitle":"sendInfo","href":"/click-to-call/sdk/api-reference/send-info"},{"title":"sendDTMF","sidebarTitle":"sendDTMF","href":"/click-to-call/sdk/api-reference/send-dtmf"}]},{"group":"State Methods","pages":[{"title":"isConnected","sidebarTitle":"isConnected","href":"/click-to-call/sdk/api-reference/is-connected"},{"title":"getCurrentSession","sidebarTitle":"getCurrentSession","href":"/click-to-call/sdk/api-reference/get-current-session"}]},{"group":"Event Methods","pages":[{"title":"on","sidebarTitle":"on","href":"/click-to-call/sdk/api-reference/on"},{"title":"off","sidebarTitle":"off","href":"/click-to-call/sdk/api-reference/off"}]},{"group":"Cleanup Methods","pages":[{"title":"destroy","sidebarTitle":"destroy","href":"/click-to-call/sdk/api-reference/destroy"}]},{"title":"Types","sidebarTitle":"Types","href":"/click-to-call/sdk/api-reference/types"}]},{"group":"Event Reference","root":{"title":"Event Reference","sidebarTitle":"Overview","href":"/click-to-call/sdk/event-reference/overview"},"pages":[{"group":"Connection Events","pages":[{"title":"connecting","sidebarTitle":"connecting","href":"/click-to-call/sdk/event-reference/connecting"},{"title":"connected","sidebarTitle":"connected","href":"/click-to-call/sdk/event-reference/connected"},{"title":"disconnected","sidebarTitle":"disconnected","href":"/click-to-call/sdk/event-reference/disconnected"},{"title":"registered","sidebarTitle":"registered","href":"/click-to-call/sdk/event-reference/registered"},{"title":"unregistered","description":"The unregistered event fires when the SIP client is unregistered from the server.","sidebarTitle":"unregistered","href":"/click-to-call/sdk/event-reference/unregistered"}]},{"group":"Call Events","pages":[{"title":"ringing","sidebarTitle":"ringing","href":"/click-to-call/sdk/event-reference/ringing"},{"title":"answered","description":"The answered event fires when a Click To Call call is accepted by the remote party.","sidebarTitle":"answered","href":"/click-to-call/sdk/event-reference/answered"},{"title":"ended","sidebarTitle":"ended","href":"/click-to-call/sdk/event-reference/ended"},{"title":"failed","sidebarTitle":"failed","href":"/click-to-call/sdk/event-reference/failed"},{"title":"muted","sidebarTitle":"muted","href":"/click-to-call/sdk/event-reference/muted"},{"title":"unmuted","sidebarTitle":"unmuted","href":"/click-to-call/sdk/event-reference/unmuted"}]},{"group":"Audio Events","pages":[{"title":"captureAudio","sidebarTitle":"captureAudio","href":"/click-to-call/sdk/event-reference/capture-audio"},{"title":"audioEnded","sidebarTitle":"audioEnded","href":"/click-to-call/sdk/event-reference/audio-ended"}]},{"group":"Info Message Events","pages":[{"title":"infoSent","sidebarTitle":"infoSent","href":"/click-to-call/sdk/event-reference/info-sent"},{"title":"dtmfSent","sidebarTitle":"dtmfSent","href":"/click-to-call/sdk/event-reference/dtmf-sent"},{"title":"infoReceived","sidebarTitle":"infoReceived","href":"/click-to-call/sdk/event-reference/info-received"}]},{"title":"transcription","sidebarTitle":"transcription","href":"/click-to-call/sdk/event-reference/transcription"},{"title":"error","sidebarTitle":"error","href":"/click-to-call/sdk/event-reference/error"}]},{"title":"Security","sidebarTitle":"Security","href":"/click-to-call/sdk/security"},{"title":"Custom Audio Handling","sidebarTitle":"Custom Audio","href":"/click-to-call/sdk/custom-audio"},{"title":"Supported Browsers","sidebarTitle":"Supported Browsers","href":"/click-to-call/sdk/supported-browsers"},{"title":"Troubleshooting","href":"/click-to-call/sdk/troubleshooting"}]}]},{"dropdown":"Webchat ","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/webchat-logo.svg","pages":[{"group":"Overview","pages":[{"title":"Cognigy Webchat","mode":"wide","href":"/webchat"},{"title":"Cognigy Webchat","sidebarTitle":"About Webchat","href":"/webchat/overview"},{"title":"Getting Started with Webchat v3","sidebarTitle":"Getting Started","href":"/webchat/getting-started"}]},{"group":"Set Up","pages":[{"group":"Webchat v3","root":{"title":"Webchat v3","sidebarTitle":"Overview","href":"/webchat/v3/overview"},"pages":[{"title":"Webchat v3: Supported Browsers","sidebarTitle":"Supported Browsers","href":"/webchat/v3/supported-browsers"},{"title":"Webchat 3: Key Features","sidebarTitle":"Key Features","href":"/webchat/v3/features"},{"group":"Endpoint Configuration","pages":[{"title":"Webchat v3: Endpoint Configuration","sidebarTitle":"Endpoint Configuration","href":"/webchat/v3/configuration"},{"title":"Collecting Metadata","sidebarTitle":"Collecting Metadata","href":"/webchat/v3/metadata"}]},{"group":"Embedding","pages":[{"title":"Webchat v3: via Hosted Script (HTML)","sidebarTitle":"Embedding via Hosted Script (HTML)","href":"/webchat/v3/embedding/hosted-script"},{"title":"Webchat 3: Embedding via npm","sidebarTitle":"Embedding via npm","href":"/webchat/v3/embedding/npm"}]},{"title":"Webchat v3: Accessibility","sidebarTitle":"Accessibility","href":"/webchat/v3/accessibility"}]},{"group":"Webchat v2 (Deprecated)","root":{"title":"Webchat v2 (Deprecated)","sidebarTitle":"Overview","href":"/webchat/v2/overview"},"pages":[{"title":"Webchat v2: Supported Browsers","sidebarTitle":"Supported Browsers","href":"/webchat/v2/supported-browsers"},{"title":"Webchat v2: Key Features","sidebarTitle":"Key Features","href":"/webchat/v2/features"},{"title":"Webchat v2: Endpoint Configuration","sidebarTitle":"Endpoint Configuration","href":"/webchat/v2/configuration"},{"title":"Webchat 2: Embedding","sidebarTitle":"Embedding","href":"/webchat/v2/embedding"}]}]},{"group":"Miscellaneous","pages":[{"title":"Migration From v2 to v3","href":"/webchat/migration"},{"title":"Webchat Plugins","href":"/webchat/plugins"},{"title":"Demo Webchat","href":"/webchat/demo"},{"title":"Webchat Cookies","sidebarTitle":"Cookies","href":"/webchat/cookies"},{"title":"Webchat Release Notes","sidebarTitle":"Release Notes","href":"/webchat/release-notes"}]}]},{"dropdown":"xApps","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/xa-logo.svg","pages":[{"group":"Overview","pages":[{"title":"Cognigy xApps","mode":"wide","href":"/xApps"},{"title":"About xApps","href":"/xApps/overview"},{"title":"xApp Use Cases","href":"/xApps/use-cases"}]},{"group":"Build an xApp","pages":[{"title":"xApps Tutorials","sidebarTitle":"Tutorials","href":"/xApps/build/overview"},{"title":"Build your First xApp","href":"/xApps/build/first-xApp"},{"title":"Build an xApp with Multiple Channels","href":"/xApps/build/xApp-with-multi-channels"},{"title":"Build a Standalone xApp","href":"/xApps/build/standalone-xApp"},{"title":"Advanced: Build a Custom xApp Node","href":"/xApps/build/custom-xApp-node"},{"title":"xApp Overlay","href":"/xApps/build/overlay"}]},{"group":"xApp Security","pages":[{"title":"xApp Security: Prevent XSS Attacks","href":"/xApps/security/secure-xApp-from-xss"}]},{"group":"Miscellaneous","pages":[{"title":"xApp Architecture","href":"/xApps/architecture"},{"title":"xApp Tokens","href":"/xApps/tokens"},{"title":"xApp Flow API","href":"/xApps/api"},{"title":"Supported Browsers and Channels","href":"/xApps/supported-browsers-and-channels"}]}]},{"dropdown":"Agent Copilot","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/ac-logo.svg","pages":[{"group":"Overview","pages":[{"title":"Cognigy Agent Copilot","mode":"wide","href":"/agent-copilot"},{"title":"Agent Copilot","sidebarTitle":"About Agent Copilot","href":"/agent-copilot/overview"},{"title":"Use Cases","href":"/agent-copilot/use-cases"},{"group":"Getting Started","root":{"title":"Overview","href":"/agent-copilot/getting-started/overview"},"pages":[{"title":"Getting Started with Agent Copilot for Chat","sidebarTitle":"Chat","href":"/agent-copilot/getting-started/chat"},{"title":"Getting Started with Agent Copilot for Voice","sidebarTitle":"Voice","href":"/agent-copilot/getting-started/voice"},{"title":"Getting Started with Agent Copilot for Voice-to-Chat","sidebarTitle":"Voice-to-Chat","href":"/agent-copilot/getting-started/voice-to-chat"}]},{"title":"Agent Copilot Glossary","sidebarTitle":"Glossary","href":"/agent-copilot/glossary"},{"title":"Browser Requirements","href":"/agent-copilot/installation/browser-requirements"}]},{"group":"Configure","pages":[{"title":"Agent Copilot Configuration","href":"/agent-copilot/configure/overview"},{"title":"Configure the Workspace","href":"/agent-copilot/configure/workspace"},{"title":"Agent Copilot Nodes","sidebarTitle":"Nodes","href":"/agent-copilot/configure/nodes"},{"title":"Copilot Section","href":"/agent-copilot/configure/copilot-section"},{"group":"Examples","root":{"title":"Configuration Examples","sidebarTitle":"Overview","href":"/agent-copilot/configure/examples/overview"},"pages":[{"title":"Grid Example: Real-Time Translation","sidebarTitle":"Real-Time Translation","href":"/agent-copilot/configure/examples/real-time-translation"},{"title":"Grid Example: Knowledge Retrieval","sidebarTitle":"Knowledge Retrieval","href":"/agent-copilot/configure/examples/knowledge-retrieval"}]}]},{"group":"Deploy","pages":[{"title":"Deploy and Integrate Agent Copilot","sidebarTitle":"Deployment Options","href":"/agent-copilot/deploy/overview"},{"title":"Embedded Agent Copilot","sidebarTitle":"Embedded","href":"/agent-copilot/deploy/embedding"},{"title":"Standalone Agent Copilot","sidebarTitle":"Standalone","href":"/agent-copilot/deploy/standalone"},{"title":"NiCE CXone AAH","href":"/agent-copilot/deploy/nice-aah"},{"title":"Agent Copilot Custom Integration","sidebarTitle":"Custom Integration","href":"/agent-copilot/deploy/custom-integration"}]},{"group":"Troubleshoot","pages":[{"title":"Troubleshooting","sidebarTitle":"Common Issues","href":"/agent-copilot/troubleshooting"}]}]},{"dropdown":"Live Agent","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/la-logo.svg","groups":[{"group":"Overview","pages":[{"title":"Cognigy Live Agent","mode":"wide","href":"/live-agent"},{"title":"About Live Agent","href":"/live-agent/overview"},{"group":"Getting Started","root":{"title":"Getting Started with Live Agent","href":"/live-agent/getting-started/overview"},"pages":[{"title":"Set up Live Agent for your Organization","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-org"},{"title":"Set up the Inbox for Live Agent","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-inbox"},{"group":"Handover Setup","root":{"title":"Set up Handover for Live Agent","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-handover"},"pages":[{"title":"Set up a Cognigy Endpoint for Handover","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-handover-endpoint"},{"title":"Set up a Cognigy Flow for Handover","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-handover-flow"}]},{"title":"Add Agents and Admins to Live Agent","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-agents"},{"title":"Add Another Inbox for your Project","href":"/live-agent/getting-started/live-agent-setup/live-agent-setup-additional-inbox"}]},{"title":"Live Agent Glossary","sidebarTitle":"Glossary","href":"/live-agent/glossary"},{"title":"Browser Requirements","href":"/live-agent/installation/browser-requirements"}]},{"group":"Conversations","pages":[{"title":"Conversations","sidebarTitle":"Live Agent Conversations","href":"/live-agent/conversation/overview"},{"title":"Conversation Assignment","href":"/live-agent/conversation/assign-conversations"},{"title":"Conversation Queue","href":"/live-agent/conversation/conversation-queue/overview"},{"group":"Conversation Routing","root":{"title":"Conversation Routing","href":"/live-agent/conversation/conversation-routing/overview"},"pages":[{"title":"Manual Mode","href":"/live-agent/conversation/conversation-routing/manual-mode"},{"title":"Automatic Mode","href":"/live-agent/conversation/conversation-routing/automatic-mode"}]},{"title":"Send Replies","href":"/live-agent/conversation/send-reply"},{"title":"Search, Filter, and Sort Conversations","href":"/live-agent/conversation/search-and-filter"},{"title":"Other Operations","href":"/live-agent/conversation/other-operations"}]},{"group":"Assistants","pages":[{"title":"Live Agent Assistants","href":"/live-agent/assistants/overview"},{"title":"Agent Copilot Whisper","href":"/live-agent/assistants/agent-copilot-whisper"},{"title":"Agent Copilot in Live Agent","href":"/live-agent/assistants/agent-copilot"},{"title":"Agent Copilot Bot","href":"/live-agent/assistants/agent-copilot-bot"}]},{"group":"Analytics Tools","pages":[{"group":"Reports","root":{"title":"Overview","href":"/live-agent/reports/overview"},"pages":[{"group":"Supervisor","pages":[{"title":"Supervisor Overview Report","href":"/live-agent/reports/supervisor-overview"}]},{"group":"Admin","root":{"title":"Administrator Reports","href":"/live-agent/reports/admin/overview"},"pages":[{"title":"Conversations Report","href":"/live-agent/reports/admin/conversations"},{"title":"Agents Report","href":"/live-agent/reports/admin/agents"},{"title":"Labels Report","href":"/live-agent/reports/admin/labels"},{"title":"Inboxes Report","href":"/live-agent/reports/admin/inboxes"},{"title":"Teams Report","href":"/live-agent/reports/admin/teams"}]}]},{"title":"Live Agent OData Analytics Endpoint","sidebarTitle":"OData","href":"/live-agent/tools/odata-endpoint"}]},{"group":"Configure","pages":[{"group":"Settings","root":{"title":"Settings","href":"/live-agent/settings/overview"},"pages":[{"title":"Agents","href":"/live-agent/settings/agents"},{"title":"Teams","href":"/live-agent/settings/teams"},{"title":"Inboxes","href":"/live-agent/settings/inboxes"},{"title":"Labels","href":"/live-agent/settings/labels"},{"title":"Skills","href":"/live-agent/settings/skills"},{"title":"Automation","href":"/live-agent/settings/automation-rules"},{"title":"Canned Responses","href":"/live-agent/settings/canned-responses"},{"title":"Attachments","href":"/live-agent/settings/attachments"},{"title":"Audit Logs","href":"/live-agent/settings/audit-logs"},{"title":"Account Settings","href":"/live-agent/settings/account-settings"}]}]},{"group":"Access Management","pages":[{"title":"Roles","href":"/live-agent/roles"}]},{"group":"User Profile and Notifications","pages":[{"title":"Notifications","href":"/live-agent/notifications"},{"title":"Profile Settings","href":"/live-agent/profile-settings"}]},{"group":"Miscellaneous","pages":[{"title":"Cognigy Live Agent API","href":"/live-agent/api"},{"title":"Questions and Answers","href":"/live-agent/FAQs"}]}]},{"dropdown":"AI Ops Center","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/oc-logo.svg","pages":[{"group":"Overview","pages":[{"title":"Cognigy AI Operations Center","sidebarTitle":"AI Ops Center","mode":"wide","href":"/ops-center"},{"title":"What's AI Ops Center?","sidebarTitle":"About AI Ops Center","href":"/ops-center/overview"},{"title":"Getting Started with AI Ops Center","sidebarTitle":"Getting Started","href":"/ops-center/getting-started"},{"title":"Key Concepts","href":"/ops-center/concepts"},{"title":"AI Ops Center Glossary","sidebarTitle":"Glossary","href":"/ops-center/glossary"}]},{"group":"Monitor","pages":[{"group":"Metrics","pages":[{"title":"Overview","href":"/ops-center/monitor/metrics/overview"},{"title":"Voice Gateway Metrics","sidebarTitle":"Voice Gateway","href":"/ops-center/monitor/metrics/voice-gateway"},{"title":"Endpoint Metrics","sidebarTitle":"Endpoints","href":"/ops-center/monitor/metrics/endpoints"},{"title":"Flow Metrics","sidebarTitle":"Flows","href":"/ops-center/monitor/metrics/flows"},{"title":"Handover Provider Metrics","sidebarTitle":"Handover Providers","href":"/ops-center/monitor/metrics/handover-providers"}]},{"title":"Alerts","href":"/ops-center/monitor/alerts"},{"title":"Errors","href":"/ops-center/monitor/errors"}]},{"group":"Manage","pages":[{"title":"Manage Alerts","href":"/ops-center/manage/alerts"},{"title":"Resolve Errors","href":"/ops-center/manage/errors"},{"title":"Assign Roles","href":"/ops-center/manage/roles"}]},{"group":"Troubleshoot","pages":[{"title":"Common Issues","href":"/ops-center/troubleshooting"}]}]},{"dropdown":"Insights","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/in-logo.svg","pages":[{"group":"Overview","pages":[{"title":"Cognigy Insights","mode":"wide","href":"/insights"},{"title":"Cognigy Insights","sidebarTitle":"What's Insights?","href":"/insights/overview"},{"title":"Insights Glossary","sidebarTitle":"Glossary","href":"/insights/glossary"}]},{"group":"Dashboards","pages":[{"group":"Conversation Analyzer","root":{"title":"Conversation Analyzer","sidebarTitle":"Overview","href":"/insights/conversation-analyzer/overview"},"tag":"beta","pages":[{"title":"Topic Discovery","href":"/insights/conversation-analyzer/topic-discovery"},{"title":"Basic Analysis","href":"/insights/conversation-analyzer/basic-analysis"},{"title":"Custom Evaluation","href":"/insights/conversation-analyzer/custom-evaluation"}]},{"title":"Business Dashboard","href":"/insights/dashboards/business"}]},{"group":"Reports","pages":[{"title":"Overview","sidebarTitle":"Overview Report","href":"/insights/reports/overview"},{"title":"Engagement","href":"/insights/reports/engagement"},{"title":"NLU Performance","href":"/insights/reports/nlu-performance"},{"title":"Live Agent","href":"/insights/reports/live-agent"},{"title":"Goals","href":"/insights/reports/goals"}]},{"group":"Explorers","pages":[{"title":"Conversations (former Transcript Explorer)","tag":"beta","href":"/insights/explorers/conversations"}]},{"group":"Filter and Sort","pages":[{"title":"Global Filters","href":"/insights/global-filters"}]},{"group":"Data Management","pages":[{"title":"Data Expiration in Insights","sidebarTitle":"Data Expiration","href":"/insights/data-management/data-expiration"},{"title":"Data Pre-Aggregation","href":"/insights/data-management/pre-aggregation"},{"title":"Time Zone with Pre-Aggregation","href":"/insights/data-management/time-zone-with-pre-aggregation"},{"title":"Time Zone","href":"/insights/data-management/time-zone"}]},{"group":"Download Reports","pages":[{"title":"Download Reports in CSV","href":"/insights/download-reports"}]}]},{"dropdown":"Support","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/support-logo.svg","pages":[{"title":"Cognigy Support","sidebarTitle":"Cognigy Support","mode":"wide","href":"/help"},{"title":"Welcome to Cognigy Academy","sidebarTitle":"Cognigy Academy","href":"/help/cognigy-academy"},{"title":"Get help and report problems","sidebarTitle":"Get help","href":"/help/get-help"}]},{"dropdown":"Release Notes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cognigy-15abf2ba/_assets/icons/dropdown/release-notes-logo.svg","pages":[{"title":"Release Notes Index","href":"/release-notes"},{"title":"Deprecations and Removals","href":"/release-notes/deprecations-and-removals"},{"group":"Product Versions","pages":[{"group":"2026.2x","pages":[{"title":"2026.21 (latest)","href":"/release-notes/2026.21"},{"title":"2026.20","href":"/release-notes/2026.20"}]},{"group":"2026.1x","pages":[{"title":"2026.19","href":"/release-notes/2026.19"},{"title":"2026.18","href":"/release-notes/2026.18"},{"title":"2026.17","href":"/release-notes/2026.17"},{"title":"2026.16","href":"/release-notes/2026.16"},{"title":"2026.15","href":"/release-notes/2026.15"},{"title":"2026.14","href":"/release-notes/2026.14"},{"title":"2026.13","href":"/release-notes/2026.13"},{"title":"2026.12","href":"/release-notes/2026.12"},{"title":"2026.11","href":"/release-notes/2026.11"},{"title":"2026.10","href":"/release-notes/2026.10"}]},{"group":"2026.x","pages":[{"title":"2026.9","href":"/release-notes/2026.9"},{"title":"2026.8","href":"/release-notes/2026.8"},{"title":"2026.7","href":"/release-notes/2026.7"},{"title":"2026.6","href":"/release-notes/2026.6"},{"title":"2026.5","href":"/release-notes/2026.5"},{"title":"2026.4","href":"/release-notes/2026.4"},{"title":"2026.3","href":"/release-notes/2026.3"},{"title":"2026.2","href":"/release-notes/2026.2"},{"title":"2026.1","href":"/release-notes/2026.1"}]},{"group":"2025.2x","pages":[{"title":"2025.25","href":"/release-notes/2025.25"},{"title":"2025.24","href":"/release-notes/2025.24"},{"title":"2025.23","href":"/release-notes/2025.23"},{"title":"2025.22","sidebarTitle":"2025.22","href":"/release-notes/2025.22"},{"title":"2025.21","sidebarTitle":"2025.21","href":"/release-notes/2025.21"},{"title":"2025.20","sidebarTitle":"2025.20","href":"/release-notes/2025.20"}]},{"group":"2025.1x","pages":[{"title":"2025.19","sidebarTitle":"2025.19","href":"/release-notes/2025.19"},{"title":"2025.18","sidebarTitle":"2025.18","href":"/release-notes/2025.18"},{"title":"2025.17","href":"/release-notes/2025.17"},{"title":"2025.16","href":"/release-notes/2025.16"},{"title":"2025.15","href":"/release-notes/2025.15"},{"title":"2025.14","href":"/release-notes/2025.14"},{"title":"2025.13","href":"/release-notes/2025.13"},{"title":"2025.12","href":"/release-notes/2025.12"},{"title":"2025.11","href":"/release-notes/2025.11"},{"title":"2025.10","href":"/release-notes/2025.10"}]},{"group":"4.10x","pages":[{"title":"4.100","href":"/release-notes/4.100"}]},{"group":"4.9x","pages":[{"title":"4.99","href":"/release-notes/4.99"},{"title":"4.98","href":"/release-notes/4.98"},{"title":"4.97","href":"/release-notes/4.97"},{"title":"4.96","href":"/release-notes/4.96"},{"title":"4.95","href":"/release-notes/4.95"},{"title":"4.94","href":"/release-notes/4.94"},{"title":"4.93","href":"/release-notes/4.93"},{"title":"4.92","href":"/release-notes/4.92"},{"title":"4.91","href":"/release-notes/4.91"},{"title":"4.90","href":"/release-notes/4.90"}]},{"group":"4.8x","pages":[{"title":"4.89","href":"/release-notes/4.89"},{"title":"4.88","href":"/release-notes/4.88"},{"title":"4.87","href":"/release-notes/4.87"},{"title":"4.86","href":"/release-notes/4.86"},{"title":"4.85","href":"/release-notes/4.85"},{"title":"4.84","href":"/release-notes/4.84"},{"title":"4.83","href":"/release-notes/4.83"},{"title":"4.82","href":"/release-notes/4.82"},{"title":"4.81","href":"/release-notes/4.81"},{"title":"4.80","href":"/release-notes/4.80"}]},{"group":"4.7x","pages":[{"title":"4.79","href":"/release-notes/4.79"},{"title":"4.78","href":"/release-notes/4.78"},{"title":"4.77","href":"/release-notes/4.77"},{"title":"4.76","href":"/release-notes/4.76"},{"title":"4.75","href":"/release-notes/4.75"},{"title":"4.74","href":"/release-notes/4.74"},{"title":"4.73","href":"/release-notes/4.73"},{"title":"4.72","href":"/release-notes/4.72"},{"title":"4.71","href":"/release-notes/4.71"},{"title":"4.70","href":"/release-notes/4.70"}]},{"group":"4.6x","pages":[{"title":"4.69","href":"/release-notes/4.69"},{"title":"4.68","href":"/release-notes/4.68"},{"title":"4.67 - Happy New Year ๐โ๏ธ","href":"/release-notes/4.67"},{"title":"4.66 - Merry Christmas ๐๐","href":"/release-notes/4.66"},{"title":"4.65","href":"/release-notes/4.65"},{"title":"4.64","href":"/release-notes/4.64"},{"title":"4.63 - Happy Halloween ๐ฆ","href":"/release-notes/4.63"},{"title":"4.62","href":"/release-notes/4.62"},{"title":"4.61","href":"/release-notes/4.61"},{"title":"4.60","href":"/release-notes/4.60"}]},{"group":"4.5x","pages":[{"title":"4.59","href":"/release-notes/4.59"},{"title":"4.58","href":"/release-notes/4.58"},{"title":"4.57","href":"/release-notes/4.57"},{"title":"4.56","href":"/release-notes/4.56"},{"title":"4.55","href":"/release-notes/4.55"},{"title":"4.54","href":"/release-notes/4.54"},{"title":"4.53","href":"/release-notes/4.53"},{"title":"4.52","href":"/release-notes/4.52"},{"title":"4.51 - Happy Telecommunications Day ๐ก","href":"/release-notes/4.51"},{"title":"4.50 - Happy World Password Day ๐","href":"/release-notes/4.50"}]},{"group":"4.4x","pages":[{"title":"email notification authentication secret.","sidebarTitle":"4.49","href":"/release-notes/4.49"},{"title":"4.48 - Happy Easter ๐","href":"/release-notes/4.48"},{"title":"4.47 - Happy Math Day ๐งฎ","href":"/release-notes/4.47"},{"title":"4.46 - Happy National Be Heard Day ๐๐ค","href":"/release-notes/4.46"},{"title":"4.45 - Happy Family National Day ๐จโ๐ฉโ๐งโ๐ฆ","href":"/release-notes/4.45"},{"title":"4.44 - Happy Get Up National Day ๐ง ๐","href":"/release-notes/4.44"},{"title":"4.43 - Happy National Pie Day ๐ฅง","href":"/release-notes/4.43"},{"title":"4.42 - Happy New Year โจ","href":"/release-notes/4.42"},{"title":"4.41 - Merry X-Mas ๐ ๐ป๐","href":"/release-notes/4.41"},{"title":"4.40","href":"/release-notes/4.40"}]},{"group":"4.3x","pages":[{"title":"4.39","href":"/release-notes/4.39"},{"title":"4.38 - Happy Halloween ๐","href":"/release-notes/4.38"},{"title":"4.37","href":"/release-notes/4.37"},{"title":"4.36","href":"/release-notes/4.36"},{"title":"4.35","href":"/release-notes/4.35"},{"title":"4.34","href":"/release-notes/4.34"},{"title":"4.33","href":"/release-notes/4.33"},{"title":"4.32","href":"/release-notes/4.32"},{"title":"4.31","href":"/release-notes/4.31"},{"title":"4.30","href":"/release-notes/4.30"}]},{"group":"Earlier Product Versions","pages":[{"title":"Earlier Versions","sidebarTitle":"Overview","href":"/release-notes/earlier-versions/overview"},{"title":"Cognigy","href":"/release-notes/earlier-versions/cognigy-ai-pre-4.30"},{"title":"Cognigy Insights","href":"/release-notes/earlier-versions/insights-pre-4.30"},{"title":"Cognigy Live Agent","href":"/release-notes/earlier-versions/live-agent-pre-4.30"}]}]}]}]},"title":"ringing - Cognigy Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["10e4515597"],"chunks":["BannerMarkdown-BVNUlwBc.js","dist-aeztFa9U.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-rL8ZCCw4.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}