Actualizar estado de la conversación

Utiliza la API toggle_status para cambiar el estado de una conversación concreta. El servidor valida si el estado de destino es válido según la matriz de transición de estados STATUS_TRANSITIONS.

Método de solicitud

POST

Endpoint

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

Autenticación

Para obtener más información, consulta la descripción del método de autenticación en Información general de la API.

Solicitud

Ejemplo de solicitud

              
              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
}'

            

Encabezados de la solicitud

Parámetros de ruta

Parámetros del cuerpo de la solicitud

Valores enumerados de status

Matriz de transición de estados (STATUS_TRANSITIONS)

Restricciones clave

• resolved es el único estado previo válido para pasar a closed: open, pending y snoozed no pueden establecerse directamente como closed; primero deben pasar a resolved antes de archivarse.
• closed solo puede volver a open: las conversaciones archivadas no pueden pasar directamente a otros estados activos como resolved, pending o snoozed.
• Establecer el mismo estado es idempotente: si el estado de destino es igual al estado actual, se omite la validación y se devuelve el éxito directamente. No se activa ninguna devolución de llamada.
• La validación se implementa en la capa de modelo ActiveRecord mediante validate :status_transition_allowed, if: :will_save_change_to_status?, y se aplica a todas las rutas save!, update! y status= + save.

Respuesta

Respuesta correcta

HTTP 200:

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

            

Parámetros de respuesta

Respuestas de error

Estructura de la respuesta 422

Infringe la matriz de transición de estados (proviene de la validación en la capa del modelo y RequestExceptionHandler la representa como full_messages):

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

            

Valor enumerado de estado desconocido (proviene de CustomExceptions::Conversation::InvalidStatus):

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

            

snoozed_until no válido (proviene de CustomExceptions::Conversation::InvalidSnoozedUntil):

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