ZCA-JS

https://tdung.gitbook.io/zca-js
Admin
ZCA-JS is an unofficial JavaScript library that provides APIs to help build Zalo chat bots using a...
Tokens:77,838
Snippets:848
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage Example for getContext

Source: https://tdung.gitbook.io/zca-js/api/getcontext.md

A simple JavaScript example demonstrating how to call the getContext method and log the result.

```javascript
console.log(api.getContext());
```

--------------------------------

### Get stickers by keyword

Source: https://tdung.gitbook.io/zca-js/api/getstickers.md

Example showing how to retrieve sticker IDs using the keyword 'xin chào' and handle the resulting promise.

```typescript
try {
    const keyword = "xin chào";
    const stickerIds = await api.getStickers(keyword);
    
    console.log(stickerIds);
} catch(e) {
    console.error(e);
}
```

--------------------------------

### Get Own ID Example

Source: https://tdung.gitbook.io/zca-js/api/getownid.md

Demonstrates how to retrieve and log the current instance's ID using api.getOwnId().

```javascript
console.log(api.getOwnId());
```

--------------------------------

### Usage Example for getFriendRecommendationsList

Source: https://tdung.gitbook.io/zca-js/api/getfriendrecommendations.md

Demonstrates how to call the getFriendRecommendationsList method and handle the returned promise.

```typescript
api.getFriendRecommendationsList()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### ChangeAccountAvatar Usage Example

Source: https://tdung.gitbook.io/zca-js/api/changeaccountavatar.md

Example showing how to call the changeAccountAvatar method with a file path and handle the promise result.

```typescript
api
    .changeAccountAvatar("./newAvatar.jpg")
    .then(console.log).catch(console.error);
```

--------------------------------

### ResetHiddenConversPin Usage Example

Source: https://tdung.gitbook.io/zca-js/api/resethiddenconverspin.md

A basic JavaScript example showing how to call the resetHiddenConversPin method and handle the promise resolution or rejection.

```javascript
api.resetHiddenConversPin()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Example Usage of api.sendVideo

Source: https://tdung.gitbook.io/zca-js/api/sendvideo.md

Demonstrates how to configure the options object and invoke the sendVideo method for a group thread.

```typescript
const options = {
    msg: "Video mẫu",
    videoUrl: "https://example.com/video.mp4",
    thumbtnailUrl: "https://example.com/videoThumbnail.jpg",
    duration: 5000,
    width: 1280;
    height: 720;
};
const threadId = "000000000000000";

api.sendVideo(options, threadId, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Retrieve Group Information Example

Source: https://tdung.gitbook.io/zca-js/api/getgroupinfo.md

Example demonstrating how to call api.getGroupInfo with a specific groupId and handle the promise result.

```typescript
const groupId = "0000000000000000000";
api.getGroupInfo(groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Example Usage of api.getQR

Source: https://tdung.gitbook.io/zca-js/api/getqr.md

Demonstrates a basic call to the getQR method to retrieve QR code information.

```typescript
console.log(api.getQR());
```

--------------------------------

### getGroupInviteBoxList Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getgroupinviteboxlist.md

Demonstrates how to call the getGroupInviteBoxList method and handle the resulting promise.

```typescript
api
    .getGroupInviteBoxList()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### fetchAccountInfo Usage Example

Source: https://tdung.gitbook.io/zca-js/api/fetchaccountinfo.md

Demonstrates how to call the fetchAccountInfo method and handle the returned promise using then and catch.

```typescript
api.fetchAccountInfo()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### UploadProductPhoto Usage Example

Source: https://tdung.gitbook.io/zca-js/api/uploadproductphoto.md

Demonstrates how to call the uploadProductPhoto method with a file path and handle the resulting promise.

```typescript
import { ThreadType } from "zca-js";

const groupId = "000000000000";

api
    .uploadProductPhoto("./product1.jpg")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### EnableGroupLink Usage Example

Source: https://tdung.gitbook.io/zca-js/api/enablegrouplink.md

Example showing how to call the enableGroupLink method with a specific groupId and handle the promise result.

```typescript
api.enableGroupLink("000000000000000000")
    .then(console.log).catch(console.error);
```

--------------------------------

### Create a Catalog Example

Source: https://tdung.gitbook.io/zca-js/api/createcatalog.md

Demonstrates how to invoke the createCatalog method with a specific catalog name and handle the resulting promise.

```typescript
api.createCatalog("Sản phẩm độc quyền")
    .then(console.log).catch(console.error);
```

--------------------------------

### Usage Example for getGroupLinkInfo

Source: https://tdung.gitbook.io/zca-js/api/getgrouplinkinfo.md

Demonstrates how to call the API with a Zalo invite link and handle the resulting promise.

```typescript
const inviteLink = "https://zalo.me/g/*******";
api.getGroupLinkInfo({ link: inviteLink })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Report User Example

Source: https://tdung.gitbook.io/zca-js/api/sendreport.md

Demonstrates how to report a user for fraud using the api.sendReport method.

```typescript
import { ReportReason } from "zca-js";
const userId = "0000000000000001"

api.sendReport(
    {
        reason: ReportReason.Fraud
    },
    userId
)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for api.getListBoard

Source: https://tdung.gitbook.io/zca-js/api/getlistboard.md

Demonstrates how to call the getListBoard method with a group ID and handle the resulting promise.

```typescript
const groupId = "0000000000000000";
api.getListBoard({}, groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### UpdateLang Usage Example

Source: https://tdung.gitbook.io/zca-js/api/updatelang.md

Demonstrates how to call api.updateLang with the English language option and handle the resulting promise.

```typescript
import { UpdateLangAvailableLanguages } from "zca-js";

api.updateLang(UpdateLangAvailableLanguages.EN)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for api.getAllGroups()

Source: https://tdung.gitbook.io/zca-js/api/getallgroups.md

Demonstrates how to invoke the getAllGroups method and handle the resulting promise using then and catch blocks.

```typescript
api.getAllGroups()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### leaveGroup Usage Example

Source: https://tdung.gitbook.io/zca-js/api/leavegroup.md

An example demonstrating how to call the leaveGroup method with a group ID and handle the promise resolution or rejection.

```typescript
api.leaveGroup("00000000000000000")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### createProductCatalog Usage Example

Source: https://tdung.gitbook.io/zca-js/api/createproductcatalog.md

Demonstrates how to invoke the createProductCatalog method with a payload containing product information and file paths.

```typescript
api
    .createProductCatalog({
        catalogId: "catelog_id",
        productName: "Sản phẩm mới",
        price: "500000",
        description: "Đây là sản phẩm mới",
        files: [
            "./san_pham_moi1.jpg",
            "./san_pham_moi2.jpg"
        ]
    })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### api.getBizAccount Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getbizaccount.md

Demonstrates how to invoke the getBizAccount method and handle the resulting Promise using then and catch.

```typescript
api.getBizAccount()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Create a new poll example

Source: https://tdung.gitbook.io/zca-js/api/createpoll.md

Demonstrates how to initialize the poll options and invoke the api.createPoll method.

```typescript
import type { CreatePollOptions } from "zca-js";

const groupId = "0000000000000000000";
const options: CreatePollOptions = {
    question: "Cuộc bình chọn mới!",
    options: [
        "Lựa chọn 1",
        "Lựa chọn 2",
        "Lựa chọn 3"
    ]
}

api.createPoll(options, groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Create a New Note Example

Source: https://tdung.gitbook.io/zca-js/api/createnote.md

Demonstrates how to invoke api.createNote with a title and pinAct option, handling the resulting promise.

```typescript
const groupId = "0000000000000000000";

api.createNote(
    {
        title: "ghi chú mới",
        pinAct: true
    },
    groupId,
)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Retrieve User Information Example

Source: https://tdung.gitbook.io/zca-js/api/getuserinfo.md

Demonstrates how to call api.getUserInfo with a specific userId and handle the resulting promise.

```typescript
const userId = "0000000000000000001";
api.getUserInfo(userId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### AddQuickMessage Usage Example

Source: https://tdung.gitbook.io/zca-js/api/addquickmessage.md

Demonstrates how to call the addQuickMessage method with a keyword, title, and an optional media path.

```typescript
await api.addQuickMessage({
    keyword: "hi",
    title: "Xin chào, mình có thể giúp gì cho bạn?",
    media: "./hello.png"
});
```

--------------------------------

### getGroupInviteBoxInfo Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getgroupinviteboxinfo.md

Demonstrates how to call the getGroupInviteBoxInfo method with a groupId and handle the resulting promise.

```typescript
api
    .getGroupInviteBoxInfo({
        groupId: "0000000000000000000"
    })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### getAllFriends Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getallfriends.md

Demonstrates how to call the getAllFriends method and handle the returned Promise using then and catch blocks.

```typescript
api.getAllFriends()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### api.getMute() Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getmute.md

Demonstrates how to call the getMute method and handle the resulting promise with console logging.

```typescript
api.getMute()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Disperse a Group Example

Source: https://tdung.gitbook.io/zca-js/api/dispersegroup.md

Example usage of the api.disperseGroup method, demonstrating how to pass a group ID and handle the resulting promise with then and catch blocks.

```typescript
const groupId = "0000000000000000000";

api.disperseGroup(groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for api.getPinConversations()

Source: https://tdung.gitbook.io/zca-js/api/getpinconversations.md

Demonstrates how to invoke the getPinConversations method and handle the resulting promise using .then() and .catch().

```typescript
api.getPinConversations()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Example Usage of updateSettings

Source: https://tdung.gitbook.io/zca-js/api/updatesettings.md

Demonstrates how to call the updateSettings method to change the AcceptCall setting to 'only friends'.

```typescript
import { UpdateSettingsType } from "zca-js";

api
    .updateSettings(UpdateSettingsType.AcceptCall, 2)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for sendDeliveredEvent

Source: https://tdung.gitbook.io/zca-js/api/senddeliveredevent.md

Demonstrates how to call sendDeliveredEvent with a list of messages and a specified ThreadType.

```typescript
import { ThreadType } from "zca-js";

const messages = [
    {
        msgId: "";
        cliMsgId: "";
        uidFrom: "";
        idTo: "";
        msgType: "";
        st: 1;
        at: 1;
        cmd: 1;
        ts: "";
    }
]

api.sendDeliveredEvent(false, messages, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### UpdateProductCatalog Usage Example

Source: https://tdung.gitbook.io/zca-js/api/updateproductcatalog.md

Demonstrates how to call the updateProductCatalog method with a payload containing product details and file paths.

```typescript
api
    .updateProductCatalog({
        catalogId: "catelog_id",
        productId: "product_id",
        productName: "Sản phẩm mới",
        price: "500000",
        description: "Đây là sản phẩm mới",
        files: [
            "./san_pham_moi1.jpg",
            "./san_pham_moi2.jpg"
        ]
    })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for sendTypingEvent

Source: https://tdung.gitbook.io/zca-js/api/sendtypingevent.md

Demonstrates how to invoke the sendTypingEvent method with required ThreadType and DestType parameters.

```typescript
import { ThreadType, DestType } from "zca-js";

api.sendTypingEvent(threadId, ThreadType.User, DestType.User)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### getQuickMessageList Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getquickmessagelist.md

Demonstrates how to call the getQuickMessageList method and handle the resulting promise with console logging.

```typescript
api.getQuickMessageList()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Send Sticker Example

Source: https://tdung.gitbook.io/zca-js/api/sendsticker.md

Demonstrates searching for a sticker by name and sending the first result to a specific user thread.

```typescript
import { ThreadType } from "zca-js"

// tìm sticker "hello", lấy và gửi sticker đầu tiên tìm thấy
api.getStickers("hello")
    .then(async (stickerIds) => {
        const stickersDetail = await api.getStickersDetail(stickerIds[0]);
        api.sendSticker(stickersDetail[0], "0000000000000001", ThreadType.User)
            .then(console.log)
            .catch(console.error);
    })
    .catch(console.error);
```

--------------------------------

### UploadAttachment Usage Example

Source: https://tdung.gitbook.io/zca-js/api/uploadattachment.md

Demonstrates how to call the uploadAttachment method with an array of file paths and a thread ID.

```typescript
import { ThreadType } from "zca-js";

const groupId = "000000000000";

api
    .uploadAttachment(
        [
            "./pic1.jpg",
            "./pic2.jpg",
        ],
        groupId,
        ThreadType.User
    )
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### CreateReminder Usage Example

Source: https://tdung.gitbook.io/zca-js/api/createreminder.md

Demonstrates how to schedule a reminder for 10:00 PM using the createReminder API.

```typescript
const startTime = new Date();
startTime.setHours(22, 0, 0, 0);

api
    .createReminder({
        title: "Đến hẹn đi ăn tối.",
        startTime: startTime.getTime()
    })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### GetAliasList Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getaliaslist.md

Demonstrates how to call the getAliasList method and handle the returned promise using then and catch blocks.

```javascript
api.getAliasList()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### UpdateLabels Usage Example

Source: https://tdung.gitbook.io/zca-js/api/updatelabels.md

Demonstrates how to retrieve existing labels, modify them, and submit the updated data using api.updateLabels.

```typescript
const labels = await api.getLabels();

const updatedLabelData = [...labels.labelData];
updatedLabelData[0].text = "Updated Label";

api.updateLabels({
    labelData: updatedLabelData,
    version: labels.version + 1,
})
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for addGroupDeputy

Source: https://tdung.gitbook.io/zca-js/api/addgroupdeputy.md

Demonstrates how to call the addGroupDeputy method with a member ID and a group ID.

```typescript
const memberId = "0000000000000000001";
const groupId = "0000000000000000000";

await api.addGroupDeputy(memberId, groupId);
```

--------------------------------

### Unblock User Example

Source: https://tdung.gitbook.io/zca-js/api/unblockuser.md

Demonstrates how to call the unblockUser method with a specific userId and handle the promise resolution or rejection.

```typescript
const userId = "0000000000000001"

api.unblockUser(userId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Send a Voice Message Example

Source: https://tdung.gitbook.io/zca-js/api/sendvoice.md

Demonstrates how to send a voice message to a user thread using the api.sendVoice method.

```typescript
const userId = "0000000000000001"

api.sendVoice(
    {
        voiceUrl: "https://example.com/voice.mp3"
    },
    userId
)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Listen to reaction events

Source: https://tdung.gitbook.io/zca-js/listener/reaction.md

Registers a listener for the reaction event and starts the listener service to begin processing events.

```javascript
api.listener.on("reaction", (reaction) => {
    console.log(reaction);
});

api.listener.start();
```

--------------------------------

### Usage Example for getFriendRequestStatus

Source: https://tdung.gitbook.io/zca-js/api/getfriendrequeststatus.md

Demonstrates how to call the getFriendRequestStatus method with a friend ID and handle the resulting promise.

```typescript
api.getFriendRequestStatus("000000000000000")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Lock a Poll Example

Source: https://tdung.gitbook.io/zca-js/api/lockpoll.md

Example usage of the api.lockPoll method using a poll ID.

```javascript
const pollId = 1;
api.lockPoll(pollId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for getGroupLinkDetail

Source: https://tdung.gitbook.io/zca-js/api/getgrouplinkdetail.md

Demonstrates how to call the getGroupLinkDetail method with a specific group ID and handle the promise result.

```typescript
const groupId = "0000000000000000000";
api.getGroupLinkDetail(groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### deleteProductCatalog Usage Example

Source: https://tdung.gitbook.io/zca-js/api/deleteproductcatalog.md

Demonstrates how to call the deleteProductCatalog method with a payload of product IDs and a catalog ID.

```typescript
api
    .deleteProductCatalog({
        productIds: ["productId1", "productId2"],
        catalogId: "catalogId1"
    })
    .then(console.log).catch(console.error);
```

--------------------------------

### Usage Example for getListReminder

Source: https://tdung.gitbook.io/zca-js/api/getlistreminder.md

Demonstrates how to call the API for a group thread by providing the group ID and the ThreadType.Group enum.

```typescript
import { ThreadType } from "zca-js";

const groupId = "0000000000000000";
api.getListReminder({}, groupId, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### RemoveUnreadMark Usage Example

Source: https://tdung.gitbook.io/zca-js/api/removeunreadmark.md

Example showing how to call removeUnreadMark with a specific thread ID and ThreadType.

```typescript
import { ThreadType } from "zca-js";

const threadId = "0000000000000000";

api.removeUnreadMark(threadId, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Change Group Owner Example

Source: https://tdung.gitbook.io/zca-js/api/changegroupowner.md

Example usage of the changeGroupOwner method to update the group owner.

```typescript
const memberId = "0000000000000000001";
const groupId = "0000000000000000000";

api
    .changeGroupOwner(memberId, groupId)
    .then(console.log).catch(console.error);
```

--------------------------------

### removeFriendAlias Usage Example

Source: https://tdung.gitbook.io/zca-js/api/removefriendalias.md

Example demonstrating how to call removeFriendAlias with a friend ID and handle the promise result.

```typescript
const friendId = "000000000000000000"

api.removeFriendAlias(friendId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### removeFriend Usage Example

Source: https://tdung.gitbook.io/zca-js/api/removefriend.md

Example showing how to call removeFriend with a friend ID and handle the resulting promise.

```typescript
api.removeFriend("0000000000000000000")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Undo Message Example

Source: https://tdung.gitbook.io/zca-js/api/undo.md

Demonstrates how to listen for messages and trigger an undo action if the message content contains the word 'undo'.

```typescript
// Thu hồi tin nhắn của bản thân nếu nó có chứa từ undo
api.listener.on("message", (message) => {
    const { content } = message.data;
    const isTextMessage = typeof content == "string";
    const shouldUndo = isTextMessage && content.includes("undo");
    if (message.isSelf && shouldUndo) {
        api.undo(message).then(console.log).catch(console.error);
    }
});
```

--------------------------------

### Update Group Name Example

Source: https://tdung.gitbook.io/zca-js/api/changegroupname.md

Example usage of the changeGroupName method to update a group's name.

```typescript
api
    .changeGroupName("Tên Mới", "0000000000000000000")
    .then(console.log).catch(console.error);
```

--------------------------------

### getPollDetail Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getpolldetail.md

Example showing how to call api.getPollDetail with a poll ID and handle the promise resolution or rejection.

```typescript
api.getPollDetail("poll_id_here")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Disable a Group Link Example

Source: https://tdung.gitbook.io/zca-js/api/disablegrouplink.md

Example usage of the api.disableGroupLink method to disable a specific group link by ID.

```typescript
api.disableGroupLink("00000000000000000")
    .then(console.log).catch(console.error);
```

--------------------------------

### Fetch Sticker Details by Keyword

Source: https://tdung.gitbook.io/zca-js/api/getstickersdetail.md

Example demonstrating how to search for stickers by keyword and retrieve details for the first five results.

```typescript
// lấy thông tin của 5 sticker đầu tiên tìm thấy với từ khóa
    
try {
    const keyword = "xin chào";
    const stickerIds = await api.getStickers(keyword);
    const stickersDetail = await api.getStickersDetail(stickerIds.slice(0, 5));
    
    console.log(stickersDetail);
} catch(e) {
    console.error(e);
}
```

--------------------------------

### removeGroupBlockedMember Usage Example

Source: https://tdung.gitbook.io/zca-js/api/removegroupblockedmember.md

Example demonstrating how to call removeGroupBlockedMember with a specific member ID and group ID, handling the promise with then and catch.

```typescript
const memberId = "000000000000000000";
const groupId = "000000000000000001";

api.removeGroupBlockedMember(memberId, groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage of api.changeFriendAlias

Source: https://tdung.gitbook.io/zca-js/api/changefriendalias.md

Example demonstrating how to call the changeFriendAlias method with an alias and friendId.

```typescript
const alias = "Tên gợi nhớ";
const friendId = "0000000000000000001";

api
    .changeFriendAlias(alias, friendId)
    .then(console.log).catch(console.error);
```

--------------------------------

### Usage of api.removeQuickMessage

Source: https://tdung.gitbook.io/zca-js/api/removequickmessage.md

Example demonstrating how to call the removeQuickMessage method with an array of item IDs.

```typescript
const itemIds = [1,2,3,4];

api.removeQuickMessage(itemIds)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### getCatalogList Usage Example

Source: https://tdung.gitbook.io/zca-js/api/getcataloglist.md

Demonstrates how to call the getCatalogList method with specific limit and page parameters, handling the resulting promise with console logging.

```typescript
api.getCatalogList({ limit: 20, page: 0 })
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Accepting a Friend Request

Source: https://tdung.gitbook.io/zca-js/api/acceptfriendrequest.md

Example usage of the api.acceptFriendRequest method with a specific user ID.

```typescript
const userId = "0000000000000000001";

await api.acceptFriendRequest(userId);
```

--------------------------------

### getSentFriendRequest Usage

Source: https://tdung.gitbook.io/zca-js/api/getsentfriendrequest.md

Basic usage example for calling the getSentFriendRequest method and handling the returned promise.

```typescript
api.getSentFriendRequest()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Example Usage of setMute

Source: https://tdung.gitbook.io/zca-js/api/setmute.md

Demonstrates how to call setMute to mute a group thread for four hours.

```typescript
import { ThreadType, MuteDuration, MuteAction } from "zca-js";

const threadIds = "000000000000000001";

api
    .setMute(
        {
            duration: MuteDuration.FOUR_HOURS,
            action: MuteAction.MUTE
        },
        threadIds,
        ThreadType.Group
    )
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for setHiddenConversations

Source: https://tdung.gitbook.io/zca-js/api/sethiddenconversations.md

Demonstrates how to hide a list of group threads using the setHiddenConversations method.

```typescript
import { ThreadType } from "zca-js";

const threadIds = ["000000000000000000", "000000000000000001"];

api.setHiddenConversations(true, threadIds, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### InviteUserToGroups Usage Example

Source: https://tdung.gitbook.io/zca-js/api/inviteusertogroups.md

Demonstrates how to call the inviteUserToGroups method with a single user ID and group ID, handling the resulting promise with console logging.

```typescript
const userId = "0000000000000000001";
const groupId = "0000000000000000002";
api.inviteUserToGroups(userId, groupId)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for api.lastOnline

Source: https://tdung.gitbook.io/zca-js/api/lastonline.md

Demonstrates how to call the lastOnline method with a user ID and handle the resulting promise using then and catch.

```typescript
api.lastOnline("00000000000000000")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Call api.getHiddenConversations()

Source: https://tdung.gitbook.io/zca-js/api/gethiddenconversations.md

Example of how to invoke the getHiddenConversations method and handle the returned promise using then and catch.

```typescript
api.getHiddenConversations()
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Call getReminderResponses

Source: https://tdung.gitbook.io/zca-js/api/getreminderresponses.md

Example of invoking the getReminderResponses method with a reminder ID and handling the resulting promise.

```typescript
api.getReminderResponses("reminderId1")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Usage Example for api.sendBankCard

Source: https://tdung.gitbook.io/zca-js/api/sendbankcard.md

Demonstrates how to invoke the sendBankCard method with a group thread ID and specific bank card details.

```typescript
import { ThreadType, BinBankCard } from "zca-js";

const groupId = "000000000000000";

api
    .sendBankCard(
        {
            binBank: BinBankCard.Techcombank,
            numAccBank: "19038393966015",
            nameAccBank: "TO CHAU TRI DUNG"
        },
        groupId,
        ThreadType.Group
    )
    .then(console.log).catch(console.error);
```

--------------------------------

### Đăng nhập với QRCode trong index.js

Source: https://tdung.gitbook.io/zca-js/dang-nhap/dang-nhap-voi-qrcode.md

Khởi tạo đối tượng Zalo với các tùy chọn cấu hình và thực hiện đăng nhập bằng mã QR. Sau khi đăng nhập thành công, phương thức listener.start() được gọi để bắt đầu lắng nghe các sự kiện.

```javascript
import { Zalo } from "zca-js";

const zalo = new Zalo({
    selfListen: false, // mặc định false, lắng nghe sự kiện của bản thân
    checkUpdate: true, // mặc định true, kiểm tra update
    logging: true // mặc định true, bật/tắt log mặc định của thư viện
});

const api = await zalo.loginQR({
    userAgent: "", // không bắt buộc
    qrPath: "" // đường dẫn lưu QR, mặc định ./qr.png
});

api.listener.start(); // bắt đầu lắng nghe sự kiện
```

--------------------------------

### Usage Example for addGroupBlockedMember

Source: https://tdung.gitbook.io/zca-js/api/addgroupblockedmember.md

Demonstrates how to call the addGroupBlockedMember method with a member ID and a group ID.

```typescript
const memberId = "0000000000000000001";
const groupId = "0000000000000000000";

await api.addGroupBlockedMember(memberId, groupId);
```

--------------------------------

### Mark a Group as Unread

Source: https://tdung.gitbook.io/zca-js/api/addunreadmark.md

Example of how to mark a group thread as unread using the addUnreadMark method.

```typescript
import { ThreadType } from "zca-js";

api
    .addUnreadMark("000000000000000000", ThreadType.Group)
    .then(console.log).catch(console.error);
```

--------------------------------

### Usage of updateHiddenConversPin

Source: https://tdung.gitbook.io/zca-js/api/updatehiddenconverspin.md

Example showing how to call the updateHiddenConversPin method with a pin string and handle the promise result.

```typescript
api
    .updateHiddenConversPin("9999")
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Adding Users to a Group

Source: https://tdung.gitbook.io/zca-js/api/addusertogroup.md

Examples demonstrating how to add a single member or an array of multiple members to a group using the addUserToGroup API.

```typescript
const groupId = "0000000000000000000";

// thêm 1 thành viên
const memberId = "0000000000000000001";
api
    .addUserToGroup(memberId, groupId)
    .then(console.log).catch(console.error);
    
// thêm nhiều thành viên
const memberIds = [
    "0000000000000000001",
    "0000000000000000002"
];
api
    .addUserToGroup(memberIds, groupId)
    .then(console.log).catch(console.error);
```

--------------------------------

### Cài đặt ZCA-JS với NPM

Source: https://tdung.gitbook.io/zca-js/bat-dau/gioi-thieu.md

Sử dụng trình quản lý gói NPM để cài đặt thư viện ZCA-JS vào dự án.

```bash
npm install zca-js
```

--------------------------------

### Usage Example for sendSeenEvent

Source: https://tdung.gitbook.io/zca-js/api/sendseenevent.md

Demonstrates how to construct the messages array and call the sendSeenEvent API with a thread ID and thread type.

```typescript
const messages = [
    {
        msgId: "";
        cliMsgId: "";
        uidFrom: "";
        idTo: "";
        msgType: "";
        st: 1;
        at: 1;
        cmd: 1;
        ts: "";
    }
]

const threadId = "000000000000000"

api.sendSeenEvent(messages, threadId, ThreadType.Group)
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### Undo a Friend Request

Source: https://tdung.gitbook.io/zca-js/api/undofriendrequest.md

Example usage of the api.undoFriendRequest method to cancel a friend request by providing the friendId.

```typescript
api.undoFriendRequest("000000000000000000")
    .then(console.log).catch(console.error);
```

--------------------------------

### editNote Usage Example

Source: https://tdung.gitbook.io/zca-js/api/editnote.md

Demonstrates how to call the editNote method with specific options and a group ID, handling the resulting promise with console logging.

```typescript
const groupId = "0000000000000000000";
const topicId = "";
const newTitle = "Tiêu đề mới"

api
    .editNote(
        {
            topicId: topicId,
            title: newTitle,
            pinAct: true
        },
        groupId
    )
    .then(console.log)
    .catch(console.error);
```

--------------------------------

### api.createCatalog(catalogName)

Source: https://tdung.gitbook.io/zca-js/api/createcatalog.md

Creates a new catalog with the specified name. Returns a promise that resolves to a CreateCatalogResponse object.

```APIDOC
## api.createCatalog(catalogName)

### Description
Creates a new catalog instance in the system.

### Parameters
- **catalogName** (string) - Required - The name of the catalog to be created.

### Return
- **Promise<CreateCatalogResponse>** - A promise that resolves to an object containing the created item and version information.

### Example
```typescript
api.createCatalog("Sản phẩm độc quyền")
    .then(console.log).catch(console.error);
```
```

--------------------------------

### ReviewPendingMemberRequest Usage Example

Source: https://tdung.gitbook.io/zca-js/api/reviewpendingmemberrequest.md

Demonstrates how to call the reviewPendingMemberRequest method with a list of member IDs and an approval flag.

```typescript
const groupId = "000000000000000";

api
    .reviewPendingMemberRequest(
        {
            members: ["000000000000001", "000000000000002"],
            isApprove: true,
        },
        groupId
    )
    .then(console.log).catch(console.error);
```

--------------------------------

### Add Reaction to Message Example

Source: https://tdung.gitbook.io/zca-js/api/addreaction.md

Demonstrates how to listen for incoming messages and automatically add a HAHA reaction when a specific condition is met.

```typescript
import { Reactions } from "zca-js";

// thả cảm xúc HAHA vào tất cả tin nhắn văn bản gửi đến có chứa ":)"
api.listener.on("message", (message) => {
    const { threadId, type } = message.data;
    const { content, msgId, cliMsgId } = message.data;

    const isTextMessage = typeof content == "string";
    const shouldReact = isTextMessage && content.includes(":)");
    
    const addReactionDestination = {
        data: { msgId, cliMsgId },
        threadId,
        type
    };
    
    // hoặc đưa cả message vào cũng được, vd: 
    // const addReactionDestination = message;
    
    if (!message.isSelf && shouldReact) {
        api
            .addReaction(Reactions.HAHA, addReactionDestination)
            .then(console.log).catch(console.error);
    }
});
```
Tokens:
Raw