my.compressImage

2025-12-19 02:34

Compress large images to fulfill the size restrictions from some mini programs.

Supported types of mini programs: DSL, H5, H5+

Sample Code

DSL

copy
my.chooseImage({
  success: res => {
    my.compressImage({
      apFilePaths: res.apFilePaths,
      compressLevel: 1,
      success(res) {
        my.alert({ title: 'compressImage  Success', content: JSON.stringify(res, null, 2) })
      },
      fail(err) {
        my.alert({ title: 'compressImage  Failed', content: JSON.stringify(err, null, 2) })
      },
    });
  },
});

H5, H5+

copy
AlipayJSBridge.call('chooseImage', {}, function (res) {
  AlipayJSBridge.call('compressImage', {
    apFilePaths: res.apFilePaths,
    compressLevel: 1
  }, function (res) {
    my.alert({ title: 'AlipayJSBridge compressImage result', content: JSON.stringify(res, null, 2) });
  });
})

Parameters

Property	Type	Required	Description
apFilePaths	Array	Yes	An array of the image paths to be compressed.
compressLevel	int	No	The image quality after the compress. Valid values are: 0: Low quality 1: Medium quality 2: High quality 4: The quality depends on the network. When the network is Wi-Fi, the image is compressed to the high-quality image. Otherwise, the image is compressed to the medium-quality image. The default value is 4.
success	Function	No	The callback method that indicates a successful call.
fail	Function	No	The callback method that indicates a failed call.
complete	Function	No	The callback method that indicates the call is completed (this will be executed regardless of whether the call succeeds or fails).

Success callback function

Property	Type	Required	Description
apFilePaths	Array	Yes	The local file path of the compressed image.

Error code

Error Code	Error Message	Description
2	Compress failed	Failed to compress all images.
2	Invalid parameter	Failed to compress one of all images.