第三方应用开发 客户端API JS-SDK 媒体 从会话选择文件
从会话选择文件
最后更新:2023/01/30
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
从会话选择文件
最后更新:2023/01/30

目录

  • 从会话选择文件
  • 获取本地临时文件
  • 从会话选择文件

    接口说明:从企业微信会话中选择文件,用户选择文件之后,返回临时文件localId,可再调用获取本地临时文件接口以获取文件内容。

    调用说明

    必须先成功调用agentConfig,否则调用时会报“no permission”错误。
    当前成员必须在应用的可见范围之中,否则调用时会报“no permission”错误。

     

    代码示例

    wx.invoke('chooseMessageFile', {
    		count: 10,
    		type: 'image',
    	}, function(res) {
    		// 这里是回调函数 
    		if (res.err_msg == "chooseMessageFile:ok"){
    			const tempFiles = res.tempFiles
    		}
    });

     

    参数说明

    参数名类型必填说明
    countNumber最多可以选择的文件个数,可以 1~100,超出该范围时报错parameter error: invalid parameter.count
    typeString所选的文件的类型,默认值是'video_and_image',合法的类型值参见“参数type的说明”,不合法时报错parameter error: invalid parameter.type


    参数type的说明

    说明
    video只能选择视频文件
    image只能选择图片文件
    file可以选择除了图片和视频之外的其它的文件
    video_and_image可以同时选择视频与图片

     

    返回结果说明

    参数名类型说明
    tempFilesArray[Object]返回选择的文件的本地临时文件对象数组

    res.tempFiles 的结构

    参数名类型说明
    localIdString本地临时文件ID,仅在当前页面生命周期内可用,页面关闭后将会被清除
    sizeNumber本地临时文件大小,单位 B
    nameString选择的文件名称
    typeString选择的文件类型
    timeNumber选择的文件的会话发送时间,Unix时间戳

    res.type说明

    说明
    video视频文件
    image图片文件
    file除图片和视频的文件

     

    平台版本说明

    平台企业微信版本要求
    ios≥4.0.20
    android≥4.0.20
    win暂不支持
    mac暂不支持

    获取本地临时文件

    接口说明:调用从会话选择文件接口之后得到临时文件localId,可再调用本接口以获取文件内容。

    调用说明

    必须先成功调用agentConfig,否则调用时会报“no permission”错误。
    当前成员必须在应用的可见范围之中,否则调用时会报“no permission”错误。
    若localId不存在或者文件已删除,报错"no such file"。
    不支持超过20M的文件,超过时则报错"file exceed size limit"。

     

    代码示例

    wx.invoke('getLocalFileData', {
    		localId: '', // 文件的localID
    	}, function(res) {
    		// 这里是回调函数 
    		if (res.err_msg == "getLocalFileData:ok"){
    			var localData = res.localData; // localData是文件的base64数据
    		}
    });

     

    参数说明

    参数名类型必填说明
    localIdString本地临时文件ID,调用从会话选择文件接口之后获得,注意该localId仅在当前页面有效,页面关闭后即失效

     

    返回结果说明

    参数名类型说明
    localDataString文件内容的base64编码

     

    平台版本说明

    平台企业微信版本要求
    ios≥4.0.20
    android≥4.0.20
    win暂不支持
    mac暂不支持
    上一篇
    文件接口
    下一篇
    Wi-Fi