Référence SDK

Chaque SDK Telybot — Android, iOS, React Native, Flutter, Ionic — implémente le même contrat simple. Si vous en avez utilisé un, vous les avez tous utilisés.

L'API

Appeler	Fonctionnalités
`init` / `initialize`	Stocke votre Client ID. Le valide et signale toute erreur de format de manière explicite.
`show`	Affiche le chat par-dessus votre application. Accepte une question facultative pour la zone de message (0.2.0).
`dismiss`	Le ferme.
`isShowing`	S'il est présenté en ce moment.
chat intégré	Le chat dans l'un de vos propres écrans, comme un onglet Aide (0.2.0).
`onShow` / `onDismiss`	Prévenu quand le chat s'ouvre et se ferme, sur Android et iOS (0.2.0).
`setVisitor`	Le nom, le téléphone et l'e-mail de votre client connecté, proposés dans les formulaires du chat (0.2.0).
`hasUnreadReply` / `onReply`	Une réponse de votre équipe que le client n'a pas encore vue (0.2.0).

Ouvrir avec une question. Passez une question à show et elle est placée dans la zone de message du chat ; le client la lit et appuie sur envoyer. Elle voyage dans le #fragment du lien, et n'atteint donc jamais un journal serveur. Jusqu'à 500 caractères, sur une seule ligne.

Le chat dans votre propre écran. Android KeydaBotView, iOS KeydaBot.makeChatViewController ou SwiftUI KeydaBotView, React Native <KeydaBotChat />, Flutter KeydaBotChat, et le embedWidget() du paquet Ionic. Il n'a pas de bouton de fermeture — la navigation de votre écran est la sortie. Sur Android, Retour ferme d'abord un article ou un panier ouvert : React Native et Flutter le font pour vous tant que le chat est l'écran au premier plan, et avec la KeydaBotView native, votre gestion du Retour appelle son goBack().

Votre client connecté. Donnez au SDK le nom, le numéro de téléphone ou l'e-mail de votre client et le chat remplit ce que votre application sait déjà. Les informations sont proposées, jamais envoyées : elles apparaissent dans le formulaire « parler à une personne », une commande, une réservation et une question d'accueil demandant un nom, un téléphone ou un e-mail, et c'est le client qui les soumet. Elles voyagent dans le #fragment du lien et sont la parole de votre application, pas une identité vérifiée. Une valeur que le chat refuserait est laissée de côté : un nom de plus de 80 caractères, un numéro de téléphone sans 8 à 15 chiffres, une adresse e-mail sans domaine correct. Le chat plein écran d'Ionic s'ouvre dans le navigateur du système, qui garde les adresses dans son historique, et ne les prend donc pas ; son widget intégré, oui.

Une réponse pendant que le chat est fermé. Quand un client demande une personne et ferme le chat, votre réponse depuis le tableau de bord attend dans la conversation. Les SDK Android, iOS, React Native et Flutter la vérifient quand votre application revient au premier plan et le signalent à votre application, pour que vous puissiez afficher un point sur votre bouton de chat jusqu'à ce que le client ouvre le chat. Ils n'interrogent que les chats dans lesquels le client a demandé une personne au cours des 14 derniers jours. Un chat que votre application garde chargé hors de vue, comme un onglet Aide en arrière-plan, ne compte pas comme lu : le point reste jusqu'à ce que le client regarde. Ce n'est pas une notification push : une réponse est remarquée quand l'application est ouverte.

Il n'y a délibérément rien d'autre. Pas d'API d'envoi de messages ni d'appel d'identité utilisateur — parce qu'aucun des deux ne fonctionne encore de bout en bout, et une méthode qui ne fonctionne pas est pire qu'une méthode absente.

L'URL que chaque SDK ouvre

{baseUrl}/chat/{clientId}

baseUrl utilise https://telybot.com par défaut et peut être remplacé sur chaque plateforme, pour la préproduction ou une installation auto-hébergée.

Pourquoi une vue web, et ce que cela vous coûte

Il existe une interface de chat unique, fournie par la plateforme, et chargée sur chaque support.

Ce que vous obtenez : une modification effectuée par le propriétaire dans le tableau de bord — couleur d'accentuation, message de bienvenue, nom du bot, mise en ligne — atteint chaque application immédiatement, sans nouvelle version. Un correctif est déployé partout en une fois. Le chat est identique sur toutes les plateformes.

Ce que cela coûte : le chat nécessite une connexion. Il n'y a pas de mode hors ligne, et il n'y a pas encore de notifications push.

Nous préférons que vous le sachiez avant le déploiement plutôt que de le découvrir après.

Garanties offertes par chaque SDK

Échappées de navigation. Un lien vers une autre origine s'ouvre dans le navigateur système au lieu de remplacer le chat. Sans cela, un simple clic sur un lien de pied de page met fin à la conversation du client sans possibilité de retour.
Continuité des conversations. Le stockage DOM est activé : si un client ferme l'application et revient, il retrouve son fil de discussion là où il l'avait laissé (pendant 24 heures).
Le clavier ne recouvre jamais la zone de saisie.
Les zones de sécurité sont respectées — aucun chat n'est affiché sous une encoche ou un indicateur d'accueil.
Aucun plantage n'atteint votre application. Un échec de chargement affiche une option de réessai.
Aucune analyse, aucun identifiant d'appareil, aucune dépendance tierce. L'ajout d'un SDK Telybot n'ajoute aucun traceur à votre application.
Retour ferme d'abord ce que le client regarde. Sur Android, Retour au-dessus d'un article, d'un panier ou d'une réservation ouverts ferme cela, et seulement ensuite le chat (SDK 0.2.0 et plus récents).

Dans le chat

Tout cela vient de la page hébergée, et atteint donc chaque application sans mise à jour du SDK :

Un message de bienvenue avec des boutons de suggestion, dans la langue sur laquelle le bot est réglé.
La conversation est conservée sur l'appareil pendant 24 heures, et le chat ne crée aucun identifiant de visiteur. Sur un site web, une conversation dure un onglet de navigateur. (Le chat plein écran du SDK Ionic a besoin de la 0.2.0 pour cela.)
Commandes et réservations, quand l'entreprise les prend : un panier, des dates et heures de réservation, un lien pour appeler l'entreprise quand une commande ou une réservation a trop attendu, et « Ajouter au calendrier » pour une réservation confirmée.
Pièces jointes : photos (JPEG, PNG, WebP, GIF) et fichiers PDF, DOCX, TXT, CSV et MD. Les SDK Android et Flutter ont besoin de la version 0.1.4 ou plus récente pour le bouton de pièce jointe, et Flutter de la 0.2.0 pour les documents.
« Ajouter au calendrier » est un lien vers un fichier .ics. iOS l'ouvre dans Calendrier comme un calendrier auquel s'abonner. Android propose l'application de calendrier du téléphone quand elle importe les fichiers .ics — le Google Agenda actuel le fait — et sinon le navigateur télécharge le fichier.

Format de l'identifiant client

kb_live_ followed by 8-48 hexadecimal characters

Tout le reste est rejeté lors de l'initialisation plutôt que d'afficher une erreur 404 devant un client. Le Client ID est public par conception — il est visible sur tout site web intégrant le widget — et ne permet ni de lire ni de modifier votre compte. Voir limites et sécurité.

Source

Public, sous licence MIT : github.com/telybotai/telybot-Sdks. Le contrat partagé auquel chaque package est soumis se trouve dans CONTRACT.md en haut de ce dépôt.