Parcourir la documentation

Référence

Erreurs

Les erreurs sont signalées par un code de statut HTTP et un corps JSON. Les erreurs de validation indiquent quel champ pose problème.
StatutSignification
400La requête est invalide : un champ ne passe pas la validation, ou la requête est refusée (un agent inconnu sur une campagne, rien à relancer)
401La clé API est absente ou inconnue
403Le réglage n'est pas activé sur votre compte (declinedStopRatio)
404La ressource, ou l'entité que vous avez indiquée, n'existe pas
409Un conflit : des éléments de deux entités, un nom ou un identifiant externe déjà pris, une entité qui contient encore des éléments, un outil encore utilisé
422Un parcours d'appel référence un outil qui n'existe pas, ou donne le nom d'un autre outil à un nœud forwardCall dont le numéro est obtenu par une recherche
5xxUne erreur serveur : réessayez avec un délai croissant (backoff), puis écrivez à support@callshift.ai

Erreurs de validation

JSON
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      { "code": "invalid_string", "path": ["contacts", 0, "email"], "message": "Invalid email" }
    ]
  }
}

Le détail des erreurs se trouve dans error. path localise le champ, ici l'email du premier contact.

Autres erreurs

JSON
{ "error": "Campaign not found" }

Certains conflits renvoient un champ supplémentaire, pour vous aider à les résoudre :

RequêteChamp supplémentaire
Créer une entité dont l'identifiant externe est déjà prisexistingEntityId : l'entité qui le détient
Supprimer une entité qui contient des élémentsusage : ses agents, phoneNumbers, webhooks
Supprimer un outil utiliséagents : les agents qui le référencent