aethexDocs
Tableau de bord

Référence API

Liste de numéros à ne pas appeler

Numéros que ce locataire ne doit jamais appeler. Vérifiés avant chaque appel sortant — POST /calls/trigger, POST /calls/batch, les chemins d'appel Teams et WhatsApp, ainsi que toute destination composée par un transfert en cours d'appel — une entrée ici est donc une garantie et non une demande. Un lot n'échoue pas parce que certains destinataires sont en opposition ; ces destinataires reviennent avec le statut skipped.

URL de base
https://api.aethexai.com/api/v1
Endpoints
6
Portées
call_suppressions:readcall_suppressions:write
POST/suppressions

Empêcher définitivement l'appel de ce numéro.

Ajouter un numéro à la liste d'opposition

Idempotent : mettre en opposition un numéro déjà présent renvoie l'entrée existante plutôt qu'une erreur, de sorte qu'un client resynchronisant toute sa liste peut rejouer cet appel sans risque. Les numéros peuvent être saisis tels qu'une personne les écrit — +1 (415) 555-1234 est accepté et stocké sous une clé canonique.

Corps de la requête

3
  • numberstringrequis

    Destination à mettre en opposition. E.164 ; la ponctuation courante est acceptée et retirée.

  • sourcestringoptionnel

    Origine de l'entrée : api, operator, carrier ou import. Par défaut api.

  • reasonstringoptionnel

    Note libre, jusqu'à 500 caractères. Renvoyée avec l'entrée.

Erreurs

1
422Entité non traitable

La valeur n'est pas un numéro de téléphone une fois la ponctuation retirée, ou source n'est pas une valeur que vous pouvez définir.

Envoyez un numéro E.164 et laissez source vide, sauf pour consigner un import ou une action d'opérateur.

POST/suppressions/bulk

Ajouter jusqu'à 1 000 numéros en une requête.

Ajouter plusieurs numéros à la liste d'opposition

La réponse distingue les nouvelles entrées des numéros déjà présents, afin qu'une resynchronisation puisse savoir ce qui a réellement changé. Tout ou rien : une requête en échec laisse la liste inchangée plutôt que d'en appliquer la moitié.

Corps de la requête

3
  • numbersstring[]requis

    Destinations à mettre en opposition. De 1 à 1 000 entrées.

  • sourcestringoptionnel

    Origine de l'entrée : api, operator, carrier ou import. Par défaut api.

  • reasonstringoptionnel

    Note libre, jusqu'à 500 caractères. Renvoyée avec l'entrée.

GET/suppressions

Les entrées de ce locataire, les plus récentes d'abord.

Lister les oppositions

Les entrées levées sont masquées sauf demande explicite. Cette liste n'inclut pas les clients qui se sont désinscrits en envoyant STOP — ceux-ci bloquent aussi les appels mais n'ont pas d'entrée ici. Utilisez le point de terminaison de vérification pour interroger un numéro sur les deux sources.

Chemin & Requête

5
  • sourcestringoptionnel

    Ne renvoyer que les entrées ayant cette source.

  • include_releasedbooleanoptionnel

    Inclure les entrées levées. Faux par défaut.

  • offsetintegeroptionnel

    Nombre de lignes à ignorer. 0 par défaut.

  • limitintegeroptionnel

    Nombre de lignes à renvoyer, de 1 à 200. 50 par défaut.

GET/suppressions/check

Un appel vers ce numéro serait-il refusé, et pourquoi ?

Vérifier un numéro

La réponse faisant autorité, sur cette liste et sur les désinscriptions SMS. Un numéro dont la source est sms_opt_out est en opposition parce que le client a répondu STOP à l'un de vos numéros ; il n'apparaîtra pas dans la liste, d'où l'existence de ce point de terminaison. Le paramètre number est validé comme sur l'endpoint de création : un numéro mal saisi répond 422 plutôt que suppressed: false.

Chemin & Requête

1
  • numberstringrequis

    Destination à vérifier, au format E.164.

GET/suppressions/:suppression_id

Récupérer une entrée par son identifiant.

Récupérer une opposition

Renvoie aussi bien les entrées levées que les entrées actives, afin qu'une entrée levée reste consultable.

Erreurs

1
404Introuvable

Aucune opposition portant cet identifiant n'appartient à ce locataire.

Listez les oppositions pour retrouver l'identifiant, ou vérifiez que vous utilisez la bonne clé d'API.

POST/suppressions/:suppression_id/release

Autoriser à nouveau l'appel de ce numéro.

Lever une opposition

Lève l'opposition sans supprimer l'enregistrement — l'entrée reste consultable avec include_released=true, car elle constitue la preuve que vous étiez fondé à cesser d'appeler cette personne. Les entrées qui consignent une demande du client ne peuvent pas être levées ici : un numéro mis en opposition parce qu'il a demandé l'arrêt, ou parce qu'il a envoyé STOP, ne vous appartient pas à dédire.

Erreurs

2
403Interdit

L'entrée consigne une demande du client (callee_request, ou un STOP par SMS).

Rien à corriger côté API. Cette opposition ne peut être levée que si le client se réinscrit.

404Introuvable

Aucune opposition portant cet identifiant n'appartient à ce locataire.

Listez les oppositions pour retrouver l'identifiant, ou vérifiez que vous utilisez la bonne clé d'API.