openShareSheet

Cập nhật lần cuối: 21/05/2025

import { openShareSheet } from "zmp-sdk/apis"; // >= 2.5.3

API cho phép ứng dụng mở giao diện chia sẻ để người dùng chia sẻ thông tin với bạn bè Zalo.

Ví dụ

Chia sẻ hình ảnh:

const data = await openShareSheet({
  type: "image",
  data: {
    imageUrls: ["http://dev.org.zads.zdn.vn/2a16c7fefbbb12e54baa"],
  },
});
console.log(data);

Chia sẻ liên kết:

const data = await openShareSheet({
  type: "link",
  data: {
    link: "http://news.zing.vn/Trung-uong-quyet-dinh-phuong-an-nhan-su-cap-cao-post632739.html",
    chatOnly: false,
  },
});
console.log(data);

Chia sẻ Official Account:

const data = await openShareSheet({
  type: "oa",
  data: {
    id: "765465772305886642",
  },
});
console.log(data);

Chia sẻ GIF:

const data = await openShareSheet({
  type: "gif",
  data: {
    imageUrl: "http://dev.org.zads.zdn.vn/2a16c7fefbbb12e54baa",
    gifUrl: "http://dev.org.zads.zdn.vn/fc88fe60c2252b7b7234",
    width: 480,
    height: 270,
  },
});
console.log(data);

Chia sẻ video:

const data = await openShareSheet({
  type: "video",
  data: {
    videoThumb: "http://dev.org.zads.zdn.vn/fc88fe60c2252b7b7234",
    videoUrl: "http://dev.org.zads.zdn.vn/fc88fe60c2252b7b7234",
    width: 480,
    height: 270,
  },
});
console.log(data);

Chia sẻ page hiện tại của Zalo Mini App:

const data = await openShareSheet({
  type: "zmp",
  data: {
    title: "My Zalo Mini App - HomePage",
    description: "Home page",
    thumbnail: "https://sample-videos.com/img/Sample-jpg-image-50kb.jpg",
  },
});
console.log(data);

Chia sẻ page hiện tại của Zalo Mini App thông qua deep link:

const data = await openShareSheet({
  type: "zmp_deep_link",
  data: {
    title: "My Zalo Mini App - HomePage",
    description: "Home page",
    thumbnail: "https://sample-videos.com/img/Sample-jpg-image-50kb.jpg",
  },
});
console.log(data);

Tham số

Truyền tham số vào API dưới dạng object chứa các thuộc tính:

Name	Type	Default	Description
type	"image" | "link" | "oa" | "gif" | "video" | "zmp" | "zmp_deep_link"		Nhận các giá trị sau: image: Chia sẻ hình ảnh. link: Chia sẻ liên kết. oa: Chia sẻ Official Account. gif: Chia sẻ ảnh động. video: Chia sẻ video. zmp: Chia sẻ page hiện tại của Zalo Mini App. zmp_deep_link: Chia sẻ page hiện tại của Zalo Mini App thông qua deep link (hỗ trợ từ API 2.25.7).
data	ShareData		Nội dung cần chia sẻ, tùy thuộc vào type.

ShareData

type='text'

Name	Type	Default	Description	Minimum Version
autoParseLink	boolean	false	Với giá trị 'true' url trong text sẽ được hiển thị dưới dạng thumbnail	2.39.0
description	string		Mô tả thêm cho nội dung cần chia sẻ	2.39.1
text	string		Nội dung văn bản cần chia sẻ	2.39.0

type='image'

Name	Type	Default	Description
imageUrls	string[]		Url của các hình ảnh cần chia sẻ

type='link'

Name	Type	Default	Description
chatOnly	boolean	true	Chỉ chia sẻ qua cửa sổ chat
link	string		Liên kết cần chia sẻ

type='oa'

Name	Type	Default	Description
id	string		Id của official account

type='gif'

Name	Type	Default	Description
gifUrl	string		Url ảnh động cần chia sẻ
height	number		Chiều cao
imageUrl	string		Url hình ảnh đại diện
width	number		Chiều rộng

type='video'

Name	Type	Default	Description
height	number		Chiều cao
videoThumb	string		Url thumbnail cho video
videoUrl	string		Url video
width	number		Chiều rộng

type='zmp'

Name	Type	Default	Description
description	string		Mô tả
path	string		Đường dẫn cần chia sẻ
thumbnail	string		Url thumbnail cho Zalo Mini App
title	string		Tiêu đề cần chia sẻ

type='zmp_deep_link'

Name	Type	Default	Description
description	string		Mô tả. Tối đa 400 ký tự
path	string		Đường dẫn cần chia sẻ, mặc định sẽ lấy theo đường dẫn hiện tại
thumbnail	string		Url thumbnail cho Zalo Mini App
title	string		Tiêu đề cần chia sẻ. Tối đa 100 ký tự

Kết quả trả về

API trả về Promise<OpenShareSheetReturns> chứa Promise chứa thông tin kết quả chia sẻ.

OpenShareSheetReturns

Name	Type	Default	Description
numberOfUser	number		Số lượng user nhận được bài chia sẻ trong trường hợp shareType=2.
shareType	'0' | '2' | '1'		Trạng thái bài chia sẻ: 0: Công khai. 1: Chỉ mình tôi. 2: Chia sẻ cho danh sách bạn.
status	'0' | '2' | '1'		Trạng thái chia sẻ: 0: User nhấn hủy/cancel bài viết. 1: Đăng bài viết thành công lên nhật ký. 2: Đăng bài viết thành công qua cửa sổ chat.