> For the complete documentation index, see [llms.txt](https://library.zoom.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://library.zoom.com/technical-library/nl/zoom-workplace/zoom-phone/third-party-integrations/zoom-and-mitel-phone-system-integration-field-guide.md).
# Veldgids voor de integratie(s) van Zoom en Mitel Telefoonsysteem
### Overzicht
Zoom en Mitel werken samen om je VoIP-systeem te verbeteren. Met deze Telefoonsysteem Integratie(s) — of PSI — haal je het beste van beide werelden in huis: de samenwerkingskracht van Zoom Workplace en de belmogelijkheden van je bestaande Mitel-systeem, allemaal vanuit de desktop- en mobiele Zoom Workplace-apps.
Als je Zoom Workplace al gebruikt, bezig bent met Aan de slag met Zoom Workplace, of meer Zoom Workplace-functies wilt toevoegen en je een compatibele Mitel-opstelling hebt, is deze Integratie(s) een goede keuze.
Hier is het idee: je Zoom Phone Tabblad wordt een SIP (sessie-initiatieprotocol) softphone die rechtstreeks verbindt met het bel Platform van Mitel. Als je via internet aan het Verbinden bent, gebruikt het Mitel's OpenScape sessiegrens Controller, of SBC. Je gebruikt ook Mitel CloudLink om aanmelden makkelijker te maken en gebruikers soepeler te beheren tussen Zoom en Mitel.
Even een heads-up: je hebt alle juiste Zoom- en Mitel-componenten nodig om deze Integratie(s) goed te laten werken.
#### Zoom en Mitel PSI-functies
Deze Integratie(s) brengt een hele reeks functies naar je huidige Mitel-implementatie. Hier zijn er slechts een paar waarvan je kunt profiteren:
* Bellen en oproepen ontvangen
* Meerdere oproepen tegelijk afhandelen
* Oproepen In de wacht zetten of een vergadering starten
* Oproepen doorverbinden (cold of warm)
* Access voicemail
* Bekijk de geschiedenis van bellen en logs
* Stel doorschakelen van bellen in
* Gebruik de modus Niet storen
* Synchroniseren van zakelijke contacten
* Zet bellen via de telefoon om in een Zoom-vergadering
* Bekijk aanwezigheidsstatus tussen Zoom Apps (beperkt met Mitel-telefoons)
* Ga van chatbericht naar een PSI-bellenoproep
#### Vereisten op hoog niveau
De volgende secties schetsen vereisten op hoog niveau voor deze Integratie(s).
**Zoom-specifieke details**
Om alles aan de Zoom-kant aan de praat te krijgen, heb je nodig:
* Een accounteigenaar of beheerder Rol om gebruikers, de PSI en Zoom Phone te beheren
* Een ondersteunde licentie per gebruiker, zoals:
* Zoom Workplace Zakelijk/Zakelijk+
* Zoom Workplace Essentials/Onderneming/Onderneming+/Onderneming Premier
* Verouderde vergaderinglicenties (ENH/EAH)
* Elk plan met Zoom Phone Pro
* Zoom Phone geconfigureerd en Actief voor uw Organisatie
* [**Automatische telefoontoewijzing**](#disable-the-automatic-phone-license-assignment-for-zoom-workplace) uitgeschakeld voor Zoom Workplace-licenties
* Zoom Workplace app versie 6.3.6 of hoger
**Mitel-specifieke details**
Aan de kant van Mitel heb je het volgende nodig:
**PBX Hardware-compatibiliteit:**
* OpenScape Voice (OSV)
* OpenScape 4k (OS4k)
* Mitel CloudLink
* MiVoice Zakelijk (MiVB)
**Ondersteunde apps en platforms:**
* Mitel Administratie app
* OpenScape 4000 Platform (voor OS4k)
* OpenScape Common Management Platform (voor OSV)
* OpenScape SBC-beheerportaal (voor OSV en OS4k)
* OpenScape SBC (voor externe Registratie met OSV/OS4k)
**Licenties:**
* Mitel ZoomPSI of Hybrid
* Teleworker licentie
Er zijn een paar belangrijke dingen die u moet weten voordat u het Integratie(s)-proces start:
* De Zoom Workplace app gebruikt de [Standaard Firewall-poorten en IP-bereiken](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060548).
* De IP-adressen en poorten voor telefonische signalering/media worden bepaald door de Mitel-configuratie en kunnen afwijken van de Standaard. Neem contactpersoon op met Mitel of uw Mitel-partner als u aanvullende informatie nodig hebt.
* U moet een Teleworker-licentie hebben voor zowel de desktop- als mobiele apps van Zoom Workplace — twee licenties per gebruiker. Deze zijn essentieel voor Verbinden met de Mitel PBX.
### Architectuur
#### Standaard Integratie(s) Architectuur
Belangrijkste verbindingen:
* **Zoom-cloud naar Mitel CloudLink**: REST API via TLS
* **Zoom Workplace-verbinding**: TLS naar de datacenters van Zoom
* **Apparaat van de gebruiker naar Mitel**: Telefonische signalering/media via TLS
* **Mitel CloudLink naar PBX**: Gepatenteerde protocollen
#### Hybride configuratie
Organisaties draaien zowel Zoom Phone als de Mitel Integratie(s) tegelijkertijd. Gebruikers met Zoom Phone-licenties verbinden met Zoom Phone SBC, terwijl gebruikers met de Mitel Integratie(s) verbinding maken met Mitel SBC. Met een BYOP-trunk die hen Verbinden, kunnen gebruikers extensies tussen verschillende systemen kiezen.
#### Technisch architectuuroverzicht
**Mitel CloudLink-verbinding**
CloudLink is een Cloud-gebaseerd Platform dat uw on-premises PBX overbrugt met Cloudoplossingen. Zoom maakt gebruik van CloudLink voor Cloud API Access tot Mitel PBX-componenten, waardoor één interface ontstaat in plaats van dat men de unieke Taal van elke PBX moet 'spreken'.
{% hint style="success" %}
**Voorbeeld**
Wanneer u Niet storen inschakelt, stuurt Zoom één API-opdracht naar CloudLink, die deze interpreteert voor de specifieke Mitel PBX (OS4K versus MiVoice Zakelijk behandelen dit anders).
{% endhint %}
**Zoom-cloud naar CloudLink-synchronisatie**
U brengt veilige communicatie tot stand via **Zoom Apps** van beide **Zoom** en **CloudLink**. Wanneer u deze apps installeert, moet een beheerder inloggen op beide systemen om een veilige OAuth-verbinding op te zetten.
Zodra de verbinding tot stand is gebracht, haalt Zoom de telefooninloggegevens van de gebruiker op via TLS:
* SIP "Naam gebruiker" (vaak het telefoonnummer)
* SIP-inloggegevens (alleen beveiligde hash)
* Registratie-IP-adressen (SBC en back-up-SBC, of interne PBX)
**app Registratieproces**
1. Zoom-cloud geeft inloggegevens door aan de Zoom Workplace-app van de gebruiker via TLS
2. Zoom Workplace activeert het Tabblad Telefoon
3. De Zoom Workplace app maakt rechtstreeks verbinding met de Mitel SBC of PBX via TLS (niet geproxied via Zoom-cloud)
**Extra** **Flows**
* Functies: De Zoom Workplace app communiceert rechtstreeks met Mitel CloudLink via REST API over TLS voor bellenlogboeken, voicemailberichten en de Niet storen-status
* Mobiele push: Mitel SBC stuurt pushmeldingen naar Zoom-cloud, die ze doorstuurt naar mobiele apparaten
* Netwerkaanpassing: Gebruikers op afstand verbinden via CloudLink en Mitel SBC. Desktops op locatie verbinden rechtstreeks met Mitel PBX. Mobiele apparaten gebruiken de veilige externe route.
### Configureer de Integratie(s)
De Integratie(s) is eenvoudig tussen Zoom en Mitel, waarbij het werk aan de Zoom-kant gemiddeld ongeveer 45 minuten duurt, met een groter deel aan de Mitel-kant. Neem voor aanvullende vragen of informatie over de timing contact op met Mitel of uw Mitel-partner.
Elke beheerder die deze stappen uitvoert, heeft de **Telefoonsysteem Integratie(s)** Toestemming om alle stappen te voltooien.
#### Voltooi de initiële Zoom Phone-installatie
Als u een nieuwe klant bent en Zoom Phone nog niet hebt geconfigureerd, volg dan ons ondersteuningsdocument over [Aan de slag met Zoom Phone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060257#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13). Anders, ga door met de volgende stap.
#### Uitschakelen van de automatische toewijzing van Zoom Phone-licenties voor Zoom Workplace
Om de automatische licentietoewijzing voor Zoom Phone voor alle gebruikers in het account uit te schakelen:
1. Meld u aan bij de [Zoom-webportal](https://zoom.us/profile) als beheerder.
2. In het [**Beheerdercentrum**](https://zoom.com/account) navigatiemenu, klik [**Instellingen**](https://zoom.com/account/setting).
3. Klik op de **Zoom Phone** Tabblad.
4. Onder **Algemeen**, klik op de **Zoom Phone-gebruikers automatisch activeren** Gebruik de In-/uitschakelen-optie om het uit te schakelen.
5. Als een Verificatie-dialoogvenster wordt weergegeven, klik **Uitschakelen** om de wijziging te verifiëren.
#### Gebruikers toevoegen aan Zoom
U kunt gebruikers afzonderlijk toevoegen, met een CSV-bestand of via SSO (Single Sign-On), met behulp van de stappen in ons ondersteuningsdocument over [Gebruikersbeheer](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0061789#h_8b193526-997c-4385-955b-ffddda0b0404). Als u een bestaande gebruiker uitnodigt om lid te worden van uw Zoom-account, lees dan meer over het proces van [bestaande gebruikers toevoegen aan een betaald account](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063202), zoals het afhandelen van eventuele resterende bedragen en gegevens die naar uw account worden overgedragen.
#### Licenties toewijzen aan gebruikers
U kunt Zoom-productlicenties afzonderlijk of in bulk toewijzen. Meer informatie is beschikbaar over hoe u [Zoom-licenties toewijzen](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064911) in het gekoppelde artikel.
#### Installeer de Mitel-app vanuit Zoom App Marketplace
Volg onderstaande stappen om Zoom te verbinden met Mitel CloudLink:
1. Meld u aan bij de [Zoom-webportal](https://zoom.us/profile) als beheerder.
2. Klik in het linkernavigatiemenu onder **Geavanceerd** op **App Marketplace**.
3. Gebruik het zoekvak om de **Mitel PSI-app** te vinden en selecteer deze. Klik op **Toevoegen**.
4. Klik op **Connector maken**.
5. Klik op **Verbinden** om te bevestigen dat u de connector van de derde partij Mitel Connector wilt verbinden met uw Zoom-account. Er wordt een Browservenster geopend dat u doorstuurt naar Mitel CloudLink.
6. Aanmelden bij Mitel CloudLink. De communicatie tussen Zoom en Mitel's CloudLink is nu voltooid.
{% hint style="info" %}
**Opmerking**
Mitel heeft ook een App Store voor CloudLink waar Zoom aan kan worden toegevoegd, zodat u wordt doorgestuurd naar Zoom om de actie te voltooien.
{% endhint %}
#### Instellingen voor telefoonintegratie configureren
Volg onderstaande stappen om gebruikers van de mobiele app van Zoom Workplace via een Mitel-systeem op locatie te laten bellen:
1. Meld u aan bij de [Zoom-webportal](https://zoom.us/profile) als beheerder.
2. Klik in het linkernavigatiemenu op **Accountbeheer**, en vervolgens **Telefoonsysteem Integratie(s)**.
3. Klik op de **Instellingen** Tabblad.
4. Selecteer voor het integreren van bellen in de mobiele app van Zoom Workplace de **Sta het gebruik van het geïntegreerde telefoonsysteem toe om te bellen op de mobiele Zoom-client** In-/uitschakelen.
5. Als een Verificatie-dialoogvenster verschijnt, klik **Inschakelen** of **Uitschakelen** om de wijziging te verifiëren.
{% hint style="info" %}
**Notities**
* Zorg ervoor dat deze instelling altijd is ingeschakeld.
* Als deze optie is ingeschakeld en de gebruikers op de lijst met Telefoonsysteemintegratie staan, kunnen deze gebruikers een Mitel-systeem op locatie gebruiken om via de mobiele app van Zoom Workplace te bellen.
{% endhint %}
#### Zoom-gebruikers toevoegen aan de Mitel PSI
U kunt ervoor kiezen om gebruikers handmatig of in bulk via CSV toe te voegen. Zie de stappen voor [Zoom-gebruikers toevoegen aan de Mitel-integratie](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurdfim2r8) in ons gekoppelde ondersteuningsartikel.
#### Verifieer de Zoom-Mitel-integratie in de Zoom Workplace-app
Om te verifiëren dat de integratie correct is geconfigureerd, meldt u zich aan bij de Zoom Workplace-app (desktop of mobiel) en klikt u op het **Telefoon** Tabblad. Zorg ervoor dat u de beller-ID (toestelnummer van Mitel) kunt zien en dat er geen foutmeldingen zijn. Als er fouten zijn, geeft de statuskolom relevante informatie:
| Status | Beschrijving |
| ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| **SIP-inloggegevens in afwachting** | Wachten tot CloudLink de gebruiker autoriseert. |
| **Inactief** | De SIP-inloggegevens zijn al gesynchroniseerd met Zoom, maar de gebruiker heeft zich nog niet geregistreerd bij de Zoom Workplace-app. |
| **Geregistreerd** | De Zoom Workplace-app is succesvol geregistreerd bij de SIP-server. |
| **SIP-foutcodes (verschillende)** | Dit biedt veelvoorkomende SIP-foutcodes en een algemene beschrijving om te helpen bij het oplossen van het registratieprobleem. |
#### Mitel Gebruikersbeheer configureren
Gebruik de verwijzingen in onze [Zoom-Mitel PSI-configuratie](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) handleiding voor informatie om u op weg te helpen. Neem contactpersoon op met Mitel of uw Mitel-partner voor vragen of aanvullende informatie.
#### Beveiligingsoverwegingen
Onze [Zoom-Mitel PSI-configuratie](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) handleiding bevat enkele beveiligingsoverwegingen voor uw Organisatie. Neem contactpersoon op met Mitel of uw Mitel-partner voor vragen of aanvullende informatie.
#### Externe contactpersonen beheren (niet-Zoom-contactpersonen)
Eigenaren van een account en beheerders kunnen een gedeelde adreslijst met externe contactpersonen maken. Meer informatie vindt u in onze[ Zoom-Mitel PSI-configuratie](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) handleiding. Neem contactpersoon op met Mitel of uw Mitel-partner voor vragen of aanvullende informatie.
#### Gebruik uw eigen PBX (BYOP)
Met BYOP kunt u een SIP-trunk opzetten tussen Zoom Phone en Mitel voor bellen op basis van extensies. Combineer naar wens — sommige kantoren gebruiken Zoom Phone, terwijl andere de Mitel-Integratie(s) gebruiken. Met een BYOP-trunk bellen gebruikers extensies tussen systemen.
Deze configuratie vereist extra firewallregels en gebruikt Mutual TLS. Raadpleeg onze ondersteuning-locatie voor de vereisten. We hebben samen met Mitel geschreven ondersteuningsdocumenten voor OpenScape SBC en MiVoice Border Gateway; ze zijn Beschikbaar op onze door Zoom Phone ondersteunde Hardware-pagina.
#### Ondersteuning voor Mitel-bureautelefoons op Zoom Phone
Elke gebruiker op Zoom Phone kan Mitel-bureautelefoons gebruiken die rechtstreeks op Zoom Phone worden geregistreerd. Raadpleeg voor een lijst met ondersteunde modellen Zoom’s [lijst met gecertificeerde Hardware](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060242).
### Veelgestelde vragen
#### Een licentie- of software-update kan vereist zijn, afhankelijk van uw Mitel-systeemconfiguratie
Elke Mitel-configuratie is anders, dus wat u nodig hebt hangt af van uw specifieke configuratie. Uw Mitel-partner kan uw systeem snel beoordelen en u vertellen of u licentie-upgrades (zoals Teleworker-licenties) of software-updates nodig hebt om alles compatibel te maken. Het is de moeite waard om dit snel te controleren, omdat de vereisten sterk variëren tussen implementaties.
#### Mitel CloudLink is vereist om deze Integratie(s) te laten werken
Ja, CloudLink is cruciaal. Het helpt alles te Synchroniseren tussen Zoom en uw Mitel-systeem, zoals de gegevens van elke gebruiker en inloggegevens. Het vereenvoudigt ook het beheer van elke gebruiker.
#### Ja, deze Integratie(s) werkt naast Zoom Phone-implementaties
U kunt mixen en matchen — sommige kantoren kunnen niet-geïntegreerde Zoom Phone gebruiken terwijl andere de Mitel Integratie(s) gebruiken. Met een BYOC/BYOP-trunk die hen Verbinden, kunnen gebruiker(s) zelfs extensies tussen verschillende systemen kiezen. Gebruik wat het beste werkt voor elke locatie.
#### Je kunt zowel een Mitel-bureautelefoon als de Zoom Workplace app gebruiken
De Zoom Workplace app werkt naast je bestaande bureautelefoon, niet in plaats daarvan. Beide kunnen overgaan wanneer iemand je toestelnummer belt, zodat je kunt opnemen wat je het handigst vindt. Je Mitel-systeem behandelt Zoom Phone als nog een telefoon op je bureau.
#### Zoom maakt verbinding met Mitel via CloudLink
CloudLink is de brug die Zoom en Mitel met elkaar laat communiceren. Het regelt drie belangrijke dingen: controleren of de gebruiker is wie die zegt te zijn, de informatie van de gebruiker tussen beide systemen synchroniseren en de inloggegevens die Zoom nodig heeft om verbinding te maken met je Mitel-systeem veilig doorgeven. Zonder CloudLink als vertaler zouden deze twee systemen niet kunnen samenwerken — het is wat de Integratie(s) mogelijk maakt.
#### Je kunt geen sms-berichten verzenden via deze Integratie(s)
sms wordt op dit moment niet ondersteund, omdat de Zoom Workplace app in wezen als een softphone fungeert die alleen voor bellen verbinding maakt met je Mitel-systeem. sms werkt op totaal andere technologie die je Mitel-systeem apart afhandelt. Zie het zo: Zoom leent de functies om te bellen van je Mitel-systeem, maar sms bevindt zich in een ander deel van dat systeem dat niet toegankelijk is via deze Integratie(s). Voor nu zul je je huidige Mitel-smstools moeten blijven gebruiken, al kan dit in toekomstige updates Wijzigen.
#### De Network Connectivity Tool werkt niet met Mitel-telefoons
De Network Connectivity Tool van Zoom kan je Mitel-telefoonverbindingen niet testen, omdat hij is ontworpen om de eigen servers van Zoom te controleren en niet je Mitel-systeem. Wanneer je deze Integratie(s) gebruikt, verlopen je gesprekken via het netwerk van Mitel (rechtstreeks naar je PBX of via de servers van Mitel), dus de testtool van Zoom kan die paden simpelweg niet zien of testen. Het is alsof je een diagnosetool van een auto op een ander merk probeert te gebruiken — ze spreken gewoon verschillende talen. De tool werkt nog steeds prima om je gewone verbindingen voor Zoom-vergaderingen te testen.
#### Zoom-gebruikers kunnen niet zien of de gebruiker aanwezig is als die alleen een Mitel-bureautelefoon heeft
Je traditionele Mitel-bureautelefoons delen met Zoom niet of iemand Beschikbaar is of aan het bellen is. De Integratie(s) werkt geweldig om aanwezigheid weer te geven tussen gebruikers van de Zoom Workplace app, maar die ouderwetse bureautelefoons werken in hun eigen wereld en kunnen hun status niet delen met het Zoom-systeem. Het staat op de roadmap om dit te verbeteren, maar voorlopig zie je alleen aanwezigheid voor mensen die de Zoom Workplace app daadwerkelijk gebruiken.
#### Momenteel zijn er geen AI-functies beschikbaar met de Mitel PSI Integratie(s)
Je bellen lopen via het systeem van Mitel, niet via Zoom's Cloud waar de AI draait, dus Zoom AI kan geen toegang krijgen tot je gesprekken. Dat betekent geen automatische voicemail-transcriptie, samenvattingen van bellen of andere AI-functies die je zou krijgen met een niet-geïntegreerde Zoom Phone. De bellen omzeilen de AI-verwerking van Zoom volledig. Toekomstige updates kunnen dit Wijzigen, maar voorlopig moet je de AI-tools gebruiken die je Mitel-systeem biedt.
#### Als er na de installatie iets niet werkt, controleer dan uw Phone Integratie(s)-Instellingen in Zoom
Als oproepen niet werken, controleer dan de Synchroniseren-status op het Tabblad Geïntegreerde gebruikers in de Instellingen voor Telefoonsysteem Integratie(s) in de beheerportal. Fouten bij Synchroniseren betekenen meestal dat CloudLink geen inloggegevens correct doorgeeft — dan wilt u uw CloudLink-logboeken controleren om te zien wat er mis is.
#### U bent verantwoordelijk voor de certificaten van uw Apparaat
Omdat je aan het Verbinden bent met je eigen Mitel-systeem (niet met de servers van Zoom), moet je de beveiligingscertificaten van je bedrijf op elk Apparaat installeren dat deze Integratie(s) zal gebruiken. Zie certificaten als digitale sleutels — Zoom beheert zijn eigen sleutels voor een niet-geïntegreerde Zoom Phone, maar met deze Integratie(s) gebruik je je eigen "sleutels" om te Verbinden met je eigen systeem. Je IT-team moet ervoor zorgen dat op elke laptop, telefoon en Tablet de juiste certificaten zijn geïnstalleerd, anders kunnen ze geen beveiligde verbindingen maken met je Mitel-systeem.
#### Verbinden is eenvoudig, of je nu op locatie bent of op het bedrijfsnetwerk
Het systeem past aan hoe het verbinding maakt, afhankelijk van waar je bent. Als je aan het thuiswerken bent of in een koffiezaak zit, maken je mobiele en desktop-apps verbinding via CloudLink en Mitel's Sessie Border Controller voor beveiliging. Maar als je op kantoor op je bedrijfsnetwerk bent, kan je desktop rechtstreeks verbinding maken met de Mitel PBX voor sneller en efficiënter bellen. Mobiele apparaten gebruiken altijd de veilige externe route voor consistentie en beveiliging, ongeacht Locatie.
#### Alleen account-eigenaren of beheerders kunnen de Mitel PSI app aan Zoom Toevoegen
Hoewel de Mitel PSI app na installatie geen gebruikmaakt van Eigenaar- of beheerderrechten, zijn deze wel vereist voor de eerste configuratie. **Let op:** als de Eigenaar of beheerder die de app oorspronkelijk heeft toegevoegd het account verlaat, zal de Integratie(s) niet meer werken. Om de functionaliteit te herstellen, moet een andere beheerder of de nieuwe Eigenaar de app opnieuw autoriseren.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://library.zoom.com/technical-library/nl/zoom-workplace/zoom-phone/third-party-integrations/zoom-and-mitel-phone-system-integration-field-guide.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
