Allo

Exécuter une action de conversation

Action Effet -------- -------- READ Marquer la conversation comme lue UNREAD Marquer la conversation comme non lue ARCHIVE Archiver la conversation et…

PUT/v2/api/conversations/{contact_number}/action

Actions disponibles

ActionEffet
READMarquer la conversation comme lue
UNREADMarquer la conversation comme non lue
ARCHIVEArchiver la conversation et marquer tous les éléments comme lus
UNARCHIVEDésarchiver la conversation

Passer une action non prise en charge renvoie une erreur 400 avec le code INVALID_ACTION.

Idempotence

Toutes les actions sont idempotentes — appeler READ sur une conversation déjà lue est un no-op et renvoie 200.

Cet endpoint prend également en charge l'en-tête Idempotency-Key. Voir Idempotence.

Ciblage d'une ligne

Omettez allo_number pour appliquer l'action sur tous les numéros Allo. Fournissez-le pour cibler l'action sur une ligne spécifique.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

contact_numberstringrequis

The external phone number in E.164 format. URL-encode the + as %2B.

Corps

actionenum<string>requis

The action to execute.

READUNREADARCHIVEUNARCHIVE

allo_numberstring

Scope the action to a specific Allo number (E.164). Without this, the action applies across all lines.

Réponses

200Action executed successfully
401
404
429