Doorzoek het Help Center
  1. Spotler Engage Help Center
  2. Instellingen
  3. Instellingen

Artikelen in deze sectie

Zie meer

API mogelijkheden

In dit artikel lees je meer over de mogelijkheden tot het benaderen van de Spotler Engage API:

Voor elk ondersteund scenario geldt dat Spotler Engage de bron is, en je eigen platform/tooling het target is. Per ondersteund scenario geldt dat er een authenticatie nodig is. Technische documentatie is hiervoor beschikbaar. Andere scenario’s dan hieronder beschreven worden niet door Spotler ondersteund.

Neem contact op met je Accountmanager als je geïnteresseerd bent om de Spotler Engage API te gebruiken en de technische documentatie te ontvangen.

Ondersteunde scenario’s

Workforce Management

In het Statistieken dashboard in de module Webcare worden de statistieken verzameld van de afhandeling van Webcare-conversaties door agenten. De gegevens uit dit dashboard kun je ontsluiten naar je eigen tooling en gebruiken voor planningsdoeleinden. De API Workforce Management geeft toegang tot dezelfde gegevens als zichtbaar in het Statistieken dashboard.

Deze (data)velden worden onder andere aangeboden in de documentatie
  • streamId: the id of the stream which this record belongs to;
  • streamName: the name of the stream which this record belongs to;
  • streamColor: the color of the stream which this record belongs to;
  • totalOpen: number of conversations/cases which match the filter and reside in Open state;
  • total: number of cases which match the filter;
  • averageWaitTime: average wait time persisted within the date range's filter for this stream;
  • averageHandleTime: average handle time persisted within the date range’s filter for this stream;
  • Conversations: number of conversations/cases which match the filter;
  • Customers: number of distinct platformuserids for which a conversation/case has at least one action performed on it and matches the filter;
  • Streams: number of distinct streams holding all conversations/cases which match the filter;
  • OldestMessage: oldest creation date for a conversation/case which matches the filter and is currently in Open state.

 

Marketing performance

Social media posts in je contentkalender leveren statistieken op. Deze worden verzameld in het Statistieken dashboard in de module Publiceren. De gegevens uit dit dashboard kun je ontsluiten naar je eigen tooling. De API Marketing performance geeft toegang tot dezelfde gegevens als zichtbaar in het Statistieken dashboard.

Deze (data)velden worden onder andere aangeboden in de documentatie
  • customerAccountId: the unique identifier for this account;
  • customerAccountName: the human readable name for this account;
  • platform: the platform this account exists on;
  • fans: the number of fans/followers for this account;
  • engagement: the number of engagements;
  • impressions: the number of impressions;
  • fanGrowth: the number of fans gained during the selected time period.

 

CRM conversation registration

In de module Webcare vinden gesprekken plaats met klanten, inwoners of contacten. Deze gesprekken kun je registreren in je eigen CRM platform. Hiermee kun je een 360-graden klantbeeld genereren.

Deze (data)velden worden onder andere aangeboden in de documentatie
  • id: unique identifier within Spotler Engage Webcare for this individual message;
  • account: the account this message belongs to (e.g. customer account phone number, timeline/page name, etc);
  • author: the information about the author who sent this message;
  • content: the content of the message (note that this is an array which can contain multiple entries);
  • postType: the (social) platform this message was sent on;
  • postSubType: an indicator of the type of message within the given (social) platform;
  • publishedAt: when this message appeared on the (social) platform.

 

WhatsApp Proactive

Je kunt de API WhatsApp Proactive gebruiken om templateberichten via WhatsApp naar bijvoorbeeld je klanten, inwoners of contacten te sturen. Denk hierbij aan boekingsbevestigingen, advertenties, nieuwsbrieven of updates. Een opt-in van de ontvanger is hierbij verplicht.

Authenticatie

Om gebruik te kunnen maken van de Spotler Engage API heb je een access token nodig. Voor de meeste Spotler Engage omgevingen verkrijg je deze access token door een aantal authenticatiecalls te doen, op basis van een gebruikersnaam, wachtwoord, omgevingsnaam en Client ID. Na contact met je Accountmanager ontvang je van ons een Client ID.

Indien je Single Sign-On (SSO) hebt geactiveerd op je Spotler Engage omgeving, dan werkt de authenticatie via een token die wordt gegenereerd in je eigen SSO omgeving. Beide authenticatiemogelijkheden zijn beschikbaar in de technische documentatie.

Voorwaarden en restricties

Workforce Management
  • Alleen aggregaties worden ontsloten, geen volledige conversaties;
  • Alleen mogelijk wanneer streams aangemaakt zijn op basis van streamtype Conversatie.
CRM conversation registration
  • X, Facebook en Instagram staan niet toe dat conversaties (inhoudelijk) middels een API ontsloten worden, alleen dát er een gesprek plaatsvond kan ontsloten worden;
  • Alleen mogelijk wanneer streams aangemaakt zijn op basis van streamtype Conversatie.
WhatsApp Proactive
  • Opt-in (consent) is verplicht;
  • Ontvanger moet een actief WhatsApp account hebben.