@green-api/greenapi-integration 0.7.2 → 0.8.1

package/dist/core/green-api.client.d.ts

@@ -1,4 +1,4 @@
-import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse } from "../types/types";
+import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse, SendInteractiveButtons, SendInteractiveButtonsReply, SendTextStatus, SendVoiceStatus, SendMediaStatus, GetStatusStatisticResponse } from "../types/types";
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
@@ -149,6 +149,76 @@ export declare class GreenApiClient {
      * ```
      */
     sendContact(message: SendContact): Promise<SendResponse>;
+    /**
+     * Sends interactive buttons to a WhatsApp chat.
+     * Supports copy, call, url, and reply button types.
+     *
+     * @param message - Interactive buttons message data
+     * @returns Promise resolving to send response
+     *
+     * @example
+     * ```typescript
+     * await client.sendInteractiveButtons({
+     *   chatId: "1234567890@c.us",
+     *   header: "Choose an option",
+     *   body: "Please select one of the following:",
+     *   footer: "Powered by GREEN-API",
+     *   buttons: [
+     *     {
+     *       type: "copy",
+     *       buttonId: "1",
+     *       buttonText: "Copy Code",
+     *       copyCode: "DISCOUNT50"
+     *     },
+     *     {
+     *       type: "call",
+     *       buttonId: "2",
+     *       buttonText: "Call Us",
+     *       phoneNumber: "1234567890"
+     *     },
+     *     {
+     *       type: "url",
+     *       buttonId: "3",
+     *       buttonText: "Visit Website",
+     *       url: "https://example.com"
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    sendInteractiveButtons(message: SendInteractiveButtons): Promise<SendResponse>;
+    /**
+     * Sends interactive reply buttons to a WhatsApp chat.
+     * These buttons return text to the chat when pressed.
+     *
+     * @param message - Interactive reply buttons message data
+     * @returns Promise resolving to send response
+     *
+     * @example
+     * ```typescript
+     * await client.sendInteractiveButtonsReply({
+     *   chatId: "1234567890@c.us",
+     *   header: "Survey",
+     *   body: "How satisfied are you with our service?",
+     *   footer: "Your feedback matters",
+     *   buttons: [
+     *     {
+     *       buttonId: "1",
+     *       buttonText: "Very Satisfied"
+     *     },
+     *     {
+     *       buttonId: "2",
+     *       buttonText: "Satisfied"
+     *     },
+     *     {
+     *       buttonId: "3",
+     *       buttonText: "Needs Improvement"
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    sendInteractiveButtonsReply(message: SendInteractiveButtonsReply): Promise<SendResponse>;
     /**
      * Reboots the GREEN-API instance.
      *
@@ -438,4 +508,84 @@ export declare class GreenApiClient {
      * @returns Promise resolving to array of outgoing messages
      */
     lastOutgoingMessages(minutes?: number): Promise<OutgoingJournalResponse[]>;
+    /**
+ * The method is aimed for sending a text status
+ *
+ * @param status - Status data containing message, backgroundColor (optional), font (optional), participants (optional)
+ * @returns Promise resolving to send response with message ID
+ *
+ * @example
+ * ```typescript
+ * await client.sendTextStatus({
+ *   message: "I use Green-API to send this status!",
+ *   backgroundColor: "#228B22", // optional
+ *   font: "SERIF", // optional
+ *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+ * });
+ * ```
+ */
+    sendTextStatus(status: SendTextStatus): Promise<SendResponse>;
+    /**
+     * The method is aimed for sending a voice status
+     *
+     * @param status - Status data containing urlFile, fileName, backgroundColor (optional), participants (optional)
+     * @returns Promise resolving to send response with message ID
+     *
+     * @example
+     * ```typescript
+     * await client.sendVoiceStatus({
+     *   urlFile: "https://my.site.com/img/horse.mp3",
+     *   fileName: "horse.mp3",
+     *   backgroundColor: "#228B22", // optional
+     *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+     * });
+     * ```
+     */
+    sendVoiceStatus(status: SendVoiceStatus): Promise<SendResponse>;
+    /**
+     * The method is aimed for sending a pictures or video status
+     *
+     * @param status - Message data containing urlFile, fileName, backgroundColor (optional), participants (optional)
+     * @returns Promise resolving to send response with message ID
+     *
+     * @example
+     * ```typescript
+     * await client.sendVoiceStatus({
+     *   urlFile: "https://my.site.com/img/horse.png",
+     *   fileName: "horse.png",
+     *   caption: "Little horse",
+     *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+     * });
+     * ```
+     */
+    sendMediaStatus(status: SendMediaStatus): Promise<SendResponse>;
+    /**
+     * The method returns the incoming status messages of the instance.
+     * In the default mode the incoming status messages for 24 hours are returned.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of incoming statuses
+     */
+    getIncomingStatuses(minutes?: number): Promise<IncomingJournalResponse[]>;
+    /**
+     * The method returns the outgoing statuses of the account.
+     * In the default mode the outgoing status messages for 24 hours are returned.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of outgoing statuses
+     */
+    getOutgoingStatuses(minutes?: number): Promise<OutgoingJournalResponse[]>;
+    /**
+     * The method returns an array of recipients marked sent/delivered/read for a given status.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param idMessage - Status message ID
+     * @returns Promise resolving to array participant, timestamp, status
+     */
+    getStatusStatistic(idMessage?: string): Promise<GetStatusStatisticResponse[]>;
 }

package/dist/core/green-api.client.js

@@ -241,6 +241,94 @@ class GreenApiClient {
             quotedMessageId: message.quotedMessageId,
         });
     }
+    /**
+     * Sends interactive buttons to a WhatsApp chat.
+     * Supports copy, call, url, and reply button types.
+     *
+     * @param message - Interactive buttons message data
+     * @returns Promise resolving to send response
+     *
+     * @example
+     * ```typescript
+     * await client.sendInteractiveButtons({
+     *   chatId: "1234567890@c.us",
+     *   header: "Choose an option",
+     *   body: "Please select one of the following:",
+     *   footer: "Powered by GREEN-API",
+     *   buttons: [
+     *     {
+     *       type: "copy",
+     *       buttonId: "1",
+     *       buttonText: "Copy Code",
+     *       copyCode: "DISCOUNT50"
+     *     },
+     *     {
+     *       type: "call",
+     *       buttonId: "2",
+     *       buttonText: "Call Us",
+     *       phoneNumber: "1234567890"
+     *     },
+     *     {
+     *       type: "url",
+     *       buttonId: "3",
+     *       buttonText: "Visit Website",
+     *       url: "https://example.com"
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    async sendInteractiveButtons(message) {
+        return this.makeRequest("post", "sendInteractiveButtons", {
+            chatId: message.chatId,
+            header: message.header,
+            body: message.body,
+            footer: message.footer,
+            buttons: message.buttons,
+            quotedMessageId: message.quotedMessageId,
+        });
+    }
+    /**
+     * Sends interactive reply buttons to a WhatsApp chat.
+     * These buttons return text to the chat when pressed.
+     *
+     * @param message - Interactive reply buttons message data
+     * @returns Promise resolving to send response
+     *
+     * @example
+     * ```typescript
+     * await client.sendInteractiveButtonsReply({
+     *   chatId: "1234567890@c.us",
+     *   header: "Survey",
+     *   body: "How satisfied are you with our service?",
+     *   footer: "Your feedback matters",
+     *   buttons: [
+     *     {
+     *       buttonId: "1",
+     *       buttonText: "Very Satisfied"
+     *     },
+     *     {
+     *       buttonId: "2",
+     *       buttonText: "Satisfied"
+     *     },
+     *     {
+     *       buttonId: "3",
+     *       buttonText: "Needs Improvement"
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    async sendInteractiveButtonsReply(message) {
+        return this.makeRequest("post", "sendInteractiveButtonsReply", {
+            chatId: message.chatId,
+            header: message.header,
+            body: message.body,
+            footer: message.footer,
+            buttons: message.buttons,
+            quotedMessageId: message.quotedMessageId,
+        });
+    }
     /**
      * Reboots the GREEN-API instance.
      *
@@ -626,5 +714,112 @@ class GreenApiClient {
     async lastOutgoingMessages(minutes) {
         return this.makeRequest("get", "lastOutgoingMessages", undefined, minutes ? { minutes } : undefined);
     }
+    /**
+ * The method is aimed for sending a text status
+ *
+ * @param status - Status data containing message, backgroundColor (optional), font (optional), participants (optional)
+ * @returns Promise resolving to send response with message ID
+ *
+ * @example
+ * ```typescript
+ * await client.sendTextStatus({
+ *   message: "I use Green-API to send this status!",
+ *   backgroundColor: "#228B22", // optional
+ *   font: "SERIF", // optional
+ *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+ * });
+ * ```
+ */
+    async sendTextStatus(status) {
+        return this.makeRequest("post", "sendTextStatus", {
+            message: status.message,
+            backgroundColor: status.backgroundColor,
+            font: status.font,
+            participants: status.participants,
+        });
+    }
+    /**
+     * The method is aimed for sending a voice status
+     *
+     * @param status - Status data containing urlFile, fileName, backgroundColor (optional), participants (optional)
+     * @returns Promise resolving to send response with message ID
+     *
+     * @example
+     * ```typescript
+     * await client.sendVoiceStatus({
+     *   urlFile: "https://my.site.com/img/horse.mp3",
+     *   fileName: "horse.mp3",
+     *   backgroundColor: "#228B22", // optional
+     *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+     * });
+     * ```
+     */
+    async sendVoiceStatus(status) {
+        return this.makeRequest("post", "sendVoiceStatus", {
+            urlFile: status.urlFile,
+            fileName: status.fileName,
+            backgroundColor: status.backgroundColor,
+            participants: status.participants,
+        });
+    }
+    /**
+     * The method is aimed for sending a pictures or video status
+     *
+     * @param status - Message data containing urlFile, fileName, backgroundColor (optional), participants (optional)
+     * @returns Promise resolving to send response with message ID
+     *
+     * @example
+     * ```typescript
+     * await client.sendVoiceStatus({
+     *   urlFile: "https://my.site.com/img/horse.png",
+     *   fileName: "horse.png",
+     *   caption: "Little horse",
+     *   participants: ["70000001234@c.us", "440000001234@c.us"] // optional
+     * });
+     * ```
+     */
+    async sendMediaStatus(status) {
+        return this.makeRequest("post", "sendMediaStatus", {
+            urlFile: status.urlFile,
+            fileName: status.fileName,
+            caption: status.caption,
+            participants: status.participants,
+        });
+    }
+    /**
+     * The method returns the incoming status messages of the instance.
+     * In the default mode the incoming status messages for 24 hours are returned.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of incoming statuses
+     */
+    async getIncomingStatuses(minutes) {
+        return this.makeRequest("get", "getIncomingStatuses", undefined, minutes ? { minutes } : undefined);
+    }
+    /**
+     * The method returns the outgoing statuses of the account.
+     * In the default mode the outgoing status messages for 24 hours are returned.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of outgoing statuses
+     */
+    async getOutgoingStatuses(minutes) {
+        return this.makeRequest("get", "getOutgoingStatuses", undefined, minutes ? { minutes } : undefined);
+    }
+    /**
+     * The method returns an array of recipients marked sent/delivered/read for a given status.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param idMessage - Status message ID
+     * @returns Promise resolving to array participant, timestamp, status
+     */
+    async getStatusStatistic(idMessage) {
+        return this.makeRequest("get", "getStatusStatistic", undefined, idMessage ? { idMessage } : undefined);
+    }
 }
 exports.GreenApiClient = GreenApiClient;

package/dist/types/types.d.ts

@@ -66,6 +66,28 @@ export interface SendPoll extends BaseMessage {
     options: PollOption[];
     multipleAnswers?: boolean;
 }
+export interface SendInteractiveButtons extends BaseMessage {
+    header?: string;
+    body: string;
+    footer?: string;
+    buttons: Array<{
+        type: "copy" | "call" | "url";
+        buttonId: string;
+        buttonText: string;
+        copyCode?: string;
+        phoneNumber?: string;
+        url?: string;
+    }>;
+}
+export interface SendInteractiveButtonsReply extends BaseMessage {
+    header?: string;
+    body: string;
+    footer?: string;
+    buttons: Array<{
+        buttonId: string;
+        buttonText: string;
+    }>;
+}
 export interface ForwardMessages {
     chatId: string;
     chatIdFrom: string;
@@ -741,3 +763,26 @@ export interface BaseUser {
     id: number | bigint | string;
     [key: string]: any;
 }
+export interface SendTextStatus {
+    message: string;
+    backgroundColor: string | null;
+    font: string | null;
+    participants: string[] | null;
+}
+export interface SendVoiceStatus {
+    urlFile: string;
+    fileName: string;
+    backgroundColor: string | null;
+    participants: string[] | null;
+}
+export interface SendMediaStatus {
+    urlFile: string;
+    fileName: string;
+    caption: string | null;
+    participants: string[] | null;
+}
+export interface GetStatusStatisticResponse {
+    timestamp: number;
+    participant: string;
+    status: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@green-api/greenapi-integration",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "description": "GREEN-API Integration library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",