ElevenAgentsConversationsMessages

Rechercher du texte dans les messages de conversation

Rechercher dans les messages des transcriptions de conversations par recherche en texte intégral et approximative

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

text_querystringRequis

Le texte de la requête de recherche pour la correspondance plein texte et approximative

agent_idstring or nullOptionnel

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

visited_agent_idslist of strings or nullOptionnel

Filtrer les conversations auxquelles l’un de ces agents a participé. Ne peut pas dépasser 50 valeurs.

visited_agent_branch_idslist of strings or nullOptionnel

Filtrer les conversations auxquelles l’une de ces branches d’agent a participé. Ne peut pas dépasser 50 valeurs.

triggered_procedure_idslist of strings or nullOptionnel

Filtrer les conversations dans lesquelles l’une de ces procédures a été déclenchée. Ne peut pas dépasser 50 valeurs.

call_successfulenum or nullOptionnel

Le résultat de l’évaluation de réussite

Valeurs autorisées:
call_start_before_unixinteger or nullOptionnel

Horodatage Unix, en secondes, permettant de filtrer les conversations jusqu’à cette date de début.

call_start_after_unixinteger or nullOptionnel

Horodatage Unix, en secondes, permettant de filtrer les conversations postérieures à cette date de début.

call_duration_min_secsinteger or nullOptionnel

Durée minimale de l’appel en secondes.

call_duration_max_secsinteger or nullOptionnel

Durée maximale de l’appel en secondes.

rating_maxinteger or nullOptionnel1-5

Note globale maximale (1 à 5).

rating_mininteger or nullOptionnel1-5

Note globale minimale (1 à 5).

has_feedback_commentboolean or nullOptionnel
Filtrer les conversations contenant des commentaires d'utilisateurs.
user_idstring or nullOptionnel

Filtrer les conversations par ID de l’utilisateur qui les a initiées.

evaluation_paramslist of strings or nullOptionnel

Filtres d’évaluation. Paramètre répétable. Format : criteria_id:result, où result est success|failure|unknown. Exemple : eval=value_framing:success

data_collection_paramslist of strings or nullOptionnel
Filtres de collecte de données. Paramètre répétable. Format : id:op:value, où op est l'une des valeurs eq|neq|gt|gte|lt|lte|in. Pour in, séparez les valeurs par une barre verticale. Une valeur vide correspond aux conversations où le champ n'a pas été collecté (id:eq:), tandis que neq avec une valeur vide correspond à celles où il l'a été (id:neq:). eq indique une égalité exacte. gt|gte|lt|lte requièrent une valeur numérique.
dynamic_variable_paramslist of strings or nullOptionnel
Filtres de variables dynamiques. Paramètre répétable. Format : name:op:value, où op correspond à eq|neq|gt|gte|lt|lte|in. Pour in, séparez les valeurs par des barres verticales. Une valeur vide correspond aux conversations où la variable n’était pas définie (name:eq:) ; neq avec une valeur vide correspond aux conversations où elle l’était (name:neq:). eq indique une égalité exacte. gt|gte|lt|lte requièrent une valeur numérique. Les noms contenant ':' ne peuvent pas être exprimés.
tool_nameslist of strings or nullOptionnel

Filtrer les conversations par noms d’outils utilisés pendant l’appel.

tool_names_successfullist of strings or nullOptionnel

Filtrer les conversations par noms d’outils ayant généré des appels réussis.

tool_names_erroredlist of strings or nullOptionnel

Filtrer les conversations par noms d’outils ayant généré des appels en erreur.

include_invalid_tool_callsbooleanOptionnelPar défaut false

Inclut également les appels d’outils qui n’ont jamais été exécutés.

main_languageslist of strings or nullOptionnel

Filtrer les conversations par langue principale détectée (code de langue).

exclude_statuseslist of enums or nullOptionnel

Exclut les conversations ayant les statuts indiqués. Utile pour masquer des listes les conversations en cours ou en traitement.

Valeurs autorisées:
termination_reasonslist of strings or nullOptionnel

Filtrer les conversations par leur termination_reason enregistrée (metadata.termination_reason). Répétez le paramètre pour correspondre à l’une de plusieurs valeurs.

page_sizeintegerOptionnel1-50Par défaut 20

Nombre de résultats par page. Maximum : 50.

summary_modeenumOptionnelPar défaut exclude

Indique s’il faut inclure les résumés de transcriptions dans la réponse.

Valeurs autorisées:
conversation_initiation_sourceenum or nullOptionnelPar défaut unknown

Énumération représentant les sources possibles d’initiation d’une conversation.

text_onlyboolean or nullOptionnel
conversation_product_typeenum or nullOptionnel

Limite les résultats à une seule interface du produit de conversation.

Valeurs autorisées:
branch_idstring or nullOptionnel
Filtrer les conversations par ID de branche.
version_idstring or nullOptionnel
Filtrer les conversations par ID de version.
topic_idslist of strings or nullOptionnel

Filtrer les conversations par ID de sujets attribués lors de la découverte de sujets.

sort_byenumOptionnel

Sort order for search results. ‘search_score’ sorts by search score, ‘created_at’ sorts by conversation start time.

Valeurs autorisées:
cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

resultslist of objects
has_moreboolean

Indique si d’autres résultats sont disponibles

metaobjectOptionnel
next_cursorstring or nullOptionnel

Curseur pour la page suivante de résultats

Erreurs

422
Unprocessable Entity Error