Comment utiliser l’API de call-tracking ?

Comment utiliser l’API de call-tracking ?

L'API Magnetis vous permet d'intégrer le call-tracking dans vos propres outils.

Accès à l'API Magnetis 

  1. Cliquez sur API & connecteurs 



Initiation à l'API 


Vous pouvez ainsi :

  1. recueillir la liste de vos comptes clients et afficher leurs indicateurs clés (nombre d'appels reçus, temps d'appel, taux d'appels manqués)
  2. obtenir pour chaque compte, la synthèse journalière des appels pour construire des tableaux jour par jour
  3. recueillir la liste des numéros trackés pour chaque compte et afficher la liste détaillée des appels reçus (support, numéro de l'appelant, temps d'appel) et obtenir les indicateurs clés du numéro tracké
  4. rechercher dans la liste des appels un numéro d'appelant précis ou une liste de numéro d'appelants afin de vérifier si un client connu vous a contacté
  5. gérer les destinataires de vos numéros trackés et modifier la redirection des appels (sur mesure)
  6. obtenir instantanément de nouveaux numéros trackés dans différents pays (sur mesure).


Exemple Javascript JQuery



Clé API

L'identification se fait par l'ajout dans l'entête HTTP de votre requête de la variable x-api-key. Par exemple, si votre clé API est bhztHDI82kehfkXjz22, vous devez ajouter au header :
x-api-key: bhztHDI82kehfkXjz22

Url de l'API


Tous les appels à l'API se font via l'url :
https://www.magnetis-in.com/v1/

Vous pouvez suivre les différentes versions de l'API depuis cette page. Actuellement, la version en production est la version v1.


Filtre sur résultats


Vous pouvez filtrer la majorité des requêtes à l'API en rajoutant les variables GET DateFrom et DateTo afin de définir un intervalle de date au format yyyymmdd.
SI vous ne spécifiez pas d'intervalle de date, la valeur par défaut est de 7 jours.


Exemple de PHP

      Liste des comptes

      Code de la requête (PHP Curl)

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.magnetis-in.com/v1/accounts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "x-api-key: yourapikey1234"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

      Réponse de l'API

{
    "123": {
        "company_name": "Cie ABC",
        "email": "contact@cie-abc.com",
        "plan": "start"
    },
    "456": {
        "company_name": "Cie XYZ",
        "email": "contact@cie-xyz.com",
        "plan": "premium"
    }
}

      Liste des appels reçus

Nous ajoutons un intervalle de date pour filtrer les réponses en ajoutant ?DateFrom=20211101&DateTo=20211130 à la requête.
La requête contient les variables idacc (123, le numéro du compte client) et phonenumber (0033123456789, un numéro du compte 123).

      Code de la requête (PHP Curl)

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.magnetis-in.com/v1/accounts/123/numbers/0033123456789/calls?DateFrom=20211101&DateTo=20211130",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "x-api-key: yourapikey1234"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

      Réponse de l'API

{
    "123456": {
        "datecall": "28/11/21",
        "heurecall": "12h52",
        "timestampcall": "20211128125234",
        "callingNumber": "0033612345672",
        "calledNumber": "0033123456789",
        "supportNumero": "My website",
        "duration": "124",
        "typeNumero": "mobile",
        "paysNumero": "fr"
    },
     "654321": {
        "datecall": "14/11/21",
        "heurecall": "09h23",
        "timestampcall": "20211114092347",
        "callingNumber": "0033123456789",
        "calledNumber": "0033123456789",
        "supportNumero": "My website",
        "duration": "321",
        "typeNumero": "fixe",
        "paysNumero": "fr"
    }
}


Exemple Javascript JQuery

      Liste des numéros d'un compte

      Code de la requête (JQuery Ajax)

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://www.magnetis-in.com/v1/accounts/123/numbers/getlist",
  "method": "GET",
  "headers": {
    "x-api-key": "yourapikey1234",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

      Code de la requête (Javascript XHR)

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = false;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://www.magnetis-in.com/v1/accounts/123/numbers/getlist");
xhr.setRequestHeader("x-api-key", "yourapikey1234");

xhr.send(data);

      Code de la requête (Réponse de l'API)

{
    "0033123456789": {
        "numero": {
            "numero": "0033123456789",
            "supportnumero": "My website",
            "formatInternational": "0033123456789",
            "formatNational": "0123456789",
            "paysNumero": "fr",
            "typeNumero": "fixe"
        }
    }
}

 Retrouver le lien vers la structure détaillée de l'API Magnetis sur ce lien suivant .




  1. Cliquez sur "Voir les clés API de tous les comptes".



  1. Vous avez une clé API qui contrôle tous les comptes ainsi qu'une clé API pour chaque sous-compte.



Clé Sandbox

La clé sandbox permet de tester l'intégration de l'API sans avoir un compte Magnetis actif. Merci de contacter le support par email pour l'obtenir.
    • Related Articles

    • Comment choisir mon forfait de call-tracking ?

      Choisir mon forfait de call-tracking Lorsque vous débutez le call-tracking, la première étape nécessaire est de choisir votre forfait. Deux choix s’offrent à vous : Les architectures de canaux prédéfinies Le choix de canal ou de canaux de tracking ...
    • Comment configurer mon module de call-tracking ?

      Configurer mon module de call tracking Après avoir choisi votre forfait et avoir ajouté vos numéros trackés, vous pouvez installer le module de call-tracking sur votre site internet. L’intégration du module de call-tracking à votre site vous permet ...
    • Comment installer le module de call-tracking sur mon site (code, GoogleTagManager, Wordpress)?

      L'intégration du module de call-tracking à votre site vous permet d'accéder aux fonctionnalités de suivi des visiteurs et d'affichage dynamique de numéros en fonction de leur origine. Vous disposez ainsi d'un accès au suivi par source de trafic (site ...
    • Comment déployer le call-tracking ?

      Déployer le call-tracking Après avoir ajouté vos numéros trackés, il vous faut déployer le call-tracking sur les différents supports dont vous souhaitez mesurer la performance. Si vous n’avez pas encore ajouté vos numéros trackés, et que vous ne ...
    • Intégrer mes données de call-tracking à Google Data Studio

      À quoi ça sert ? Google Data Studio est un outil de Data Visualization très puissant, utilisé par les entreprises et les agences de communication pour présenter les performances Google Analytics, Google Ads, Search Console et autre. Magnétis vous ...