aethexDocs

Portées

Chaque clé API porte un ensemble de portées qui contrôlent les endpoints qu'elle peut atteindre. Les clés sont créées avec l'ensemble par défaut complet ci-dessous ; restreignez une clé en choisissant ses portées lors de sa création dans le tableau de bord, ou en passant une liste `scopes` personnalisée via l'API. Les clés sans la portée requise reçoivent un 403 Forbidden de l'endpoint correspondant.

Agents

Créer et gérer les agents vocaux, leurs outils et leur base de connaissances.

  • agents:readLecture

    Lister, récupérer et inspecter les agents, leurs outils et le contenu de la base de connaissances.

    Couvre également l'exécution des requêtes sur la base de connaissances.

  • agents:writeÉcriture

    Créer, mettre à jour, dupliquer et supprimer des agents ; gérer les outils ; téléverser des documents de base de connaissances.

    Requis au moment de la pré-signature pour POST /uploads/presign avec kind="doc/knowledge-base". Les octets sont envoyés directement vers l'URL de stockage présignée via PUT.

Appels

Passer des appels sortants et piloter des sessions de conversation WebRTC en direct.

  • calls:readLecture

    Lister et récupérer les enregistrements d'appels et les jobs par lots.

    Couvre également GET /conversation/{session_id}/status pour le polling de session en direct.

  • calls:writeÉcriture

    Passer des appels sortants et piloter des sessions de conversation en direct (connexion, envoi de texte, fin).

    Couvre les appels déclenchés via REST (/calls, /calls/trigger, /calls/batch), la fin d'un appel en cours (/calls/:call_id/end) et le contrôle de session WebRTC.

Conversations

Lire les transcriptions, enregistrements et diagnostics des appels terminés.

  • conversations:readLecture

    Lister, rechercher et récupérer les transcriptions, diagnostics et enregistrements de conversations.

    Inclut les endpoints de jetons audio et les feedbacks (qui mutent mais sont dans le rôle lecture car ils ne s'attachent qu'aux conversations existantes).

Enregistrements

Métadonnées d'enregistrement et téléchargements audio.

  • recordings:readLecture

    Lister les enregistrements, récupérer les métadonnées, télécharger l'audio.

  • recordings:writeÉcriture

    Supprimer des enregistrements.

    DELETE /recordings/{id}.

Synthèse vocale

Transcription et synthèse vocale.

  • transcribe:useUtilisation

    Soumettre de l'audio pour transcription (synchrone, asynchrone, upload présigné), interroger le statut des jobs, annuler des jobs.

    Requis au moment de la pré-signature pour POST /uploads/presign avec kind="audio/transcribe".

  • tts:useUtilisation

    Synthétiser de la parole (synchrone, streaming, par lots) et générer des aperçus de voix.

    Toutes les routes sous /tts plus POST /voices/preview.

Voix

Parcourir le catalogue de voix.

  • voices:readLecture

    Lister le catalogue de voix et récupérer les métadonnées d'une voix individuelle.

    GET /voices et GET /voices/{voice_id}.

Numéros de téléphone

Enregistrer et gérer les numéros depuis lesquels vos agents peuvent appeler.

  • phone_numbers:readLecture

    Lister et récupérer les numéros de téléphone enregistrés sur votre compte.

  • phone_numbers:writeÉcriture

    Enregistrer des numéros Twilio, modifier leur configuration de routage, puis les libérer.

Comptes Twilio

Identifiants de sous-compte Twilio par compte.

  • twilio_accounts:readLecture

    Lister et récupérer les identifiants de sous-compte Twilio enregistrés sur votre compte.

  • twilio_accounts:writeÉcriture

    Enregistrer et supprimer des identifiants de sous-compte Twilio.

SMS

Les messages qu'un agent peut envoyer par SMS, les conversations clients qu'ils créent, et l'opérateur qui les achemine.

  • sms_messages:readLecture

    Consulter les messages que les agents peuvent envoyer.

  • sms_messages:writeÉcriture

    Rédiger et gérer les messages envoyés par les agents.

    Ne couvre que la bibliothèque de messages. Ce scope ne permet pas d'envoyer du texte libre à une personne : c'est `sms_inbox:write`.

  • sms_inbox:readLecture

    Lire les conversations SMS des clients et leurs messages.

  • sms_inbox:writeÉcriture

    Répondre en tant que personne, passer les conversations de l'agent à un humain et inversement, et les marquer comme lues.

    Distinct de `sms_messages:*` car il envoie du texte libre à un vrai destinataire et lit ce que les clients ont écrit.

  • sms_campaigns:readLecture

    Consulter les campagnes SMS et les personnes touchées.

  • sms_campaigns:writeÉcriture

    Créer des campagnes SMS, et les démarrer, mettre en pause ou annuler.

    Écrit à des milliers de personnes qui ne vous ont jamais contacté en premier, et chaque message est facturé. À accorder délibérément.

  • messaging_accounts:readLecture

    Consulter l'opérateur relié qui envoie les SMS.

  • messaging_accounts:writeÉcriture

    Relier et gérer l'opérateur qui envoie les SMS.

WhatsApp

Les numéros WhatsApp Business reliés, les conversations qui s'y déroulent, et ce qui peut y être envoyé.

  • whatsapp_accounts:readLecture

    Consulter les numéros WhatsApp Business reliés.

  • whatsapp_accounts:writeÉcriture

    Relier et gérer les numéros WhatsApp Business.

  • whatsapp_messages:writeÉcriture

    Envoyer des messages modèles et passer des appels depuis un numéro WhatsApp relié.

    Engage des dépenses : chaque message modèle ouvre une conversation facturée par WhatsApp. Il n'est pas impliqué par `whatsapp_accounts:write`.

  • whatsapp_inbox:readLecture

    Lire les conversations et messages clients sur les numéros reliés.

  • whatsapp_inbox:writeÉcriture

    Répondre en tant qu'opérateur, passer les conversations entre l'agent et un humain, lancer des campagnes, et effacer définitivement la conversation d'un client.

    Les campagnes sont facturées par conversation : ce scope autorise donc aussi la dépense, pas seulement la réponse. Il permet aussi d'effacer définitivement la conversation d'un client sur un numéro : ses messages, les transcriptions et l'audio de ses appels, et ce que l'agent retient de lui.

Connexion opérateur

Les comptes opérateur qu'Aethex relie pour vous afin de provisionner numéros et trunks.

  • carrier_accounts:readLecture

    Consulter les comptes opérateur reliés.

  • carrier_accounts:writeÉcriture

    Relier une clé API opérateur et provisionner automatiquement des trunks SIP.

    Provisionne de vrais trunks sur votre compte opérateur : sa portée dépasse donc Aethex.

Microsoft Teams

La connexion au tenant Teams et les numéros qui y sont rattachés.

  • msteams:readLecture

    Consulter la connexion Microsoft Teams reliée.

  • msteams:writeÉcriture

    Connecter et déconnecter un tenant Microsoft Teams, y rattacher ses numéros et passer des appels dessus.

    Distinct de `calls:write` car passer un appel Teams agit à l'intérieur de votre tenant Microsoft.

Intégrations

Les connexions tierces qu'un agent peut lire et mettre à jour pendant un appel.

  • integrations:readLecture

    Consulter les intégrations tierces connectées.

    Couvre aussi l'exploration des entités et des champs d'un système connecté lors d'un import.

  • integrations:writeÉcriture

    Connecter et gérer les intégrations tierces.

Trunks SIP

Trunks SIP de votre propre opérateur et leur provisionnement.

  • sip_trunks:readLecture

    Lister et récupérer les trunks SIP enregistrés sur votre compte.

  • sip_trunks:writeÉcriture

    Créer, intégrer, mettre à jour, supprimer des trunks SIP et définir le trunk sortant par défaut.

    POST /sip-trunks/onboard requiert aussi `phone_numbers:write` pour l'enregistrement de numéro en une étape.

Utilisation

Lire les métriques d'utilisation et configurer les déclencheurs webhook basés sur l'utilisation.

  • usage:readLecture

    Lire les métriques d'utilisation (période courante, quotidienne, mensuelle, résumé) et inspecter les déclencheurs d'utilisation.

  • usage:writeÉcriture

    Créer et mettre à jour des déclencheurs d'utilisation, redélivrer des déclenchements, faire pivoter le secret de signature des webhooks.

Modèles

Parcourir le catalogue des modèles LLM utilisés pour le champ `llm_model` des agents.

  • models:readLecture

    Lister les modèles LLM disponibles et inspecter les métadonnées du catalogue.

    GET /models. Requis pour chaque appel au point d'accès du catalogue de modèles.

La plupart des intégrations ont besoin de `agents:write`, `calls:write` et des portées de lecture correspondantes. Ajoutez les autres au fur et à mesure.