> 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/sv/zoom-workplace/zoom-phone/third-party-integrations/zoom-and-mitel-phone-system-integration-field-guide.md).

# Fältguide för integreringar mellan Zoom och Mitel telefonsystem

### Översikt

Zoom och Mitel samarbetar för att förbättra ditt VoIP-system. Med denna integrering av telefonsystem — eller PSI — får du det bästa av två världar: Zoom Workplace:s samarbetskraft och samtalsfunktionerna i ditt befintliga Mitel-system, allt inifrån Zoom Workplace-apparna för dator och mobil.

Om du redan använder Zoom Workplace, funderar på "Kom igång med Zoom Workplace" eller lägger till fler Zoom Workplace-funktioner och har en kompatibel Mitel-konfiguration, passar den här integreringen utmärkt.

Så här är tanken: din Zoom Phone-flik blir ett SIP-telefonprogram (sessionsinitieringsprotokoll) som ansluter direkt till Mitels samtalsplattform. Om du ansluter via internet använder den Mitels OpenScape Session Border Controller, eller SBC. Du använder också Mitel CloudLink för att göra inloggningar enklare och hantera användare smidigare mellan Zoom och Mitel.

Bara som en påminnelse behöver du ha alla rätta Zoom- och Mitel-komponenter på plats för att integreringen ska fungera korrekt.

#### <mark style="color:blå;">Funktioner i Zoom- och Mitel-PSI</mark>

Den här integreringen ger en hel rad funktioner till din nuvarande Mitel-installation. Här är bara några du kan dra nytta av:

* Ringa och ta emot samtal
* Hantera flera samtal samtidigt
* Pausa samtal eller starta en konferens
* Överföra samtal (kall eller varm)
* Få åtkomst till röstbrevlåda
* Visa samtalshistorik och loggar
* Ställ in vidarekoppling
* Använd läget Stör ej
* Synkronisera företagskontakter
* Gör ett telefonsamtal till ett Zoom-möte
* Visa närvarostatus mellan Zoom Apps (begränsat med Mitel-telefoner)
* Hoppa från chatt till ett PSI-samtal

#### <mark style="color:blå;">Övergripande krav</mark>

Följande avsnitt beskriver kraven på hög nivå för den här integreringen.

<mark style="color:blå;">**Zoom-specifika uppgifter**</mark>

För att få allt att fungera på Zoom-sidan behöver du:

* En kontoägare eller adminroll för att hantera användare, PSI och Zoom Phone
* En licens som stöds per användare, till exempel:
  * Zoom Workplace Business/Business+
  * Zoom Workplace Essentials/Enterprise/Enterprise+/Enterprise Premier
  * Äldre möteslicenser (ENH/EAH)
  * Alla abonnemang med Zoom Phone Pro
* Zoom Phone konfigurerat och aktivt för din organisation
* [**Automatisk tilldelning av telefonlicens**](#disable-the-automatic-phone-license-assignment-for-zoom-workplace) avstängd för Zoom Workplace-licenser
* Zoom Workplace-appversion 6.3.6 eller senare

<mark style="color:blå;">**Mitel-specifika uppgifter**</mark>

På Mitel-sidan behöver du följande:

**Kompatibilitet för PBX-hårdvara:**

* OpenScape Voice (OSV)
* OpenScape 4k (OS4k)
* Mitel CloudLink
* MiVoice Business (MiVB)

**Appar och plattformar som stöds:**

* Mitel administrationsapp
* OpenScape 4000-plattformen (för OS4k)
* OpenScape Common Management-plattformen (för OSV)
* OpenScape SBC-hanteringsportalen (för OSV och OS4k)
* OpenScape SBC (för extern registrering med OSV/OS4k)

**Licenser:**

* Mitel ZoomPSI eller hybrid
* Teleworker-licens

Det finns några viktiga saker att känna till innan du påbörjar integreringsprocessen:

* Zoom Workplace-appen använder [standardbrandväggsportar och IP-intervall](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060548).
* IP-adresser och portar för telefonsignalering/media bestäms av Mitel-konfigurationen och kan skilja sig från standarderna. Kontakta Mitel eller din Mitel-partner om du behöver mer information.
* Du måste ha en Teleworker-licens för både Zoom Workplace-dator- och mobilapparna — två licenser per användare. Dessa är nödvändiga för att kunna ansluta tillbaka till Mitel PBX.

### Arkitektur

#### <mark style="color:blå;">Standardarkitektur för integrering</mark>

<div data-with-frame="true"><figure><img src="https://460446308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FctBXUMeBy4rtLMmMkKRG%2Fuploads%2FUWtIKOBvIsEx5MwXW3Rw%2Fimage.png?alt=media&amp;token=e2e85a6c-0e99-4595-989d-3b0c7dd9229d" alt=""><figcaption></figcaption></figure></div>

Viktiga anslutningar:

* **Zoom-molnet till Mitel CloudLink**: REST API över TLS
* **Zoom Workplace-anslutning**: TLS till Zooms datacenter
* **Användarenhet till Mitel**: Telefonsignalering/media över TLS
* **Mitel CloudLink till PBX**: Proprietära protokoll

#### Hybridkonfiguration

<div data-with-frame="true"><figure><img src="https://460446308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FctBXUMeBy4rtLMmMkKRG%2Fuploads%2FcxxvncUeZ9TYNzvoB3z9%2Fimage.png?alt=media&amp;token=9c75f8e7-4e37-4b71-82b8-dec51bd9ed75" alt=""><figcaption></figcaption></figure></div>

Organisationer kör både Zoom Phone och Mitel-integreringen samtidigt. Användare med Zoom Phone-licenser ansluter till Zoom Phone SBC, medan användare med Mitel-integreringen ansluter till Mitel SBC. Med en BYOP-trunk som kopplar samman dem kan användare ringa anknytningar mellan olika system.

#### <mark style="color:blå;">Översikt över teknisk arkitektur</mark>

**Mitel CloudLink-anslutning**

CloudLink är en molnbaserad plattform som kopplar samman din lokala PBX med molnlösningar. Zoom använder CloudLink för åtkomst till Mitel PBX-komponenter via moln-API, vilket skapar ett enda gränssnitt i stället för att behöva tala varje PBX:s unika språk.

{% hint style="success" %}
**Exempel**

När du aktiverar Stör ej skickar Zoom ett API-kommando till CloudLink, som tolkar det för den specifika Mitel PBX:en (OS4K och MiVoice Business hanterar detta olika).
{% endhint %}

**Synkronisering från Zoom-molnet till CloudLink**

Du upprättar säker kommunikation via **Zoom Apps** från både **Zoom** och **CloudLink**. När du installerar dessa appar måste en admin logga in i båda systemen för att skapa en säker OAuth-anslutning.

När anslutningen är upprättad hämtar Zoom användarens telefoninloggningsuppgifter via TLS:

* SIP-användarnamn (ofta telefonnumret)
* SIP-autentiseringsuppgifter (endast säker hash)
* Registrerings-IP-adresser (SBC och reserv-SBC, eller intern PBX)

**Process för appregistrering**

1. Zooms moln skickar inloggningsuppgifterna till användarens Zoom Workplace-app via TLS
2. Zoom Workplace aktiverar fliken Phone
3. Zoom Workplace-appen ansluter direkt till Mitel SBC eller PBX via TLS (inte via Zoom-molnet)

**Ytterligare** **Flöden**

* Funktioner: Zoom Workplace-appen kommunicerar direkt med Mitel CloudLink via REST API över TLS för samtalsloggar, röstbrevlådor och statusen Stör ej
* Mobil push: Mitel SBC skickar pushmeddelanden till Zooms moln, som vidarebefordrar dem till mobila enheter
* Nätverksanpassning: Fjärranvändare ansluter via CloudLink och Mitel SBC. Stationära datorer på plats ansluter direkt till Mitel PBX. Mobila enheter använder den säkra externa vägen.

### Konfigurera integreringen

Integreringen är enkel mellan Zoom och Mitel, och arbetet på Zooms sida tar i genomsnitt cirka 45 minuter, med en större del på Mitels sida. Kontakta Mitel eller din Mitel-partner om du har fler frågor eller behöver information om tidsåtgången.

Alla admin som utför dessa steg behöver **behörighet för integrering av telefonsystem** för att slutföra alla steg.

#### <mark style="color:blå;">Slutför den första Zoom Phone-konfigurationen</mark>

Om du är en ny kund och inte har konfigurerat Zoom Phone ännu, följ vårt supportdokument om "Kom igång med Zoom Phone". [Kom igång med Zoom Phone](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060257#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13)Annars fortsätter du med nästa steg.

#### <mark style="color:blå;">Inaktivera den automatiska tilldelningen av telefonlicenser för Zoom Workplace</mark>

För att inaktivera automatisk tilldelning av telefonlicenser för Zoom Phone för alla användare i kontot:

1. Logga in på [Zoom-webbportal](https://zoom.us/profile) som admin.
2. I [**Admincenter**](https://zoom.com/account) navigeringsmenyn, klicka på [**inställningar**](https://zoom.com/account/setting).
3. Klicka på **Zoom Phone** fliken.
4. Under **Allmänt**, klicka på **Tilldela Zoom Phone-användare automatiskt** växla för att inaktivera den.
5. Om en verifieringsdialog visas klickar du på **Inaktivera** för att verifiera ändringen.

#### <mark style="color:blå;">Lägg till användare i Zoom</mark>

Du kan lägga till användare individuellt, med en CSV-fil eller genom att använda SSO (enkel inloggning) enligt stegen i vårt supportdokument om Hantera användare [Hantera användare](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0061789#h_8b193526-997c-4385-955b-ffddda0b0404). Om du bjuder in en befintlig användare att gå med i ditt Zoom-konto kan du läsa mer om processen för [att lägga till befintliga användare i ett betalt konto](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063202), till exempel hur återstående saldon och data som överförs till ditt konto hanteras.

#### <mark style="color:blå;">Tilldela licenser till användare</mark>

Du kan tilldela Zoom-produktlicenser individuellt eller i bulk. Mer information finns om hur man [Tilldela Zoom-licenser](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0064911) i den länkade artikeln.

#### <mark style="color:blå;">Installera Mitel-appen från Zoom App Marketplace</mark>

För att ansluta Zoom med Mitel CloudLink följer du stegen nedan:

1. Logga in på [Zoom-webbportal](https://zoom.us/profile) som admin.
2. I menyn till vänster, under **Avancerat** klicka på **App Marketplace**.
3. Använd sökrutan för att hitta **Mitel PSI-appen** och markera den. Klicka på **Lägg till**.
4. Klicka **Skapa anslutningsprogram**.
5. Klicka **Anslut** för att bekräfta att du vill ansluta tredjepartsanslutningsprogrammet Mitel till ditt Zoom-konto. Ett webbläsarfönster öppnas och du omdirigeras till Mitel CloudLink.
6. Logga in på Mitel CloudLink. Kommunikationen mellan Zoom och Mitels CloudLink är nu klar.

{% hint style="info" %}
**Obs**

Mitel har också en App Store för CloudLink där Zoom kan läggas till så att du omdirigeras till Zoom för slutförandet.
{% endhint %}

#### <mark style="color:blå;">Konfigurera inställningar för telefoniintegrering</mark>

För att låta användare av Zoom Workplace-mobilappen ringa samtal via ett lokalt Mitel-system följer du stegen nedan:

1. Logga in på [Zoom-webbportal](https://zoom.us/profile) som admin.
2. I menyn till vänster klickar du på **konto-hantering**, sedan **behörighet för integrering av telefonsystem**.
3. Klicka på **inställningar** fliken.
4. För att integrera samtal i Zoom Workplace-mobilappen markerar du **Tillåt användning av det integrerade telefonsystemet för att ringa samtal i Zoom-mobilklient** .
5. Om en verifieringsdialog visas klickar du på **Aktivera** eller **Inaktivera** för att verifiera ändringen.

{% hint style="info" %}
**Anteckningar**

* Se till att den här inställningen alltid är aktiverad.
* Om det här alternativet är aktiverat och användarna finns i listan över Telefonsystemintegrering kan dessa användare använda ett lokalt Mitel-system för att ringa samtal via Zoom Workplace-mobilappen.
  {% endhint %}

#### <mark style="color:blå;">Lägg till Zoom-användare i Mitel-PSI</mark>

Du kan välja att lägga till användare manuellt eller i bulk via CSV. Se stegen för [att lägga till Zoom-användare i Mitel-integreringen](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurdfim2r8) i vår länkade supportartikel.

#### <mark style="color:blå;">Verifiera Zoom-Mitel-integreringen i Zoom Workplace-appen</mark>

För att verifiera att integreringen är korrekt konfigurerad loggar du in i Zoom Workplace-appen (dator eller mobil) och klickar på **telefon** fliken. Se till att du kan se uppringar-ID (anknytningen från Mitel) och att det inte finns några felmeddelanden. Om det finns fel ger Statuskolumnen relevant information:

| Status                                   | Beskrivning                                                                                                                         |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| **Väntande SIP-autentiseringsuppgifter** | Väntar på att CloudLink ska auktorisera användaren.                                                                                 |
| **Inaktiv**                              | SIP-autentiseringsuppgiften har redan synkroniserats med Zoom, men användaren har ännu inte registrerat sig i Zoom Workplace-appen. |
| **Registrerad**                          | Zoom Workplace-appen har registrerats med SIP-servern.                                                                              |
| **SIP-felkoder (olika)**                 | Detta ger vanliga SIP-felkoder och en allmän beskrivning som hjälper till att felsöka registreringsproblemet.                       |

#### <mark style="color:blå;">Konfigurera Mitels användarhantering</mark>

Använd hänvisningarna i vår [Zoom-Mitel PSI-konfigurationsguide](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) för viss information som hjälper dig att komma igång. Kontakta Mitel eller din Mitel-partner om du har frågor eller behöver mer information.

#### <mark style="color:blå;">Säkerhetsaspekter</mark>

Vår [Zoom-Mitel PSI-konfigurationsguide](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) guide innehåller några säkerhetsaspekter för din organisation. Kontakta Mitel eller din Mitel-partner om du har frågor eller behöver mer information.

#### <mark style="color:blå;">Hantera externa kontakter (icke-Zoom-kontakter)</mark>

Kontoägare och administratörer kan skapa en delad katalog med externa kontakter. Mer information finns i vår[ Zoom-Mitel PSI-konfigurationsguide](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0079172#mcetoc_1iiurmd8a34k) guide. Kontakta Mitel eller din Mitel-partner om du har frågor eller behöver mer information.

#### <mark style="color:blå;">Ta med egen PBX (BYOP)</mark>

BYOP låter dig bygga en SIP-trunk mellan Zoom Phone och Mitel för anknytningsbaserad uppringning. Blanda och matcha — vissa kontor använder Zoom Phone medan andra använder Mitel-integreringen. Med en BYOP-trunk som kopplar samman dem kan användare ringa anknytningar mellan systemen.

<div data-with-frame="true"><figure><img src="https://460446308-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FctBXUMeBy4rtLMmMkKRG%2Fuploads%2FgKb0NnrRXTCwjfSCeYTw%2Fimage.png?alt=media&amp;token=f5227575-d847-46bd-a27b-71296714f4d0" alt=""><figcaption></figcaption></figure></div>

Denna konfiguration kräver ytterligare brandväggsregler och använder ömsesidig TLS. Se vår supportsajt för kraven. Vi har tillsammans med Mitel skrivit supportdokument för OpenScape SBC och MiVoice Border Gateway, som finns på vår sida för stödd hårdvara för Zoom Phone.

#### <mark style="color:blå;">Stöd för Mitel-skrivbordstelefoner i Zoom Phone</mark>

Användare i Zoom Phone kan använda Mitel-skrivbordstelefoner som registreras direkt i Zoom Phone. För en lista över modeller som stöds, se Zooms [lista över certifierad hårdvara](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0060242).

### vanliga frågor

#### <mark style="color:blå;">Licens- eller programvaruuppdateringar kan krävas, beroende på konfigurationen av ditt Mitel-system</mark>

Varje Mitel-konfiguration är olika, så det du behöver beror på din specifika konfiguration. Din Mitel-partner kan snabbt bedöma ditt system och tala om för dig om du behöver licensuppgraderingar (till exempel Teleworker-licenser) eller programvaruuppdateringar för att allt ska vara kompatibelt. Det är värt en snabb kontroll eftersom kraven varierar kraftigt mellan olika installationer.

#### <mark style="color:blå;">Mitel CloudLink krävs för att den här integreringen ska fungera</mark>

Ja, CloudLink är nyckeln. Den hjälper till att hålla allt synkroniserat mellan Zoom och ditt Mitel-system, till exempel användarinformation och inloggningsuppgifter. Den förenklar också hanteringen av användare.

#### <mark style="color:blå;">Ja, den här integreringen fungerar tillsammans med Zoom Phone-installationer</mark>

Du kan blanda och matcha — vissa kontor kan använda Zoom Phone utan integrering medan andra använder Mitel-integreringen. Med en BYOC/BYOP-trunk som kopplar samman dem kan användare till och med ringa anknytningar mellan olika system. Använd det som fungerar bäst för varje plats.

#### <mark style="color:blå;">Du kan använda både en Mitel-skrivbordstelefon och Zoom Workplace-appen</mark>

Zoom Workplace-appen fungerar tillsammans med din befintliga skrivbordstelefon, inte i stället för den. Båda kan ringa när någon ringer ditt anknytningsnummer, så du kan svara på den som passar bäst. Ditt Mitel-system behandlar Zoom Phone som en annan telefon på ditt skrivbord.

#### <mark style="color:blå;">Zoom ansluter till Mitel via CloudLink</mark>

CloudLink är bron som gör att Zoom och Mitel kan kommunicera med varandra. Den hanterar tre huvuduppgifter: att verifiera att användarna är de de utger sig för att vara, att hålla användarinformation synkroniserad mellan båda systemen och att säkert skicka de inloggningsuppgifter som Zoom behöver för att ansluta till ditt Mitel-system. Utan CloudLink som fungerar som översättare skulle dessa två system inte kunna fungera tillsammans — det är det som gör integreringen möjlig.

#### <mark style="color:blå;">Du kan inte skicka SMS-meddelanden genom den här integreringen</mark>

SMS stöds inte för tillfället eftersom Zoom Workplace-appen i praktiken fungerar som ett telefonprogram som ansluter till ditt Mitel-system endast för röstsamtal. SMS bygger på helt annan teknik som ditt Mitel-system hanterar separat. Tänk så här: Zoom lånar ditt Mitel-systems samtalsfunktioner, men SMS finns i en annan del av systemet som inte är tillgänglig via den här integreringen. Du måste tills vidare använda dina nuvarande Mitel-SMS-verktyg, även om detta kan ändras i framtida uppdateringar.

#### <mark style="color:blå;">Verktyget för nätverksanslutning fungerar inte med Mitel-telefoner</mark>

Zooms verktyg för nätverksanslutning kan inte testa dina Mitel-telefonanslutningar eftersom det är utformat för att kontrollera Zooms egna servrar, inte ditt Mitel-system. När du använder den här integreringen går dina samtal via Mitels nätverk (antingen direkt till din PBX eller via Mitels servrar), så Zooms testverktyg kan helt enkelt inte se eller testa de vägarna. Det är som att försöka använda ett fordons diagnosverktyg på ett annat märke – de talar helt enkelt olika språk. Verktyget fungerar fortfarande bra för att testa dina vanliga anslutningar till Zoom-möten, dock.

#### <mark style="color:blå;">Zoom-användare kan inte se närvarostatus för användare som bara har Mitel-skrivbordstelefoner</mark>

Dina traditionella Mitel-skrivbordstelefoner delar inte med sig av om någon är tillgänglig eller i ett samtal med Zoom. Integreringen fungerar utmärkt för att visa närvarostatus mellan användare av Zoom Workplace-appen, men de där traditionella skrivbordstelefonerna lever i sin egen värld och kan inte dela sin status med Zooms system. Det är planerat att förbättra detta, men tills vidare ser du bara närvarostatus för personer som faktiskt använder Zoom Workplace-appen.

#### <mark style="color:blå;">För närvarande finns inga AI-funktioner tillgängliga med Mitel-PSI-integreringen</mark>

Dina samtal går via Mitels system, inte via Zooms moln där AI:n finns, så Zoom AI kan inte komma åt dina konversationer. Det betyder ingen automatisk transkription av röstbrevlådan, inga sammanfattningar av samtal eller andra AI-funktioner som du skulle få med Zoom Phone utan integrering. Samtalen går helt förbi Zooms AI-bearbetning. Framtida uppdateringar kan ändra på detta, men tills vidare måste du använda de AI-verktyg som ditt Mitel-system erbjuder.

#### <mark style="color:blå;">Om något inte fungerar efter installationen, kontrollera inställningarna för telefoniintegrering i Zoom</mark>

När samtal inte fungerar kontrollerar du synkroniseringsstatusen på fliken Integrerade användare i inställningarna för Telefonsystemintegrering i adminportalen. Synkroniseringsfel betyder vanligtvis att CloudLink inte skickar autentiseringsuppgifterna korrekt — då vill du kontrollera CloudLinks loggar för att se vad som är fel.

#### <mark style="color:blå;">Du ansvarar för dina enhetscertifikat</mark>

Eftersom du ansluter till ditt eget Mitel-system (inte Zooms servrar) måste du installera företagets säkerhetscertifikat på varje enhet som ska använda den här integreringen. Tänk på certifikat som digitala nycklar — Zoom hanterar sina egna nycklar för Zoom Phone utan integrering, men med den här integreringen använder du dina egna "nycklar" för att ansluta till ditt eget system. Ditt IT-team måste se till att varje laptop, telefon och surfplatta har rätt certifikat installerade, annars kan de inte göra säkra anslutningar till ditt Mitel-system.

#### <mark style="color:blå;">Det är enkelt att ansluta, oavsett om du är på plats eller i företagets nätverk</mark>

Systemet anpassar hur det ansluter beroende på var du befinner dig. Om du jobbar hemifrån eller på ett kafé ansluter dina mobil- och datorappar via CloudLink och Mitels Session Border Controller för säkerhets skull. Men om du är på kontoret i ditt företags nätverk kan din dator ansluta direkt till Mitel PBX för snabbare och effektivare samtal. Mobila enheter använder alltid den säkra externa vägen för konsekvens och säkerhet, oavsett plats.

#### <mark style="color:blå;">Endast kontoägare eller administratörer kan lägga till Mitel PSI-appen i Zoom</mark>

Även om Mitel PSI-appen inte använder ägar- eller adminbehörighet efter installationen, krävs den för den första installationen. **Observera:** om den ägare eller admin som ursprungligen lade till appen lämnar kontot slutar integreringen att fungera. För att återställa funktionen måste en annan admin eller den nya ägaren auktorisera appen på nytt.


---

# 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/sv/zoom-workplace/zoom-phone/third-party-integrations/zoom-and-mitel-phone-system-integration-field-guide.md?ask=<question>&goal=<user_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.
