Utviklerdokumentasjon

Ditt første kall

1. Registrer bedriften og logg inn i dashbordet.
2. Lag en testnøkkel under Utviklere. En testnøkkel sender ingenting og koster ingenting, så du kan prøve fritt.
3. Send en SMS med nøkkelen:

curl -X POST "https://api.telkit.no/v1/sms" \  -H "Authorization: Bearer $TELKIT_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: ordre-2041-hentemelding" \  -d '{  "profile": "nettbutikken",  "to": "+4791234567",  "text": "Hei! Pakken din er klar til henting."}'

const response = await fetch("https://api.telkit.no/v1/sms", {  method: "POST",  headers: {    Authorization: `Bearer ${process.env.TELKIT_API_KEY}`,    "Content-Type": "application/json",    "Idempotency-Key": "ordre-2041-hentemelding",  },  body: JSON.stringify({    profile: "nettbutikken",    to: "+4791234567",    text: "Hei! Pakken din er klar til henting.",  }),});const answer = await response.json();

Svaret har ok: true og meldingen i data: id-en, tilstanden, hvor mange SMS-enheter teksten ble, prisen i øre og testMode: true. Bytt til en ekte nøkkel når du vil sende på ordentlig.

Det alle kall har felles

• Alle kall går til https://api.telkit.no, under /v1. Du sender og får JSON.
• Nøkkelen står i Authorization-headeren. Les API-nøkler og tilganger.
• Beløp er hele tall i øre uten mva., i felt som slutter på Ore. 1 krone er 100 øre.
• Tidspunkt er tekst i ISO 8601. Id-er er UUID-er, bortsett fra hendelser (evt_…).
• Kall som sender eller ringer, tar en Idempotency-Key, så et nytt forsøk aldri sender to ganger. Les Idempotens.
• Når vi sier nei, får du en kode du kan lese i koden din. Les Svar og feil.

Guider

• Send SMS: nå eller senere, fra navn eller nummer, med avmelding.
• Ring ut og styr samtalen: les opp en tekst, koble en selger i nettleseren til en kunde, konferanser og samtaler mellom app-brukere.
• Ta imot samtaler: systemet ditt bestemmer hva som skjer når noen ringer.
• Tale til tekst: lydfiler, direkte lyd og samtaler.
• Send e-post: enkeltmeldinger og kampanjer.

Få vite hva som skjer

Hver gang noe skjer, en SMS blir levert eller en samtale slutter, lager telkit en hendelse. Du kan få hendelsene på tre måter, og alle tre bruker den samme id-en for den samme hendelsen:

• Webhooks: vi sender hendelsen til en adresse hos deg.
• Hendelsesstrømmen: du holder en forbindelse åpen og leser hendelsene når de kommer.
• Hendelsesloggen: du spør etter alt som har skjedd siden sist.

Hendelseskatalogen viser alle hendelsene med feltene sine.

Referanse

API-referansen viser alle operasjonene med felt og avvisningskoder. Den lages fra API-ets egen OpenAPI-fil, som du også kan laste ned der.