typed-wx-api/dist/api/mp/api/mp_media.d.ts

Typed Wechat API

/// <reference types="node" />
import { WxMpBase } from './mp_base';
/**
 * @internal
 */
export declare abstract class WxMpMedia extends WxMpBase {
    /**
     * 新增临时素材，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）
     *
     * 1、临时素材media_id是可复用的。
     * 2、媒体文件在微信后台保存时间为3天，即3天后media_id失效。
     * 3、上传临时素材的格式、大小限制与公众平台官网一致。
     * 图片（image）: 10M，支持PNG\JPEG\JPG\GIF格式
     * 语音（voice）：2M，播放长度不超过60s，支持AMR\MP3格式
     * 视频（video）：10MB，支持MP4格式
     * 缩略图（thumb）：64KB，支持JPG格式
     * @group 临时素材
     */
    uploadMedia(buffer: Buffer, type: 'image' | 'voice' | 'video' | 'thumb', filename: string): Promise<{
        type: "video" | "image" | "voice" | "thumb";
        media_id: string;
        created_at: number;
    }>;
    /**
     * 获取临时素材
     * 如果要获取视频素材, 请使用 getVideoMedia
     * @param media_id
     * @group 临时素材
     */
    getMedia(media_id: string): Promise<Buffer>;
    /**
     * 获取临时视频素材
     * @param media_id
     * @group 临时素材
     */
    getVideoMedia(media_id: string): Promise<{
        video_url: string;
    }>;
    /**
     * 获取高清语音素材
     * @group 临时素材
     */
    getMediaHD(media_id: string): Promise<Buffer>;
    /**
     * 上传图文消息内的图片获取URL
     * @group 临时素材
     */
    uploadImage(buffer: Buffer, filename: string): Promise<{
        url: string;
    }>;
}