Chat 会话元数据

本文档介绍了聊天会话元数据记录的架构。元数据记录是 Contact Center AI 平台为支持聊天会话创建的 JSON 文档。CCAI Platform 会将元数据记录作为聊天 session-end 命令的一部分交付给您的 CRM 集成。启用外部存储空间后，CCAI 平台还会使用 metadata.json 文件将记录写入外部存储空间配置。每次聊天都会生成一条记录，该记录由顶层 id 唯一标识。您可以使用此架构将记录注入到下游系统中、验证收到的载荷，或将字段映射到数据仓库列。

架构根

聊天会话元数据记录是一个 JSON 对象，表示一个聊天会话。有三个顶级概念决定了记录的身份和形状。

主键：id（整数）

在您的租户中唯一标识聊天会话。每个对话都有一条记录。所有其他顶级字段、数组和嵌套对象都描述了相应 id 所标识的聊天室的属性。

处理程序判别器：agent_info（对象，oneOf）

一个对象，其形状因聊天的最后一个处理程序而异。这两种变体互斥，只能存在一种：

• 人工客服变体：当聊天的最后处理者是人工客服时显示。 除了共享的 id、name 和 avatar_url 字段之外，还包含 email、first_name、last_name 和 agent_number。

• 虚拟客服变体：当聊天的最后一个处理程序是虚拟客服时，会显示此变体。携带 va_alias 并省略 email、first_name、last_name 和 agent_number。

如需检测记录携带的是哪个变体，请检查是否存在特定于变体的字段，通常是人工客服变体的 agent_info.email 或虚拟客服变体的 agent_info.va_alias。如需了解每种变体的完整定义，请参阅定义：agent和定义：virtual_agent。

聊天形状判别器：chat_type、session_type、session_type_v2（字符串）

同一底层聊天类型的三种并行视图。它们在记录所代表的聊天类型方面永远不会有分歧；它们仅在用于命名聊天类型的词汇方面有所不同。

• chat_type：使用旧版枚举词汇，例如“Messaging Inbound”（应用 Chat）、“Messaging”（短信）和“Messaging”（WhatsApp）。

• session_type：始终返回与 chat_type 相同的字符串。它的存在是为了向后兼容以该字段为键的集成；请将其视为 chat_type 的已弃用别名。

• session_type_v2：使用当前的枚举词汇表，其中可能包含更精细的区分，例如“Messaging Inbound (Mobile Chat)”。对于没有特定于 v2 的聊天类型，session_type_v2 返回的字符串与 chat_type 相同。新的集成应解析 session_type_v2。

如需了解每个字段的值，请参阅核心信息。

核心信息

• id（整数）：每个聊天会话的唯一标识符。此主键用于区分不同的对话。

• lang（字符串）：聊天期间使用的 ISO 639 语言代码（例如，"en" 表示英语，"es" 表示西班牙语）。

• chat_type（字符串）：聊天类型，使用旧版类型词汇。 值包括 "Messaging Inbound (App Chat)"、"Messaging Inbound (Web Chat)"、"Messaging (SMS)"、"Messaging (WhatsApp)" 和 "Messaging (Apple Messaging for Business)"。

• session_type（字符串）：chat_type 的副本（值相同），保留此字段是为了实现向后兼容性。请参阅版本控制和弃用：旧版重复项。

• session_type_v2（字符串）：聊天类型，使用当前类型词汇。它通过更精细的区分来优化 chat_type 值。值包括 "Messaging Inbound (Mobile Chat)"、"Messaging Inbound (Web Chat)"、"Messaging (WhatsApp)"、"Messaging (Apple Messaging for Business)"、"Messaging (SMS)"、"Messaging Inbound (SMS)"、"Messaging Outbound (SMS)"、"Messaging Outbound (SMS using the API)"、"Messaging Inbound (SMS Direct)"、"Messaging Outbound (SMS Direct)" 和 "Messaging Outbound (SMS Direct using the API)"。

• status（字符串）：对话的当前状态。可能的值："queued"、"selecting"、"assigned"、"va_assigned"、"dismissed"、"va_dismissed"、"check_in_timeout"、"finished"、"no_response"、"canceled" 和 "failed"。（CCAI 平台会将未收到消费者回复的已结束对话报告为 "no_response"。）

• sub_status（字符串或 null）：聊天的更具体的状态详细信息（如果有）。可能的值："selecting"、"queued"、"ongoing"、"dismissed"、"finished"、"timeout"、"deflected"、"abandoned"、"expired"、"failed"、"disconnected_by_agent"、"disconnected_by_end_user"、"no_messages"、"no_messages_disconnected_by_agent"、"no_messages_disconnected_by_end_user" 和 "end_user_opt_out"。

• created_at（字符串，日期时间）：CCAI Platform 创建聊天会话时的时间戳。

• assigned_at（字符串、日期时间或 null）：CCAI Platform 将对话分配给客服人员的时间戳，如果未分配，则为 null。

• ends_at（字符串、日期时间或 null）：聊天会话结束时的时间戳。

• updated_at（字符串，日期时间）：CCAI Platform 上次更新聊天数据时的时间戳。

• first_msg_sent_at（字符串、日期时间或 null）：参与者在聊天中发送第一条消息时的时间戳。

• last_msg_sent_at（字符串、日期时间或 null）：相应参与者在聊天中发送最后一条消息时的时间戳。

• wait_duration（整数）：消费者等待的总时间（以秒为单位）。

• chat_duration（整数）：对话的总时长（以秒为单位）。

• verified（布尔值）：表示验证智能操作是否验证了互动。

• rating（整数或 null）：消费者提供的客户满意度 (CSAT) 评分；如果消费者未提供评分，则为 null。

• has_feedback（布尔值）：表示消费者是否在聊天后提供了反馈。

• out_ticket_id（字符串或 null）：CCAI 平台在外部 CRM 系统中创建的支持请求的标识符。

• out_ticket_url（字符串、URI 或 null）：CRM 工单的网址。

• is_out_ticket_account（布尔值或 null）：表示 CRM 工单是代表客户 (true) 还是代表聊天互动 (false)。

• fail_reason（字符串）：聊天期间发生任何失败的原因，或聊天未失败时的 "nothing"。可能的值："nothing"、"unknown"、"expired"、"after_hours"、"escalation_failed"、"check_in_timed_out"、"check_in_timed_out_expired"、"expired_menu_selection"、"end_user_opt_out"、"over_cap_email"、"group_deleted_no_substitute"、"presession_deflection_unknown"、"presession_deflection_timeout"、"presession_deflection_message_delivery_failed"、"sms_error" 和 "force_ended"。

• provider_type（字符串）：所用聊天服务提供商的类型。可能的值："unknown"、"messaging"、"twilio_conversations"、"nexmo_conversations" 和 "ujet_conversations"。

• provider_channel_id（字符串或 null）：聊天的提供方专用渠道标识符。

• message_count（整数）：聊天中交流的消息总数。

• average_response_time（整数）：聊天期间客服人员的平均回复时间（以秒为单位）。

• longest_response_time（整数）：聊天期间客服人员最长的回复时间（以秒为单位）。

• transcript（布尔值）：指示会话是否存在聊天记录。

代理和虚拟客服信息

• agent_info（对象）：上次处理聊天的人工客服或虚拟客服的相关信息。此字段使用 oneOf 关键字指定它可以是两种类型之一。

  • agent（对象）：有关人工客服的信息：

    • id（整数）：代理的唯一 ID。

    • agent_number（字符串或 null）：分配给代理的标识符。

    • email（字符串，电子邮件地址）：代理的电子邮件地址。

    • name（字符串）：代理的完整名称。

    • last_name（字符串）：代理的姓氏。

    • first_name（字符串）：代理的姓名。

    • avatar_url（字符串、URI 或 null）：代理的头像图片的网址。

  • virtual_agent（对象）：有关虚拟客服的信息：

    • id（整数）：虚拟代理的唯一 ID。

    • name（字符串）：虚拟代理的名称。

    • avatar_url（字符串、URI 或 null）：虚拟客服的头像图片网址。

    • va_alias（字符串或 null）：虚拟代理的显示别名（如果已配置）。始终存在于载荷中；如果未设置别名，则为 null。

菜单导航

• selected_menu（对象或 null）：消费者在聊天期间选择的菜单的相关信息。

  • id（整数）：菜单的唯一 ID。

  • name（字符串）：菜单的名称。

  • parent_id（整数或 null）：父级菜单的 ID（如有）。

  • position（整数或 null）：相对于同一级别的其他菜单的菜单位置。

  • deleted（布尔值）：指示管理员是否删除了相应菜单。

  • menu_type（字符串）：菜单的类型（例如 "sms_menu"、"web_menu"）。

  • hidden（布尔值）：菜单是否可见或可供使用。

  • menu_path（对象或 null）：描述客户浏览的菜单的层次结构路径。

  • items_count（整数）：路径中的菜单数量。

  • name（字符串或 null）：以斜杠分隔的菜单名称字符串（例如 "Support/Billing"），如果菜单路径不可用，则为 null。

  • materialized_path（字符串）：以斜杠分隔的菜单 ID 字符串。

• queue_priority_level（整数）：分配给聊天所选队列的队列优先级。仅当您的账号启用了队列优先级时才存在。

最终用户详细信息

• end_user（对象或 null）：有关消费者的信息：

  • id（整数或 null）：消费者的内部 ID。

  • identifier（字符串或 null）：消费者的外部标识符。

  • out_contact_id（字符串或 null）：CRM 中的消费者 ID。

客户标志和 SDK 提供的数据

• customer_flag（对象）：标志，用于标记外部系统在会话期间提供或更新的重要消费者属性。仅当外部系统在会话期间提供或更新了与身份验证相关的客户标志时才显示。

  • verified_customer（布尔值）：指示外部系统是否将相应消费者标记为已验证。

  • bad_actor（布尔值）：指示外部系统是否将相应消费者标记为作恶方。

  • repeat_customer（布尔值）：表示外部系统是否将相应买家标记为回头客。

• custom_data_secured（对象或 null）：SDK 或 Apps API 提供的自定义安全签名数据。

• custom_data_not_secured（对象或 null）：SDK 或 Apps API 提供的自定义非安全签名数据。

• sip_headers（对象）：为聊天捕获的入站 SIP 标头。键和值反映了从上游提供商处收到的 SIP 标头。仅当您在账号中启用 SIP 标头捕获功能并将其配置为显示在会话元数据中时才会显示

媒体附件

• photos（数组）：与对话关联的照片或屏幕截图。

  • id（整数）：照片的唯一标识符。

  • photo_type（字符串）：照片的类型。可能的值包括 "photo" 和 "screenshot"。

  • url（字符串，URI）：存储的照片的网址。

  • smart_action_type（字符串或 null）：与照片关联的智能操作（如果有）。

  • transfer_id（整数或 null）：与照片关联的转移事件标识符（如果参与者在转移完成后上传了照片）。

• videos（数组）：与聊天关联的视频。

  • id（整数）：视频的唯一标识符。

  • url（字符串，网址）：指向存储视频的网址。

  • smart_action_type（字符串或 null）：与视频关联的智能操作（如果有）。

  • transfer_id（整数或 null）：与视频关联的传输事件标识符（如果参与者在传输完成后上传了视频）。

Chat 转接

• transfers（数组）：聊天期间每次转移事件对应一个条目。记录客服、虚拟客服和菜单之间的转移。

  • id（整数）：转移的唯一标识符。

  • status（字符串）：转移的当前状态。可能的值包括 "transferring"、"transferred"、"failed" 和 "deflected"。

  • fail_reason（字符串）：转移失败的原因，如果未失败，则为 "nothing"。可能的值："nothing"、"timeout"、"canceled"、"ag_connection_timeout"、"va_failure"、"agent_detection_missed"、"unknown" 和 "unreachable_phone_number"。

  • created_at（字符串，日期时间）：转移开始时的时间戳。

  • assigned_at（字符串、日期时间或 null）：CCAI 平台分配转移的时间戳。

  • connected_at（字符串、日期时间或 null）：转移连接时的时间戳。

  • updated_at（字符串、日期时间或 null）：CCAI 平台上次更新转移记录的时间戳。

  • call_duration（整数或 null）：转移的对话片段的时长（以秒为单位）。

  • wait_duration（整数或 null）：在转移期间，消费者等待的时间（以秒为单位）。

  • deflection（字符串）：与转移关联的转接类型。如需了解允许的值，请参阅定义：deflection。

  • answer_type_path（字符串或 null）：用于描述智能体或菜单如何回答原始对话和目标对话的路径。

  • from_menu_path / to_menu_path（对象或 null）：转移前后的菜单路径；与定义中的 menu_path 具有相同的形状。

  • from_agent / to_agent（对象或 null）：转移的每一方的人工客服；与定义中的 agent 对象具有相同的形状。

  • from_virtual_agent / to_virtual_agent（对象或 null）：转移的每一侧的虚拟代理；与定义中的 virtual_agent 对象具有相同的形状。

  • from_queue_priority_level / to_queue_priority_level（整数或 null）：转移前后的队列优先级。

Chat 处理时长

• handle_durations（数组）：一个对象数组，每个对象都表示由客服人员处理的对话片段。

  • id（整数）：处理时长的唯一标识符。

  • agent_id（整数或 null）：代理的标识符。

  • acw_duration（整数）：聊天后工作时长（以秒为单位）。

  • chat_duration（整数）：相应时间段内的 Chat 时长（以秒为单位）。

  • menu_path_id（整数或 null）：菜单路径的 ID。

  • menu_path（字符串）：菜单路径的名称。

  • lang（字符串）：所用语言。

  • transfer（布尔值）：是否发生了转移。

  • transfer_id（整数或 null）：转移作业的 ID。

  • started_at（字符串、日期时间或 null）：开始时间戳。

  • ended_at（字符串、日期时间或 null）：结束时间戳。

  • response_count（整数）：智能体响应的数量。

  • response_time_total（整数）：客服人员总响应时间，以秒为单位。

  • response_time_max（整数）：最长的客服人员响应时间（以秒为单位）。

  • response_time_avg（数字或 null）：代理的平均响应时间（以秒为单位）。此值可能包含小数精度。

  • assigned_connection_duration（整数）：在此细分中，分配的客服人员连接期间，消费者等待的时长。

队列时长

• queue_durations（数组）：一个对象数组，每个对象代表消费者在队列中等待的聊天会话片段。

  • id（整数）：唯一标识符。

  • agent_id（整数或 null）：代理标识符。

  • ended_at（字符串，日期时间）：结束时间戳。

  • lang（字符串）：语言。

  • menu_path_id（整数或 null）：菜单路径标识符。

  • menu_path（字符串）：菜单路径。

  • queue_duration（整数或 null）：队列时长（以秒为单位）。

  • started_at（字符串，日期时间）：开始时间戳。

  • transfer_cold（布尔值或 null）：聊天是否为冷转移。

  • transfer（布尔值）：是否发生了转移。

  • transfer_id（整数或 null）：转移标识符。

  • service_level_abandon_time_threshold（整数）：服务级放弃阈值，以秒为单位。

  • service_level_event（字符串）：服务级事件状态。可能的值包括 "excluded"、"in_sla" 和 "not_in_sla"。

  • service_level_target_percent（整数）：服务等级目标百分比。

  • service_level_target_time（整数）：服务等级目标时间，以秒为单位。

虚拟客服转人工客服

• escalations（数组）：每个条目都表示从虚拟客服到人工客服的升级。

  • id（整数）：升级的唯一标识符。

  • status（字符串）：升级的当前状态。可能的值："escalating"、"escalated"、"canceled"、"deflecting" 和 "deflected"。

  • reason（字符串）：上报对话的原因。可能的值："unknown"、"by_end_user_ask"、"by_end_user_message"、"by_virtual_agent"、"payload_failure"、"could_not_resume"、"by_human_agent"、"invalid_queue" 和 "dismissed"。

  • created_at（字符串，日期时间）：升级开始时的时间戳。

  • escalated_at（字符串、日期时间或 null）：升级完成时的时间戳。

  • from_virtual_agent（对象或 null）：升级聊天会话的虚拟客服。与 Definitions 中的 virtual_agent 对象具有相同的形状。

  • to_agent（对象或 null）：聊天升级到的人工客服。与 Definitions 中的 agent 对象具有相同的形状。

  • from_menu_path / to_menu_path（对象或 null）：升级前后的菜单路径。

虚拟客服避免的升级

• virtual_agent_deflected_escalations（数组）：从转到其他目的地的虚拟代理升级的详细信息。

  • id（整数）：唯一标识符。

  • deflection（字符串）：被转移的升级请求的转移类型。 可能的值："no_deflection"、"over_cap"、"over_cap_email"、"over_cap_virtual_agent"、"over_cap_human_agent"、"over_cap_sip"、"over_cap_extension"、"after_hours"、"after_hours_email" 和 "after_hours_virtual_agent"。

  • escalation_id（整数）：升级事件标识符。

  • escalation_reason（字符串）：上报原因。与 escalations[].reason 相同的值（请参阅 10. 虚拟客服到人工客服的升级）。

  • escalated_at（字符串，日期时间）：升级时间戳。

  • menu_path_id（整数）：菜单路径 ID。

  • menu_path（字符串）：菜单路径。

  • lang（字符串）：语言。

  • virtual_agent（对象）：虚拟客服详细信息。请参阅定义：virtual_agent。

虚拟客服处理时长

• virtual_agent_handle_durations（数组）：聊天由虚拟客服处理的时间段。

  • id（整数）：唯一标识符。

  • virtual_agent（对象）：虚拟客服详细信息。请参阅定义：virtual_agent。

  • chat_duration（整数）：片段时长（以秒为单位）。

  • escalation_reason（字符串）：上报原因。

  • finish_reason（字符串）：互动结束的原因。

  • response_count（整数）：虚拟客服响应次数。

  • response_time_total（整数）：虚拟客服的总响应时间（以秒为单位）。

  • response_time_max（整数）：最长的虚拟客服响应时间（以秒为单位）。

  • response_time_avg（数字或 null）：虚拟客服的平均响应时间（以秒为单位）。此值可能包含小数精度。

  • fallback_response_count（整数）：后备回答数。

  • initiated_by（字符串）：虚拟客服会话的启动方式。可能的值："end_user"、"human_agent" 和 "post_session"。

  • menu_path_id（整数）：菜单路径 ID。

  • menu_path（字符串）：菜单路径。

  • lang（字符串）：语言。

  • transfer（布尔值）：聊天是否已转接。

  • transfer_id（整数或 null）：转移事件标识符。

  • started_at（字符串，日期时间）：开始时间戳。

  • ended_at（字符串，日期时间）：结束时间戳。

消费者处理时长

• consumer_handle_durations（数组）：消费者在聊天中的时长。

  • id（整数）：唯一标识符。

  • chat_duration（整数）：消费细分时长（以秒为单位）。

  • started_at（字符串、日期时间或 null）：开始时间戳。

  • ended_at（字符串、日期时间或 null）：结束时间戳。

  • message_count（整数）：使用方消息的数量。

  • response_count（整数）：使用方响应的数量。

  • response_time_total（整数）：总消费者响应时间（以秒为单位）。

  • response_time_max（整数）：最长的消费者响应时间（以秒为单位）。

  • response_time_avg（整数）：平均消费者响应时间（以秒为单位）。

消费类活动时长

• consumer_event_durations（数组）：消费者聊天事件的详细信息（例如客户满意度、付款）。

  • id（整数）：唯一标识符。

  • duration（整数）：活动时长（以秒为单位）。

  • type（字符串）：事件类型。可能的值："csat"。

  • event（字符串）：活动结果。可能的值："finished" 和 "abandoned"。

  • menu_path_id（整数）：菜单路径 ID。

  • menu_path（字符串）：菜单路径。

  • lang（字符串）：语言。

  • started_at（字符串，日期时间）：开始时间戳。

  • ended_at（字符串，日期时间）：结束时间戳。

参与者

• participants（数组）：有关聊天中每位参与者（例如最终用户、客服人员、虚拟客服）的信息。

  • id（整数）：参与者的唯一标识符。

  • type（字符串）：参与者的类型。可能的值："end_user"、"agent"、"manager"、"virtual_agent"、"external_agent" 和 "task_virtual_agent"。

  • entry_type（字符串）：参与者加入聊天的方式。可能的值："queue_or_transfer"、"barge" 和 "post_session"。

  • user_id（整数或 null）：如果参与者是客服人员，则为用户 ID。

  • end_user_id（整数或 null）：如果参与者是消费者，则为消费者标识符。

  • virtual_agent_id（整数或 null）：如果参与者是虚拟客服，则为虚拟客服 ID。

  • virtual_agent_params（对象）：虚拟代理使用的自定义元数据。仅在您配置虚拟代理自定义元数据包含时显示。

  • status（字符串）：参与者的状态。可能的值："waiting"、"connecting"、"invited"、"connected"、"wrapping_up"、"finished"、"failed"、"resuming" 和 "post_session_in_progress"。

  • fail_reason（字符串）：失败原因（如有）。可能的值："nothing"、"canceled"、"ag_connection_timeout" 和 "unknown"。

  • connected_at（字符串、日期时间或 null）：参与者连接时的时间戳。

  • phone_number（字符串）：参与者的电话号码。仅在消费者参与者中显示。

  • chat_id（整数）：相应对话的标识符。

  • chat_duration（整数或 null）：相应参与者的 Chat 时长（以秒为单位）。

  • finished_at（字符串、日期时间或 null）：参与者参与结束的时间戳。

  • agent_assist（对象）：为参与者启用的 Agent Assist 设置。始终存在；如果未配置 Agent Assist，则为空默认对象。

  • virtual_agent（对象或 null）：充当相应参与者的虚拟客服的详细信息；与顶级 agent_info 和 virtual_agent_params 不同。

  • sip_headers（对象或 null）：与相应参与者关联的 SIP 标头。始终存在于载荷中；当 CCAI 平台未捕获任何内容时为 null。

  • location（字符串或 null）：代理的配置位置。仅在代理参与者上显示。

  • location_id（整数或 null）：位置的标识符。仅在代理参与者上显示。

  • email（字符串，电子邮件地址）：代理的电子邮件地址。仅在代理参与者上显示。

  • first_name（字符串或 null）：代理的姓名。仅在代理参与者上显示。

  • last_name（字符串或 null）：代理的姓氏。仅在代理参与者上显示。

  • middle_name（字符串或 null）：代理的中间名。仅在代理参与者上显示。

  • teams（数组）：描述代理所属团队的 { id, name } 对象数组。仅在代理参与者中显示。

签到日志

• check_in_logs（数组）：聊天会话期间记录的签到事件。 每个项都会将一次签到流程的签到事件分组。

  • check_in_id（整数）：签到流程的标识符。

  • check_in_modal_displayed（字符串，日期时间）：CCAI Platform 向消费者显示入住确认模态框时的时间戳。 仅当 CCAI 平台显示签到模态框时才存在。

  • check_in_modal_confirmed（字符串，日期时间）：消费者确认自己仍在场的时间戳。仅当消费者确认入住模态框时存在。

  • check_in_modal_timed_out（字符串，日期时间）：签到提示超时的时间戳。仅当签到模态框超时时存在。

  • timeout_modal_rejoin_success（字符串，日期时间）：重新加入操作成功时的时间戳。仅当使用方在超时后成功重新加入时存在。

  • timeout_modal_rejoin_failed_after_hour（字符串，日期时间）：由于非营业时间行为而导致重新加入操作失败的时间戳。仅当因队列在非工作时间而导致重新加入失败时才存在。

  • timeout_modal_exit_chat（字符串，日期时间）：消费者选择退出聊天的时间戳。仅当使用方从超时模态框退出聊天时才存在。

  • timeout_modal_time_out_sdk_closed（字符串，日期时间）：因 SDK 关闭而导致超时模态流程结束的时间戳。仅当 SDK 在超时后关闭时存在。

提供活动

• offer_type（字符串或 null）：CCAI 平台向客服提供聊天的方式。

• offer_events（数组）：CCAI 平台向客服人员提供聊天服务的事件。

  • casting_time（字符串，日期时间）：CCAI 平台提供聊天服务的时间。

  • group（字符串）：CCAI Platform 向其提供对话的群组。

其他详情

• dismiss_duration（整数）：相应对话处于已关闭状态的时长（以秒为单位）。仅当对话处于已关闭状态时存在。

• answer_type（字符串或 null）：聊天回答方式。可能的值："manual"、"auto"、"outbound" 和 "deflection"。

• inbound_number（字符串）：与相应对话关联的来电手机号码。 仅当入站手机号码与相应对话相关联时才存在。

• outbound_number（字符串）：与相应聊天关联的外拨手机号码。 仅当聊天关联了拨出手机号码时才显示。

• after_hours（布尔值）：聊天是否发生在非工作时间。

• dispositions（数组）：客服人员记录的收尾代码和备注。仅当您在账号中启用收尾代码或备注时显示。每个条目可能包含根据收尾配置有条件呈现的字段：

  • user_id（整数）：代理标识符。

  • transfer_id（整数或 null）：转移事件标识符（如果是在转移后记录的）。

  • participant_id（整数）：参与者标识符。

  • note（字符串）：自由格式的代理备注。

  • original_note（字符串）：笔记的原始（编辑前）版本。

  • code（字符串）：处置代号。

  • ujet_code_id（整数或空字符串）：处置代码的 CCAI 平台分配的标识符；代码的稳定键（代码显示名称可能会更改）。不可用时为空字符串。

  • list（字符串）：代码所属列表的名称。

  • list_path（字符串）：以斜杠分隔的代码列表路径。

  • ujet_list_id（整数或空字符串）：处置代码所属列表的 CCAI 平台分配的标识符；列表的稳定键。如果不可用，则为空字符串。

  • custom_list_id（字符串或整数）：客户定义的列表标识符（如果已映射）。

  • custom_code_id（字符串或整数）：客户定义的代码标识符（如果已映射）。

• auto_session_summaries（数组）：保存到 CRM 记录中的 AI 生成的会话摘要。仅当您在账号中启用对话总结功能，且 AI 成功生成总结时存在。每个条目都包含以下内容：

  • user_id（整数）：与摘要关联的代理参与者的标识符。

  • participant_id（整数）：参与者标识符。

  • session_summary（字符串）：摘要文本。

  • session_summary_sections（数组或对象）：结构化部分的摘要（如有）。

• transfer_limit（对象或 null）：相应聊天的转移限额数据。

  • enabled（布尔值）：聊天是否启用了转移限制跟踪。

  • limit_count（整数）：允许的转移次数。

  • limit_reached（布尔值）：聊天是否达到配置的转移上限。

• email（字符串、电子邮件地址或 null）：消费者的电子邮件地址。

• feedback（字符串或 null）：消费者反馈。

• smart_action_text（字符串或 null）：所采取的任何智能操作的文本。

定义

以下子架构会多次出现在聊天会话元数据文档中。每个子架构仅显示一次。引用这些属性组的属性组会指向此部分，而不是重新定义其内嵌形状。

menu_path（对象）

描述了聊天机器人遍历的分层菜单路径。如需查看其字段的完整列表，请参阅菜单导航。

引用自：顶级 menu_path 字段；每个 transfers[].from_menu_path 和 transfers[].to_menu_path；每个 escalations[].from_menu_path 和 escalations[].to_menu_path。

agent（对象）

描述人工客服。这是顶级 agent_info 判别器的两种变体之一（请参阅架构根）。如需查看其字段的完整列表，请参阅客服人员和虚拟客服人员信息。

参考自：聊天记录的最后处理者是人工客服人员时的 agent_info 字段；每个 transfers[].from_agent 和 transfers[].to_agent；每个 escalations[].to_agent。

virtual_agent（对象）

描述虚拟客服。这是顶级 agent_info 判别器的两种变体之一（请参阅架构根）。如需查看其字段的完整列表，请参阅客服人员和虚拟客服人员信息。

引用自：聊天的最后处理者是虚拟客服人员时的 agent_info 字段；每个 transfers[].from_virtual_agent 和 transfers[].to_virtual_agent；每个 escalations[].from_virtual_agent；每个 virtual_agent_handle_durations[].virtual_agent；每个 virtual_agent_deflected_escalations[].virtual_agent；每个 participants[].virtual_agent。

deflection（字符串，枚举）

与转移相关的分流状态。值遵循 <trigger>_<destination> 模式，其中前缀用于标识触发改道的条件，后缀用于标识目的地或处理方式（例如 _phone、_voicemail、_message、_queue、_sip、_extension、_callback、_wait）。

按触发器系列分组的允许值：

• 无分流：no_deflection、deflecting

• 超出容量，即队列超出其容量阈值时：over_cap_phone、over_cap_voicemail、over_cap_callback、over_cap_wait、over_cap_message、over_cap_ewt_only、over_cap_queue、over_cap_sip、over_cap_extension、over_cap_phone_with_extension

• 非工作时间，即聊天到达时间不在菜单配置的工作时间范围内：after_hours_voicemail、after_hours_phone、after_hours_message_only、after_hours_message、after_hours_queue、after_hours_sip、after_hours_extension、after_hours_phone_with_extension

• 临时重定向，当菜单上配置了临时重定向时：temp_redirection_phone、temp_redirection_message、temp_redirection_voicemail、temp_redirection_queue、temp_redirection_sip、temp_redirection_extension、temp_redirection_phone_with_extension

• IVR 会前：ivr_presession_deflection

• 虚拟客服重定向，指虚拟客服重定向聊天会话时：va_redirection_phone、va_redirection_sip

引用自：每个 transfers[].deflection。（虚拟客服分流的升级中的虚拟客服分流的升级使用单独的较小分流词汇，相关文档已内嵌在其中。）

transfer（对象）

描述了聊天期间发生的转移。转移可以将对话从一个菜单、客服人员和虚拟客服人员转移到另一个菜单、客服人员和虚拟客服人员。如需查看其字段的完整列表，请参阅聊天转接。

引用自：顶层 transfers 数组。（文档中所有其他名为 transfer_id 的字段都是对转移的 id 的整数引用，而不是内嵌的 transfer 对象。）

participant（对象）

描述聊天中的一位参与者。参与者形状因参与者类型而异；代理参与者可以包括代理个人资料、位置、团队和 Agent Assist 字段，而消费者和虚拟代理参与者则包括特定于类型的标识符。如需查看已记录的完整字段列表，请参阅参与者。

引用自：顶级 participants 数组；auto_session_summaries[].participant_id；处置记录。

时长行（对象）

描述聊天中的一个测量时间间隔，例如客服处理时间、排队时间、客户处理时间、客户事件时间或虚拟客服处理时间。 每个时长数组都有自己的行形状，因为名称相似的字段在不同表中的精度或可为 null 性可能不同。

参考自： handle_durations、queue_durations、virtual_agent_handle_durations、consumer_handle_durations 和 consumer_event_durations。

版本控制和弃用

聊天会话元数据文档旨在实现向后兼容的架构演变。我们可能会随时添加新字段和数组，集成应忽略任何无法识别的键，以确保功能持续正常运行。以下字段属于旧版字段或已被软取代；它们仍保留在载荷中以实现向后兼容性，但新的集成应遵循针对每个字段的指南。

旧版重复内容

• session_type（字符串）：chat_type 的旧版别名。始终返回与 chat_type 相同的值，并使用相同的旧版枚举词汇。保留此属性是为了与以 session_type 为键的集成保持向后兼容性。新的集成应直接解析 chat_type，或者为了更精细的区分而解析 session_type_v2（请参阅下文中的词汇演变）。

词汇演变

chat_type 和 session_type_v2 使用两种不同的词汇描述了相同的底层聊天类型。CCAI Platform 会在每条记录中同时发出这两个字段；它们彼此之间不是重复的：

• chat_type 使用旧版枚举词汇表。“即时通讯入站（应用聊天）”和“即时通讯（短信）”等值描述了原始的聊天类型类别。

• session_type_v2 使用当前的枚举词汇。它可能会针对具有 v2 特定值的聊天类型引入更精细的区别。 对于没有特定于 v2 的聊天类型，session_type_v2 返回的字符串与 chat_type 相同。

新集成应解析 session_type_v2。每个字段的值均列在核心信息中。

加性场

聊天会话元数据载荷可能会随着时间的推移而添加新的顶级字段、嵌套字段、数组项字段或枚举值。集成应忽略无法识别的键，并尽可能保留原始记录。避免在出现新属性时解析失败的严格解析。