@adcp/client API Reference - v3.11.2
    Preparing search index...

    Interface SISendMessageResponse

    Standard visual component that brand returns and host renders

    interface SISendMessageResponse {
        session_id: string;
        response?: {
            message?: string;
            surface?: A2UISurface;
            ui_elements?: SIUIElement[];
        };
        mcp_resource_uri?: string;
        session_status: "active"
        | "complete"
        | "pending_handoff";
        handoff?: {
            type?: "complete" | "transaction";
            intent?: {
                action?: string;
                product?: {};
                price?: { amount?: number; currency?: string };
            };
            context_for_checkout?: {
                conversation_summary?: string;
                applied_offers?: string[];
            };
        };
        errors?: Error[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    session_id response? mcp_resource_uri? session_status handoff? errors? ext?

    Properties

    session_id: string

    Session identifier

    response?: {
        message?: string;
        surface?: A2UISurface;
        ui_elements?: SIUIElement[];
    }

    Brand agent's response

    Type Declaration

    • Optionalmessage?: string

      Conversational message from brand agent

    • Optionalsurface?: A2UISurface
    • Optionalui_elements?: SIUIElement[]

      Visual components to render (DEPRECATED: use surface instead)

    mcp_resource_uri?: string

    MCP resource URI for hosts with MCP Apps support (e.g., ui://si/session-abc123)

    session_status: "active" | "complete" | "pending_handoff"

    Current session status

    handoff?: {
        type?: "complete" | "transaction";
        intent?: {
            action?: string;
            product?: {};
            price?: { amount?: number; currency?: string };
        };
        context_for_checkout?: {
            conversation_summary?: string;
            applied_offers?: string[];
        };
    }

    Handoff request when session_status is pending_handoff

    Type Declaration

    • Optionaltype?: "complete" | "transaction"

      Type of handoff: transaction (ready for ACP checkout) or complete (conversation done)

    • Optionalintent?: {
          action?: string;
          product?: {};
          price?: { amount?: number; currency?: string };
      }

      For transaction handoffs: what the user wants to purchase

      • Optionalaction?: string

        The commerce action (e.g., 'purchase')

      • Optionalproduct?: {}

        Product details for checkout

      • Optionalprice?: { amount?: number; currency?: string }

        Price information

    • Optionalcontext_for_checkout?: { conversation_summary?: string; applied_offers?: string[] }

      Context to pass to ACP for seamless checkout

      • Optionalconversation_summary?: string

        Summary of the conversation leading to purchase

      • Optionalapplied_offers?: string[]

        Offer IDs that were applied during the conversation

    errors?: Error[]
    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties