API publique

Une API téléphonie pour vos données d'appels et de SMS, directement dans vos outils.

Avec l'API téléphonie d'OVOKY, récupérez historique d'appels, enregistrements, KPI et rapports dans votre outil de BI, votre CRM ou votre back-office, achetez des numéros et envoyez des SMS depuis votre propre code. Chaque clé ne porte que les périmètres dont elle a besoin et peut être limitée à vos serveurs.

endpoints REST
26
périmètres (scopes) pour les clés API
15
requêtes par minute et par clé par défaut
60
how it works

Une API REST pour l'intégration téléphonie, avec des clés à périmètres : lisez KPI, appels, enregistrements et rapports, achetez des numéros et envoyez des SMS.

  1. Couverture

    Consultez votre solde, vos KPI, votre consommation quotidienne, vos paiements, abonnements et tarifs. Listez les interactions d'appels et de SMS, téléchargez enregistrements et messages vocaux, lisez les événements d'agenda et exécutez les rapports prêts à l'emploi en JSON. Recherchez des numéros disponibles, achetez-les et résiliez-les.

    • Solde, KPI, consommation, paiements, abonnements et tarifs
    • Historique des appels et des SMS, enregistrements et messages vocaux
    • Numéros : liste, détails, disponibilités, achat et résiliation
    • Événements d'agenda et rapports
  2. Sécurité

    Créez une clé par intégration et donnez-lui uniquement les périmètres nécessaires, par exemple lire les rapports sans pouvoir acheter de numéros. Fixez une date d'expiration et limitez la clé à une liste d'adresses IP ou de domaines web. Chaque réponse indique le nombre de requêtes qu'il vous reste.

    • 15 périmètres, de balance:read à numbers:purchase
    • Date d'expiration par clé
    • Listes d'adresses IP et de domaines autorisés
    • Limites par défaut de 60 par minute, 3 600 par heure et 50 000 par jour
  3. SMS

    Envoyez à un numéro ou jusqu'à 100 en une seule requête, programmez l'envoi pour plus tard et passez une clé d'idempotence pour qu'une requête relancée n'envoie jamais deux fois. Listez les routes disponibles, puis vérifiez le statut de remise de chaque message grâce à son identifiant.

    • Jusqu'à 100 destinataires par requête
    • Envoi programmé
    • Clé d'idempotence contre les envois en double
    • Routes, historique d'envoi et statut de remise

Inclus

Tout ce qui est inclus : API publique

Exemples de code

Chaque endpoint documenté avec des exemples en cURL, JavaScript et Python.

Clés bearer

Authentifiez chaque requête avec votre clé API, transmise comme jeton bearer.

Rapports en JSON

Exécutez un rapport prêt à l'emploi avec ses filtres et récupérez les lignes en JSON.

Enregistrements

Téléchargez les enregistrements d'appels et l'audio des messages vocaux pour vos propres archives.

Commande de numéros

Recherchez des numéros disponibles, achetez-les et résiliez-les depuis votre code.

En-têtes de limite de débit

Les réponses indiquent la limite et ce qu'il reste, avec un délai d'attente quand vous l'atteignez.

API publique : vos questions

Les réponses courtes aux questions qu'on nous pose le plus souvent. Une autre question en tête ? Nous contacter

  • Non. OVOKY ne pousse pas d'événements vers vos systèmes. Pour rester synchronisé, interrogez régulièrement les endpoints utiles, comme les interactions d'appels ou le statut des SMS, dans la limite de vos quotas.

  • Créez une clé API dans les réglages de votre espace, choisissez ses périmètres et envoyez-la comme jeton bearer dans l'en-tête Authorization. Seuls les utilisateurs disposant de la permission clés API peuvent créer ou gérer des clés.

  • Par défaut, chaque clé peut envoyer 60 requêtes par minute, 3 600 par heure et 50 000 par jour. Les réponses indiquent la limite et les requêtes restantes, et une requête au-delà de la limite reçoit un en-tête Retry-After.

  • Pas aujourd'hui. L'API couvre les domaines listés sur cette page : données du compte, interactions, enregistrements, messages vocaux, numéros, événements d'agenda, rapports et SMS. Les contacts s'importent dans l'application par CSV, et les campagnes s'y gèrent aussi.

  • La documentation présente chaque endpoint en cURL, JavaScript et Python. Tout langage capable d'envoyer des requêtes HTTP et de lire du JSON fonctionne avec l'API.

Réunissez toutes vos conversations client au même endroit

Appels, SMS, WhatsApp, e-mail et chat dans une boîte de réception, sur une seule facture. Commencez avec une équipe, puis ajoutez les suivantes.