SDK-referentie

Elke Telybot SDK — Android, iOS, React Native, Flutter, Ionic — implementeert dezelfde kleine contracten. Als je er één hebt gebruikt, heb je ze allemaal gebruikt.

De API

Openen met een vraag. Geef een vraag door aan show en die komt in het berichtvak van de chat; de klant leest hem en tikt op verzenden. Hij reist mee in de #fragment van de link en bereikt dus nooit een serverlog. Maximaal 500 tekens, als één regel.

De chat in je eigen scherm. Android KeydaBotView, iOS KeydaBot.makeChatViewController of SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat, en de embedWidget() van het Ionic-pakket. Hij heeft geen sluitknop — de navigatie van je scherm is de weg naar buiten. Op Android sluit Terug eerst een geopend item of de winkelwagen: React Native en Flutter doen dat voor je zolang de chat het voorste scherm is, en met de native KeydaBotView roept je Terug-afhandeling zijn goBack() aan.

Je ingelogde klant. Geef de SDK de naam, het telefoonnummer of het e-mailadres van je klant en de chat vult in wat je app al weet. De gegevens worden aangeboden, nooit verzonden: ze verschijnen in het formulier “met een persoon praten”, in een bestelling, een boeking en een welkomstvraag naar naam, telefoon of e-mail, en de klant verstuurt ze zelf. Ze reizen mee in de #fragment van de link en zijn het woord van je app, geen geverifieerde identiteit. Een waarde die de chat zou weigeren wordt weggelaten: een naam langer dan 80 tekens, een telefoonnummer zonder 8 tot 15 cijfers, een e-mailadres zonder echt domein. De chat op volledig scherm van Ionic opent in de systeembrowser, die adressen in zijn geschiedenis bewaart, en neemt ze daarom niet aan; de ingebedde widget wel.

Een antwoord terwijl de chat gesloten is. Wanneer een klant om een persoon vraagt en de chat sluit, wacht je antwoord uit het dashboard in het gesprek. De SDK's voor Android, iOS, React Native en Flutter controleren dit wanneer je app naar de voorgrond komt en melden het aan je app, zodat je een stip op je chatknop kunt tonen tot de klant de chat opent. Ze vragen alleen naar chats waarin de klant in de afgelopen 14 dagen om een persoon heeft gevraagd. Een chat die je app uit het zicht geladen houdt, zoals een Help-tab op de achtergrond, telt niet als gelezen: de stip blijft tot de klant kijkt. Dit is geen pushmelding: een antwoord wordt opgemerkt wanneer de app wordt geopend.

Er is bewust niets anders. Geen API om berichten te versturen en geen aanroep voor gebruikersidentiteit — omdat geen van beide al van begin tot eind werkt, en een methode die niet werkt is erger dan een die ontbreekt.

De URL die elke SDK opent

{baseUrl}/chat/{clientId}

baseUrl staat standaard ingesteld op https://telybot.com en kan op elk platform worden overschreven, voor een testomgeving of een self-hosted installatie.

Waarom een webview en wat het je kost

Er is één chatinterface, geleverd door het platform, en elk oppervlak laadt deze.

Wat je krijgt: een wijziging die een eigenaar maakt in het dashboard — accentkleur, welkomstbericht, botnaam, live gaan — bereikt elke app onmiddellijk, zonder release. Een fix komt overal tegelijk aan. De chat is identiek op alle platformen.

Wat het kost: de chat heeft een verbinding nodig. Er is geen offline modus en er zijn nog geen pushmeldingen.

We hebben dit liever dat je dit weet voordat je live gaat dan dat je er pas achter komt.

Garanties die elke SDK biedt

1. Navigatie-escapes. Een link naar een andere herkomst opent in de systeembrrowser in plaats van de chat te vervangen. Zonder dit maakt één tik op een footerlink een einde aan het gesprek van een klant zonder weg terug.
2. Gespreksvoortzetting. DOM-opslag staat aan, dus een klant die de app sluit en terugkomt, vindt de chat waar hij of zij was gebleven (gedurende 24 uur).
3. Het toetsenbord bedekt de invoer nooit.
4. Er wordt rekening gehouden met veilige zones — er wordt geen chat getekend onder een notch of een home-indicator.
5. Geen enkele crash bereikt je app. Bij een mislukte laadactie wordt een knop om opnieuw te proberen getoond.
6. Geen analyse-tools, geen apparaat-identificaties, geen afhankelijkheden van derden. Het toevoegen van een Telybot SDK voegt geen tracker toe aan je app.
7. Terug sluit eerst wat de klant bekijkt. Op Android sluit Terug boven een geopend item, winkelwagen of boeking eerst dat, en pas daarna de chat (SDK 0.2.0 en later).

In de chat

Dit komt allemaal van de gehoste pagina en bereikt dus elke app zonder SDK-update:

• Een welkomstbericht met suggestieknoppen, in de taal waarop de bot is ingesteld.
• Het gesprek blijft 24 uur op het apparaat bewaard, en de chat maakt geen bezoekers-id. Op een website duurt een gesprek één browsertab. (De chat op volledig scherm van de Ionic-SDK heeft hiervoor 0.2.0 nodig.)
• Bestellingen en boekingen, wanneer het bedrijf ze aanneemt: een winkelwagen, boekingsdata en -tijden, een link om het bedrijf te bellen wanneer een bestelling of boeking te lang heeft gewacht, en “Toevoegen aan agenda” voor een bevestigde boeking.
• Bijlagen: foto's (JPEG, PNG, WebP, GIF) en PDF-, DOCX-, TXT-, CSV- en MD-bestanden. De Android- en Flutter-SDK's hebben 0.1.4 of later nodig voor de bijlageknop, en Flutter heeft 0.2.0 nodig voor documenten.
• “Toevoegen aan agenda” is een link naar een .ics-bestand. iOS opent het in Agenda als een agenda om op te abonneren. Android biedt de agenda-app van de telefoon aan wanneer die .ics-bestanden importeert — de huidige Google Agenda doet dat — en anders downloadt de browser het bestand.

Client id-indeling

kb_live_ followed by 8-48 hexadecimal characters

Al het andere wordt bij de initialisatie geweigerd in plaats van een 404 te openen voor een klant. De client id is ontworpen om openbaar te zijn — deze is zichtbaar op elke website die de widget insluit — en geeft geen bevoegdheid om je account te lezen of te wijzigen. Zie limieten en beveiliging.

Bron

Openbaar, onder MIT-licentie: github.com/telybotai/telybot-Sdks. Het gedeelde contract waaraan elk pakket zich moet houden staat in CONTRACT.md bovenaan die repository.