Skip to main content
POST
Modifiez les paramètres personnels pris en charge. Seul le propriétaire de l’équipe peut modifier le vocabulaire partagé et les instructions de traduction. Les paramètres omis restent inchangés.

Authentification et autorisations

string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont acceptés uniquement par MCP, pas par cet endpoint REST.
Autorisations requises: settings:write. Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.

Paramètres

string
Facultatif au niveau du transport : le serveur injecte un identifiant avant la validation si ce champ est omis. Fournissez votre propre UUID v4 stable pour récupérer le résultat en toute sécurité si la réponse est perdue.Format: “uuid”. Motif: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
Valeur textuelle.Longueur minimale: 1. Longueur maximale: 120.
array
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre maximal d’éléments: 1000.
string
Valeur textuelle.Longueur maximale: 500.
union
Accepte les possibilités indiquées dans le schéma d’entrée complet.
array
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre maximal d’éléments: 50.
array
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre maximal d’éléments: 50.
array
Liste de valeurs. Consultez le schéma d’entrée complet pour connaître la structure de ses éléments.Nombre maximal d’éléments: 10.
object
Objet JSON. Consultez le schéma d’entrée complet pour connaître ses champs imbriqués.
boolean
Valeur booléenne.
boolean
Valeur booléenne.
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.

Idempotence

Utilisez un UUID v4 dans requestId ou dans l’en-tête HTTP Idempotency-Key pour chaque mutation. Après une erreur réseau, réutilisez le même identifiant avec des arguments identiques. Si les deux sont fournis, ils doivent correspondre. Rejouer une requête enregistrée ne répète pas l’opération et ne décompte pas un nouvel appel mensuel. Les requêtes en échec ou interrompues ne sont pas relancées automatiquement. Toute mutation peut renvoyer HTTP 202 lorsqu’une nouvelle tentative retrouve la même requête encore en cours, même si sa première exécution est habituellement synchrone. Si l’exécution est terminée mais que resultStored vaut false, une nouvelle tentative renvoie HTTP 200 avec l’état de la requête enregistrée, au lieu du résultat d’origine. Récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement de son domaine.

Exemples de requêtes

Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.

Réponse

Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Confirme que les paramètres pris en charge fournis ont été enregistrés.

Champs du résultat

Récupérer et suivre cette requête

Utilisez le même identifiant, même après une perte de connexion. Si resultStored vaut false, récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement correspondante. Ne lancez jamais une seconde génération uniquement pour vérifier l’avancement.
HTTP 200

Notes de l’opération

  • Fournissez au moins un paramètre en plus du requestId facultatif. Les paramètres omis restent inchangés.
  • Seul le propriétaire de l’équipe peut modifier brandVocabulary et customTranslationInstructions. Les membres de l’équipe peuvent mettre à jour leurs autres préférences personnelles.
  • Le vocabulaire accepte jusqu’à 1,000 termes. Chaque terme normalisé doit comporter au maximum 49 caractères et cinq mots, sans crochets, accolades, chevrons ni barres obliques inverses. Les termes en double sont supprimés sans distinction de casse.
  • Les noms d’entreprise contiennent 1–120 caractères. Les instructions de traduction du compte contiennent au maximum 500 caractères.
  • Les préréglages de langues et de chaînes acceptent jusqu’à 50 préréglages, chacun avec 1–50 langues ou chaînes sélectionnées. Les préréglages de marque de synthèse vocale acceptent jusqu’à 10 identifiants uniques, des noms de 60 caractères, des instructions de 300 caractères et une vitesse de 0.5 à 2.

Utilisation

Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.

Erreurs