Package com.foxinmy.weixin4j.qy.api

Class MediaApi

  • public class MediaApi
extends QyApi
    媒体相关API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    MediaType

    • Field Summary

      • Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

        weixinExecutor

    • Constructor Summary

      Constructors 
      Constructor Description
      MediaApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)  

    • Constructor Detail

      • MediaApi

        public MediaApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • uploadImage

        public String uploadImage​(InputStream is,
                          String fileName)
                   throws com.foxinmy.weixin4j.exception.WeixinException
        上传图文消息内的图片:用于上传图片到企业号服务端，接口返回图片url，请注意，该url仅可用于图文消息的发送， 且每个企业每天最多只能上传100张图片。
        Parameters:
        is - 图片数据
        fileName - 文件名
        Returns:
        图片url
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        上传图文消息内的图片

      • uploadMedia

        public com.foxinmy.weixin4j.model.media.MediaUploadResult uploadMedia​(int agentid,
                                                                      InputStream is,
                                                                      String fileName)
                                                               throws com.foxinmy.weixin4j.exception.WeixinException
        上传媒体文件:分别有图片（image）、语音（voice）、视频（video），普通文件(file)

        正常情况下返回{"type":"TYPE","media_id":"MEDIA_ID","created_at":123456789}, 否则抛出异常.

        Parameters:
        agentid - 企业应用ID(大于0时视为上传永久媒体文件)
        is - 媒体数据流
        fileName - 文件名
        Returns:
        上传到微信服务器返回的媒体标识
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MediaUploadResult, 上传临时素材文件说明, 上传永久素材文件说明

      • downloadMedia

        public com.foxinmy.weixin4j.model.media.MediaDownloadResult downloadMedia​(int agentid,
                                                                          String mediaId)
                                                                   throws com.foxinmy.weixin4j.exception.WeixinException
        下载媒体文件
        Parameters:
        agentid - 企业应用Id(大于0时视为获取永久媒体文件)
        mediaId - 媒体ID
        Returns:
        媒体下载结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MediaDownloadResult, 获取临时媒体说明, 获取永久媒体说明

      • uploadMaterialArticle

        public String uploadMaterialArticle​(int agentid,
                                    List<com.foxinmy.weixin4j.tuple.MpArticle> articles)
                             throws com.foxinmy.weixin4j.exception.WeixinException
        上传永久图文素材

        、新增的永久素材也可以在公众平台官网素材管理模块中看到,永久素材的数量是有上限的，请谨慎新增。图文消息素材和图片素材的上限为5000， 其他类型为1000

        Parameters:
        agentid - 企业应用的id
        articles - 图文列表
        Returns:
        上传到微信服务器返回的媒体标识
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        上传永久媒体素材, MpArticle

      • deleteMaterialMedia

        public com.foxinmy.weixin4j.http.weixin.ApiResult deleteMaterialMedia​(int agentid,
                                                                      String mediaId)
                                                               throws com.foxinmy.weixin4j.exception.WeixinException
        删除永久媒体素材
        Parameters:
        agentid - 企业应用ID
        mediaId - 媒体素材的media_id
        Returns:
        处理结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        删除永久媒体素材

      • downloadArticle

        public List<com.foxinmy.weixin4j.tuple.MpArticle> downloadArticle​(int agentid,
                                                                  String mediaId)
                                                           throws com.foxinmy.weixin4j.exception.WeixinException
        下载永久图文素材
        Parameters:
        agentid - 企业应用ID
        mediaId - 媒体素材的media_id
        Returns:
        图文列表
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MpArticle

      • updateMaterialArticle

        public String updateMaterialArticle​(int agentid,
                                    String mediaId,
                                    List<com.foxinmy.weixin4j.tuple.MpArticle> articles)
                             throws com.foxinmy.weixin4j.exception.WeixinException
        修改永久图文素材
        Parameters:
        agentid - 企业应用的id
        mediaId - 上传后的media_id
        articles - 图文列表
        Returns:
        操作结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        修改永久媒体素材, MpArticle

      • countMaterialMedia

        public com.foxinmy.weixin4j.model.media.MediaCounter countMaterialMedia​(int agentid)
                                                                 throws com.foxinmy.weixin4j.exception.WeixinException
        获取永久媒体素材的总数
        Parameters:
        agentid - 企业应用id
        Returns:
        总数对象
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MediaCounter, 获取素材总数

      • listMaterialMedia

        public com.foxinmy.weixin4j.model.media.MediaRecord listMaterialMedia​(int agentid,
                                                                      com.foxinmy.weixin4j.type.MediaType mediaType,
                                                                      com.foxinmy.weixin4j.model.paging.Pageable pageable)
                                                               throws com.foxinmy.weixin4j.exception.WeixinException
        获取媒体素材记录列表
        Parameters:
        agentid - 企业应用ID
        mediaType - 素材的类型，图片（image）、视频（video）、语音 （voice）、图文（news）、文件（file）
        pageable - 分页数据
        Returns:
        媒体素材的记录对象
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        MediaRecord, MediaType, MediaItem, Pageable, Pagedata, 获取素材列表

      • listAllMaterialMedia

        public List<com.foxinmy.weixin4j.model.media.MediaItem> listAllMaterialMedia​(int agentid,
                                                                             com.foxinmy.weixin4j.type.MediaType mediaType)
                                                                      throws com.foxinmy.weixin4j.exception.WeixinException
        获取全部的媒体素材
        Parameters:
        agentid - 企业应用id
        mediaType - 媒体类型
        Returns:
        素材列表
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException

      • batchUploadUsers

        public String batchUploadUsers​(List<User> users)
                        throws com.foxinmy.weixin4j.exception.WeixinException
        批量上传成员
        Parameters:
        users - 成员列表
        Returns:
        上传后的mediaId
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        批量任务

      • batchUploadParties

        public String batchUploadParties​(List<Party> parties)
                          throws com.foxinmy.weixin4j.exception.WeixinException
        批量上传部门
        Parameters:
        parties - 部门列表
        Returns:
        上传后的mediaId
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        批量任务