cn.felord.api

Class MediaApi

java.lang.Object

cn.felord.api.MediaApi

public class MediaApi
extends Object

素材管理

Since:

2023 /6/10 17:09

Author:

dax

Field Summary

Fields

Modifier and Type	Field and Description
private InternalMediaApi	internalMediaApi

Constructor Summary

Constructors

Constructor and Description
MediaApi(retrofit2.Retrofit retrofit) Instantiates a new Media api.

Method Summary

Modifier and Type	Method and Description
okhttp3.ResponseBody	getMedia(String mediaId) 获取临时素材 TODO 待优化 需要根据不同的HTTP头进行处理
okhttp3.ResponseBody	getMediaJsSdk(String mediaId) 获取高清语音素材 TODO 待优化 需要根据不同的HTTP头进行处理
MediaJobResponse	getUploadByUrlResult(JobId jobId) 查询异步任务结果
private okhttp3.MultipartBody	toMultipartBody(MultipartResource resource)
MediaResponse	uploadAttachment(MediaTypeEnum mediaType, MediaAttachmentType attachmentType, MultipartResource resource) 上传附件资源
GenericResponse<String>	uploadByUrl(MediaUploadRequest request) 生成异步上传任务
MediaResponse	uploadImage(MultipartResource resource) 上传图片
MediaResponse	uploadMedia(MediaTypeEnum mediaType, MultipartResource resource) 上传临时素材
GenericResponse<String>	uploadPayImage(MultipartResource resource) 创建对外收款账户-提交图片

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

internalMediaApi

private final InternalMediaApi internalMediaApi

Constructor Detail

MediaApi

MediaApi(retrofit2.Retrofit retrofit)

Instantiates a new Media api.

Parameters:

retrofit - the retrofit

Method Detail

uploadAttachment

public MediaResponse uploadAttachment(MediaTypeEnum mediaType,
                                      MediaAttachmentType attachmentType,
                                      MultipartResource resource)

上传附件资源

素材上传得到media_id，该media_id仅三天内有效 media_id在同一企业内应用之间可以共享

Parameters:

mediaType - the media type

attachmentType - the attachment type

resource - the resource

Returns:

the media response

uploadMedia

public MediaResponse uploadMedia(MediaTypeEnum mediaType,
                                 MultipartResource resource)

上传临时素材

图片（image）：10MB，支持JPG,PNG格式 语音（voice） ：2MB，播放长度不超过60s，仅支持AMR格式 视频（video） ：10MB，支持MP4格式 普通文件（file）：20MB

Parameters:

mediaType - the media type

resource - the resource

Returns:

the media response

uploadImage

public MediaResponse uploadImage(MultipartResource resource)

上传图片

上传图片得到图片URL，该URL永久有效 返回的图片URL，仅能用于图文消息正文中的图片展示，或者给客户发送欢迎语等；若用于非企业微信环境下的页面，图片将被屏蔽。 每个企业每月最多可上传3000张图片，每天最多可上传1000张图片

Parameters:

resource - the resource

Returns:

the media response

getMedia

public okhttp3.ResponseBody getMedia(String mediaId)

获取临时素材 TODO 待优化 需要根据不同的HTTP头进行处理

Parameters:

mediaId - the media id

Returns:

the media

getMediaJsSdk

public okhttp3.ResponseBody getMediaJsSdk(String mediaId)

获取高清语音素材 TODO 待优化 需要根据不同的HTTP头进行处理

Parameters:

mediaId - the media id

Returns:

the media js sdk

uploadByUrl

public GenericResponse<String> uploadByUrl(MediaUploadRequest request)

生成异步上传任务

Parameters:

request - the request

Returns:

the single

getUploadByUrlResult

public MediaJobResponse getUploadByUrlResult(@Body
                                             JobId jobId)

查询异步任务结果

Parameters:

jobId - the job id

Returns:

the upload by url result

uploadPayImage

public GenericResponse<String> uploadPayImage(MultipartResource resource)

创建对外收款账户-提交图片

Parameters:

resource - the resource

Returns:

the generic response

toMultipartBody

private okhttp3.MultipartBody toMultipartBody(MultipartResource resource)