Publieke API

Je gespreks- en sms-gegevens, in je eigen tools.

Met de telefonie-API van OVOKY haal je je belgeschiedenis, opnames, KPI's en rapporten binnen in je BI-tool, CRM of backoffice, en koop je nummers en verstuur je sms'en vanuit je eigen code. Elke sleutel krijgt alleen de scopes die ze nodig heeft en kan beperkt worden tot je eigen servers.

REST-endpoints
26
scopes voor API-sleutels
15
verzoeken per minuut per sleutel, standaard
60
how it works

Een REST API met afgebakende sleutels om KPI's, oproepen, opnames en rapporten op te halen, nummers te kopen en sms'en te sturen vanuit je eigen systemen.

  1. Wat de API dekt

    Lees je tegoed, KPI's, dagelijks verbruik, betalingen, abonnementen en tarieven. Vraag de geschiedenis van oproepen en sms'en op, download gespreksopnames en voicemails, lees agenda-items en draai de kant-en-klare rapporten als JSON, zodat je KPI's kunt exporteren naar je eigen tools. Zoek beschikbare nummers, koop ze en zeg ze op.

    • Tegoed, KPI's, verbruik, betalingen, abonnementen en tarieven
    • Geschiedenis van oproepen en sms'en, gespreksopnames en voicemails
    • Nummers: lijst, details, beschikbaarheid, aankoop en opzegging
    • Agenda-items en rapporten
  2. Beveiliging

    Maak een sleutel per koppeling en geef ze alleen de scopes die ze nodig heeft, bijvoorbeeld rapporten lezen zonder het recht om nummers te kopen. Stel een vervaldatum in en beperk de sleutel tot een lijst van IP-adressen of webdomeinen. Elk antwoord toont hoeveel verzoeken je nog over hebt.

    • 15 scopes, van balance:read tot numbers:purchase
    • Vervaldatum per sleutel
    • Allowlists voor IP-adressen en domeinen
    • Standaardlimieten van 60 per minuut, 3.600 per uur en 50.000 per dag
  3. Sms

    Stuur naar één nummer of naar maximaal 100 in één verzoek, plan de levering voor later en geef een idempotentiesleutel mee, zodat een herhaald verzoek nooit twee keer verstuurt. Vraag de routes op die voor jou beschikbaar zijn en controleer daarna de leveringsstatus van elk bericht via zijn ID.

    • Tot 100 ontvangers per verzoek
    • Geplande levering
    • Idempotentiesleutel tegen dubbele verzending
    • Routes, verzendgeschiedenis en leveringsstatus

Inbegrepen

Alles rond je publieke API

Codevoorbeelden

Elk endpoint is gedocumenteerd met voorbeelden in cURL, JavaScript en Python.

Bearer-sleutels

Authenticeer elk verzoek met je API-sleutel als bearer token.

Rapporten als JSON

Draai een kant-en-klaar rapport met filters en krijg de rijen terug als JSON.

Opnames

Download gespreksopnames en voicemails voor je eigen archief.

Nummers bestellen

Zoek beschikbare nummers, koop ze en zeg ze op vanuit je code.

Headers voor rate limits

Antwoorden tonen de limiet en wat er overblijft, met een wachttijd als je ze bereikt.

Publieke API: veelgestelde vragen

Korte antwoorden op wat teams ons het vaakst vragen. Nog een andere vraag? Contacteer ons

  • Nee. OVOKY stuurt geen gebeurtenissen naar je systemen. Om gesynchroniseerd te blijven, bevraag je regelmatig de endpoints die je nodig hebt, zoals oproepen of sms-status, binnen je rate limits.

  • Maak een API-sleutel aan in de instellingen van je werkruimte, kies de scopes en stuur de sleutel als bearer token in de Authorization-header. Alleen gebruikers met het recht voor API-sleutels kunnen sleutels aanmaken of beheren.

  • Standaard kan elke sleutel 60 verzoeken per minuut doen, 3.600 per uur en 50.000 per dag. Antwoorden bevatten de limiet en het aantal resterende verzoeken, en een verzoek boven de limiet krijgt een Retry-After-header.

  • Vandaag niet. De API dekt de domeinen op deze pagina: accountgegevens, interacties, opnames, voicemails, nummers, agenda-items, rapporten en sms. Contacten importeer je in de app via csv, en ook campagnes beheer je daar.

  • De documentatie toont elk endpoint in cURL, JavaScript en Python. Elke taal die HTTP-verzoeken kan doen en JSON kan lezen, werkt met de API.

Breng al je klantgesprekken samen op één plek

Oproepen, sms, WhatsApp, e-mail en chat in één inbox en op één factuur. Begin met één team en breid uit wanneer je wilt.