Passer au contenu principal
PUT
/
v2
/
api
/
conversations
/
{contact_number}
/
action
Execute conversation action
curl --request PUT \
  --url https://api.withallo.com/v2/api/conversations/{contact_number}/action \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "READ",
  "allo_number": "+14155550100"
}
'
{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "request_id": "<string>",
    "retry_after_seconds": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

Scope requis : CONVERSATIONS_WRITE

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.

Autorisations

Authorization
string
header
requis

Paramètres de chemin

contact_number
string
requis

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

Exemple:

"+14155551234"

Corps

application/json
action
enum<string>
requis

The action to execute.

Options disponibles:
READ,
UNREAD,
ARCHIVE,
UNARCHIVE
allo_number
string

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

Exemple:

"+14155550100"

Réponse

Action executed successfully