Mettre à jour le statut de la conversation

Utilisez l'API toggle_status pour modifier le statut d'une conversation donnée. Le serveur vérifie si le statut cible est valide conformément à la matrice de transitions de statut STATUS_TRANSITIONS.

Méthode de requête

POST

URL de requête

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

Authentification

Pour plus de détails, consultez les instructions d'authentification dans Présentation 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 la requête

Paramètres de chemin

Paramètres du corps de la requête

Valeurs énumérées de status

Matrice de transitions de statut (STATUS_TRANSITIONS)

Contraintes principales

• resolved est le seul statut prérequis pour passer à closed : open, pending et snoozed ne peuvent pas être directement transformés en closed. Ils doivent d'abord passer à resolved avant d'être archivés.
• closed peut uniquement revenir à open : une conversation archivée ne peut pas passer directement à d'autres statuts actifs, tels que resolved, pending ou snoozed.
• L'écriture du même statut est idempotente : lorsque le statut cible est identique au statut actuel, la validation est ignorée et la requête aboutit 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= suivis de save.

Réponse

Réponse réussie

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 transitions de statut (issue de la validation au niveau du modèle et générée sous forme de full_messages par RequestExceptionHandler) :

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

            

Valeur énumérée inconnue pour le statut (issue de CustomExceptions::Conversation::InvalidStatus) :

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

            

Valeur snoozed_until non valide (issue de CustomExceptions::Conversation::InvalidSnoozedUntil) :

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