Control de errores en las API de mensajería

Al trabajar con las API de mensajería, es importante comprender cómo se comunican los errores, ya que le ayuda a implementar el control y la depuración de errores adecuados en las aplicaciones.

Las API devuelven códigos de estado HTTP estándar para indicar éxito o error e incluye mensajes de error detallados en el cuerpo de la respuesta. Estas respuestas de error suelen seguir la especificación RFC 7807 para obtener detalles del problema en las API HTTP.

Además del código de estado y el mensaje, las solicitudes con error incluyen un identificador de correlación en los encabezados de respuesta que puede usar para solucionar problemas.

Códigos de estado HTTP

Código de estado Meaning Description
400 Solicitud incorrecta La solicitud no se ajustaba al contrato de API. La respuesta sigue RFC 7807 Detalles del Problema.
401 No autorizado El token ha expirado, no es válido o el identificador de canal no está autorizado para la organización.
404 No encontrado No se encontró el identificador de conversación especificado o ya está cerrado.
429 Demasiadas solicitudes Se ha superado el límite de velocidad de solicitud. El encabezado indica cuándo puede reintentar.
500 Error interno del servidor El servicio omnicanal no pudo procesar la solicitud.
503 Servicio no disponible El servicio omnicanal no está disponible temporalmente.

Error 400 de ejemplo (formato RFC 7807)

{
  "type": "https://en.wikipedia.org/wiki/Square_root",
  "title": "Bad Input",
  "status": 400,
  "detail": "Negative or complex numbers are not allowed."
}

Códigos de error en el cuerpo de la respuesta

Código de error Mensaje de error Código HTTP
30001 El identificador de organización proporcionado no es válido. 400
30002 El identificador de canal proporcionado no es válido. 400
30003 La operación solicitada no es válida o no se admite. 400
30004 La configuración del canal especificada no existe. 404
30005 El identificador de conversación proporcionado no es válido. 400
30006 La marca de tiempo proporcionada no es válida. 400
30007 El tamaño de página de las conversaciones debe ser NULL o entre 1 y 250. 400
30008 El tamaño de página de los mensajes debe ser NULL o entre 1 y 100. 400
30009 El token de continuación proporcionado no es válido. Use el mismo token que antes. 400
30010 El tamaño del contexto de conversación es demasiado grande. El máximo permitido es 100 entradas. 400
30011 La longitud del texto del mensaje es demasiado grande. Se permiten 6000 caracteres como máximo. 400
30012 El cuerpo de la solicitud no se proporcionó o tiene un formato incorrecto. 400
30013 La conversación especificada no existe. 404
30014 La configuración del canal especificada no está vinculada a una secuencia de trabajo. 400
30015 El cuerpo de la respuesta no se serializó correctamente. Póngase en contacto con el servicio de atención al cliente para obtener ayuda. 500
30016 La actividad del mensaje no tiene texto ni datos adjuntos. 400

Uso de CorrelationID para solucionar problemas

Cada respuesta con error incluye un encabezado , , que identifica de forma única la transacción dentro del sistema. Puede guardar este identificador y compartirlo con el soporte técnico de Microsoft si necesita ayuda para solucionar errores específicos.

Introducción a las API de mensajería

  • Last updated on