API Tutorial

Introductie

U kunt Userlike verbinden met uw custom back-end of legacy CRM. Wordt op de hoogte gehouden van interacties met uw bezoekers en klanten, monitor uw operator states en resources met deze callback API addon. Registreer voor een set van events waarvoor u een HTTP POST callback ontvangt naar uw eindpunt.

Account registreren

Stap 1

Ga naar de Addons sectie en selecteer de API configuratie optie.

Stap 2

Voer de callback URL van uw API endpoint in. HTTP en HTTPS worden ondersteund als protovols. We POSTen deze data naar uw URL als een JSON document met het content type applicatie json. Om deze addon te configureren, moet de callback URL toegankelijk zijn vanaf het internet en moet deze een HTTP 200 code terugsturen na het ontvangen van de POST request.

De data die u ontvangt via email is een JSON Object. Als u de Javascript API gebruikt om uw custom data door te geven aan de chat client, wordt deze als object toegevoegd in het "custom" veld.

API Callbacks

De calls worden gegroept in vijf dedicated formats die geïdentificeerd worden door the_type field.

TypeBeschrijving
offline_messageDuidt een offline bericht aan, het data format wordt in detail uitgelegd in de volgende alinea's.
chat_metaDuidt een chat aan, het data format wordt in detail uitgelegd in de volgende alinea's.
chat_widgetDuidt een widget aan, het data format wordt in detail uitgelegd in de volgende alinea's.
operatorToont een Operator status verandering. Het data format wordt verderop uitgebreid uitgelegd.
miscToont events die niet in een van de eerdergenoemde formats passen.

U kunt uw Haddon configureren en zich registreren voor een set van events waarvoor u een callback wilt ontvangen.

TypeEventBeschrijving
offline_messagereceiveOntvang een callback voor elk nieuw offline bericht dat u ontvangt.
chat_metastartOntvang een callback voor elke nieuwe chat sessie.
chat_metaforwardOntvang een callback als een chat sessie doorverwezen wordt.
chat_metaratingOntvang een callback als een chat sessie een waardering krijgt.
chat_metafeedbackOntvang een callback als een chat sessie feedback ontvangt.
chat_metasurveyOntvang een callback als een chat sessie een survey antwoord krijgt.
chat_metareceiveOntvang een callback als een chat sessie afloopt en de conversatie afgelopen is.
chat_metagoalOntvang een callback als een goal is bereikt.
chat_widgetconfigOntvang een callback voor Widget configuratie veranderingen.
operatoronlineOntvang een callback als een Operator online komt.
operatorofflineOntvang een callback als een Operator offline gaat.
operatorawayOntvang een callback als een Operator op Afwezig gaat.
operatorbackOntvang een callback als een Operator terug komt.
miscchatbutler_incomingOntvang een callback als een nieuwe chat sessie wacht.

Offline Message - Receive

Ontvang een callback voor elk nieuw offline bericht dat u ontvangt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Meta - Start

Ontvang een callback voor elke nieuwe chat sessie. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Meta - Forward

Ontvang een callback als een chat sessie doorverwezen wordt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Meta - Rating

Ontvang een callback als een chat sessie een waardering krijgt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Meta - Feedback

Ontvang een callback als een chat sessie feedback ontvangt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Chat Meta - Survey

Ontvang een callback als een chat sessie een survey antwoord krijgt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Meta - Receive

Ontvang een callback als een chat sessie afloopt en de conversatie afgelopen is. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder. Als u het Javascript API gebruikt om uw custom data naar de chat client te sturen, zal deze als een object worden bijgevoegd in het "custom" veld.

Chat Widget - Config

Ontvang een callback als een chat widget configuratie verandert. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Operator - Online

Ontvang een callback als een operator online gaat. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Operator - Offline

Ontvang een callback als een operator offline gaat. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Operator - Away

Ontvang een callback als een operator op afwezig gaat. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Operator - Back

Ontvang een callback als een operator terug komt. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Misc - Chat Butler incoming

Ontvang een callback als een nieuwe chat sessie wacht. De "POST" callback naar uw API eindpunt bevat de data van het object in JSON formaat. U vindt het gedetailleerde formaat in de sample onder.

Chat Butler is een simpele chatbot die automatisch reageert op chat verzoeken als er geen Operator meteen beschikbaar is. Hij notificeert uw service team herhaaldelijk dat een chat wachtende is (volledige Chat Butler tutorial).

U kunt deze notificaties integreren in elk van uw bestaande notificatie frameworks door een API eindpunt te leveren dat dit callback formaat consumeert.

Offline Berichten Versturen

Na het configuratie proces kunt u uw offline berichten van het dashboard naar uw API sturen.

Chats versturen

Dezelfde functie is beschikbaar voor het sturen van chat transcripten naar uw API. U kunt deze actie ook uitvoeren vanuit een chat sessie met een chat command.

  • $api - Verstuur huidige chat naar uw API.