列出会话

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_filter=data_collection_filter \
     -d data_collection_ids=data_collection_ids \
     -d data_collection_params=data_collection_params \
     -d dynamic_variable_filter=dynamic_variable_filter \
     -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 phone_number_ids=phone_number_ids \
     -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_ids=tool_ids \
     -d tool_ids_errored=tool_ids_errored \
     -d tool_ids_successful=tool_ids_successful \
     -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 whatsapp_phone_number_ids=whatsapp_phone_number_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",
      "cost": 1,
      "cost_fiat": 1.1,
      "user_message_count": 1,
      "agent_message_count": 1,
      "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"
}

获取用户拥有的智能体的所有对话。可选择仅获取指定智能体的对话。

查询参数

cursorstring可选

用于获取下一页。响应中会返回游标。

agent_idstring可选

智能体 id（agent_…）或语音引擎外部 id（seng_），均会解析为同一底层资源。

visited_agent_idsstring可选

筛选任一指定智能体参与过的对话。最多不超过 50 个值。

visited_agent_branch_idsstring可选

筛选任一指定智能体分支参与过的对话。最多不超过 50 个值。

triggered_procedure_idsstring可选

筛选触发过任一指定流程的对话。最多不超过 50 个值。

call_successfulenum可选

成功评估结果

允许的值:

call_start_before_unixinteger可选

用于筛选截至此开始日期对话的 Unix 时间戳（秒）。

call_start_after_unixinteger可选

用于筛选此开始日期之后对话的 Unix 时间戳（秒）。

call_duration_min_secsinteger可选

最短通话时长，单位为秒。

call_duration_max_secsinteger可选

最长通话时长，单位为秒。

rating_maxinteger可选1-5

总体评分上限（1-5）。

rating_mininteger可选1-5

总体评分下限（1-5）。

has_feedback_commentboolean可选

筛选含有用户反馈评论的对话。

user_idstring可选

按发起对话的用户 ID 筛选对话。

evaluation_paramsstring可选

评估筛选条件。可重复传入此参数。格式：criteria_id:result，其中 result 为 success|failure|unknown 之一。示例：eval=value_framing:success

data_collection_paramsstring可选

数据收集筛选条件。可重复使用该参数。格式：id:op:value，其中 op 为 eq|neq|gt|gte|lt|lte|in 之一。对于 in，使用竖线分隔值。空值匹配未收集该字段的对话（id:eq:）；使用空值的 neq 匹配已收集该字段的对话（id:neq:）。eq 表示完全相等。gt|gte|lt|lte 需要数值。

dynamic_variable_paramsstring可选

动态变量筛选条件。可重复使用该参数。格式：name:op:value，其中 op 为 eq|neq|gt|gte|lt|lte|in 之一。对于 in，值以竖线分隔。空值匹配未设置该变量的对话（name:eq:），使用空值的 neq 则匹配已设置该变量的对话（name:neq:）。eq 表示完全相等。gt|gte|lt|lte 需要数值。名称中包含 ’:’ 时无法表示。

data_collection_filterstring可选

单个数据收集筛选条件，适用于每个查询参数只能发送一个标量值的调用方。格式与 data_collection_params 相同（id:op:value）；同时提供两者时会合并使用。

dynamic_variable_filterstring可选

单个动态变量筛选条件，适用于每个查询参数只能发送一个标量值的调用方。格式与 dynamic_variable_params 相同（name:op:value）；同时提供两者时会合并使用。

data_collection_idsstring可选

要包含在每个对话摘要中的数据收集字段 ID。可重复使用该参数。省略时，不返回 data_collection_results。

evaluation_criteria_idsstring可选

要包含在每个对话摘要中的评估标准 ID。可重复传入此参数。省略时，不会返回 evaluation_criteria_results。

tool_namesstring可选

按通话期间使用的工具名称筛选对话。

tool_names_successfulstring可选

按调用成功的工具名称筛选对话。

tool_names_erroredstring可选

按调用出错的工具名称筛选对话。

tool_idsstring可选

按通话期间使用的工具 ID 筛选对话。系统工具使用 ‘_system<tool_name>‘。与 tool_names 不同，此参数可区分名称相同的工具。

tool_ids_successfulstring可选

按调用成功的工具 ID 筛选对话。

tool_ids_erroredstring可选

按调用出错的工具 ID 筛选对话。

include_invalid_tool_callsboolean可选默认为 false

同时匹配从未运行的工具调用。

main_languagesstring可选

按检测到的主要语言（语言代码）筛选对话。

phone_number_idsstring可选

按智能体电话号码 ID 筛选对话。

whatsapp_phone_number_idsstring可选

按智能体 WhatsApp 号码 ID 筛选对话。

page_sizeinteger可选1-100默认为 30

最多返回的对话数量。不能超过 100，默认为 30。

summary_modeenum可选默认为 exclude

是否在响应中包含转录摘要。

允许的值:

searchstring可选Deprecated

对转录消息进行全文或模糊搜索

conversation_initiation_sourceenum可选默认为 unknown

表示对话发起来源的枚举。

text_onlyboolean可选

conversation_product_typeenum可选

将结果限制为单个对话产品界面。

允许的值:

branch_idstring可选

按分支 ID 筛选对话。

version_idstring可选

按版本 ID 筛选对话。

parent_conversation_idstring可选

按子智能体对话的父对话 ID 筛选对话。

topic_idsstring可选

按主题发现期间分配的主题 ID 筛选对话。

exclude_statusesenum可选

排除具有指定状态的对话。适用于在列表视图中隐藏进行中/处理中对话。

允许的值:

tag_idsstring可选

按通过 conversation-tags 端点分配的对话标签 ID 筛选对话。

workflow_node_entered_idstring可选

仅筛选进入指定节点的对话。

termination_reasonsstring可选

按存储的 termination_reason（metadata.termination_reason）筛选对话。重复传入参数可匹配多个值中的任意一个。

guardrail_typesenum可选

筛选触发过任一指定类型护栏的对话（metadata.triggered_guardrails.guardrail_type）。重复传入参数可匹配多个值中的任意一个。

custom_guardrail_namesstring可选

筛选触发过任一指定名称的自定义护栏的对话（metadata.triggered_guardrails.guardrail_name）。只有自定义护栏具有名称。重复传入参数可匹配多个值中的任意一个。

sort_directionenum可选

按通话开始时间排序对话的方向。默认为降序（最新优先）。

允许的值:

响应

成功响应

conversationslist of objects

has_moreboolean

next_cursorstring可选

错误

422

Conversations List Request Unprocessable Entity Error

请求头

查询参数

响应

错误