API de tickets

Unusual Suite expone una API HTTP REST que acepta solicitudes de soporte y devuelve respuestas generadas por IA en formato JSON.

Configurar el acceso a la API

1. Configura un usuario de Unusual Suite que tenga acceso de escritura a los registros de tickets.
2. Asigna una clave de API a ese usuario en la interfaz de usuario.
3. Copia la clave de API al portapapeles.

Enviar una solicitud

1. Envía una solicitud HTTP POST a https://ds-01.unusual-suite.com/open-api/ticket/compose-response.
2. Incluye un encabezado de solicitud con la clave api-key establecida con la clave de API del paso de configuración anterior.
3. Establece el cuerpo de la solicitud en uno de los siguientes:
   • La consulta del ticket como texto sin formato, Markdown o HTML.
   • Un objeto JSON (ver estructura a continuación) si necesitas incluir archivos adjuntos.
4. Espera la respuesta — Unusual Suite normalmente responde en segundos, pero puede tardar hasta un minuto.

Formato del cuerpo de la solicitud (con archivos adjuntos)

Cuando envíes archivos adjuntos, usa esta estructura JSON:

{
  "text": "<el texto del ticket como texto sin formato, texto markdown o HTML>",
  "attachments": [       // los archivos adjuntos son opcionales
    {                   // se pueden proporcionar uno o más objetos de archivo adjunto
      "name": "<el nombre del archivo adjunto; la extensión del archivo es importante y debe proporcionarse>",
      "content": "<el contenido del archivo adjunto como texto sin formato o como cadena binaria codificada en base64>"
    }
  ]
}

Formato de respuesta

Unusual Suite devuelve un objeto JSON. Algunas propiedades se omiten en este ejemplo ya que no son relevantes para la mayoría de las integraciones:

{
  "text": "<respuesta en formato markdown>",
  "text-html": "<respuesta en formato HTML>"
}