v3

latestOpenAPI 3.0.02026-08-081996601.2 MB

Agent End User Sessions

List end user sessions for alias

Lists the calling end user's own sessions created through this alias. The response never includes sessions owned by another principal.

get/v2/agent_aliases/{alias_key}/end_user_sessions

Path parameters

alias_keystring required

The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.

Example:support

The unique key of the alias to list the caller's sessions for.

Query parameters

limitinteger

The maximum number of sessions to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

The caller's own sessions.

Example response

{
  "sessions": [
    {
      "key": "customer_support_chat",
      "name": "Customer Support Session",
      "description": "Helping customer troubleshoot widget installation issues",
      "enabled": true,
      "status": "stopped",
      "tti_minutes": 60,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}