Listar conversas

GET

/v1/convai/conversations

GET

/v1/convai/conversations

curl -G https://api.elevenlabs.io/v1/convai/conversations \
     -d agent_id=agent_id \
     -d branch_id=branch_id \
     -d call_duration_max_secs=1 \
     -d call_duration_min_secs=1 \
     -d call_start_after_unix=1 \
     -d call_start_before_unix=1 \
     -d call_successful=success \
     -d conversation_initiation_source=unknown \
     -d conversation_product_type=agents \
     -d cursor=cursor \
     -d custom_guardrail_names=custom_guardrail_names \
     -d data_collection_ids=data_collection_ids \
     -d data_collection_params=data_collection_params \
     -d dynamic_variable_params=dynamic_variable_params \
     -d evaluation_criteria_ids=evaluation_criteria_ids \
     -d evaluation_params=evaluation_params \
     -d exclude_statuses=initiated \
     -d guardrail_types=custom \
     -d has_feedback_comment=true \
     -d include_invalid_tool_calls=true \
     -d main_languages=main_languages \
     -d page_size=1 \
     -d parent_conversation_id=parent_conversation_id \
     -d rating_max=1 \
     -d rating_min=1 \
     -d search=search \
     -d sort_direction=asc \
     -d summary_mode=exclude \
     -d tag_ids=tag_ids \
     -d termination_reasons=termination_reasons \
     -d text_only=true \
     -d tool_names=tool_names \
     -d tool_names_errored=tool_names_errored \
     -d tool_names_successful=tool_names_successful \
     -d topic_ids=topic_ids \
     -d triggered_procedure_ids=triggered_procedure_ids \
     -d user_id=user_id \
     -d version_id=version_id \
     -d visited_agent_branch_ids=visited_agent_branch_ids \
     -d visited_agent_ids=visited_agent_ids \
     -d workflow_node_entered_id=workflow_node_entered_id

{
  "conversations": [
    {
      "agent_id": "agent_id",
      "conversation_id": "conversation_id",
      "start_time_unix_secs": 1,
      "call_duration_secs": 1,
      "message_count": 1,
      "status": "initiated",
      "call_successful": "success",
      "branch_id": "branch_id",
      "version_id": "version_id",
      "agent_name": "agent_name",
      "termination_reason": "termination_reason",
      "call_success_score": 1.1,
      "transcript_summary": "transcript_summary",
      "call_summary_title": "call_summary_title",
      "main_language": "main_language",
      "conversation_initiation_source": "unknown",
      "tool_names": [
        "tool_names"
      ],
      "direction": "inbound",
      "rating": 1.1,
      "sentiment_analysis": {
        "overall_label": "positive",
        "overall_sentiment_score": 1.1,
        "overall_frustration_score": 1.1,
        "min_user_sentiment_score": 1.1,
        "max_user_frustration_score": 1.1,
        "num_scored_user_turns": 1
      },
      "data_collection_results": {
        "key": "value"
      },
      "tag_ids": [
        "tag_ids"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Obtenha todas as conversas dos agentes pertencentes ao usuário, com opção de restringir a um agente específico.

Parâmetros de consulta

cursorstringOpcional

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

agent_idstringOpcional

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

visited_agent_idsstringOpcional

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

visited_agent_branch_idsstringOpcional

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

triggered_procedure_idsstringOpcional

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

call_successfulenumOpcional

O resultado da avaliação de sucesso

Valores permitidos:

call_start_before_unixintegerOpcional

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

call_start_after_unixintegerOpcional

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

call_duration_min_secsintegerOpcional

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

call_duration_max_secsintegerOpcional

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

rating_maxintegerOpcional1-5

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

rating_minintegerOpcional1-5

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

has_feedback_commentbooleanOpcional

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

user_idstringOpcional

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

evaluation_paramsstringOpcional

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_paramsstringOpcional

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_paramsstringOpcional

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.

data_collection_idsstringOpcional

IDs dos campos de coleta de dados a incluir em cada resumo de conversa. Parâmetro repetível. Quando omitido, data_collection_results não é retornado.

evaluation_criteria_idsstringOpcional

IDs dos critérios de avaliação a incluir em cada resumo de conversa. Repita o parâmetro. Quando omitido, evaluation_criteria_results não é retornado.

tool_namesstringOpcional

Filtre conversas pelos nomes das ferramentas usadas durante a chamada.

tool_names_successfulstringOpcional

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

tool_names_erroredstringOpcional

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_languagesstringOpcional

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

page_sizeintegerOpcional1-100Padrão é 30

Quantidade máxima de conversas a retornar. Não pode exceder 100; o padrão é 30.

summary_modeenumOpcionalPadrão é exclude

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

Valores permitidos:

searchstringOpcionalDeprecated

Pesquisa de texto completo ou aproximada nas mensagens da transcrição

conversation_initiation_sourceenumOpcionalPadrão é unknown

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

text_onlybooleanOpcional

conversation_product_typeenumOpcional

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

Valores permitidos:

branch_idstringOpcional

Filtre conversas por ID da ramificação.

version_idstringOpcional

Filtre conversas por ID da versão.

parent_conversation_idstringOpcional

Filtre conversas pelo ID da conversa principal em conversas de subagentes.

topic_idsstringOpcional

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

exclude_statusesenumOpcional

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

Valores permitidos:

tag_idsstringOpcional

Filtre conversas por IDs de tags de conversa atribuídas pelos endpoints conversation-tags.

workflow_node_entered_idstringOpcional

Filtre apenas conversas que entraram no nó informado.

termination_reasonsstringOpcional

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

guardrail_typesenumOpcional

Filtre conversas nas quais uma proteção de qualquer um destes tipos foi acionada (metadata.triggered_guardrails.guardrail_type). Repita o parâmetro para corresponder a qualquer um entre vários valores.

custom_guardrail_namesstringOpcional

Filtre conversas nas quais uma proteção personalizada com qualquer um destes nomes foi acionada (metadata.triggered_guardrails.guardrail_name). Apenas proteções personalizadas têm um nome. Repita o parâmetro para corresponder a qualquer um entre vários valores.

sort_directionenumOpcional

A direção para ordenar as conversas pelo horário de início da chamada. O padrão é decrescente (mais recentes primeiro).

Valores permitidos:

Resposta

Resposta bem-sucedida

conversationslist of objects

has_moreboolean

next_cursorstringOpcional

Erros

422

Conversations List Request Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros