Konversationsnachrichten per Text durchsuchen

Gesprächstranskriptnachrichten per Volltext- und unscharfer Suche durchsuchen

Header

xi-api-keystringOptional

Abfrageparameter

text_querystringErforderlich

Der Suchanfragetext für Volltext- und Fuzzy-Matching

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.
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).

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:
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.

page_sizeintegerOptional1-50Standardwert ist 20
Anzahl der Ergebnisse pro Seite. Maximal 50.
summary_modeenumOptionalStandardwert ist exclude
Ob Transkriptzusammenfassungen in die Antwort aufgenommen werden sollen.
Erlaubte Werte:
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.

topic_idslist of strings or nullOptional

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

sort_byenumOptional

Sortierreihenfolge für Suchergebnisse. ‘search_score’ sortiert nach Suchbewertung, ‘created_at’ nach Gesprächsstartzeit.

Erlaubte Werte:
cursorstring or nullOptional

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

Antwort

Erfolgreiche Antwort
resultslist of objects
has_moreboolean

Ob weitere Ergebnisse verfügbar sind.

metaobjectOptional
next_cursorstring or nullOptional

Cursor für die nächste Ergebnisseite

Fehler

422
Unprocessable Entity Error