Skip to main content
PUT
Save call flow draft
Scope requis : PHONE_NUMBERS_WRITE

Comportement

Crée ou met à jour le brouillon de travail du flux d’appel d’un numéro. Le brouillon est validé de manière souple et n’affecte pas le routage en direct tant qu’il n’est pas publié. Le paramètre de chemin {number} est le numéro Allo au format E.164. Envoyez le document definition complet ainsi que la schema_version à laquelle il se conforme.

Mise en ligne

Enregistrer un brouillon ne modifie jamais le routage en direct. Deux façons de le mettre en ligne :
  • Le publier vous-même avec Publier le flux d’appel, en passant la lock_version de cette réponse. Le routage des appels entrants en direct change immédiatement.
  • Le confier à une personne via la confirmation_url de cette réponse : un lien où un utilisateur connecté ouvre ce brouillon, le vérifie et le publie. Préférez cette option lorsqu’un humain doit approuver la modification.
Traitez la confirmation_url comme opaque : renvoyez-la telle quelle, ne la reconstruisez jamais à partir d’un hôte d’application codé en dur et ne l’analysez pas. (Elle n’est présente que lorsque le status de la réponse est DRAFT.)

Concurrence

  • lock_version — passez la valeur du brouillon que vous avez lu. Omettez-la (ou envoyez null) pour mettre à jour le brouillon sans contrôle de concurrence. Une valeur périmée renvoie 409 CALL_FLOW_STALE_LOCK.
  • base_published_version — la version publiée sur laquelle repose votre modification. Si quelqu’un a publié une nouvelle version pendant votre édition, cela renvoie 409 CALL_FLOW_CONCURRENT_EDIT.

Erreurs

  • 400 CALL_FLOW_SCHEMA_VERSION_MISMATCHschema_version ne correspond pas à la version actuelle du serveur.
  • 400 CALL_FLOW_INVALID — le definition est mal formé ou a échoué à la validation.
  • 404 PHONE_NUMBER_NOT_FOUND — le numéro ne fait pas partie des numéros de votre compte.
  • 409 CALL_FLOW_STALE_LOCK / 409 CALL_FLOW_CONCURRENT_EDIT — voir Concurrence ci-dessus.

Autorisations

Authorization
string
header
requis

Paramètres de chemin

number
string
requis

Allo phone number in E.164 format

Exemple:

"+14155551234"

Corps

application/json
definition
object
requis

The call flow tree document (opaque; camelCase keys).

schema_version
integer
requis

Must match the server's current call flow schema version.

Exemple:

1

lock_version
integer | null

The lock_version of the draft you are updating; omit or null to upsert without a concurrency check.

base_published_version
integer | null

The published version your edit is based on; a mismatch means someone published mid-edit (409).

engine_subset
enum<string> | null

Force the engine subset; inferred from the definition when omitted.

Options disponibles:
NESTED_IVR,
FULL_FLOW

Réponse

The saved draft

data
object

A version of a phone number's call flow.