ElevenAgentsConversationsMessages

Pesquisar mensagens da conversa por texto

Pesquise mensagens de transcrições de conversas por texto completo e pesquisa aproximada

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

text_querystringObrigatório

O texto da consulta de pesquisa para correspondência de texto completo e aproximada

agent_idstring or nullOpcional

ID do agente (agent_…) ou ID externo do mecanismo de fala (seng_), resolvidos para o mesmo recurso subjacente.

visited_agent_idslist of strings or nullOpcional

Filtre conversas das quais qualquer um desses agentes participou. Não pode exceder 50 valores.

visited_agent_branch_idslist of strings or nullOpcional

Filtre conversas das quais qualquer uma dessas ramificações de agente participou. Não pode exceder 50 valores.

triggered_procedure_idslist of strings or nullOpcional

Filtre conversas nas quais qualquer um desses procedimentos foi acionado. Não pode exceder 50 valores.

call_successfulenum or nullOpcional

O resultado da avaliação de sucesso

Valores permitidos:
call_start_before_unixinteger or nullOpcional

Timestamp Unix (em segundos) para filtrar conversas até esta data inicial.

call_start_after_unixinteger or nullOpcional

Timestamp Unix (em segundos) para filtrar conversas posteriores a esta data inicial.

call_duration_min_secsinteger or nullOpcional

Duração mínima da chamada em segundos.

call_duration_max_secsinteger or nullOpcional

Duração máxima da chamada em segundos.

rating_maxinteger or nullOpcional1-5

Avaliação geral máxima (1 a 5).

rating_mininteger or nullOpcional1-5

Avaliação geral mínima (1 a 5).

has_feedback_commentboolean or nullOpcional

Filtre conversas com comentários de feedback dos usuários.

user_idstring or nullOpcional

Filtre conversas pelo ID do usuário que as iniciou.

evaluation_paramslist of strings or nullOpcional

Filtros de avaliação. Repita o parâmetro. Formato: criteria_id:result, em que result é success|failure|unknown. Exemplo: eval=value_framing:success

data_collection_paramslist of strings or nullOpcional
Filtros de coleta de dados. Parâmetro repetível. Formato: id:op:value, em que op é um de eq|neq|gt|gte|lt|lte|in. Para in, separe os valores por barra vertical. Um valor vazio corresponde a conversas em que o campo não foi coletado (id:eq:), e neq com um valor vazio corresponde àquelas em que foi (id:neq:). eq representa igualdade exata. gt|gte|lt|lte exigem um valor numérico.
dynamic_variable_paramslist of strings or nullOpcional
Filtros de variáveis dinâmicas. Parâmetro repetível. Formato: name:op:value, em que op é um de eq|neq|gt|gte|lt|lte|in. Para in, separe os valores com barra vertical. Um valor vazio corresponde a conversas em que a variável não foi definida (name:eq:), e neq com um valor vazio corresponde àquelas em que ela foi definida (name:neq:). eq representa igualdade exata. gt|gte|lt|lte exigem um valor numérico. Nomes que contêm ':' não podem ser expressos.
tool_nameslist of strings or nullOpcional
Filtre conversas pelos nomes das ferramentas usadas durante a chamada.
tool_names_successfullist of strings or nullOpcional

Filtre conversas pelos nomes das ferramentas que tiveram chamadas bem-sucedidas.

tool_names_erroredlist of strings or nullOpcional
Filtre conversas pelos nomes das ferramentas que tiveram chamadas com erro.
include_invalid_tool_callsbooleanOpcionalPadrão é false

Também corresponda a chamadas de ferramentas que nunca foram executadas.

main_languageslist of strings or nullOpcional

Filtre conversas pelo idioma principal detectado (código do idioma).

exclude_statuseslist of enums or nullOpcional

Exclua conversas com os status especificados. Útil para ocultar conversas em andamento ou em processamento nas visualizações de lista.

Valores permitidos:
termination_reasonslist of strings or nullOpcional

Filtre conversas pelo termination_reason armazenado (metadata.termination_reason). Repita o parâmetro para corresponder a qualquer um entre vários valores.

page_sizeintegerOpcional1-50Padrão é 20

Número de resultados por página. Máximo de 50.

summary_modeenumOpcionalPadrão é exclude

Indica se deve incluir resumos das transcrições na resposta.

Valores permitidos:
conversation_initiation_sourceenum or nullOpcionalPadrão é unknown

Enumeração que representa as possíveis origens para o início de uma conversa.

text_onlyboolean or nullOpcional
conversation_product_typeenum or nullOpcional

Restrinja os resultados a uma única interface de produto de conversas.

Valores permitidos:
branch_idstring or nullOpcional

Filtre conversas por ID da ramificação.

version_idstring or nullOpcional

Filtre conversas por ID da versão.

topic_idslist of strings or nullOpcional

Filtre conversas pelos IDs de tópicos atribuídos durante a descoberta de tópicos.

sort_byenumOpcional

Ordem de classificação dos resultados de pesquisa. ‘search_score’ ordena pela pontuação da pesquisa, e ‘created_at’ ordena pelo horário de início da conversa.

Valores permitidos:
cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

resultslist of objects
has_moreboolean

Indica se há mais resultados disponíveis

metaobjectOpcional
next_cursorstring or nullOpcional

Cursor para a próxima página de resultados

Erros

422
Unprocessable Entity Error