@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface SIInitiateSessionResponse

    Brand agent's response to session initiation

    interface SIInitiateSessionResponse {
        session_id: string;
        response?: { message?: string; ui_elements?: SIUIElement[] };
        negotiated_capabilities?: SICapabilities;
        session_status: SISessionStatus;
        session_ttl_seconds?: number;
        errors?: Error[];
        ext?: ExtensionObject;
    }
    Index

    Properties

    session_id response? negotiated_capabilities? session_status session_ttl_seconds? errors? ext?

    Properties

    session_id: string

    Unique session identifier for subsequent messages

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

    Brand agent's initial response

    Type Declaration

    • Optionalmessage?: string

      Conversational message from brand agent

    • Optionalui_elements?: SIUIElement[]

      Visual components to render

    negotiated_capabilities?: SICapabilities
    session_status: SISessionStatus
    session_ttl_seconds?: number

    Session inactivity timeout in seconds. After this duration without a message, the brand agent may terminate the session. Hosts SHOULD warn users before timeout when possible.

    errors?: Error[]

    Errors during session initiation

    ext?: ExtensionObject

    Settings

    Member Visibility

    On This Page

    Properties