Mettre à jour le statut de la conversation

Utilisez l'API toggle_status pour modifier le statut d'une conversation spécifiée. Le serveur vérifie si le statut cible est valide selon la matrice de transition d'état STATUS_TRANSITIONS.

Méthode de requête

POST

Point de terminaison

https://livedesk-api.engagelab.com/api/v2/accounts/conversations/{conversation_id}/toggle_status

Authentification

Pour plus de détails, consultez la description de la méthode d'authentification dans la vue d'ensemble de l'API.

Requête

Exemple de requête

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/conversations/{conversation_id}/toggle_status' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
    "status": "resolved",
    "snoozed_until": 1715000000
}'

            

En-têtes de requête

Paramètres de chemin

Paramètres du corps de la requête

Valeurs d'énumération de status

Matrice de transition d'état (STATUS_TRANSITIONS)

Contraintes clés

• resolved est le seul état préalable pour passer à closed : open, pending et snoozed ne peuvent pas être définis directement sur closed ; ils doivent d'abord passer à resolved avant d'être archivés.
• closed ne peut revenir qu'à open : les conversations archivées ne peuvent pas passer directement à d'autres états actifs tels que resolved, pending ou snoozed.
• Définir le même statut est idempotent : si le statut cible est identique au statut actuel, la validation est ignorée et la réussite est renvoyée directement. Aucun callback n'est déclenché.
• La validation est implémentée au niveau du modèle ActiveRecord via validate :status_transition_allowed, if: :will_save_change_to_status?, et s'applique à tous les chemins save!, update! et status= + save.

Réponse

Réponse en cas de succès

HTTP 200 :

              
              {
  "meta": {},
  "payload": {
    "success": true,
    "conversation_id": 45,
    "current_status": "resolved",
    "snoozed_until": null
  }
}

            

Paramètres de réponse

Réponses d'erreur

Structure de la réponse 422

Violation de la matrice de transition d'état (provient de la validation au niveau du modèle et est renvoyée sous forme de full_messages par RequestExceptionHandler) :

              
              {
  "message": "Status can't transition from open to closed",
  "attributes": ["status"]
}

            

Valeur d'énumération de statut inconnue (provient de CustomExceptions::Conversation::InvalidStatus) :

              
              {
  "message": "Invalid conversation status: \"foo\" ('foo' is not a valid status)"
}

            

snoozed_until invalide (provient de CustomExceptions::Conversation::InvalidSnoozedUntil) :

              
              {
  "message": "Invalid snoozed_until: \"not-a-timestamp\" (invalid date)"
}