Wyszukiwanie tekstowe wiadomości w rozmowie

Przeszukuj wiadomości w transkrypcji rozmowy za pomocą wyszukiwania pełnotekstowego i rozmytego

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

text_querystringWymagany

Tekst zapytania wyszukiwania dla dopasowania pełnotekstowego i przybliżonego

agent_idstring or nullOpcjonalny

Identyfikator agenta (agent_…) lub zewnętrzny identyfikator silnika mowy (seng_), wskazujące ten sam zasób.

visited_agent_idslist of strings or nullOpcjonalny

Filtruj rozmowy, w których uczestniczył dowolny z tych agentów. Maksymalnie 50 wartości.

visited_agent_branch_idslist of strings or nullOpcjonalny

Filtruj rozmowy, w których uczestniczyła dowolna z tych gałęzi agenta. Maksymalnie 50 wartości.

triggered_procedure_idslist of strings or nullOpcjonalny

Filtruj rozmowy, w których uruchomiono dowolną z tych procedur. Maksymalnie 50 wartości.

call_successfulenum or nullOpcjonalny
Wynik oceny powodzenia
Dozwolone wartości:
call_start_before_unixinteger or nullOpcjonalny

Znacznik czasu Unix (w sekundach) do filtrowania rozmów do tej daty początkowej.

call_start_after_unixinteger or nullOpcjonalny

Znacznik czasu Unix (w sekundach) do filtrowania rozmów po tej dacie początkowej.

call_duration_min_secsinteger or nullOpcjonalny

Minimalny czas trwania połączenia w sekundach.

call_duration_max_secsinteger or nullOpcjonalny

Maksymalny czas trwania połączenia w sekundach.

rating_maxinteger or nullOpcjonalny1-5

Maksymalna ocena ogólna (1–5).

rating_mininteger or nullOpcjonalny1-5

Minimalna ocena ogólna (1–5).

has_feedback_commentboolean or nullOpcjonalny

Filtruj rozmowy z komentarzami użytkowników.

user_idstring or nullOpcjonalny

Filtruj rozmowy według ID użytkownika, który je rozpoczął.

evaluation_paramslist of strings or nullOpcjonalny

Filtry oceny. Parametr powtarzalny. Format: criteria_id:result, gdzie result to success|failure|unknown. Przykład: eval=value_framing:success

data_collection_paramslist of strings or nullOpcjonalny
Filtry zbierania danych. Parametr powtarzalny. Format: id:op:value, gdzie op to jedno z eq|neq|gt|gte|lt|lte|in. Dla in oddziel wartości pionową kreską. Pusta wartość pasuje do rozmów, w których pole nie zostało zebrane (id:eq:), a neq z pustą wartością — do tych, w których zostało zebrane (id:neq:). eq oznacza dokładną równość. gt|gte|lt|lte wymagają wartości liczbowej.
dynamic_variable_paramslist of strings or nullOpcjonalny
Filtry zmiennych dynamicznych. Parametr powtarzalny. Format: name:op:value, gdzie op to jedna z wartości eq|neq|gt|gte|lt|lte|in. Dla in rozdziel wartości pionową kreską. Pusta wartość dopasowuje rozmowy, w których zmienna nie została ustawiona (name:eq:), a neq z pustą wartością dopasowuje te, w których została ustawiona (name:neq:). eq oznacza dokładną równość. gt|gte|lt|lte wymagają wartości liczbowej. Nie można wyrazić nazw zawierających „:”.
tool_nameslist of strings or nullOpcjonalny

Filtruj rozmowy według nazw narzędzi użytych podczas połączenia.

tool_names_successfullist of strings or nullOpcjonalny

Filtruj rozmowy według nazw narzędzi, których wywołania zakończyły się powodzeniem.

tool_names_erroredlist of strings or nullOpcjonalny

Filtruj rozmowy według nazw narzędzi, których wywołania zakończyły się błędem.

include_invalid_tool_callsbooleanOpcjonalnyDomyślnie false

Uwzględnia też wywołania narzędzi, które nigdy nie zostały uruchomione.

main_languageslist of strings or nullOpcjonalny

Filtruj rozmowy według wykrytego głównego języka (kodu języka).

exclude_statuseslist of enums or nullOpcjonalny

Wyklucza rozmowy o podanych statusach. Przydatne do ukrywania rozmów w toku / przetwarzanych na listach.

Dozwolone wartości:
termination_reasonslist of strings or nullOpcjonalny

Filtruj rozmowy według zapisanej wartości termination_reason (metadata.termination_reason). Powtórz parametr, aby dopasować dowolną z kilku wartości.

page_sizeintegerOpcjonalny1-50Domyślnie 20

Liczba wyników na stronę. Maks. 50.

summary_modeenumOpcjonalnyDomyślnie exclude

Czy uwzględniać podsumowania transkrypcji w odpowiedzi.

Dozwolone wartości:
conversation_initiation_sourceenum or nullOpcjonalnyDomyślnie unknown

Wyliczenie przedstawiające możliwe źródła rozpoczęcia rozmowy.

text_onlyboolean or nullOpcjonalny
conversation_product_typeenum or nullOpcjonalny

Ogranicz wyniki do jednego obszaru produktu rozmów.

Dozwolone wartości:
branch_idstring or nullOpcjonalny

Filtruj rozmowy według ID gałęzi.

version_idstring or nullOpcjonalny

Filtruj rozmowy według ID wersji.

topic_idslist of strings or nullOpcjonalny

Filtruj rozmowy według ID tematów przypisanych podczas wykrywania tematów.

sort_byenumOpcjonalny

Kolejność sortowania wyników wyszukiwania. „search_score” sortuje według wyniku wyszukiwania, a „created_at” według czasu rozpoczęcia rozmowy.

Dozwolone wartości:
cursorstring or nullOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

resultslist of objects
has_moreboolean

Czy dostępne są kolejne wyniki

metaobjectOpcjonalny
next_cursorstring or nullOpcjonalny

Kursor do następnej strony wyników

Błędy

422
Unprocessable Entity Error