Documentation API

Intégrez les fonctionnalités de La Secrétaire Virtuelle directement dans vos applications.

Introduction

Notre API RESTful vous permet d'intégrer les fonctionnalités de La Secrétaire Virtuelle dans vos propres applications. Cette documentation vous guidera à travers les différents endpoints disponibles, ainsi que les méthodes d'authentification et les formats de données.

URL de base : https://api.lasecretairevirtuelle.com/v1

Authentification

Toutes les requêtes API doivent être authentifiées à l'aide d'une clé API. Vous pouvez générer une clé API depuis votre tableau de bord.

Authentification par en-tête

Authorization: Bearer VOTRE_CLE_API

Exemple de requête

curl -X GET \
  https://api.lasecretairevirtuelle.com/v1/assistants \
  -H 'Authorization: Bearer VOTRE_CLE_API'

Points d'accès disponibles

Assistants

GET/assistants

Récupère la liste de tous vos assistants virtuels.

Paramètres de requête

Paramètre	Type	Description
limit	Integer	Nombre maximum d'assistants à retourner (par défaut: 10)
offset	Integer	Nombre d'assistants à sauter (pour la pagination)
active	Boolean	Filtrer par statut d'activation

GET/assistants/{id}

Récupère les détails d'un assistant spécifique.

Paramètres de chemin

Paramètre	Type	Description
id	Integer	L'identifiant unique de l'assistant

Appels

GET/calls

Récupère l'historique des appels.

Paramètres de requête

Paramètre	Type	Description
limit	Integer	Nombre maximum d'appels à retourner (par défaut: 10)
offset	Integer	Nombre d'appels à sauter (pour la pagination)
assistant_id	Integer	Filtrer par ID d'assistant
status	String	Filtrer par statut (completed, missed, voicemail)
from_date	String (ISO 8601)	Date de début de la plage de recherche
to_date	String (ISO 8601)	Date de fin de la plage de recherche

Exemples d'intégration

JavaScript

// Exemple d'utilisation avec fetch
const API_KEY = 'votre_cle_api';
const API_URL = 'https://api.lasecretairevirtuelle.com/v1';

async function getAssistants() {
  try {
    const response = await fetch(`${API_URL}/assistants`, {
      method: 'GET',
      headers: {
        'Authorization': `Bearer ${API_KEY}`,
        'Content-Type': 'application/json'
      }
    });
    
    if (!response.ok) {
      throw new Error(`Erreur HTTP: ${response.status}`);
    }
    
    const data = await response.json();
    return data;
  } catch (error) {
    console.error('Erreur lors de la requête:', error);
    throw error;
  }
}

Python

import requests

API_KEY = 'votre_cle_api'
API_URL = 'https://api.lasecretairevirtuelle.com/v1'

def get_calls(assistant_id=None, status=None, limit=10):
    headers = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
    
    params = {
        'limit': limit
    }
    
    if assistant_id:
        params['assistant_id'] = assistant_id
        
    if status:
        params['status'] = status
    
    response = requests.get(f'{API_URL}/calls', headers=headers, params=params)
    response.raise_for_status()
    
    return response.json()

Prêt à commencer l'intégration ?

Connectez-vous à votre compte pour générer votre clé API et commencer à intégrer La Secrétaire Virtuelle dans vos applications.

Générer une clé API