Session Link

Developer-API

Haal vanuit uw eigen systemen een directe link naar het gesprek van een klant op; de klant en het gesprek worden aangemaakt als ze nog niet bestaan.

• WhatsApp
• Instagram
• REST API

Installeren vanuit MonoStoreBekijken op monochat.ai

Overzicht

Eén API-aanroep met een kanaal en het telefoonnummer of e-mailadres van een klant geeft een link terug die het gesprek van die klant in MonoChat opent. Als de klant of het gesprek nog niet bestaat, worden ze aangemaakt.

Zet de link in uw CRM, helpdesk of orderscherm en uw team springt van daaruit direct naar de chat.

Highlights

• Openen of aanmaken. Werkt voor een klant op een bepaald WhatsApp-, Instagram- of ander kanaal, via telefoonnummer of e-mailadres.
• Onderweg routeren. Wijs het gesprek in dezelfde aanroep toe aan een medewerker, via id of e-mailadres, of aan een werkgroep.
• Zelfde klant, zelfde gesprek. Als u de aanroep opnieuw doet voor dezelfde klant en hetzelfde kanaal, krijgt u het bestaande gesprek terug.

Installeren en instellen

1. Installeer Session Link via Instellingen › MonoStore › Apps, of open de installatielink app.monochat.ai/apps/vvKJe8Nbp4EQNy2KA. Heeft u nog geen MonoChat-account, dan kunt u zich via de link eerst registreren en wordt de app voor u geïnstalleerd.
2. Maak een API-token aan onder Profiel › API-tokens. Het token wordt maar één keer getoond, dus kopieer het meteen. Zie API-tokens.
3. Open Instellingen › Session Link API. De documentatie daar toont het exacte endpointadres van uw workspace en kant-en-klare voorbeeldverzoeken om te kopiëren. Probeer het voorbeeld met een van uw kanalen.
4. Voeg aan uw CRM, helpdesk of orderscherm een knop “Chat op WhatsApp” toe die de API aanroept en de teruggegeven url opent.

notitie

• De link opent MonoChat voor mensen die zijn ingelogd en dat gesprek mogen zien.
• De aanroep opent alleen het gesprek; er wordt geen bericht naar de klant gestuurd. Gebruik WhatsApp Template API om als eerste te schrijven.

Functies

Link naar het gesprek

Het antwoord bevat de link die het gesprek in MonoChat opent en de id van het gesprek.

Klant aangemaakt indien nodig

Er wordt een nieuwe klant aangemaakt met de voor- en achternaam die u meestuurt; het antwoord geeft aan of de klant al bekend was.

Toewijzing

Wijs toe aan een medewerker via id of e-mailadres, of aan een werkgroep.

Documentatiescherm

De API-referentie met het exacte endpointadres van uw workspace en kant-en-klare voorbeeldverzoeken om te kopiëren.

API-referentie

De aanroep is een POST met een JSON-body, geauthenticeerd met een API-token.

POST https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js
Authorization: Bearer <API_TOKEN>
Content-Type: application/json

• <slug> is de tenant slug van uw workspace, het deel na /tenants/ in uw MonoChat-adres.
• <app-folder> is de map waarin de app is geïnstalleerd. Het scherm Instellingen › Session Link API toont het volledige adres met beide ingevuld.
• Maak het token aan onder Profiel › API-tokens. Zie API-tokens.

Verzoekvelden

Veld	Verplicht	Beschrijving
connectorBrand	ja	Het kanaaltype, bijvoorbeeld whatsapp of instagram.
channelUsername	ja	De gebruikersnaam van uw kanaal in MonoChat, bijvoorbeeld uw WhatsApp-nummer zonder +.
customer.identityType	ja	phoneNumber of email.
customer.identity	ja	Het telefoonnummer van de klant (landcode, zonder +) of het e-mailadres.
customer.firstname, customer.lastname	nee	Wordt gebruikt als de klant nieuw is in MonoChat. Standaard -.
assignment.type	nee	agent (gebruikers-id van de medewerker), agentIdentity (e-mailadres van de medewerker) of workgroup (id van de werkgroep).
assignment.value	met assignment.type	De id of het e-mailadres waaraan het gesprek wordt toegewezen.

Voorbeeldverzoek

curl --location 'https://app.monochat.ai/api/<slug>/custom-functions/<app-folder>/methods/session-link.js' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
  "connectorBrand": "whatsapp",
  "channelUsername": "905334445566",
  "customer": {
    "identityType": "phoneNumber",
    "identity": "905306667788",
    "firstname": "Ayşe",
    "lastname": "Yılmaz"
  },
  "assignment": { "type": "agentIdentity", "value": "sarah@yourcompany.com" }
}'

Antwoord

{
  "result": {
    "url": "https://app.monochat.ai/tenants/<slug>?tab=messages&sessionTab=all&filter=…&_id=<sessionId>",
    "sessionId": "Zeii7vpeeFFnsJepZ",
    "isOldUser": true
  }
}

Veld	Beschrijving
url	Opent het gesprek in MonoChat.
sessionId	De id van het gesprek. Dezelfde klant op hetzelfde kanaal krijgt altijd hetzelfde gesprek.
isOldUser	false wanneer de klant door deze aanroep is aangemaakt.

Fouten

Een mislukte aanroep antwoordt met een foutstatus en een bericht:

Bericht	Oorzaak
connectorBrand, channelUsername and customer fields are required	Een verplicht veld op het hoogste niveau ontbreekt.
customer.identityType must be one of: phoneNumber, email	identityType ontbreekt of heeft een andere waarde.
customer.identity field is required	Het telefoonnummer of e-mailadres van de klant ontbreekt.
Channel not found	Er is in uw workspace geen kanaal van dat type met die gebruikersnaam.
Customer Channel not found	De klant kon niet aan een kanaalidentiteit worden gekoppeld.
Agent user not found	Er is geen medewerker met het e-mailadres dat in assignment.value is opgegeven.
401	De header Authorization ontbreekt of het token is ongeldig.

Schermafbeeldingen

Een CRM, helpdesk en ordermanagementscherm die elk het juiste gesprek in MonoChat openenHet gesprek in dezelfde API-aanroep aan een medewerker of werkgroep toewijzenEen nieuwe klant en een nieuw gesprek die automatisch worden aangemaakt vanuit het API-verzoekEén API-aanroep geeft de link naar het gesprek terugEen knop “Chat op WhatsApp” in een CRM opent met één klik het gesprek van de klantAls u de API opnieuw aanroept voor dezelfde klant, wordt het bestaande gesprek geopend

Veelgestelde vragen

Stuurt Session Link een bericht naar de klant?

Nee. Het opent of maakt alleen het gesprek en geeft er een link naar terug. Gebruik de app WhatsApp Template API om als eerste naar de klant te schrijven.

Met welke kanalen werkt het?

WhatsApp, Instagram en de andere kanalen die aan uw MonoChat-workspace zijn gekoppeld. In het verzoek geeft u het kanaaltype en de gebruikersnaam van uw kanaal op.

Worden er dubbele gesprekken aangemaakt?

Nee. Dezelfde klant op hetzelfde kanaal krijgt altijd hetzelfde gesprek.

Wie kan de link openen?

Mensen die bij MonoChat zijn ingelogd en dat gesprek mogen zien.

Gerelateerd

• WhatsApp Template API
• MonoStore-apps
• Profielinstellingen
• Werkgroepen