Sign in

v3

latestOpenAPI 3.0.02026-08-081996601.2 MB
Agent Aliases

List events on alias-routed session

Lists events of a session originally created via this alias.

get/v2/agent_aliases/{alias_key}/sessions/{session_key}/events

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
session_keystring required

A unique key that identifies an agent session.

Example:customer_support_chat

Query parameters

limitinteger
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

Events on this session.

Example response

{
  "events": [
    {
      "id": "aev_user_001",
      "session_key": "customer_support_chat",
      "created_at": "2024-01-15T10:35:00Z",
      "messages": [
        {
          "type": "text",
          "content": "I need help with my widget installation"
        }
      ]
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}