Brilliant Navigator - API
Övergripande teknisk specifikation för automatiserad rekrytering till enkäter via API
1. Bakgrund
Automatisering av kundundersökningar innebär att Brilliant skickar ut telefon-, sms- eller e-postbaserade enkäter direkt efter avslutade samtal, ärenden eller transaktioner.
För att detta ska fungera behöver ni utveckla ett script eller en applikation som utför följande:
-
Fångar upp data från era system (t.ex. telefoni, CRM eller ärendehantering).
-
Filtrerar bort kontakter som inte ska få en enkät (t.ex. avbrutna eller för korta samtal).
-
Hämtar en JWT-token från Brilliant Navigator API.
-
Skickar ett rekryteringsanrop till API:et med respondentens kontaktuppgifter och relevanta parametrar.
2. Data som ska överföras
För att ett rekryteringsanrop ska kunna genomföras krävs minst kundens telefonnummer eller e-postadress, samt referenskoder för agent och enkät.
| Parameter | Beskrivning | Unik per samtal |
|---|---|---|
| CompanyRefCode | Organisations-ID tillhandahållet av Brilliant | Nej (om inte flera konton används) |
| PhoneNumberOrEmail | Kundens telefonnummer eller e-postadress | Ja |
| AgentRefCode | Referenskod till agenten som hanterat ärendet, t.ex. telefon-ID | Ja |
| SurveyRefCode | Referenskod till undersökningen (varierar vid olika grupper/linjer) | Ja |
| LanguageCode | Språk för enkäten (SE/NO/DK/FI) | Nej, såvida inte flera språk används |
| MetaKey (valfri) | Kundreferens eller annan unik identifierare | Ja |
| Attributes (valfri) | Metadata i JSON-format, t.ex. samtalslängd, väntetid, samtalstyp | Ja |
3. Rekommenderat flöde
-
Anrop bör göras direkt efter varje avslutat samtal eller ärende.
Detta säkerställer att kunden får enkäten i nära anslutning till sin kontakt, vilket höjer svarsfrekvensen. -
Vi rekommenderar att ni tar höjd för att ta emot och lagra ResultCode som returneras vid anropet.
Detta underlättar uppföljning av t.ex. ogiltiga agentreferenser eller felaktiga telefonnummer.
Undersökningslogik:
-
Brilliant Navigator ringer upp efter ca 5 sekunder (konfigurerbart).
-
Undersökningen tar mindre än 2 minuter att besvara.
-
Resultat visas omedelbart efter slutförd undersökning.
Obs! Brilliant har egna kontroller för att:
-
förhindra att kunder kontaktas för ofta,
-
undvika utskick på olämpliga tider,
-
fördela svarstillfällen jämnare över månaden (slumpfunktion).
4. Support
Har ni frågor eller behöver hjälp?
Kontakta oss gärna på support@brilliantfuture.se.