Ferndesk

Conversaciones del asistente

Obtener la transcripción de una conversación

Devuelve una conversación con su transcripción en texto plano y los artículos a los que hizo referencia.

La transcripción contiene únicamente texto del usuario y del asistente: las llamadas a herramientas, el razonamiento, las delimitaciones de metadatos internos, los borradores de escalación y el sentimiento nunca se exponen. Requiere el alcance conversations:read.

Alcance requerido: conversations:read

GET /assistant/conversations/{id}

Obtener la transcripción de una conversación

curl --request GET \
  --url 'https://api.ferndesk.com/v1/assistant/conversations/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "status": "<string>",
  "source": "help",
  "pageUrl": "<string>",
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "summary": "<string>",
  "coverage": "covered",
  "feedback": "positive",
  "escalated": true,
  "messageCount": 1
}

Transcripción de la conversación

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página Developer settings.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, anular la publicación, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de la asignación de alcances tienen alcances null = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string
  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.

  • status string

    Estado del ciclo de vida de la conversación.

  • source string enum | null

    Origen de la conversación: el centro de ayuda (help) o el widget integrado (widget).

  • pageUrl string | null

    La página en la que se encontraba el usuario final cuando comenzó la conversación, si se capturó.

  • user anyOf

    Usuario identificado del centro de ayuda para esta conversación, o null cuando el usuario final era anónimo.

    + Show Child Attributes
    • anyOf options 2 variants anyOf

      One or more options can apply.

      + Show Child Attributes
      • option 1 object
        + Show Child Attributes
        • id string

          ID de usuario del centro de ayuda de Ferndesk (hcusr_...).

        • name string | null

          Nombre mostrado del usuario del centro de ayuda.

      • option 2 null
  • summary string | null

    Resumen de una línea generado por IA, si está disponible.

  • coverage string enum | null

    Qué tan bien respondió el centro de ayuda a la pregunta.

  • feedback string enum | null

    Comentario del usuario final mediante pulgar sobre la conversación, o null si no se dejó ninguno.

  • escalated boolean

    Indica si la conversación se escaló a una persona.

  • messageCount integer

    Número de mensajes del usuario final en la conversación.

  • transcript[] object array

    Transcripción en texto plano. Solo incluye los turnos del usuario y del asistente; se excluyen las llamadas a herramientas, el razonamiento, los metadatos internos y los turnos vacíos. Un turno de la transcripción de una conversación.

    + Show Child Attributes
    • role string enum enum

      Allowed values: user, assistant.

    • text string

      Contenido del mensaje en texto plano (se eliminaron las delimitaciones de metadatos y se descartaron las llamadas a herramientas y el razonamiento).

  • references[] object array

    Artículos citados por el asistente a lo largo de la conversación. Un artículo al que hizo referencia el asistente en la conversación.

    + Show Child Attributes
    • articleId string

      ID de artículo de Ferndesk (art_...).

    • title string

      Título del artículo en el momento de la referencia (se usa el título actual como alternativa).