API

Construisez avec VeyCall.

Une API REST pour tout ce que propose le tableau de bord : agents, connaissances, conversations, prospects et sessions vocales en temps réel. Disponible avec l'offre Pro.

Ouvrir la référence interactiveTélécharger la spécification OpenAPI

Présentation

Tous les points d'accès se trouvent sous /api/v1. Requêtes et réponses sont en JSON, sauf l'import de fichiers (multipart) et les aperçus de voix (MP3).

https://api.veycall.com/api/v1

Authentification

Envoyez le jeton d'accès d'un utilisateur VeyCall connecté comme jeton Bearer. Si l'utilisateur appartient à plusieurs organisations, choisissez-en une avec l'en-tête x-organization-id ; sinon, son organisation par défaut est utilisée.

Authorization: Bearer <access_token>
x-organization-id: <organization_id>

Le nombre de requêtes est limité par utilisateur. Si vous recevez 429, patientez un instant puis réessayez.

Réponses et erreurs

Les réponses réussies placent le résultat dans data. Les listes sont paginées avec un curseur dans meta.next_cursor ; renvoyez-le dans cursor pour obtenir la page suivante.

{ "data": [ ... ], "meta": { "next_cursor": "..." } }

Les erreurs renvoient le code HTTP correspondant et un code stable que vous pouvez tester dans votre code :

{ "error": { "code": "NOT_FOUND", "message": "Agent not found" } }

Exemple

Lister vos agents :

curl https://api.veycall.com/api/v1/agents \
  -H "Authorization: Bearer $VEYCALL_TOKEN"

Agents

  • GET/agentsLister les agents
  • POST/agentsCréer un agent
  • GET/agents/{agent_id}Obtenir un agent
  • PATCH/agents/{agent_id}Modifier un agent
  • DELETE/agents/{agent_id}Supprimer un agent
  • POST/agents/{agent_id}/duplicateDupliquer un agent
  • POST/agents/{agent_id}/publishPublier un agent
  • POST/agents/{agent_id}/unpublishDépublier un agent

Connaissances

  • GET/knowledgeLister les documents
  • POST/knowledgeAjouter une adresse, un texte ou une FAQ
  • POST/knowledge/uploadImporter un fichier PDF, DOCX, TXT ou CSV
  • GET/knowledge/{id}Obtenir un document
  • POST/knowledge/{id}/reindexRetraiter un document
  • DELETE/knowledge/{id}Supprimer un document

Conversations

  • GET/conversationsLister les conversations
  • GET/conversations/{id}Obtenir une conversation et son prospect
  • GET/conversations/{id}/messagesObtenir la transcription
  • DELETE/conversations/{id}Supprimer une conversation

Prospects

  • GET/leadsLister les prospects
  • POST/leadsCréer un prospect
  • GET/leads/{id}Obtenir un prospect
  • PATCH/leads/{id}Modifier le statut ou les informations d'un prospect
  • DELETE/leads/{id}Supprimer un prospect

Sessions vocales

  • GET/voicesLister les voix disponibles
  • GET/voices/previewAperçu audio d'une voix (MP3)
  • POST/voice/sessionsCréer une session vocale
  • POST/voice/sessions/{id}/endTerminer une session vocale
  • GET/realtimeWebSocket vocal en temps réel

Organisation et consommation

  • GET/meUtilisateur connecté et ses organisations
  • GET/organizationOrganisation, offre et limites
  • GET/organization/membersLister les membres
  • GET/usageConsommation sur une période de facturation
  • GET/usage/dailyConsommation quotidienne
  • GET/analytics/overviewStatistiques des conversations, prospects et agents