Hoppa till navigering

Lista konversationer

Hämta alla samtal för agenter som användaren äger. Du kan begränsa till en specifik agent.

Headers

xi-api-keystringValfri

Frågeparametrar

cursorstring or nullValfri

Används för att hämta nästa sida. Markören returneras i svaret.

agent_idstring or nullValfri

Agent-ID (agent_…) eller externt ID för talmotor (seng_), som matchas mot samma underliggande resurs.

visited_agent_idslist of strings or nullValfri

Filtrera konversationer där någon av dessa agenter deltog. Får inte överstiga 50 värden.

visited_agent_branch_idslist of strings or nullValfri

Filtrera konversationer där någon av dessa agentgrenar deltog. Får inte överstiga 50 värden.

triggered_procedure_idslist of strings or nullValfri

Filtrera konversationer där någon av dessa procedurer utlöstes. Får inte överstiga 50 värden.

call_successfulenum or nullValfri

Resultatet av framgångsutvärderingen

Tillåtna värden:
call_start_before_unixinteger or nullValfri

Unix-tidsstämpel (i sekunder) för att filtrera samtal fram till detta startdatum.

call_start_after_unixinteger or nullValfri

Unix-tidsstämpel (i sekunder) för att filtrera samtal efter detta startdatum.

call_duration_min_secsinteger or nullValfri

Minsta samtalslängd i sekunder.

call_duration_max_secsinteger or nullValfri

Maximal samtalslängd i sekunder.

rating_maxinteger or nullValfri1-5

Högsta övergripande betyg (1–5).

rating_mininteger or nullValfri1-5

Minsta övergripande betyg (1–5).

has_feedback_commentboolean or nullValfri

Filtrera konversationer med kommentarer från användarfeedback.

user_idstring or nullValfri

Filtrera konversationer efter användar-ID:t för den som initierade dem.

evaluation_paramslist of strings or nullValfri

Utvärderingsfilter. Upprepad parameter. Format: criteria_id:result där result är något av success|failure|unknown. Exempel: eval=value_framing:success

data_collection_paramslist of strings or nullValfri

Filter för datainsamling. Upprepa parametern. Format: id:op:value, där op är något av eq|neq|gt|gte|lt|lte|in. För in avgränsar du värden med lodstreck. Ett tomt värde matchar konversationer där fältet inte samlades in (id:eq:), och neq med ett tomt värde matchar där det samlades in (id:neq:). eq innebär exakt likhet. gt|gte|lt|lte kräver ett numeriskt värde.

dynamic_variable_paramslist of strings or nullValfri

Filter för dynamiska variabler. Upprepa parametern. Format: name:op:value där op är ett av eq|neq|gt|gte|lt|lte|in. För in, avgränsa värden med lodstreck. Ett tomt värde matchar samtal där variabeln inte angavs (name:eq:), och neq med ett tomt värde matchar där den angavs (name:neq:). eq är exakt likhet. gt|gte|lt|lte kräver ett numeriskt värde. Namn som innehåller ':' kan inte uttryckas.

data_collection_idslist of strings or nullValfri

ID:n för datainsamlingsfält att inkludera i varje konversationssammanfattning. Upprepa parametern. När den utelämnas returneras inte data_collection_results.

evaluation_criteria_idslist of strings or nullValfri

ID:n för utvärderingskriterier som ska inkluderas i varje samtalssammanfattning. Upprepad parameter. Om den utelämnas returneras inte evaluation_criteria_results.

tool_nameslist of strings or nullValfri

Filtrera konversationer efter verktygsnamn som användes under samtalet.

tool_names_successfullist of strings or nullValfri
Filtrera konversationer efter verktygsnamn med lyckade anrop.
tool_names_erroredlist of strings or nullValfri
Filtrera konversationer efter verktygsnamn med felaktiga anrop.
include_invalid_tool_callsbooleanValfriStandard är false

Matcha även verktygsanrop som aldrig kördes.

main_languageslist of strings or nullValfri

Filtrera konversationer efter identifierat huvudspråk (språkkod).

page_sizeintegerValfri1-100Standard är 30

Maximalt antal samtal att returnera. Får inte överstiga 100, standardvärdet är 30.

summary_modeenumValfriStandard är exclude
Om transkriptionssammanfattningar ska inkluderas i svaret.
Tillåtna värden:
searchstring or nullValfriDeprecated

Fulltextsökning eller fuzzy-sökning i transkriptmeddelanden

conversation_initiation_sourceenum or nullValfriStandard är unknown

Enum som representerar möjliga källor för att initiera samtal.

text_onlyboolean or nullValfri
conversation_product_typeenum or nullValfri

Begränsa resultaten till en enda produktvy för konversationer.

Tillåtna värden:
branch_idstring or nullValfri

Filtrera konversationer efter gren-ID.

version_idstring or nullValfri

Filtrera konversationer efter versions-ID.

parent_conversation_idstring or nullValfri

Filtrera konversationer efter överordnat konversations-ID för underagentkonversationer.

topic_idslist of strings or nullValfri

Filtrera konversationer efter ämnes-ID:n som tilldelats vid ämnesidentifiering.

exclude_statuseslist of enums or nullValfri

Uteslut samtal med de angivna statusarna. Användbart för att dölja pågående samtal / samtal under bearbetning från listvyer.

Tillåtna värden:
tag_idslist of strings or nullValfri

Filtrera konversationer efter konversationstagg-ID:n som tilldelats via conversation-tags-slutpunkterna.

workflow_node_entered_idstring or nullValfri

Filtrera konversationer så att endast de som gick in i den angivna noden returneras.

termination_reasonslist of strings or nullValfri

Filtrera konversationer efter deras lagrade termination_reason (metadata.termination_reason). Upprepa parametern för att matcha något av flera värden.

guardrail_typeslist of enums or nullValfri

Filtrera till konversationer där ett skyddsräcke av någon av dessa typer utlöstes (metadata.triggered_guardrails.guardrail_type). Upprepa parametern för att matcha något av flera värden.

custom_guardrail_nameslist of strings or nullValfri

Filtrera till konversationer där en anpassad skyddsräcke med något av dessa namn utlöstes (metadata.triggered_guardrails.guardrail_name). Endast anpassade skyddsräcken har ett namn. Upprepa parametern för att matcha något av flera värden.

sort_directionenumValfri

Riktningen för sortering av konversationer efter samtalsstarttid. Standard är fallande (nyaste först).

Tillåtna värden:

Svar

Lyckat svar
conversationslist of objects
has_moreboolean
next_cursorstring or nullValfri

Fel

422
Unprocessable Entity Error