Amagi API 文档 - v5.6.3
    正在准备搜索索引...

    变量 douyin常量

    douyin: {
        getTextWorkInfo: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "视频作品数据"
                    | "图集作品数据"
                    | "合辑作品数据"
                    | "聚合解析"
                    | "文字作品数据";
                    aweme_id: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyTextWork, M>>>;
        getWorkInfo: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "视频作品数据"
                    | "图集作品数据"
                    | "合辑作品数据"
                    | "聚合解析"
                    | "文字作品数据";
                    aweme_id: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<
            ApiResponse<
                ConditionalReturnType<
                    DyImageAlbumWork
                    | DySlidesWork
                    | DyVideoWork,
                    M,
                >,
            >,
        >;
        getVideoWorkInfo: <M extends TypeMode>(
            options: Omit<{ methodType: "视频作品数据"; aweme_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyVideoWork, M>>>;
        getImageAlbumWorkInfo: <M extends TypeMode>(
            options: Omit<{ methodType: "图集作品数据"; aweme_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyImageAlbumWork, M>>>;
        getSlidesWorkInfo: <M extends TypeMode>(
            options: Omit<{ methodType: "合辑作品数据"; aweme_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DySlidesWork, M>>>;
        getComments: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "评论数据";
                    aweme_id: string;
                    number?: number;
                    cursor?: number;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyWorkComments, M>>>;
        getCommentReplies: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "指定评论回复数据";
                    aweme_id: string;
                    comment_id: string;
                    number?: number;
                    cursor?: number;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<CommentReply, M>>>;
        getUserProfile: <M extends TypeMode>(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页视频列表数据"
                | "直播间信息数据"; sec_uid: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyUserInfo, M>>>;
        getEmojiList: <M extends TypeMode>(
            options: Omit<{ methodType: "Emoji数据" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyEmojiList, M>>>;
        getEmojiProList: <M extends TypeMode>(
            options: Omit<{ methodType: "动态表情数据" }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyEmojiProList, M>>>;
        getUserVideos: <M extends TypeMode>(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页视频列表数据"
                | "直播间信息数据"; sec_uid: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyUserPostVideos, M>>>;
        getMusicInfo: <M extends TypeMode>(
            options: Omit<{ methodType: "音乐数据"; music_id: string }, "methodType"> & {
                typeMode?: TypeMode;
            } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyMusicWork, M>>>;
        getSuggestWords: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "热点词数据"
                    | "搜索数据";
                    query: string;
                    number?: number;
                    search_id?: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DySuggestWords, M>>>;
        search: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "热点词数据"
                    | "搜索数据";
                    query: string;
                    number?: number;
                    search_id?: string;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DySearchInfo, M>>>;
        getLiveRoomInfo: <M extends TypeMode>(
            options: Omit<
                { methodType: "用户主页数据"
                | "用户主页视频列表数据"
                | "直播间信息数据"; sec_uid: string },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyUserLiveVideos, M>>>;
        getDanmaku: <M extends TypeMode>(
            options: Omit<
                {
                    methodType: "弹幕数据";
                    aweme_id: string;
                    start_time?: number;
                    end_time?: number;
                    duration: number;
                },
                "methodType",
            > & { typeMode?: TypeMode } & { typeMode?: M },
            cookie: string,
            requestConfig?: RequestConfig,
        ) => Promise<ApiResponse<ConditionalReturnType<DyDanmakuList, M>>>;
    } = ...

    封装了所有抖音相关的API请求,采用对象化的方式组织。

    提供了一系列方法,用于与抖音相关的 API 进行交互。

    每个方法都接受参数和 Cookie,返回 Promise,解析为统一格式的API响应。

    类型声明

    • getTextWorkInfo: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "视频作品数据"
                  | "图集作品数据"
                  | "合辑作品数据"
                  | "聚合解析"
                  | "文字作品数据";
                  aweme_id: string;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyTextWork, M>>>

      获取文字作品数据

    • getWorkInfo: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "视频作品数据"
                  | "图集作品数据"
                  | "合辑作品数据"
                  | "聚合解析"
                  | "文字作品数据";
                  aweme_id: string;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<
          ApiResponse<
              ConditionalReturnType<DyImageAlbumWork | DySlidesWork | DyVideoWork, M>,
          >,
      >

      聚合解析 (视频/图集/合辑)

    • getVideoWorkInfo: <M extends TypeMode>(
          options: Omit<{ methodType: "视频作品数据"; aweme_id: string }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyVideoWork, M>>>

      获取视频作品数据

    • getImageAlbumWorkInfo: <M extends TypeMode>(
          options: Omit<{ methodType: "图集作品数据"; aweme_id: string }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyImageAlbumWork, M>>>

      获取图集作品数据

    • getSlidesWorkInfo: <M extends TypeMode>(
          options: Omit<{ methodType: "合辑作品数据"; aweme_id: string }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DySlidesWork, M>>>

      获取合辑作品数据

    • getComments: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "评论数据";
                  aweme_id: string;
                  number?: number;
                  cursor?: number;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyWorkComments, M>>>

      获取评论数据

    • getCommentReplies: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "指定评论回复数据";
                  aweme_id: string;
                  comment_id: string;
                  number?: number;
                  cursor?: number;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<CommentReply, M>>>

      获取指定评论回复数据

    • getUserProfile: <M extends TypeMode>(
          options: Omit<
              { methodType: "用户主页数据"
              | "用户主页视频列表数据"
              | "直播间信息数据"; sec_uid: string },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyUserInfo, M>>>

      获取用户主页数据

    • getEmojiList: <M extends TypeMode>(
          options: Omit<{ methodType: "Emoji数据" }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyEmojiList, M>>>

      获取 Emoji 数据

    • getEmojiProList: <M extends TypeMode>(
          options: Omit<{ methodType: "动态表情数据" }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyEmojiProList, M>>>

      获取动态表情数据

    • getUserVideos: <M extends TypeMode>(
          options: Omit<
              { methodType: "用户主页数据"
              | "用户主页视频列表数据"
              | "直播间信息数据"; sec_uid: string },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyUserPostVideos, M>>>

      获取用户主页视频列表数据

    • getMusicInfo: <M extends TypeMode>(
          options: Omit<{ methodType: "音乐数据"; music_id: string }, "methodType"> & {
              typeMode?: TypeMode;
          } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyMusicWork, M>>>

      获取音乐数据

    • getSuggestWords: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "热点词数据"
                  | "搜索数据";
                  query: string;
                  number?: number;
                  search_id?: string;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DySuggestWords, M>>>

      获取热点词数据

    • 获取搜索数据

    • getLiveRoomInfo: <M extends TypeMode>(
          options: Omit<
              { methodType: "用户主页数据"
              | "用户主页视频列表数据"
              | "直播间信息数据"; sec_uid: string },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyUserLiveVideos, M>>>

      获取直播间信息

    • getDanmaku: <M extends TypeMode>(
          options: Omit<
              {
                  methodType: "弹幕数据";
                  aweme_id: string;
                  start_time?: number;
                  end_time?: number;
                  duration: number;
              },
              "methodType",
          > & { typeMode?: TypeMode } & { typeMode?: M },
          cookie: string,
          requestConfig?: RequestConfig,
      ) => Promise<ApiResponse<ConditionalReturnType<DyDanmakuList, M>>>

      获取弹幕数据