From 64fea0b65ad8a3aec900d19208ff13b0d4d436eb Mon Sep 17 00:00:00 2001 From: Him188 Date: Sat, 17 Oct 2026 15:45:57 +0900 Subject: [PATCH] docs(agents): list one end user's sessions with end_user_id The session list accepts an end_user_id filter, and session rows return the end_user_id set at creation. Co-Authored-By: Claude Opus 5.5 --- agents/deploy/authenticated-sessions.mdx | 2 +- agents/monitor/conversation-history.mdx | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/agents/deploy/authenticated-sessions.mdx b/agents/deploy/authenticated-sessions.mdx index 3d3181e..6f81d58 100644 --- a/agents/deploy/authenticated-sessions.mdx +++ b/agents/deploy/authenticated-sessions.mdx @@ -129,7 +129,7 @@ More on what the SDK can do once connected is in the [Web SDK](/agents/deploy/we | `overrides` | object, optional | Replace parts of the published configuration for this session. See [Overrides](#overrides). | | `dynamic_variables` | object, optional | Up to 50 entries of string, number, or boolean values, substituted into `{{placeholders}}`. See [Dynamic variables](/agents/build/dynamic-variables). | | `tool_events` | boolean, optional | Stream tool lifecycle events (`toolCallStarted` / `toolCallCompleted` / `toolCallFailed`) to the client. Default `true`; set `false` to keep tool inputs and outputs off the client. | -| `end_user_id` | string, optional | Your identifier for the end user, up to 256 characters. Stored on the session and echoed in [webhook](/agents/monitor/webhooks) payloads and [custom LLM](/agents/build/custom-llm) requests. | +| `end_user_id` | string, optional | Your identifier for the end user, up to 256 characters. Stored on the session, returned on [session queries](/agents/monitor/conversation-history) where you can also filter by it, and echoed in [webhook](/agents/monitor/webhooks) payloads and [custom LLM](/agents/build/custom-llm) requests. | | `metadata` | object, optional | Your own key-value namespace. Stored and returned verbatim on session queries and webhooks, never read or interpreted by the platform. | | `llm_extra_body` | object, optional | JSON object (at most 16 KB) forwarded verbatim to your [custom LLM](/agents/build/custom-llm) endpoint on every request as `fishaudio_extra_body`, for example the chat or thread the user is in. Not stored or returned on session reads; ignored when the agent uses a platform model. | | `record_audio` | boolean, optional | Whether to record this session's audio. Overrides the agent's [recording setting](/agents/monitor/conversation-history#what-gets-stored) for this session only; omit it to use the agent's configuration. | diff --git a/agents/monitor/conversation-history.mdx b/agents/monitor/conversation-history.mdx index 88a4e3a..dd2b70c 100644 --- a/agents/monitor/conversation-history.mdx +++ b/agents/monitor/conversation-history.mdx @@ -10,7 +10,7 @@ This is a server-side API: authenticate with your API key. The client SDKs delib ## What gets stored -The session record (status, timing, caller attribution, name, and `metadata`) and the conversation transcript are always kept for production sessions. Audio recording is a per-agent choice, on by default: set `conversation.record_audio` in the console under your agent's **Settings** or in the `conversation` section of the [config API](/agents/build/configuration#configure-through-the-api), with a per-session override on the [session request](/agents/deploy/authenticated-sessions). Recording off means there is no audio to download. +The session record (status, timing, caller attribution, name, `end_user_id`, and `metadata`) and the conversation transcript are always kept for production sessions. Audio recording is a per-agent choice, on by default: set `conversation.record_audio` in the console under your agent's **Settings** or in the `conversation` section of the [config API](/agents/build/configuration#configure-through-the-api), with a per-session override on the [session request](/agents/deploy/authenticated-sessions). Recording off means there is no audio to download. The setting doesn't affect the live call: transcript events still stream to connected clients in real time. @@ -53,6 +53,7 @@ Each row carries the session facts: "agent_id": "…", "agent_name": "Support agent", "name": "Order #4821 follow-up", + "end_user_id": "user_42", "status": "completed", "end_reason": "user_hangup", "source": "phone", @@ -70,7 +71,7 @@ Each row carries the session facts: } ``` -`caller_number` and `dialed_number` are set for phone sessions only (E.164) and are `null` for web sessions. `sip_call_id` is the SIP `Call-ID` of the call's INVITE. It is `null` on web sessions and on outbound calls that were never answered. See [Match calls with your SIP records](/agents/telephony/byo-sip#match-calls-with-your-sip-records). `name` is the display name you passed when creating the session (`null` when omitted), and `metadata` echoes back whatever you attached when creating the session. +`caller_number` and `dialed_number` are set for phone sessions only (E.164) and are `null` for web sessions. `sip_call_id` is the SIP `Call-ID` of the call's INVITE. It is `null` on web sessions and on outbound calls that were never answered. See [Match calls with your SIP records](/agents/telephony/byo-sip#match-calls-with-your-sip-records). `name` is the display name you passed when creating the session (`null` when omitted), `end_user_id` is the end-user identifier you passed (`null` when omitted), and `metadata` echoes back whatever you attached when creating the session. ### Status and end reason @@ -103,6 +104,7 @@ The same values appear on the [`call.ended` webhook](/agents/monitor/webhooks) a | `end_reason` | One or more of the `end_reason` values above, comma-separated | | `caller_number` | Exact match on the caller's E.164 number; a bare number gets `+` prepended automatically | | `sip_call_id` | Exact match on the SIP `Call-ID` of the call's INVITE, for looking up the session behind a carrier CDR entry | +| `end_user_id` | Exact, case-sensitive match on the `end_user_id` you set when [creating the session](/agents/deploy/authenticated-sessions), for listing one customer's sessions | | `created_after` / `created_before` | ISO 8601 timestamps |