Skip to navigation
ElevenAgentsGesprekkenBerichten

Gespreksberichten met tekst zoeken

Doorzoek berichten in gesprekstranscripten met full-text- en fuzzy search

Headers

xi-api-keystringOptional

Query parameters

text_querystringRequired
De tekst van de zoekopdracht voor volledige tekst en fuzzy matching
agent_idstring or nullOptional

Agent-ID (agent_…) of externe ID van de spraakengine (seng_), die naar dezelfde onderliggende resource verwijzen.

visited_agent_idslist of strings or nullOptional
Filter gesprekken waaraan een van deze agents heeft deelgenomen. Maximaal 50 waarden.
visited_agent_branch_idslist of strings or nullOptional
Filter gesprekken waaraan een van deze agentbranches heeft deelgenomen. Maximaal 50 waarden.
triggered_procedure_idslist of strings or nullOptional
Filter gesprekken waarin een van deze procedures is geactiveerd. Maximaal 50 waarden.
call_successfulenum or nullOptional
Het resultaat van de succesevaluatie
Allowed values:
call_start_before_unixinteger or nullOptional

Unix-timestamp (in seconden) om gesprekken tot deze startdatum te filteren.

call_start_after_unixinteger or nullOptional

Unix-timestamp (in seconden) om gesprekken vanaf deze startdatum te filteren.

call_duration_min_secsinteger or nullOptional
Minimale gespreksduur in seconden.
call_duration_max_secsinteger or nullOptional
Maximale gespreksduur in seconden.
rating_maxinteger or nullOptional1-5

Maximale algemene beoordeling (1-5).

rating_mininteger or nullOptional1-5

Minimale algemene beoordeling (1-5).

has_feedback_commentboolean or nullOptional
Filter gesprekken met feedbackreacties van gebruikers.
user_idstring or nullOptional

Filter gesprekken op de gebruikers-ID van degene die ze heeft gestart.

evaluation_paramslist of strings or nullOptional

Evaluatiefilters. Herhaalbare parameter. Indeling: criteria_id:result, waarbij result een van success|failure|unknown is. Voorbeeld: eval=value_framing:success

data_collection_paramslist of strings or nullOptional

Filters voor gegevensverzameling. Herhaalparameter. Indeling: id:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Gebruik voor in een pipe als scheidingsteken tussen waarden. Een lege waarde komt overeen met gesprekken waarin het veld niet is verzameld (id:eq:), en neq met een lege waarde komt overeen met gesprekken waarin dat wel het geval was (id:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde.

dynamic_variable_paramslist of strings or nullOptional

Filters voor dynamische variabelen. Herhaalbare parameter. Indeling: name:op:value, waarbij op een van eq|neq|gt|gte|lt|lte|in is. Scheid waarden voor in met een verticale streep. Een lege waarde komt overeen met gesprekken waarin de variabele niet was ingesteld (name:eq:), en neq met een lege waarde komt overeen met gesprekken waarin deze wel was ingesteld (name:neq:). eq is exacte gelijkheid. gt|gte|lt|lte vereisen een numerieke waarde. Namen die ’:’ bevatten, kunnen niet worden uitgedrukt.

tool_nameslist of strings or nullOptional
Filter gesprekken op toolnamen die tijdens de call zijn gebruikt.
tool_names_successfullist of strings or nullOptional
Filter gesprekken op toolnamen met geslaagde calls.
tool_names_erroredlist of strings or nullOptional
Filter gesprekken op toolnamen met mislukte calls.
include_invalid_tool_callsbooleanOptionalDefaults to false
Komt ook overeen met toolaanroepen die nooit zijn uitgevoerd.
main_languageslist of strings or nullOptional

Filter gesprekken op gedetecteerde hoofdtaal (taalcode).

exclude_statuseslist of enums or nullOptional

Sluit gesprekken met de opgegeven statussen uit. Handig om gesprekken die nog bezig zijn / worden verwerkt te verbergen in lijstweergaven.

Allowed values:
termination_reasonslist of strings or nullOptional

Filter gesprekken op hun opgeslagen termination_reason (metadata.termination_reason). Herhaal de parameter om een van meerdere waarden te matchen.

page_sizeintegerOptional1-50Defaults to 20
Aantal resultaten per pagina. Maximaal 50.
summary_modeenumOptionalDefaults to exclude

Of transcript-samenvattingen in de response moeten worden opgenomen.

Allowed values:
conversation_initiation_sourceenum or nullOptionalDefaults to unknown
Enum die de mogelijke bronnen voor het starten van een gesprek weergeeft.
text_onlyboolean or nullOptional
conversation_product_typeenum or nullOptional

Beperk de resultaten tot één productinterface voor gesprekken.

Allowed values:
branch_idstring or nullOptional

Filter gesprekken op branch-ID.

version_idstring or nullOptional

Filter gesprekken op versie-ID.

topic_idslist of strings or nullOptional

Filter gesprekken op topic-ID’s die tijdens topic discovery zijn toegewezen.

sort_byenumOptional

Sorteervolgorde voor zoekresultaten. ‘search_score’ sorteert op zoekscore, ‘created_at’ sorteert op de starttijd van het gesprek.

Allowed values:
cursorstring or nullOptional
Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response
resultslist of objects
has_moreboolean
Of er meer resultaten beschikbaar zijn
metaobjectOptional
next_cursorstring or nullOptional
Cursor voor de volgende pagina met resultaten

Errors

422
Unprocessable Entity Error