Shopee SDK API Reference - v1.11.0
    Preparing search index...

    Interface GetSessionDetailResponse

    Response for getting session detail

    interface GetSessionDetailResponse {
        error: string;
        message: string;
        request_id: string;
        response: {
            cover_image_url: string;
            create_time: number;
            description: string;
            end_time: number;
            is_test: boolean;
            session_id: number;
            share_url: string;
            start_time: number;
            status: SessionStatus;
            stream_url_list: StreamUrlInfo;
            title: string;
            update_time: number;
        };
        warning?: string
        | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    error message request_id response warning?

    Properties

    error: string

    Error code if any error occurred

    message: string

    Error message if any error occurred

    request_id: string

    The identifier for an API request for error tracking

    response: {
        cover_image_url: string;
        create_time: number;
        description: string;
        end_time: number;
        is_test: boolean;
        session_id: number;
        share_url: string;
        start_time: number;
        status: SessionStatus;
        stream_url_list: StreamUrlInfo;
        title: string;
        update_time: number;
    }

    Type Declaration

    • cover_image_url: string

      The cover image URL

    • create_time: number

      Create time in unix timestamp (milliseconds)

    • description: string

      The description of livestream session

    • end_time: number

      End time in unix timestamp (milliseconds)

    • is_test: boolean

      Whether it's a test session

    • session_id: number

      The identifier of livestream session

    • share_url: string

      Share URL

    • start_time: number

      Start time in unix timestamp (milliseconds)

    • status: SessionStatus

      Session status: 0=Not started, 1=Ongoing, 2=Ended

    • stream_url_list: StreamUrlInfo

      Stream URL information

    • title: string

      The title of livestream session

    • update_time: number

      Update time in unix timestamp (milliseconds)

    warning?: string | string[]

    Warning message or list of warning messages

    Settings

    Member Visibility

    On This Page

    Properties