Webhooks och API

Översikt

Den här artikeln förklarar hur du kan använda Webhooks och TechTells API för att skapa egna integrationer och automatisera processer kopplade till din företagstelefoni. Den riktar sig till dig som är tekniskt kunnig och vill anpassa TechTells tjänster ytterligare till din verksamhets unika behov.

Så gör du

Använda Webhooks för realtidsuppdateringar

Webhooks är ett sätt för TechTell att meddela andra system i realtid när specifika händelser inträffar. Detta möjliggör omedelbar respons och automatisering.

1. Identifiera Händelsen: Bestäm vilken händelse i TechTells system som ska trigga din webhook. Exempelvis: inkommande samtal, missat samtal, ett samtal påbörjas i kontaktcentret, eller en användarstatus ändras.
2. Konfigurera Webhook URL: I TechTells adminportal (admin.techtell.se), navigera till avsnittet för integrationer eller utvecklarinställningar. Här anger du den URL till din egen server eller tjänst som TechTell ska skicka informationen till.
3. Välj Händelsetyp: Specificera vilka händelsetyper som ska utlösa webhooken till den angivna URL:en.
4. Implementera Mottagaren: Din server eller tjänst måste kunna ta emot och bearbeta den HTTP POST-förfrågan som TechTell skickar. Data skickas oftast i JSON-format.
5. Testa: Utlös den valda händelsen i TechTells system och verifiera att din mottagande tjänst tar emot datan korrekt.

Arbeta med TechTells API för datamanipulation

TechTells API (Application Programming Interface) låter dig programmatiskt hämta information och utföra åtgärder i ditt telefonsystem.

1. API-åtkomst: Börja med att generera API-nycklar eller behörighetstokens i adminportalen (admin.techtell.se). Se till att nyckeln har de behörigheter som krävs för de operationer du tänkt utföra.
2. Läs Dokumentationen: Gå igenom den API-dokumentation som finns tillgänglig i adminportalen. Den beskriver tillgängliga endpoints, autentiseringsmetoder, förfrågnings- och svarsformat.
3. Välj API Endpoint: Bestäm vilken funktion du vill utföra. Exempelvis: hämta samtalsloggar, uppdatera användarstatus, ändra köstatus eller schemalägga ett möte.
4. Skriv Din Kod: Använd ett programmeringsspråk (t.ex. Python, JavaScript, C#) för att konstruera HTTP-förfrågningar (GET, POST, PUT, DELETE) till TechTells API-endpoints. Inkludera din API-nyckel för autentisering.
5. Hantera Svar: Bearbeta JSON-svaret från API:et. Detta kan inkludera felhantering om förfrågan misslyckades.
6. Testa och Iterera: Utför tester med dina API-anrop och justera koden baserat på resultatet.

Tips och best practice

• Säkerhet först: Behandla dina API-nycklar som konfidentiell information. Förvara dem säkert och rotera dem regelbundet. Använd aldrig API-nycklar direkt i klientbaserad kod.
• Felhantering: Implementera robust felhantering i din kod för att gracefully hantera API-fel, nätverksproblem eller oväntade svar.
• Throttling och Rate Limits: Var medveten om eventuella begränsningar för antal API-anrop per tidsenhet. Bygg in fördröjningar om nödvändigt för att undvika att överbelasta systemet.
• Batcha Förfrågningar: Om du behöver utföra många liknande API-operationer, undersök om det finns batch-endpoints som kan effektivisera processen.
• Loggning: Logga webhook-händelser och API-anrop, inklusive förfrågningar och svar, för enklare felsökning och övervakning.

Felsökning

• Webhook mottas inte:
  • Kontrollera att URL:en i adminportalen är korrekt och tillgänglig från internet.
  • Säkerställ att din mottagande server är igång och lyssnar på rätt port.
  • Verktyg som RequestBin eller ngrok kan användas för att tillfälligt fånga webhook-anrop och verifiera att TechTell skickar dem.
• API-anrop returnerar fel:
  • HTTP 401 Unauthorized: Kontrollera att din API-nyckel är korrekt och giltig. Se över behörigheterna för nyckeln.
  • HTTP 400 Bad Request: Din förfrågan kan ha felaktigt format eller sakna obligatoriska parametrar. Jämför med API-dokumentationen.
  • HTTP 403 Forbidden: Din API-nyckel har inte behörighet att utföra den begärda operationen.
  • HTTP 404 Not Found: Kontrollera att API-endpointen är korrekt skriven.
  • HTTP 5xx Server Error: Detta indikerar ett problem på TechTells serversida. Försök igen senare. Om problemet kvarstår, kontakta kundservice@techtell.se.

Vanliga frågor

Kan jag använda Webhooks för att trigga en process i mitt CRM-system?

Ja, precis! Genom att konfigurera en webhook som triggas av ett inkommande samtal, kan du skicka information om den inkommande samtalaren till ditt CRM för att automatiskt slå upp kundens profil eller skapa en händelse.

Vilken typ av data skickas med Webhooks?

De flesta webhooks skickar en JSON-payload som innehåller detaljer om händelsen, såsom händelsetyp, tidsstämpel, samtals-ID, information om deltagare (nummer, anknytning) och statusändringar. Den exakta datastrukturen finns beskriven i vår API-dokumentation.

Finns det exempelkod för att komma igång med API:et?

Ja, vår API-dokumentation i adminportalen (admin.techtell.se) innehåller ofta kodexempel i populära programmeringsspråk för att hjälpa dig att snabbt komma igång med de vanligaste API-operationerna.

Vad är skillnaden mellan Webhooks och API?

Webhooks är ett sätt för TechTell att skicka data till dig i realtid när en händelse inträffar ("push"). API:et är ett sätt för du att begära data eller utföra åtgärder i TechTells system när du vill ("pull"). Båda är kraftfulla verktyg som ofta används tillsammans.