Guide voice management

LE GUIDE UTILISATEUR DE VOTRE SOLUTION CALL CENTER

Retour au guide

API variables dans SVI

1 - Généralités

L’API de consultations des variables dans le SVI permet de récupérer l’ensemble des informations liées aux variables configurées dans le SVI

2 – Formalisme

Cette API s’inspire du formalisme REST. Les données sont servies au format JSON.

Vous devez obtenir auprès de votre interlocuteur Axialys vos données d’authentification.

3 – Format des requêtes

Les requêtes seront de la forme

https://SERVER/vm...?user=<username>&password=<password>

A noter concernant le format des paramètres :

  • les numéros de téléphone sont attendus au format E164 (c’est-à-dire code pays suivi du numéro national, par exemple 33145420000 pour un numéro parisien).
  • les dates sont attendues au format IS0 8601. Cependant, notre système acceptera les variations les plus communes, et notamment le format AAAA-MM-DD HH:MM.

2.2 – Format des réponses

Les réponses sont fournies au format JSON par défaut sauf si la requête est passée depuis un navigateur, auquel cas les données sont présentées au format HTML. Pour forcer une réponse JSON, ajouter le paramètre

accept=application/json

.

Attention, la réponse JSON est susceptible de contenir des données supplémentaires, en cas d’évolution de l’API. Ne pas en tenir compte.

3 - Infos générales

3.1 - Méthode GET

URL /variables
Méthode(s)
GET

Les requêtes devront se faire sous la forme

				
					https://api.axialys.com/voice-management/variables?call_ids=95334828,95334829

Paramètre en entrée

Paramètre Exemple Format Description
call_ids
172452
Nombre entier
IDs de(s) l'appel(s) à rechercher

3.2 - Méthode POST

URL /variables
Méthode(s)
POST

Les requêtes devront se faire sous la forme

				
					https://api.axialys.com/voice-management/variables

Le JSON a mettre dans la requête POST serait de forme : [<Idappel>,<Idappel>]

Données retournées

				
					{
    "app": "axialys-com",
    "version": "preprod",
    "datetime": "2023-03-17T14:34:25.059622",
    "timestamp": 1679060065.059622,
    "timezone": null,
    "code": 200,
    "status": "success",
    "data": [
        {
            "call_id": 95334828,
            "variables": {
                "fvff": "1234"
            }
        },
        {
            "call_id": 95334829,
            "variables": {
                "feverarffrazfarz": "1234563212",
                "saisie": "2354",
                "abc": "1234567892"
            }
        }
    ]
}
  • Table des matières