Konversationen auflisten

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_3701k3ttaq12ewp8b7qv5rfyszkz \
     -d call_successful=success

{
  "conversations": [
    {
      "agent_id": "string",
      "conversation_id": "string",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "string",
      "version_id": "string",
      "agent_name": "string",
      "termination_reason": "",
      "call_success_score": 1.1,
      "transcript_summary": "string",
      "call_summary_title": "string",
      "main_language": "string",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "string"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 0,
        "overall_frustration_score": 0.5,
        "min_user_sentiment_score": 0,
        "max_user_frustration_score": 0.5,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {},
      "evaluation_criteria_results": {},
      "tag_ids": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Alle Unterhaltungen von Agenten abrufen, die dem Nutzer gehören. Kann auf einen bestimmten Agenten eingeschränkt werden.

Abfrageparameter

cursorstring or nullOptional

Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

agent_idstring or nullOptional

Agent-ID (agent_…) oder externe Speech-Engine-ID (seng_), die derselben zugrunde liegenden Ressource zugeordnet werden.

visited_agent_idslist of strings or nullOptional

Unterhaltungen filtern, an denen einer dieser Agenten beteiligt war. Maximal 50 Werte.

visited_agent_branch_idslist of strings or nullOptional

Unterhaltungen filtern, an denen eine dieser Agent-Branches beteiligt war. Maximal 50 Werte.

triggered_procedure_idslist of strings or nullOptional

Unterhaltungen filtern, in denen eines dieser Verfahren ausgelöst wurde. Maximal 50 Werte.

call_successfulenum or nullOptional

Das Ergebnis der Erfolgsauswertung

Erlaubte Werte:

call_start_before_unixinteger or nullOptional

Unix-Zeitstempel in Sekunden zum Filtern von Unterhaltungen bis zu diesem Startdatum.

call_start_after_unixinteger or nullOptional

Unix-Zeitstempel in Sekunden zum Filtern von Unterhaltungen nach diesem Startdatum.

call_duration_min_secsinteger or nullOptional

Minimale Anrufdauer in Sekunden.

call_duration_max_secsinteger or nullOptional

Maximale Anrufdauer in Sekunden.

rating_maxinteger or nullOptional1-5

Maximale Gesamtbewertung (1–5).

rating_mininteger or nullOptional1-5

Minimale Gesamtbewertung (1–5).

has_feedback_commentboolean or nullOptional

Unterhaltungen mit Nutzerfeedback-Kommentaren filtern.

user_idstring or nullOptional

Unterhaltungen nach der ID des Nutzers filtern, der sie gestartet hat.

evaluation_paramslist of strings or nullOptional

Auswertungsfilter. Parameter wiederholen. Format: criteria_id:result, wobei result success|failure|unknown ist. Beispiel: eval=value_framing:success

data_collection_paramslist of strings or nullOptional

Filter für die Datenerfassung. Parameter wiederholen. Format: id:op:value, wobei op einer von eq|neq|gt|gte|lt|lte|in ist. Für in Werte durch senkrechte Striche trennen. Ein leerer Wert entspricht Gesprächen, bei denen das Feld nicht erfasst wurde (id:eq:); neq mit leerem Wert entspricht Gesprächen, bei denen es erfasst wurde (id:neq:). eq bedeutet exakte Gleichheit. gt|gte|lt|lte erfordern einen numerischen Wert.

dynamic_variable_paramslist of strings or nullOptional

Filter für dynamische Variablen. Parameter wiederholen. Format: name:op:value, wobei op einer der Werte eq|neq|gt|gte|lt|lte|in ist. Für in Werte mit Pipe-Zeichen trennen. Ein leerer Wert entspricht Gesprächen, in denen die Variable nicht gesetzt wurde (name:eq:); neq mit leerem Wert entspricht Gesprächen, in denen sie gesetzt wurde (name:neq:). eq steht für exakte Gleichheit. gt|gte|lt|lte erfordern einen numerischen Wert. Namen, die ’:’ enthalten, können nicht angegeben werden.

data_collection_idslist of strings or nullOptional

IDs der Datenerfassungsfelder, die in jede Gesprächszusammenfassung aufgenommen werden sollen. Parameter wiederholen. Wenn nicht angegeben, wird data_collection_results nicht zurückgegeben.

evaluation_criteria_idslist of strings or nullOptional

IDs der Auswertungskriterien, die in jede Gesprächszusammenfassung aufgenommen werden sollen. Parameter wiederholen. Wenn nicht angegeben, wird evaluation_criteria_results nicht zurückgegeben.

tool_nameslist of strings or nullOptional

Unterhaltungen nach während des Anrufs verwendeten Tool-Namen filtern.

tool_names_successfullist of strings or nullOptional

Unterhaltungen nach Tool-Namen filtern, bei denen Aufrufe erfolgreich waren.

tool_names_erroredlist of strings or nullOptional

Unterhaltungen nach Tool-Namen filtern, bei denen Aufrufe fehlgeschlagen sind.

include_invalid_tool_callsbooleanOptionalStandardwert ist false

Berücksichtigt auch Tool-Aufrufe, die nie ausgeführt wurden.

main_languageslist of strings or nullOptional

Unterhaltungen nach erkannter Hauptsprache filtern (Sprachcode).

page_sizeintegerOptional1-100Standardwert ist 30

Maximale Anzahl zurückzugebender Unterhaltungen. Darf 100 nicht überschreiten, Standardwert ist 30.

summary_modeenumOptionalStandardwert ist exclude

Ob Transkriptzusammenfassungen in die Antwort aufgenommen werden sollen.

Erlaubte Werte:

searchstring or nullOptionalDeprecated

Volltext- oder unscharfe Suche in Transkriptnachrichten

conversation_initiation_sourceenum or nullOptionalStandardwert ist unknown

Aufzählung der möglichen Quellen für den Gesprächsbeginn.

text_onlyboolean or nullOptional

conversation_product_typeenum or nullOptional

Ergebnisse auf eine einzelne Unterhaltungs-Produktoberfläche beschränken.

Erlaubte Werte:

branch_idstring or nullOptional

Unterhaltungen nach Branch-ID filtern.

version_idstring or nullOptional

Unterhaltungen nach Versions-ID filtern.

parent_conversation_idstring or nullOptional

Unterhaltungen von Subagenten nach übergeordneter Unterhaltungs-ID filtern.

topic_idslist of strings or nullOptional

Unterhaltungen nach während der Themenerkennung zugewiesenen Themen-IDs filtern.

exclude_statuseslist of enums or nullOptional

Gespräche mit den angegebenen Status ausschließen. Nützlich, um laufende bzw. verarbeitete Gespräche in Listenansichten auszublenden.

Erlaubte Werte:

tag_idslist of strings or nullOptional

Unterhaltungen nach Tag-IDs filtern, die über die conversation-tags-Endpunkte zugewiesen wurden.

workflow_node_entered_idstring or nullOptional

Nur Unterhaltungen filtern, die den angegebenen Knoten erreicht haben.

termination_reasonslist of strings or nullOptional

Unterhaltungen nach ihrem gespeicherten termination_reason (metadata.termination_reason) filtern. Parameter wiederholen, um eine von mehreren Optionen zu berücksichtigen.

guardrail_typeslist of enums or nullOptional

Auf Unterhaltungen filtern, in denen eine Guardrail eines dieser Typen ausgelöst wurde (metadata.triggered_guardrails.guardrail_type). Parameter wiederholen, um eine von mehreren Optionen zu berücksichtigen.

custom_guardrail_nameslist of strings or nullOptional

Auf Unterhaltungen filtern, in denen eine benutzerdefinierte Guardrail mit einem dieser Namen ausgelöst wurde (metadata.triggered_guardrails.guardrail_name). Nur benutzerdefinierte Guardrails haben einen Namen. Parameter wiederholen, um eine von mehreren Optionen zu berücksichtigen.

sort_directionenumOptional

Die Richtung zum Sortieren von Unterhaltungen nach Anrufstartzeit. Standardmäßig absteigend (neueste zuerst).

Erlaubte Werte:

Antwort

Erfolgreiche Antwort

conversationslist of objects

has_moreboolean

next_cursorstring or nullOptional

Fehler

422

Unprocessable Entity Error

Header

Abfrageparameter

Antwort

Fehler