Vai alla navigazione
ElevenAgentsConversazioni

Elenca conversazioni

Ottieni tutte le conversazioni degli agenti di proprietà dell’utente, con la possibilità di limitarle a un agente specifico.

Header

xi-api-keystringOpzionale

Parametri di query

cursorstring or nullOpzionale
Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.
agent_idstring or nullOpzionale

ID dell'agente (agent_…) o ID esterno del motore vocale (seng_), risolti nella stessa risorsa sottostante.

visited_agent_idslist of strings or nullOpzionale

Filtra le conversazioni a cui ha partecipato uno qualsiasi di questi agenti. Non può superare 50 valori.

visited_agent_branch_idslist of strings or nullOpzionale

Filtra le conversazioni a cui ha partecipato uno qualsiasi di questi branch dell'agente. Non può superare 50 valori.

triggered_procedure_idslist of strings or nullOpzionale

Filtra le conversazioni in cui è stata attivata una qualsiasi di queste procedure. Non può superare 50 valori.

call_successfulenum or nullOpzionale
Il risultato della valutazione di successo
Valori consentiti:
call_start_before_unixinteger or nullOpzionale
Timestamp Unix, in secondi, per filtrare le conversazioni fino a questa data di inizio.
call_start_after_unixinteger or nullOpzionale
Timestamp Unix, in secondi, per filtrare le conversazioni successive a questa data di inizio.
call_duration_min_secsinteger or nullOpzionale
Durata minima della chiamata in secondi.
call_duration_max_secsinteger or nullOpzionale
Durata massima della chiamata in secondi.
rating_maxinteger or nullOpzionale1-5

Valutazione complessiva massima (1-5).

rating_mininteger or nullOpzionale1-5

Valutazione complessiva minima (1-5).

has_feedback_commentboolean or nullOpzionale
Filtra le conversazioni con commenti di feedback degli utenti.
user_idstring or nullOpzionale
Filtra le conversazioni in base all'ID dell'utente che le ha avviate.
evaluation_paramslist of strings or nullOpzionale

Filtri di valutazione. Parametro ripetibile. Formato: criteria_id:result, dove result è uno tra success|failure|unknown. Esempio: eval=value_framing:success

data_collection_paramslist of strings or nullOpzionale

Filtri di raccolta dati. Parametro ripetibile. Formato: id:op:value, dove op è uno tra eq|neq|gt|gte|lt|lte|in. Per in, separa i valori con una barra verticale. Un valore vuoto corrisponde alle conversazioni in cui il campo non è stato raccolto (id:eq:), mentre neq con un valore vuoto corrisponde a quelle in cui è stato raccolto (id:neq:). eq indica un'uguaglianza esatta. gt|gte|lt|lte richiedono un valore numerico.

dynamic_variable_paramslist of strings or nullOpzionale

Filtri per variabili dinamiche. Parametro ripetibile. Formato: name:op:value, dove op è uno tra eq|neq|gt|gte|lt|lte|in. Per in, delimita i valori con una barra verticale. Un valore vuoto corrisponde alle conversazioni in cui la variabile non è stata impostata (name:eq:), mentre neq con un valore vuoto corrisponde a quelle in cui è stata impostata (name:neq:). eq indica l'uguaglianza esatta. gt|gte|lt|lte richiedono un valore numerico. Non è possibile esprimere nomi contenenti ':'.

data_collection_idslist of strings or nullOpzionale

ID dei campi di raccolta dati da includere in ogni riepilogo della conversazione. Parametro ripetibile. Se omesso, data_collection_results non viene restituito.

evaluation_criteria_idslist of strings or nullOpzionale

ID dei criteri di valutazione da includere in ogni riepilogo della conversazione. Parametro ripetibile. Se omesso, evaluation_criteria_results non viene restituito.

tool_nameslist of strings or nullOpzionale
Filtra le conversazioni in base ai nomi degli strumenti usati durante la chiamata.
tool_names_successfullist of strings or nullOpzionale
Filtra le conversazioni in base ai nomi degli strumenti con chiamate riuscite.
tool_names_erroredlist of strings or nullOpzionale
Filtra le conversazioni in base ai nomi degli strumenti con chiamate che hanno generato errori.
include_invalid_tool_callsbooleanOpzionalePredefinito a false
Trova anche le chiamate degli strumenti che non sono mai state eseguite.
main_languageslist of strings or nullOpzionale

Filtra le conversazioni in base alla lingua principale rilevata (codice lingua).

page_sizeintegerOpzionale1-100Predefinito a 30

Numero massimo di conversazioni da restituire. Non può superare 100; il valore predefinito è 30.

summary_modeenumOpzionalePredefinito a exclude
Indica se includere nella risposta i riepiloghi delle trascrizioni.
Valori consentiti:
searchstring or nullOpzionaleDeprecated

Ricerca full-text o fuzzy nei messaggi della trascrizione

conversation_initiation_sourceenum or nullOpzionalePredefinito a unknown
Enum che rappresenta le possibili origini per l'avvio della conversazione.
text_onlyboolean or nullOpzionale
conversation_product_typeenum or nullOpzionale
Limita i risultati a una singola interfaccia di prodotto per conversazioni.
Valori consentiti:
branch_idstring or nullOpzionale
Filtra le conversazioni in base all'ID del branch.
version_idstring or nullOpzionale
Filtra le conversazioni in base all'ID della versione.
parent_conversation_idstring or nullOpzionale
Filtra le conversazioni in base all'ID della conversazione padre per le conversazioni dei subagenti.
topic_idslist of strings or nullOpzionale
Filtra le conversazioni in base agli ID degli argomenti assegnati durante il rilevamento degli argomenti.
exclude_statuseslist of enums or nullOpzionale

Escludi le conversazioni con gli stati indicati. Utile per nascondere dalle visualizzazioni elenco le conversazioni in corso / in elaborazione.

Valori consentiti:
tag_idslist of strings or nullOpzionale

Filtra le conversazioni in base agli ID dei tag di conversazione assegnati tramite gli endpoint conversation-tags.

workflow_node_entered_idstring or nullOpzionale
Filtra le conversazioni includendo quelle che sono entrate nel nodo specificato.
termination_reasonslist of strings or nullOpzionale

Filtra le conversazioni in base al relativo termination_reason memorizzato (metadata.termination_reason). Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

guardrail_typeslist of enums or nullOpzionale

Filtra le conversazioni in cui è stato attivato un guardrail di uno qualsiasi di questi tipi (metadata.triggered_guardrails.guardrail_type). Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

custom_guardrail_nameslist of strings or nullOpzionale

Filtra le conversazioni in cui è stato attivato un guardrail personalizzato con uno qualsiasi di questi nomi (metadata.triggered_guardrails.guardrail_name). Solo i guardrail personalizzati hanno un nome. Ripeti il parametro per trovare una corrispondenza con uno qualsiasi di più valori.

sort_directionenumOpzionale

La direzione per ordinare le conversazioni in base all'ora di inizio della chiamata. Per impostazione predefinita è decrescente (prima le più recenti).

Valori consentiti:

Risposta

Risposta riuscita
conversationslist of objects
has_moreboolean
next_cursorstring or nullOpzionale

Errori

422
Unprocessable Entity Error