polyv-live-api-sdk 1.0.13 → 1.0.14

package/dist/types/channel.d.ts

@@ -109,7 +109,7 @@ export interface CreateChannelRequest {
  * Parameters required for creating a new channel using V4 API.
  * V4 API uses JSON body for request parameters.
  *
- * @see docs/api/v4/channel/create.md
+ * @see v4/channel/create.md under POLYV_API_DOCS_DIR or ../document-center/docs/live/api relative to the repository root
  */
 export interface CreateChannelV4Request {
     /** 直播名称，最大长度100 - REQUIRED */
@@ -223,7 +223,7 @@ export interface AuthSetting {
  * Update Watch Condition Request
  * 修改频道观看条件请求
  *
- * @see docs/api/web/watch_condition/set_watch_condition.md
+ * @see web/watch_condition/set_watch_condition.md under POLYV_API_DOCS_DIR or ../document-center/docs/live/api relative to the repository root
  */
 export interface UpdateWatchConditionRequest {
     /** 频道号，不传为通用设置 */
@@ -737,33 +737,33 @@ export interface ChannelSession {
     duration: number;
 }
 /**
- * Record File Item
+ * Record File Response
  */
-export interface RecordFileItem {
+export interface RecordFileResponse {
     fileId: string;
+    userId: string;
     channelId: string;
-    sessionId: string;
     startTime: string;
     endTime: string;
-    fileSize: number;
+    filename: string;
+    filesize: number;
+    createdTime: number;
+    width: number;
+    height: number;
     duration: number;
-    url: string;
-}
-/**
- * Record File Response
- */
-export interface RecordFileResponse {
-    contents: RecordFileItem[];
-    total: number;
-    pageSize: number;
-    pageNumber: number;
+    bitrate: number;
+    mp4: string;
+    m3u8: string;
+    channelSessionId: string;
+    liveType: ChannelScene;
+    daysLeft: number;
+    originSessionId?: string;
 }
 /**
  * Record File Request
  */
 export interface RecordFileRequest {
-    page?: number;
-    pageSize?: number;
+    fileId: string;
 }
 /**
  * Record Info
@@ -1095,6 +1095,174 @@ export interface RecordAddBreakpointRequestOld {
     sessionId: string;
     time: number;
 }
+/**
+ * Playback video move type.
+ */
+export type PlaybackVideoMoveType = 'up' | 'down';
+/**
+ * List channel sessions request.
+ */
+export interface ListChannelSessionsParams extends ChannelSessionsRequest {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+}
+/**
+ * Historical record file subtitle item.
+ */
+export interface HistoricalRecordFileSubtitle {
+    id: number;
+    name: string;
+    srtUrl: string;
+    language: string;
+    status: string;
+}
+/**
+ * Historical record file item from /live/v2/channels/{channelId}/recordFiles.
+ */
+export interface HistoricalRecordFileItem {
+    channelId: string;
+    fileId: string;
+    url: string;
+    startTime: string;
+    endTime: string;
+    fileSize: number;
+    duration: number;
+    bitrate: number;
+    resolution?: string;
+    channelSessionId: string;
+    fileName: string;
+    daysLeft: number;
+    origin?: 'manual' | 'auto' | 'merge' | 'clip' | 'smart-clip' | string;
+    originSessionId?: string;
+    recordFileType?: 'complete' | 'part' | 'merge' | 'clip' | string;
+    subtitleList?: HistoricalRecordFileSubtitle[];
+}
+/**
+ * List historical record files request.
+ */
+export interface ListRecordFilesParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** POLYV user ID - REQUIRED */
+    userId: string;
+    /** Start date, yyyy-MM-dd */
+    startDate?: string;
+    /** End date, yyyy-MM-dd */
+    endDate?: string;
+    /** Live session IDs, comma-separated */
+    sessionIds?: string;
+}
+export type ListRecordFilesResponse = HistoricalRecordFileItem[];
+/**
+ * Merge historical record files request.
+ */
+export interface MergeRecordFilesParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Record file URLs, comma-separated or array. Takes precedence when both urls and fileIds are provided. */
+    urls?: string | string[];
+    /** Record file IDs, comma-separated or array */
+    fileIds?: string | string[];
+    /** Merged file name */
+    fileName?: string;
+}
+export type MergeRecordFilesResponse = string;
+/**
+ * Add VOD video to playback library request.
+ */
+export interface AddVodPlaybackToLibraryParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** VOD video ID - REQUIRED */
+    vid: string;
+    /** Whether to set as default playback video */
+    setAsDefault?: YNFlag;
+    /** Playback list type */
+    listType?: PlaybackListType;
+}
+export type AddVodPlaybackToLibraryResponse = PlaybackVideoItem;
+/**
+ * Delete historical record files request.
+ */
+export interface DeleteRecordFileParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Live session ID */
+    sessionId?: string;
+    /** Record start time, yyyyMMddHHmmss */
+    startTime?: string;
+}
+/**
+ * Convert historical record file to VOD request.
+ */
+export interface ConvertRecordFileToVodParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** POLYV user ID - REQUIRED */
+    userId: string;
+    /** VOD video name after conversion - REQUIRED */
+    fileName: string;
+    /** Record file URL */
+    fileUrl?: string;
+    /** Live session ID */
+    sessionId?: string;
+    /** VOD category ID */
+    cataid?: string;
+    /** VOD category name */
+    cataname?: string;
+    /** Whether to put converted video into playback list */
+    toPlayList?: YNFlag;
+    /** Whether to set as default playback video */
+    setAsDefault?: YNFlag;
+}
+export type ConvertRecordFileToVodResponse = string;
+/**
+ * Set playback enabled by user scope request.
+ */
+export interface SetUserPlaybackEnabledParams {
+    /** POLYV user ID - REQUIRED */
+    userId: string;
+    /** Playback enabled flag - REQUIRED */
+    playBackEnabled: YNFlag;
+    /** Channel ID. Omit or pass -1 to update all channels under the user. */
+    channelId?: string;
+}
+export type SetUserPlaybackEnabledResponse = string;
+/**
+ * Move one playback or VOD video up/down request.
+ */
+export interface MovePlaybackVideoParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Video ID - REQUIRED */
+    videoId: string;
+    /** Move direction - REQUIRED */
+    type: PlaybackVideoMoveType;
+    /** Playback list type */
+    listType?: PlaybackListType;
+}
+/**
+ * Set default playback or VOD video request.
+ */
+export interface SetDefaultPlaybackVideoParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Video ID - REQUIRED */
+    videoId: string;
+    /** Playback list type */
+    listType?: PlaybackListType;
+}
+/**
+ * Sort playback or VOD videos request.
+ */
+export interface SortPlaybackVideosParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Complete ordered video ID list - REQUIRED */
+    videoIds: string[];
+    /** Playback list type */
+    listType?: PlaybackListType;
+}
 /**
  * Player Logo Settings
  */
@@ -2066,6 +2234,445 @@ export interface UpdateWarmupVideoRequest {
     /** Warmup FLV URL - REQUIRED */
     warmUpFlv: string;
 }
+/**
+ * Channel advert item returned by /live/v3/channel/advert/list.
+ */
+export interface ChannelAdvert {
+    /** Text advert content */
+    text?: string;
+    /** Image advert URL */
+    img?: string;
+    /** Advert link URL */
+    href?: string;
+}
+/**
+ * Channel product library enabled status.
+ */
+export interface ChannelProductEnabledResponse {
+    /** Product library enabled flag */
+    enabled: YNFlag;
+}
+/**
+ * PPT record setting returned by /live/v3/channel/pptRecord/get-setting.
+ */
+export interface PptRecordSettingResponse {
+    /** Channel ID */
+    channelId: string | number;
+    /** PolyV user ID */
+    userId: string;
+    /** Video layout type: 0 three-screen, 1 document-only, 2 picture-in-picture */
+    type: number;
+    /** Whether global setting is enabled */
+    globalSettingEnabled: YNFlag;
+    /** Camera aspect ratio */
+    videoRatio?: string | number;
+    /** Display image URL used by older docs */
+    brandImgFile?: string;
+    /** Background image URL used by older docs */
+    backgroundImgFile?: string;
+    /** Display image URL */
+    brandImg?: string;
+    /** Background image URL */
+    backgroundImg?: string;
+    /** Created time */
+    createdTime?: number;
+    /** Last modified time */
+    lastModified?: number;
+    /** Camera position */
+    actionPosition?: string;
+}
+/**
+ * Query parameters for /live/v3/channel/pptRecord/list.
+ */
+export interface ListPptRecordTasksParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** PPT record session ID */
+    sessionId?: string;
+    /** Task status */
+    status?: string;
+    /** Live start time lower bound, yyyyMMddHHmmss */
+    startTime?: string;
+    /** Live start time upper bound, yyyyMMddHHmmss */
+    endTime?: string;
+    /** Page number */
+    page?: number;
+    /** Page size */
+    pageSize?: number;
+}
+/**
+ * PPT record task item.
+ */
+export interface PptRecordTaskItem {
+    /** Task ID */
+    taskId: number;
+    /** Channel ID */
+    channelId: string | number;
+    /** Playback title */
+    title?: string;
+    /** MP4 download URL */
+    url?: string;
+    /** PPT record session ID */
+    sessionId?: string;
+    /** Live start time, yyyyMMddHHmmss */
+    startTime?: string;
+    /** Task status */
+    status?: string;
+    /** Remaining days before expiry */
+    remainDay?: number;
+    /** Video duration in seconds */
+    duration?: number;
+    /** Live system video ID */
+    videoId?: string;
+    /** VOD VID after upload */
+    vid?: string | null;
+}
+/**
+ * PPT record task page response.
+ */
+export interface ListPptRecordTasksResponse {
+    pageNumber: number;
+    totalPages: number;
+    pageSize: number;
+    contents: PptRecordTaskItem[];
+}
+/**
+ * Query parameters for /live/v3/channel/transmit/get-associations.
+ */
+export interface GetTransmitAssociationsParams {
+    /** Source channel ID; omit to query all associations under the account */
+    channelId?: string;
+}
+/**
+ * Transmit association item.
+ */
+export interface TransmitAssociation {
+    /** Source channel ID; null when the receiver has no source channel association */
+    channelId: string | number | null;
+    /** Receiver channel ID */
+    receiveChannelId: string | number;
+}
+/**
+ * Query parameters for /live/v4/channel/channel-user-children/get-channels.
+ */
+export interface GetUserChildrenChannelsParams {
+    /** Child account user ID - REQUIRED */
+    childUserId: string;
+    /** Channel created time lower bound */
+    startTime?: number;
+    /** Channel created time upper bound */
+    endTime?: number;
+    /** Page number - REQUIRED */
+    pageNumber: number;
+    /** Page size - REQUIRED */
+    pageSize: number;
+}
+/**
+ * Child account channel item.
+ */
+export interface UserChildrenChannel {
+    /** Channel ID */
+    channelId: number;
+    /** Organization ID */
+    organizationId?: string;
+    /** Created time */
+    createdTime?: number;
+}
+/**
+ * Child account channel page response.
+ */
+export interface GetUserChildrenChannelsResponse {
+    pageSize: number;
+    pageNumber: number;
+    totalItems: number;
+    totalPages: number;
+    contents: UserChildrenChannel[];
+}
+/**
+ * Query parameters for /live/v3/channel/promotion/list-channels-follow.
+ */
+export interface ListChannelsFollowParams {
+    /** Channel IDs, comma-separated or array - REQUIRED */
+    channelIds: string | Array<string | number>;
+}
+/**
+ * Channel follow-public-account settings.
+ */
+export interface ChannelFollowSetting {
+    /** Channel ID */
+    channelId: string | number;
+    /** Follow feature switch */
+    enabled: YNFlag;
+    /** Auto popup switch */
+    autoShowEnabled: YNFlag;
+    /** QR code image URL */
+    qrCodeUrl?: string;
+    /** Entry text */
+    entranceText?: string;
+    /** Popup tips */
+    tips?: string;
+    /** PC popup tips */
+    pcFollowTips?: string;
+}
+/**
+ * Channel follow settings response.
+ */
+export interface ListChannelsFollowResponse {
+    list: ChannelFollowSetting[];
+}
+export type ChannelIdListInput = string | Array<string | number>;
+export interface AddPptRecordTaskParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Playback video ID - REQUIRED */
+    videoId: string;
+}
+export interface PptRecordMutationResponse {
+    /** Operation result */
+    result: boolean;
+}
+export interface UpdatePptRecordSettingParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Whether global setting is enabled */
+    globalSettingEnabled?: YNFlag;
+    /** Video layout type: 0 three-screen, 1 document-only, 2 picture-in-picture */
+    type?: 0 | 1 | 2;
+    /** Camera aspect ratio: 0 = 16:9, 1 = 4:3 */
+    videoRatio?: 0 | 1;
+    /** Display image file or URL */
+    brandImgFile?: string | File | Blob | Buffer;
+    /** Background image file or URL */
+    backgroundImgFile?: string | File | Blob | Buffer;
+}
+export interface DeletePptRecordParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** PPT record task IDs - REQUIRED */
+    taskIds: ChannelIdListInput;
+}
+export interface ViewerApiTokenParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Viewer ID, 1-64 chars - REQUIRED */
+    viewerId: string;
+    /** Viewer nickname */
+    nickname?: string;
+    /** Viewer avatar URL */
+    avatar?: string;
+    /** WeChat OpenID */
+    openid?: string;
+    /** Viewer actor/title */
+    actor?: string;
+}
+export interface ViewerApiTokenResponse {
+    /** API token */
+    token: string;
+}
+export interface ChatTokenParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Viewer/user ID - REQUIRED */
+    userId: string;
+    /** Role - REQUIRED */
+    role: 'teacher' | 'admin' | 'guest' | 'assistant' | 'viewer';
+    /** Watch origin */
+    origin?: string;
+}
+export interface ChatTokenResponse {
+    token: string;
+    mediaChannelKey?: string;
+    roomId?: string;
+    childRoomEnabled?: YNFlag;
+    chatApiDomain?: string;
+    chatDomain?: string;
+}
+export interface TokenLoginUrlParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Role account ID */
+    accountId?: string;
+}
+export type TokenLoginUrlResponse = string | {
+    token: string;
+};
+export interface BatchAddTransmitParams {
+    /** Source transmit channel ID - REQUIRED */
+    channelId: string;
+    /** Receiver channel names, max 100 - REQUIRED */
+    names: string[];
+}
+export interface TransmitChannelInfo {
+    channelId: number;
+    name: string;
+    channelPasswd?: string;
+    authType?: string;
+    playBackEnabled?: YNFlag;
+    streamType?: string;
+    debugEnabled?: YNFlag;
+    stream?: string;
+    status?: string;
+    categoryId?: number;
+    categoryName?: string;
+    isSmallClass?: YNFlag;
+    scene?: string | null;
+    newScene?: string | null;
+    template?: string | null;
+    createdTime?: number;
+    coverImage?: string;
+    type?: string;
+    startTime?: number | null;
+    publisher?: string;
+    splashImg?: string;
+    splashEnabled?: YNFlag;
+    pureRtcEnabled?: YNFlag;
+    roomIds?: string | null;
+}
+export type BatchAddTransmitResponse = TransmitChannelInfo[];
+export interface SubmeetingChannelInput {
+    /** Submeeting channel ID - REQUIRED */
+    channelId: string | number;
+    /** Submeeting name */
+    name?: string;
+}
+export interface BatchAddSubmeetingParams {
+    /** Main meeting channel ID - REQUIRED */
+    channelId: string;
+    /** Submeeting channel list, max 60 - REQUIRED */
+    subChannels: SubmeetingChannelInput[];
+}
+export type BatchAddSubmeetingResponse = number[];
+export interface AssociationReceiveChannelsParams {
+    /** Source transmit channel ID - REQUIRED */
+    channelId: string;
+    /** Receiver channel IDs - REQUIRED */
+    receiveChannelIds: ChannelIdListInput;
+    /** Operation type, defaults to add */
+    type?: 'add' | 'cancel';
+}
+export type AssociationReceiveChannelsResponse = Array<string | number>;
+export interface RemoveChatContentsParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Chat message IDs - REQUIRED */
+    ids: string | string[];
+}
+export interface BatchDeleteChannelProductParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Product IDs, max 100 - REQUIRED */
+    productIds: number[];
+}
+export type BatchAddChannelProductItem = Omit<AddChannelProductParams, 'channelId'>;
+export interface BatchAddChannelProductsParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Products - REQUIRED */
+    products: BatchAddChannelProductItem[];
+}
+export type BatchAddChannelProductsResponse = AddChannelProductResponse[];
+export interface BatchShelfChannelProductParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Product IDs, max 100 - REQUIRED */
+    productIds: number[];
+    /** Shelf status: 1 on shelf, 2 off shelf - REQUIRED */
+    shelf: ProductStatus;
+}
+export interface ProductIdParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Product ID - REQUIRED */
+    productId: number;
+}
+export interface ShelfChannelProductParams extends ProductIdParams {
+    /** Shelf status: 1 on shelf, 2 off shelf - REQUIRED */
+    shelf: ProductStatus;
+}
+export interface PushChannelProductParams extends ProductIdParams {
+    /** Push card type */
+    pushCardType?: 'smallCard' | 'bigCard';
+}
+export interface SortChannelProductOrderParams extends ProductIdParams {
+    /** 10 up, 20 down, 50 move to explicit sort */
+    type: 10 | 20 | 50;
+    /** Required when type=50 */
+    sort?: number;
+}
+export interface ReferenceProductParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Platform product origin ID - REQUIRED */
+    originId: string;
+    /** Shelf status: 1 on shelf, 2 off shelf - REQUIRED */
+    status: ProductStatus;
+    /** Whether to sync platform tags */
+    withTags?: boolean;
+}
+export type ReferenceProductResponse = ChannelProductItem;
+export interface DeleteDiskVideosParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** VOD/material video IDs */
+    vids?: string | string[];
+    /** Disk video IDs */
+    videoIds?: string | string[];
+}
+export interface AddDiskVideosParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Video IDs or record file IDs - REQUIRED */
+    vids: string | string[];
+    /** Video origin, defaults to vod */
+    origin?: 'vod' | 'material' | 'record';
+    /** Start times in 13-digit ms timestamps */
+    startTimes?: string | number | Array<string | number>;
+}
+export interface SetChannelTokenParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** One-time login token - REQUIRED */
+    token: string;
+}
+export interface StopQuestionnaireParams {
+    /** Channel IDs - REQUIRED */
+    channelIds: ChannelIdListInput;
+}
+export interface StopQuestionnaireResponse {
+    result: boolean | string;
+}
+export interface BatchUpdateDanmuParams {
+    /** Channel IDs - REQUIRED */
+    channelIds: ChannelIdListInput;
+    /** Y closes danmu, N opens danmu - REQUIRED */
+    closeDanmu: YNFlag;
+    /** Whether to show danmu info - REQUIRED */
+    showDanmuInfoEnabled: YNFlag;
+}
+export interface UpdateChannelsFollowParams {
+    /** Channel IDs - REQUIRED */
+    channelIds: ChannelIdListInput;
+    /** QR code image URL - REQUIRED */
+    qrCodeUrl: string;
+    enabled?: YNFlag;
+    autoShowEnabled?: YNFlag;
+    /** Entry text, max 8 chars */
+    entranceText?: string;
+    /** Popup tips, max 30 chars */
+    tips?: string;
+    /** PC popup tips, max 30 chars */
+    pcFollowTips?: string;
+}
+export interface UpdateStreamTypeParams {
+    /** Channel ID - REQUIRED */
+    channelId: string;
+    /** Stream type - REQUIRED */
+    streamType: ChannelStreamType;
+    /** Pull URL, required when streamType=pull */
+    pullUrl?: string;
+    /** Pull stream start time */
+    pullStreamTime?: number;
+}
 /**
  * Product link type
  * - 10: Universal link (通用链接)
@@ -2398,4 +3005,253 @@ export interface ListChannelProductsResponse {
     /** Has more pages */
     hasMore?: boolean;
 }
+/**
+ * Backend login-state endpoint scope for channel viewer APIs.
+ */
+export type ChannelViewerApiScope = 'user' | 'teacher';
+/**
+ * Common params for backend login-state channel viewer APIs.
+ */
+export interface ChannelViewerScopedParams {
+    /** Endpoint scope, defaults to user */
+    scope?: ChannelViewerApiScope;
+}
+/**
+ * Generic page response used by channel viewer backend APIs.
+ */
+export interface ChannelViewerPageResponse<T> {
+    /** Current page number */
+    pageNumber: number;
+    /** Page size */
+    pageSize: number;
+    /** Total pages */
+    totalPages: number;
+    /** Total item count */
+    totalItems: number;
+    /** Page items */
+    contents: T[];
+}
+/**
+ * Channel viewer group item.
+ */
+export interface ChannelViewerGroup {
+    /** Group ID */
+    id: number;
+    /** Channel ID */
+    channelId: number;
+    /** Group name */
+    name: string;
+    /** Number of viewers associated with this group */
+    viewerCount: number;
+}
+export interface ListChannelViewerGroupsParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+}
+export type ListChannelViewerGroupsResponse = ChannelViewerGroup[];
+export interface CreateChannelViewerGroupParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Group name, max 128 chars - REQUIRED */
+    name: string;
+}
+export interface UpdateChannelViewerGroupParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Group ID - REQUIRED */
+    id: string | number;
+    /** New group name, max 128 chars - REQUIRED */
+    name: string;
+}
+export interface DeleteChannelViewerGroupParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Group ID - REQUIRED */
+    id: string | number;
+}
+export interface ChannelViewerGroupSetting {
+    /** Channel viewer group switch */
+    channelViewerGroupEnabled: YNFlag;
+    /** Allow viewers outside groups to watch */
+    notInGroupWatchEnabled: YNFlag;
+}
+export interface GetChannelViewerGroupSettingParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+}
+export interface UpdateChannelViewerGroupSettingParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Channel viewer group switch */
+    channelViewerGroupEnabled?: YNFlag;
+    /** Allow viewers outside groups to watch */
+    notInGroupWatchEnabled?: YNFlag;
+}
+/**
+ * Channel-owned viewer item.
+ */
+export interface ChannelViewerItem {
+    /** Primary key */
+    id: number;
+    /** Channel ID */
+    channelId: number;
+    /** Viewer ID */
+    viewerId: string;
+    /** Group ID */
+    groupId?: number;
+    /** Group name */
+    groupName?: string;
+    /** Viewer nickname */
+    nickname?: string;
+    /** WeChat avatar */
+    wxAvatar?: string;
+    /** WeCom avatar */
+    qwAvatar?: string;
+    /** Mobile number */
+    mobile?: string;
+}
+export interface ListChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Group ID */
+    groupId?: string | number;
+    /** Viewer ID, max 64 chars */
+    viewerId?: string;
+    /** Viewer nickname, max 128 chars */
+    nickname?: string;
+    /** Mobile number, max 32 chars */
+    mobile?: string;
+    /** Page number, default 1 */
+    pageNumber?: number;
+    /** Page size, default 10, max 1000 */
+    pageSize?: number;
+}
+export type ListChannelViewersResponse = ChannelViewerPageResponse<ChannelViewerItem>;
+export interface ExportChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Group ID */
+    groupId?: string | number;
+    /** Viewer ID */
+    viewerId?: string;
+    /** Viewer nickname */
+    nickname?: string;
+    /** Mobile number */
+    mobile?: string;
+}
+export type ExportChannelViewersResponse = string;
+export interface AddChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Target group ID */
+    groupId?: string | number;
+    /** Viewer IDs, max 1000 - REQUIRED */
+    viewerIds: string[];
+}
+export interface DeleteChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Viewer IDs, max 1000 - REQUIRED */
+    viewerIds: string[];
+}
+export interface TransferChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Target group ID; omit to clear group association */
+    targetGroupId?: string | number;
+    /** Viewer IDs, max 1000 - REQUIRED */
+    viewerIds: string[];
+}
+export type ChannelViewerImportFile = File | Blob | Buffer;
+export interface ImportChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    /** Target group ID */
+    groupId?: string | number;
+    /** Excel file - REQUIRED */
+    file: ChannelViewerImportFile;
+}
+export interface ImportChannelViewersResponse {
+    /** Successful import count */
+    successCount: number;
+    /** Failed import count */
+    failCount: number;
+    /** Failed detail file URL */
+    failFileUrl?: string;
+}
+/**
+ * Viewer not associated with any channel group.
+ */
+export interface UnrelatedChannelViewerItem {
+    /** Viewer unique ID */
+    viewerUnionId: string;
+    /** Viewer nickname */
+    nickname?: string;
+    /** WeChat nickname */
+    wxNickName?: string;
+    /** Mobile number */
+    mobile?: string;
+    /** External viewer ID */
+    externalViewerId?: string;
+    /** WeChat OpenID */
+    wxOpenId?: string;
+    /** WeChat UnionID */
+    wxUnionId?: string;
+    /** Viewer source */
+    source?: string;
+    /** Name */
+    name?: string;
+    /** Last collected mobile number */
+    lastCollectMobile?: string;
+    /** Email */
+    email?: string;
+    /** Area */
+    area?: string;
+    /** Latest access IP */
+    latestAccessIp?: string;
+    /** Device information */
+    device?: string;
+    /** Total watch duration in seconds */
+    watchDuration?: number;
+    /** Watched channel count */
+    watchChannelCount?: number;
+    /** Label IDs */
+    labelIds?: Array<string | number>;
+    /** Label names */
+    labelNames?: string[];
+    /** Viewer status */
+    status?: string;
+    /** Creation time */
+    createTime?: string;
+}
+export interface ListUnrelatedChannelViewersParams extends ChannelViewerScopedParams {
+    /** Channel ID - REQUIRED */
+    channelId: string | number;
+    name?: string;
+    mobile?: string;
+    externalViewerId?: string;
+    wxOpenId?: string;
+    wxUnionId?: string;
+    nickname?: string;
+    wxNickName?: string;
+    source?: string;
+    email?: string;
+    area?: string;
+    lastCollectMobile?: string;
+    /** Search keyword matching nickname and wxNickName */
+    searchKeyword?: string;
+    viewerId?: string;
+    status?: string;
+    /** Registration start time, yyyy-MM-dd HH:mm:ss */
+    startCreateTime?: string;
+    /** Registration end time, yyyy-MM-dd HH:mm:ss */
+    endCreateTime?: string;
+    /** Label IDs, max 10 */
+    labelIds?: Array<string | number>;
+    /** Page number, default 1, max 1000 */
+    pageNumber?: number;
+    /** Page size, default 10, max 1000 */
+    pageSize?: number;
+}
+export type ListUnrelatedChannelViewersResponse = ChannelViewerPageResponse<UnrelatedChannelViewerItem>;
 //# sourceMappingURL=channel.d.ts.map