diff --git a/404.html b/404.html index bfd729efa4..7ec58737d8 100644 --- a/404.html +++ b/404.html @@ -14,13 +14,13 @@ - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/59764584.e365c4a5.js b/assets/js/59764584.2fff5709.js similarity index 75% rename from assets/js/59764584.e365c4a5.js rename to assets/js/59764584.2fff5709.js index 4da58a0e42..bbff6c0d47 100644 --- a/assets/js/59764584.e365c4a5.js +++ b/assets/js/59764584.2fff5709.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs_v_3=self.webpackChunkdocs_v_3||[]).push([[7927],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,u=k["".concat(d,".").concat(N)]||k[N]||m[N]||i;return a?n.createElement(u,l(l({ref:t},s),{},{components:a})):n.createElement(u,l({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"api_Client.Client",title:"Class: Client",sidebar_label:"Client",custom_edit_url:null},l=void 0,p={unversionedId:"api/classes/api_Client.Client",id:"api/classes/api_Client.Client",title:"Class: Client",description:"api/Client.Client",source:"@site/docs/api/classes/api_Client.Client.md",sourceDirName:"api/classes",slug:"/api/classes/api_Client.Client",permalink:"/docs/api/classes/api_Client.Client",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"api_Client.Client",title:"Class: Client",sidebar_label:"Client",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PREPROCESSORS",permalink:"/docs/api/enums/structures_preProcessors.PREPROCESSORS"},next:{title:"AddParticipantError",permalink:"/docs/api/classes/api_model_errors.AddParticipantError"}},d={},o=[{value:"Methods",id:"methods",level:2},{value:'B
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"acceptGroupJoinRequest",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"checkNumberStatus",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"cutMsgCache",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"getAllCommunities",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"getBlockedIds",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:'getCommonGroups
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"getMe",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"getStickerDecryptable",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:'getStoryViewers
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postVideoStatus
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:"prepEventData",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"promoteParticipant",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"react",id:"react",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"refresh",id:"refresh",level:3},{value:"Returns",id:"returns-152",level:4},{value:"registerWebhook",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-153",level:4},{value:"rejectGroupJoinRequest",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"removeAllListeners",id:"removealllisteners",level:3},{value:"Returns",id:"returns-155",level:4},{value:"removeLabel",id:"removelabel",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-156",level:4},{value:"removeListener",id:"removelistener",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeProduct",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeWebhook",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"reply",id:"reply",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:'reportSpam
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:"resizePage",id:"resizepage",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"revokeGroupInviteLink",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"sendAdvancedButtons",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAudio",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"sendBanner",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendButtons",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendContact",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"sendCustomProduct",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendEmoji",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"sendFile",id:"sendfile",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFileFromUrl",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendGiphy",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphyAsSticker",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendImage",id:"sendimage",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImageAsSticker",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:'sendImageAsStickerAsReply
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:"sendImageWithProduct",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendLinkWithAutoPreview",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendListMessage",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendLocation",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"sendMessageWithThumb",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMp4AsSticker",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:'sendMultipleContacts
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:"sendPaymentRequest",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPoll",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:'sendProduct
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:"sendPtt",id:"sendptt",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendRawWebpAsSticker",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:'sendRawWebpAsStickerAsReply
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:"sendReplyWithMentions",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendSeen",id:"sendseen",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendStickerfromUrl",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:'sendStickerfromUrlAsReply
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendText
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:"sendTextWithMentions",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendVCard",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVideoAsGif",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendYoutubeLink",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:'setChatBackgroundColourHex
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatEphemeral
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:"setChatState",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setGroupApprovalMode",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupDescription",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupEditToAdminsOnly",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupIcon",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIconByUrl",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:'setGroupTitle
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:"setGroupToAdminsOnly",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setMyName",id:"setmyname",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyStatus",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setPresence",id:"setpresence",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setProfilePic",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"simulateRecording",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateTyping",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"starMessage",id:"starmessage",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"syncContacts",id:"synccontacts",level:3},{value:"Returns",id:"returns-218",level:4},{value:'tagEveryone
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-219",level:4},{value:"testButtons",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"testCallback",id:"testcallback",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:'unmuteChat
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:"unstarMessage",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"updateWebhook",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"waitAllQEmpty",id:"waitallqempty",level:3},{value:"Returns",id:"returns-225",level:4},{value:"waitWhQIdle",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-226",level:4},{value:"Events",id:"events",level:2},{value:"onAck",id:"onack",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-227",level:4},{value:"onAddedToGroup",id:"onaddedtogroup",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAnyMessage",id:"onanymessage",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onBattery",id:"onbattery",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"onBroadcast",id:"onbroadcast",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"onButton",id:"onbutton",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"onCallState",id:"oncallstate",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"onChatDeleted",id:"onchatdeleted",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:'onChatOpened
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:'onChatState
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onContactAdded
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupChange",id:"ongroupchange",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onIncomingCall",id:"onincomingcall",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onLabel",id:"onlabel",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLiveLocation",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"onLogout",id:"onlogout",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"onMessage",id:"onmessage",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"onMessageDeleted",id:"onmessagedeleted",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"onParticipantsChanged",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"onPlugged",id:"onplugged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPollVote",id:"onpollvote",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:'onReaction
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:'onRemovedFromGroup
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"onStateChanged",id:"onstatechanged",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:'onStory
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/api_Client"},"api/Client"),".Client"),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"b-insiders"},"B ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"B"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.")),(0,r.kt)("p",null,"Use a raw payload within your open-wa session"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{any} returns: MessageId")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"acceptgroupjoinrequest"},"acceptGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"acceptGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Accepts a request from a recipient to join a group. Takes the message ID of the request message."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addlabel"},"addLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Adds label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipant"},"addParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Add participant to Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the contacts, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_CONTACT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"approvegroupjoinrequest"},"approveGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"approveGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Approves a group join request"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The contact id of the person who is requesting to join the group")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"archivechat"},"archiveChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"archiveChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean true => archive, false => unarchive")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked, false: didnt work (probably already in desired state)"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"autoreject"},"autoReject"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"autoReject"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."),(0,r.kt)("p",null,"Update: Due to the nature of MD, the host account will continue ringing."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional message to send to the calling account when their call is detected and rejected")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"awaitmessages"},"awaitMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"awaitMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"c"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_Collector.Collection"},(0,r.kt)("inlineCode",{parentName:"a"},"Collection")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">",">"),(0,r.kt)("p",null,"[FROM DISCORDJS]","\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"c")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Mesasge/Chat or Chat Id to base this message colletor on")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/structures_Collector.CollectorFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorFilter")),"<[",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"]",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The filter function to use")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/structures_Collector.AwaitMessagesOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"AwaitMessagesOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional options to pass to the internal collector")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_Collector.Collection"},(0,r.kt)("inlineCode",{parentName:"a"},"Collection")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checknumberstatus"},"checkNumberStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkNumberStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.NumberCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"NumberCheck")),">"),(0,r.kt)("p",null,"Checks if a number is a valid WA number"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.NumberCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"NumberCheck")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkreadreceipts-insiders"},"checkReadReceipts ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkReadReceipts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Check if a recipient has read receipts on."),(0,r.kt)("p",null,"This will only work if you have chats sent back and forth between you and the contact 1-1."),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Id of the contact with which you have an existing conversation with messages already.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"clearallchats"},"clearAllChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"clearAllChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"number A chat that has had a message after ts (epoch timestamp) will not be cleared.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"clearchat"},"clearChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"clearChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Delete all messages from the chat."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"contactblock"},"contactBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"contactBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Block contact"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"contactunblock"},"contactUnblock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"contactUnblock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Unblock contact"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcommunity-insiders"},"createCommunity ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCommunity"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"communitySubject"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"icon"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"existingGroups?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"newGroups?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5C"},"\\`${number}@g.us\\`\\")),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Create a new community"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The community name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communitySubject")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"icon")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL of a 1:1 ratio jpeg for the community icon")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"existingGroups")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"[]")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of existing group IDs, that are not already part of a community, to add to this new community.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newGroups?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup"},(0,r.kt)("inlineCode",{parentName:"a"},"NewCommunityGroup")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of new group objects that")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5C"},"\\`${number}@g.us\\`\\")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"creategroup"},"createGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contacts"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChatCreationResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatCreationResponse")),">"),(0,r.kt)("p",null,"Create a group and add contacts to it"),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"group name: 'New group'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contacts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChatCreationResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatCreationResponse")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createlabel-insiders"},"createLabel ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Adds label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.kt)("inlineCode",{parentName:"p"},'"58"'),")"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createmessagecollector"},"createMessageCollector"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createMessageCollector"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"c"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_MessageCollector.MessageCollector"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageCollector"))),(0,r.kt)("p",null,"Returns a new message collector for the chat which is related to the first parameter c"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"c")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Mesasge/Chat or Chat Id to base this message colletor on")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/structures_Collector.CollectorFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorFilter")),"<[",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"]",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A function that consumes a ","[Message]"," and returns a boolean which determines whether or not the message shall be collected.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/structures_Collector.CollectorOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_MessageCollector.MessageCollector"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageCollector"))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createnewproduct-insiders"},"createNewProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createNewProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"price"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"images"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"internalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isHidden?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Add a product to your catalog"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"price")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The price of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The 3-letter currenct code for the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"images")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional, the description of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the product for more information")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"internalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The internal/backoffice id of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isHidden?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not the product is shown publicly in your catalog")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("p",null,"product object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cutchatcache"},"cutChatCache"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cutChatCache"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"after"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"before"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } }",">"),(0,r.kt)("p",null,"This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.kt)("inlineCode",{parentName:"p"},"getAmountOfLoadedMessages")," to intelligently control the session message cache."),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"after"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"before"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cutmsgcache"},"cutMsgCache"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cutMsgCache"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.kt)("inlineCode",{parentName:"p"},"getAmountOfLoadedMessages")," to intelligently control the session message cache."),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"darkmode"},"darkMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"darkMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"activate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Start dark mode ","[NOW GENERALLY AVAILABLE]"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"activate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"true to activate dark mode, false to deactivate")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decryptmedia"},"decryptMedia"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decryptMedia"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"Decrypts a media message."),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"This can be the serialized MessageId or the whole Message object. It is advised to just use the serialized message ID.")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise<[[DataURL]]>")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deleteallstatus"},"deleteAllStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteAllStatus"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deleteallstories-restricted"},"deleteAllStories ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteAllStories"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Deletes all your existing stories."),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. True if it worked."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletechat"},"deleteChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Delete the conversation from your WA"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletemessage"},"deleteMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyLocal?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes message of given message id"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chat id from which to delete the message.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The specific message id of the message to be deleted")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyLocal")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false.")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"nothing"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestalechats"},"deleteStaleChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStaleChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"startingFrom?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.kt)("inlineCode",{parentName:"p"},"100")," then all chats from index ",(0,r.kt)("inlineCode",{parentName:"p"},"100")," onwards will be deleted."),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"startingFrom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.kt)("inlineCode",{parentName:"td"},"1000"))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestatus"},"deleteStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"statusesToDelete"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"statusesToDelete")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestory-restricted"},"deleteStory ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStory"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"statusesToDelete"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Consumes a list of id strings of stories to delete."),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"statusesToDelete")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"string [] ","|"," string an array of ids of stories to delete.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. True if it worked."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"demoteparticipant"},"demoteParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"demoteParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Demote Admin of Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"download"},"download"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"download"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"optionsOverride?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"A convinience method to download the DataURL of a file"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"optionsOverride")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can use this to override the ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"axios request config"))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"downloadfilewithcredentials"},"downloadFileWithCredentials"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"downloadFileWithCredentials"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"Download via the browsers authenticated session via URL."),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"base64 string (non-data url)"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"downloadprofilepicfrommessage"},"downloadProfilePicFromMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"downloadProfilePicFromMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"Download profile pics from the message object."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"}," const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"editmessage"},"editMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"editMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"NOTE: This is experimental, most accounts do not have access to this feature in their apps."),(0,r.kt)("p",null,"Edit an existing message"),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message ID to edit")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new text content")))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"editproduct-insiders"},"editProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"editProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"price?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"images?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"internalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isHidden?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Edit a product in your catalog"),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The catalog ID of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"price?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The price of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The 3-letter currenct code for the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"images?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional, the description of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the product for more information")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"internalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The internal/backoffice id of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isHidden?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not the product is shown publicly in your catalog")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("p",null,"product object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emitunreadmessages"},"emitUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emitUnreadMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"array of message IDs"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcerefocus"},"forceRefocus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceRefocus"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"This is a convinient method to click the ",(0,r.kt)("inlineCode",{parentName:"p"},"Use Here")," button in the WA web session."),(0,r.kt)("p",null,"Use this when STATE is ",(0,r.kt)("inlineCode",{parentName:"p"},"CONFLICT"),". You can read more about managing state here:"),(0,r.kt)("p",null,"Detecting Logouts"),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcestalemediaupdate-insiders"},"forceStaleMediaUpdate ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceStaleMediaUpdate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."),(0,r.kt)("p",null,"if you run this without a valid insiders key, it will return false and cause an error upon decryption."),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Message OR ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forceupdateconnectionstate"},"forceUpdateConnectionState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceUpdateConnectionState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"killBeforeReconnect?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"Forces the session to update the connection state."),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"killBeforeReconnect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"updated connection state"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forceupdatelivelocation"},"forceUpdateLiveLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceUpdateLiveLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),"[]",">"),(0,r.kt)("p",null,"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Id of the chat you want to force the phone to get the livelocation data for.")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," | boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forwardmessages"},"forwardMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forwardMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"skipMyMessages"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"Forward an array of messages to a specific chat using the message ids or Objects"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"this can be any mixture of message ids or message objects")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"skipMyMessages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This indicates whether or not to skip your own messages from the array")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gc"},"gc"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"gc"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"It calls the JavaScript garbage collector"),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Nothing."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchatids"},"getAllChatIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChatIds"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"retrieves all Chat Ids"),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"array of ","[ChatId]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchats"},"getAllChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessageOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"Retrieves all chats"),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessageOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of ","[Chat]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchatswithmessages"},"getAllChatsWithMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChatsWithMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessageOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Retrieves all chats with messages"),(0,r.kt)("p",null,"Please use ",(0,r.kt)("inlineCode",{parentName:"p"},"getAllUnreadMessages")," instead of this to see all messages indicated by the green dots in the chat."),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessageOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of ","[Chat]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallcommunities"},"getAllCommunities"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllCommunities"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5B%5D%5C"},"\\`${number}@g.us\\`[]\\")),(0,r.kt)("p",null,"Retrieve all commmunity Ids"),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5B%5D%5C"},"\\`${number}@g.us\\`[]\\")),(0,r.kt)("p",null,"array of group ids"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallcontacts"},"getAllContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Retrieves all contacts"),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"array of ","[Contact]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallgroups"},"getAllGroups"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllGroups"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessagesOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"Retrieve all groups"),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessagesOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of groups"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalllabels"},"getAllLabels"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllLabels"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),"[]",">"),(0,r.kt)("p",null,"Returns all labels and the corresponding tagged items."),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallmessagesinchat"},"getAllMessagesInChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllMessagesInChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all Messages in a chat that have been loaded within the WA web instance."),(0,r.kt)("p",null,"This does not load every single message in the chat history."),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallnewmessages"},"getAllNewMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllNewMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all new Messages. where isNewMsg==true"),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallunreadmessages"},"getAllUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllUnreadMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages. where ack==-1"),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getamountofloadedmessages"},"getAmountOfLoadedMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAmountOfLoadedMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbatterylevel"},"getBatteryLevel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBatteryLevel"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Retrieves Battery Level"),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockedids"},"getBlockedIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockedIds"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"retrieves an array of IDs of accounts blocked by the host account."),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbusinessprofile"},"getBusinessProfile"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBusinessProfile"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.BusinessProfile"},(0,r.kt)("inlineCode",{parentName:"a"},"BusinessProfile")),">"),(0,r.kt)("p",null,"Get the business info of a given contact id"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of business profile (i.e the number with @c.us)")))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.BusinessProfile"},(0,r.kt)("inlineCode",{parentName:"a"},"BusinessProfile")),">"),(0,r.kt)("p",null,"None"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbusinessprofilesproducts"},"getBusinessProfilesProducts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBusinessProfilesProducts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Find any product listings of the given number. Use this to query a catalog"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of business profile (i.e the number with @c.us)")))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"None"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchat"},"getChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Retrieves chat object of given contact id"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatbyid"},"getChatById"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatById"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Retrieves chat object of given contact id"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatwithnoncontacts"},"getChatWithNonContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatWithNonContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns a list of contact with whom the host number has an existing chat who are also not contacts."),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatsbylabel"},"getChatsByLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatsByLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'),(0,r.kt)("p",null,"This method is case insenstive and only works on business host accounts."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Label"))),(0,r.kt)("p",null,"The label name"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommongroups-insiders"},"getCommonGroups ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommonGroups"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[]",">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves the groups that you have in common with a contact"),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[]",">"),(0,r.kt)("p",null,"Promise returning an array of common groups {\nid:string,\ntitle:string\n}"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityadminids"},"getCommunityAdminIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityAdminIds"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community admin Ids"),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityadmins"},"getCommunityAdmins"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityAdmins"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community admins as Contact objects"),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityinfo"},"getCommunityInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata")),"[] }",">"),(0,r.kt)("p",null,"Returns the community metadata. Like group metadata but with a ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups")," property which is the group metadata of the community subgroups."),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata")),"[] }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityparticipantids"},"getCommunityParticipantIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityParticipantIds"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community members Ids"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityparticipants"},"getCommunityParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community members as Contact objects"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getconfig"},"getConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getConfig"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.ConfigObject"},(0,r.kt)("inlineCode",{parentName:"a"},"ConfigObject"))),(0,r.kt)("p",null,"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.ConfigObject"},(0,r.kt)("inlineCode",{parentName:"a"},"ConfigObject"))),(0,r.kt)("p",null,"SessionInfo"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getconnectionstate"},"getConnectionState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getConnectionState"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"Returns the connection state"),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcontact"},"getContact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getContact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),">"),(0,r.kt)("p",null,"Retrieves contact detail object of given contact id"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geteventsignature"},"getEventSignature"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getEventSignature"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"simpleListener?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"simpleListener?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))))),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getfeatures"},"getFeatures"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getFeatures"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgenerateduseragent"},"getGeneratedUserAgent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGeneratedUserAgent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"userA?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Get the generated user agent, this is so you can send it to the decryption module."),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"userA?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"String useragent of wa-web session"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgptarray"},"getGptArray"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGptArray"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"last?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"role"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"user"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"assistant"')," }[]",">"),(0,r.kt)("p",null,"Returns a properly formatted array of messages from to send to the openai api"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"last")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"10")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The amount of previous messages to retrieve. Defaults to 10")))),(0,r.kt)("h4",{id:"returns-74"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"role"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"user"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"assistant"')," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupadmins"},"getGroupAdmins"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupAdmins"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Get Admins of a Group"),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")))),(0,r.kt)("h4",{id:"returns-75"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupapprovalrequests"},"getGroupApprovalRequests"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupApprovalRequests"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Gets the contact IDs of members requesting approval to join the group"),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")))))),(0,r.kt)("h4",{id:"returns-76"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupinfo"},"getGroupInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns the title and description of a given group id."),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-77"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupinvitelink"},"getGroupInviteLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupInviteLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves an invite link for a group chat. returns false if chat is not a group."),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-78"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupmembers"},"getGroupMembers"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupMembers"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns group members ","[Contact]"," objects"),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")))))),(0,r.kt)("h4",{id:"returns-79"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupmembersid"},"getGroupMembersId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupMembersId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Retrieves group members as ","[Id]"," objects"),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-80"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethostnumber"},"getHostNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostNumber"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves the host device number. Use this number when registering for a license key"),(0,r.kt)("h4",{id:"returns-81"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getindicatednewmessages"},"getIndicatedNewMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIndicatedNewMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n')),(0,r.kt)("h4",{id:"returns-82"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinstanceid"},"getInstanceId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInstanceId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Get the INSTANCE_ID of the current session"),(0,r.kt)("h4",{id:"returns-83"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getisplugged"},"getIsPlugged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIsPlugged"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves whether or not phone is plugged in (i.e on charge)"),(0,r.kt)("h4",{id:"returns-84"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getissuelink"},"getIssueLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIssueLink"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Generate a pre-filled github issue link to easily report a bug"),(0,r.kt)("h4",{id:"returns-85"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getkickedgroups"},"getKickedGroups"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getKickedGroups"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("p",null,"Returns an array of group ids where the host account has been kicked"),(0,r.kt)("h4",{id:"returns-86"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlastmsgtimestamps"},"getLastMsgTimestamps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLastMsgTimestamps"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"t"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }[]",">"),(0,r.kt)("p",null,"Get an array of chatIds with their respective last message's timestamp."),(0,r.kt)("p",null,"This is useful for determining what chats are old/stale and need to be deleted."),(0,r.kt)("h4",{id:"returns-87"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"t"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlastseen"},"getLastSeen"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLastSeen"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"They have set it so you cannot see their last seen via privacy settings."),(0,r.kt)("li",{parentName:"ol"},"You do not have an existing chat with the contact."),(0,r.kt)("li",{parentName:"ol"},"The chatId is for a group\nIn both of those instances this method will return undefined.")),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chat.")))),(0,r.kt)("h4",{id:"returns-88"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"number timestamp when chat was last online or undefined."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlicenselink"},"getLicenseLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLicenseLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Generate a license link"),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-89"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlicensetype"},"getLicenseType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLicenseType"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model_config.LicenseType"},(0,r.kt)("inlineCode",{parentName:"a"},"LicenseType")),">"),(0,r.kt)("p",null,"Returns the the type of license key used by the session."),(0,r.kt)("h4",{id:"returns-90"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model_config.LicenseType"},(0,r.kt)("inlineCode",{parentName:"a"},"LicenseType")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlistenerqueues"},"getListenerQueues"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getListenerQueues"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"If you have set ",(0,r.kt)("inlineCode",{parentName:"p"},"onAnyMessage")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"onMessage")," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."),(0,r.kt)("h4",{id:"returns-91"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAck")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAddedToGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAnyMessage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onBattery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onBroadcast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onButton")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onCallState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatDeleted")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatOpened")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onContactAdded")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGlobalParticipantsChanged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGroupApprovalRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGroupChange")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onIncomingCall")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onLabel")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onLogout")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onMessage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onMessageDeleted")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onNewProduct")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onOrder")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onPlugged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onPollVote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onReaction")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRemovedFromGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onStateChanged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onStory")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getme"},"getMe"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMe"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object with all of your host device details"),(0,r.kt)("h4",{id:"returns-92"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessagebyid"},"getMessageById"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageById"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Retrieves message object of given message id"),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-93"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessageinfo-insiders"},"getMessageInfo ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.MessageInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageInfo")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Get the detailed message info for a group message sent out by the host account."),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message Id")))),(0,r.kt)("h4",{id:"returns-94"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.MessageInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageInfo")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessagereaders"},"getMessageReaders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageReaders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.kt)("inlineCode",{parentName:"p"},"t")," which represents the time at which that contact read the message."),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message id")))),(0,r.kt)("h4",{id:"returns-95"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmylastmessage"},"getMyLastMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyLastMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Retrieves the last message sent by the host account in any given chat or globally."),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"This is optional. If no chat Id is set then the last message sent by the host account will be returned.")))),(0,r.kt)("h4",{id:"returns-96"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object or ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," if the host account's last message could not be found."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmystatusarray"},"getMyStatusArray"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyStatusArray"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"returns-97"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmystoryarray-restricted"},"getMyStoryArray ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyStoryArray"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves all existing stories."),(0,r.kt)("p",null,"Only works with a Story License Key"),(0,r.kt)("h4",{id:"returns-98"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getorder-insiders"},"getOrder ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getOrder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves an order object"),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-99"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),">"),(0,r.kt)("p",null,"order object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpage"},"getPage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPage"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Page")),(0,r.kt)("h4",{id:"returns-100"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Page")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpolldata"},"getPollData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPollData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),">"),(0,r.kt)("p",null,"Returns poll data including results and votes."),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message id of the Poll")))),(0,r.kt)("h4",{id:"returns-101"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprocessstats"},"getProcessStats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProcessStats"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Get the stats of the current process and the corresponding browser process."),(0,r.kt)("h4",{id:"returns-102"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprofilepicfromserver"},"getProfilePicFromServer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProfilePicFromServer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves chat picture"),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-103"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Url of the chat picture or undefined if there is no picture for the chat."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsessionid"},"getSessionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSessionId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-104"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsessioninfo"},"getSessionInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSessionInfo"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.SessionInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"SessionInfo"))),(0,r.kt)("p",null,"Get the session info"),(0,r.kt)("h4",{id:"returns-105"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.SessionInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"SessionInfo"))),(0,r.kt)("p",null,"SessionInfo"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsingleproperty"},"getSingleProperty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSingleProperty"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"namespace"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"property"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."),(0,r.kt)("p",null,"Example - get message read state (ack):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n")),(0,r.kt)("h4",{id:"parameters-70"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"namespace")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_Client.namespace"},(0,r.kt)("inlineCode",{parentName:"a"},"namespace"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of the object to get from the specific namespace")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"property")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the single property key to get from the object.")))),(0,r.kt)("h4",{id:"returns-106"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"any If the property or the id cannot be found, it will return a 404"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsnapshot"},"getSnapshot"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSnapshot"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"Returns a PNG DataURL screenshot of the session"),(0,r.kt)("h4",{id:"parameters-71"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Chat ID to open before taking a snapshot")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Width of the viewport for the snapshot. Height also required if you want to resize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Height of the viewport for the snapshot. Width also required if you want to resize.")))),(0,r.kt)("h4",{id:"returns-107"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstarredmessages"},"getStarredMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStarredMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves the starred messages in a given chat"),(0,r.kt)("h4",{id:"parameters-72"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Chat ID to filter starred messages by")))),(0,r.kt)("h4",{id:"returns-108"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"message object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstatus"},"getStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"Get the status of a contact"),(0,r.kt)("h4",{id:"parameters-73"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"{string} to '",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"' returns: {id: string,status: string}")))),(0,r.kt)("h4",{id:"returns-109"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstickerdecryptable"},"getStickerDecryptable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStickerDecryptable"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."),(0,r.kt)("p",null,"If you run this without a valid insiders key, it will return false and cause an error upon decryption."),(0,r.kt)("h4",{id:"parameters-74"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message ID ",(0,r.kt)("inlineCode",{parentName:"td"},"message.id"))))),(0,r.kt)("h4",{id:"returns-110"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object OR ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstoryviewers-restricted"},"getStoryViewers ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStoryViewers"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: MessageId]"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]; }",">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves an array of user ids that have 'read' your story."),(0,r.kt)("h4",{id:"parameters-75"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The id of the story")))),(0,r.kt)("h4",{id:"returns-111"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: MessageId]"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]; }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettunnelcode"},"getTunnelCode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTunnelCode"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."),(0,r.kt)("h4",{id:"returns-112"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getunreadmessages"},"getUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getUnreadMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"use_unread_count"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.SingleChat"},(0,r.kt)("inlineCode",{parentName:"a"},"SingleChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[] & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChat"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages"),(0,r.kt)("h4",{id:"parameters-76"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"use_unread_count")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-113"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.SingleChat"},(0,r.kt)("inlineCode",{parentName:"a"},"SingleChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[] & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChat"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[]",">"),(0,r.kt)("p",null,"any"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getunsentmessages"},"getUnsentMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getUnsentMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"),(0,r.kt)("h4",{id:"returns-114"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getvcards"},"getVCards"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getVCards"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"msgId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Extracts vcards from a message.This works on messages of typ ",(0,r.kt)("inlineCode",{parentName:"p"},"vcard")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"multi_vcard")),(0,r.kt)("h4",{id:"parameters-77"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"msgId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string id of the message to extract the vcards from")))),(0,r.kt)("h4",{id:"returns-115"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"[vcard]"," "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n')),(0,r.kt)("p",null,"or false if no valid vcards found."),(0,r.kt)("p",null,"Please use ",(0,r.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/vcf"},"vcf")," to convert a vcard string into a json object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwaversion"},"getWAVersion"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWAVersion"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-116"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ghostforward"},"ghostForward"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ghostForward"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Ghost forwarding is like a normal forward but as if it were sent from the host phone ","[i.e it doesn't show up as forwarded.]","\nAny potential abuse of this method will see it become paywalled."),(0,r.kt)("h4",{id:"parameters-78"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-117"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"healthcheck"},"healthCheck"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"healthCheck"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.HealthCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"HealthCheck")),">"),(0,r.kt)("p",null,"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."),(0,r.kt)("h4",{id:"returns-118"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.HealthCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"HealthCheck")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iamadmin"},"iAmAdmin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"iAmAdmin"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("p",null,"Returns an array of group ids where the host account is admin"),(0,r.kt)("h4",{id:"returns-119"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"inviteinfo"},"inviteInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"inviteInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Get the details of a group through the invite link"),(0,r.kt)("h4",{id:"parameters-79"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This can be an invite link or invite code")))),(0,r.kt)("h4",{id:"returns-120"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ischatmuted"},"isChatMuted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isChatMuted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if a chat is muted"),(0,r.kt)("h4",{id:"parameters-80"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chat you want to check")))),(0,r.kt)("h4",{id:"returns-121"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat does not exist."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ischatonline"},"isChatOnline"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isChatOnline"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if a chat contact is online. Not entirely sure if this works with groups."),(0,r.kt)("p",null,"It will return ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the chat is ",(0,r.kt)("inlineCode",{parentName:"p"},"online"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat is ",(0,r.kt)("inlineCode",{parentName:"p"},"offline"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"PRIVATE")," if the privacy settings of the contact do not allow you to see their status and ",(0,r.kt)("inlineCode",{parentName:"p"},"NO_CHAT")," if you do not currently have a chat with that contact."),(0,r.kt)("h4",{id:"parameters-81"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-122"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconnected"},"isConnected"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConnected"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves if the phone is online. Please note that this may not be real time."),(0,r.kt)("h4",{id:"returns-123"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isgroupidunsafe-insiders"},"isGroupIdUnsafe ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isGroupIdUnsafe"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."),(0,r.kt)("h4",{id:"parameters-82"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat you want to deteremine is unsafe")))),(0,r.kt)("h4",{id:"returns-124"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isphonedisconnected"},"isPhoneDisconnected"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isPhoneDisconnected"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,'Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.kt)("inlineCode",{parentName:"p"},"true"),"."),(0,r.kt)("h4",{id:"returns-125"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"joingroupvialink"},"joinGroupViaLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"joinGroupViaLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"returnChatObj?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Joins a group via the invite link, code, or message"),(0,r.kt)("h4",{id:"parameters-83"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This param is the string which includes the invite link or code. The following work: - Follow this link to join my WA group: ",(0,r.kt)("a",{parentName:"td",href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"},"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ")," - ",(0,r.kt)("a",{parentName:"td",href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"},"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ")," - DHTGJUfFJAV9MxOpZO1fBZ If you have been removed from the group previously, it will return ",(0,r.kt)("inlineCode",{parentName:"td"},"401"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"returnChatObj?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata.")))),(0,r.kt)("h4",{id:"returns-126"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," Either false if it didn't work, or the group id."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"joinwebbeta"},"joinWebBeta"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"joinWebBeta"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"join"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Join or leave the wa web beta program. Will return true of operation was successful."),(0,r.kt)("h4",{id:"parameters-84"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"join")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"true to join the beta, false to leave")))),(0,r.kt)("h4",{id:"returns-127"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"kill"},"kill"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"kill"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"reason?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Shuts down the page and browser"),(0,r.kt)("h4",{id:"parameters-85"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"reason")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"MANUALLY_KILLED"'))))),(0,r.kt)("h4",{id:"returns-128"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"leavegroup"},"leaveGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"leaveGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes the host device from the group"),(0,r.kt)("h4",{id:"parameters-86"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-129"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listwebhooks"},"listWebhooks"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listWebhooks"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),"[]",">"),(0,r.kt)("p",null,"Retreives an array of webhook objects"),(0,r.kt)("h4",{id:"returns-130"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadallearliermessages"},"loadAllEarlierMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadAllEarlierMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load all messages in chat object from server."),(0,r.kt)("h4",{id:"parameters-87"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-131"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadandgetallmessagesinchat"},"loadAndGetAllMessagesInChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadAndGetAllMessagesInChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"loads and Retrieves all Messages in a chat"),(0,r.kt)("h4",{id:"parameters-88"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-132"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"any"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadearliermessages"},"loadEarlierMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadEarlierMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"),(0,r.kt)("h4",{id:"parameters-89"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-133"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message []"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadearliermessagestilldate"},"loadEarlierMessagesTillDate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadEarlierMessagesTillDate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"timestamp"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load all messages until a given timestamp in chat object from server."),(0,r.kt)("h4",{id:"parameters-90"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"timestamp")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"in seconds")))),(0,r.kt)("h4",{id:"returns-134"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logger"},"logger"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"logger"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Grab the logger for this session/process"),(0,r.kt)("h4",{id:"returns-135"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logout"},"logout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"logout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"preserveSessionData?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Logs out from the session."),(0,r.kt)("h4",{id:"parameters-91"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preserveSessionData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"skip session.data.json file invalidation Please be careful when using this as it can exit the whole process depending on your config")))),(0,r.kt)("h4",{id:"returns-136"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"markallread"},"markAllRead"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"markAllRead"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Runs sendSeen on all chats"),(0,r.kt)("h4",{id:"returns-137"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"markasunread"},"markAsUnread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"markAsUnread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets a chat status to unread. May be useful to get host's attention"),(0,r.kt)("h4",{id:"parameters-92"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-138"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metrics"},"metrics"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"metrics"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns some metrics of the session/page."),(0,r.kt)("h4",{id:"returns-139"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"middleware"},"middleware"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"middleware"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"useSessionIdInPath?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"PORT?"),"): (",(0,r.kt)("inlineCode",{parentName:"p"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Request"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ParamsDictionary"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ParsedQs"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Response"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"next"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"NextFunction"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n")),(0,r.kt)("p",null,"All requests need to be ",(0,r.kt)("inlineCode",{parentName:"p"},"POST")," requests. You use the API the same way you would with ",(0,r.kt)("inlineCode",{parentName:"p"},"client"),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"}," await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n")),(0,r.kt)("p",null,"as a request with a path:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n")),(0,r.kt)("p",null,"or as a request without a path:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n")),(0,r.kt)("p",null,"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n')),(0,r.kt)("h4",{id:"parameters-93"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useSessionIdInPath")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean Set this to true if you want to keep each session in it's own path. For example, if you have a session with id ",(0,r.kt)("inlineCode",{parentName:"td"},"host")," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.kt)("inlineCode",{parentName:"td"},"host"),". E.g ",(0,r.kt)("inlineCode",{parentName:"td"},"localhost:8082/sendText")," becomes ",(0,r.kt)("inlineCode",{parentName:"td"},"localhost:8082/host/sendText"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PORT?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-140"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"fn")),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"next"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h5",{id:"parameters-94"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Request"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParamsDictionary"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedQs"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Response"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"next")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextFunction"))))),(0,r.kt)("h5",{id:"returns-141"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mutechat-insiders"},"muteChat ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"muteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"muteDuration"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."),(0,r.kt)("h4",{id:"parameters-95"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation you want to mute")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"muteDuration")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatMuteDuration"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatMuteDuration"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatMuteDuration enum of the time you want this chat to be muted for.")))),(0,r.kt)("h4",{id:"returns-142"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked or error code or message"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onnewproduct-insiders"},"onNewProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onNewProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to new orders. Only works on business accounts"),(0,r.kt)("h4",{id:"parameters-96"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"product"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-143"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onorder-insiders"},"onOrder ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onOrder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to new orders. Only works on business accounts"),(0,r.kt)("h4",{id:"parameters-97"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"order"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-144"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pinchat"},"pinChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"pinChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pin"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Pin/Unpin chats"),(0,r.kt)("h4",{id:"parameters-98"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-145"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postimagestatus-restricted"},"postImageStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postImageStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Posts an image story."),(0,r.kt)("h4",{id:"parameters-99"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"data url string ",(0,r.kt)("inlineCode",{parentName:"td"},"data:[][;charset=][;base64],"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The caption for the story")))),(0,r.kt)("h4",{id:"returns-146"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttextstatus-restricted"},"postTextStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postTextStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"textRgba"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"backgroundRgba"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"font"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Sends a formatted text story."),(0,r.kt)("h4",{id:"parameters-100"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text to be displayed in the story")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textRgba")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backgroundRgba")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"font")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from: 0: Sans Serif 1: Serif 2: ",(0,r.kt)("a",{parentName:"td",href:"https://fonts.google.com/specimen/Norican"},"Norican Regular")," 3: ",(0,r.kt)("a",{parentName:"td",href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm"},"Bryndan Write")," 4: ",(0,r.kt)("a",{parentName:"td",href:"https://www.dafont.com/bebas-neue.font"},"Bebasneue Regular")," 5: ",(0,r.kt)("a",{parentName:"td",href:"https://www.fontsquirrel.com/fonts/oswald"},"Oswald Heavy"))))),(0,r.kt)("h4",{id:"returns-147"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postvideostatus-restricted"},"postVideoStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postVideoStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Posts a video story."),(0,r.kt)("h4",{id:"parameters-101"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"data url string ",(0,r.kt)("inlineCode",{parentName:"td"},"data:[][;charset=][;base64],"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The caption for the story")))),(0,r.kt)("h4",{id:"returns-148"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prepeventdata"},"prepEventData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prepEventData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"event"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"extras?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.EventPayload"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPayload"))),(0,r.kt)("h4",{id:"parameters-102"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"JsonObject"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"event")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"extras?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"JsonObject"))))),(0,r.kt)("h4",{id:"returns-149"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.EventPayload"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPayload"))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"promoteparticipant"},"promoteParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"promoteParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Promote Participant to Admin in Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-103"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-150"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"react"},"react"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"react"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"emoji"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"React to a message"),(0,r.kt)("h4",{id:"parameters-104"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to react to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emoji")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"1 single emoji to add to the message as a reacion")))),(0,r.kt)("h4",{id:"returns-151"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"refresh"},"refresh"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"refresh"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"),(0,r.kt)("h4",{id:"returns-152"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"registerwebhook"},"registerWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"registerWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"events"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"concurrency?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"The client can now automatically handle webhooks. Use this method to register webhooks."),(0,r.kt)("h4",{id:"parameters-105"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The webhook url")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"events")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"all"')),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of SimpleListener enums or ",(0,r.kt)("inlineCode",{parentName:"td"},"all")," (to register all possible listeners)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"concurrency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"5")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the amount of concurrent requests to be handled by the built in queue. Default is 5.")))),(0,r.kt)("h4",{id:"returns-153"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rejectgroupjoinrequest"},"rejectGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"rejectGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Rejects a group join request"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"})),(0,r.kt)("h4",{id:"parameters-106"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat id *")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The contact id of the person who is requesting to join the group *")))),(0,r.kt)("h4",{id:"returns-154"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removealllisteners"},"removeAllListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAllListeners"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-155"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelabel"},"removeLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-107"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-156"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelistener"},"removeListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"//////////////////////// LISTENERS"),(0,r.kt)("h4",{id:"parameters-108"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))))),(0,r.kt)("h4",{id:"returns-157"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Remove participant of Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-109"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0000000000-00000000@g.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"000000000000@c.us"))))),(0,r.kt)("h4",{id:"returns-158"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeproduct"},"removeProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Remove a product from the host account's catalog"),(0,r.kt)("h4",{id:"parameters-110"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the product")))),(0,r.kt)("h4",{id:"returns-159"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removewebhook"},"removeWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"webhookId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes a webhook."),(0,r.kt)("p",null,"Returns ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the webhook was found and removed. ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Retruns"))),(0,r.kt)("p",null,"boolean"),(0,r.kt)("h4",{id:"parameters-111"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webhookId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ID of the webhook")))),(0,r.kt)("h4",{id:"returns-160"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reply"},"reply"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sendSeen?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."),(0,r.kt)("h4",{id:"parameters-112"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string chatid")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string reply text")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the msg id to reply to.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sendSeen?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean If set to true, the chat will 'blue tick' all messages before sending the reply")))),(0,r.kt)("h4",{id:"returns-161"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," false if didn't work, otherwise returns message id."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reportspam-restricted"},"reportSpam ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reportSpam"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Report a contact for spam, block them and attempt to clear chat."),(0,r.kt)("h4",{id:"parameters-113"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-162"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resizepage"},"resizePage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"resizePage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."),(0,r.kt)("h4",{id:"parameters-114"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1920"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1080"))))),(0,r.kt)("h4",{id:"returns-163"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revokegroupinvitelink"},"revokeGroupInviteLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revokeGroupInviteLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Revokes the current invite link for a group chat. Any previous links will stop working"),(0,r.kt)("h4",{id:"parameters-115"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-164"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendadvancedbuttons"},"sendAdvancedButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendAdvancedButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"body"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"buttons"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"footer"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."),(0,r.kt)("p",{parentName:"admonition"},"THIS IS NOT WORKING FOR GROUPS YET."),(0,r.kt)("p",{parentName:"admonition"},"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.")),(0,r.kt)("p",null,"Send advanced buttons with media body. This is an insiders feature for MD accounts."),(0,r.kt)("p",null,"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."),(0,r.kt)("h4",{id:"parameters-116"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"body")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.LocationButtonBody"},(0,r.kt)("inlineCode",{parentName:"a"},"LocationButtonBody"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The body of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"buttons")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.AdvancedButton"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedButton")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of buttons - limit is 3!")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"footer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The footer of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Required if body is a file!!")))),(0,r.kt)("h4",{id:"returns-165"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendaudio"},"sendAudio"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendAudio"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send an audio file with the default audio player (not PTT/voice message)"),(0,r.kt)("h4",{id:"parameters-117"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")))),(0,r.kt)("h4",{id:"returns-166"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendbanner"},"sendBanner"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendBanner"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"base64"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a banner image"),(0,r.kt)("p",null,"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."),(0,r.kt)("h4",{id:"parameters-118"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"base64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"base64 encoded jpeg")))),(0,r.kt)("h4",{id:"returns-167"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendbuttons"},"sendButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"body"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"buttons"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"footer?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."),(0,r.kt)("p",{parentName:"admonition"},"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.")),(0,r.kt)("p",null,"Send generic quick reply buttons. This is an insiders feature for MD accounts."),(0,r.kt)("h4",{id:"parameters-119"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"body")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.LocationButtonBody"},(0,r.kt)("inlineCode",{parentName:"a"},"LocationButtonBody"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The body of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"buttons")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.Button"},(0,r.kt)("inlineCode",{parentName:"a"},"Button")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of buttons - limit is 3!")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title/header of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"footer?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The footer of the buttons message")))),(0,r.kt)("h4",{id:"returns-168"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendcontact"},"sendContact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendContact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."),(0,r.kt)("h4",{id:"parameters-120"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-169"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendcustomproduct"},"sendCustomProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendCustomProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productData"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Feature Currently only available with Premium License accounts."),(0,r.kt)("p",null,"Send a custom product to a chat. Please see CustomProduct for details."),(0,r.kt)("p",null,"Caveats:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"URL will not work (unable to click), you will have to send another message with the URL."),(0,r.kt)("li",{parentName:"ul"},'Recipient will see a thin banner under picture that says "Something went wrong"'),(0,r.kt)("li",{parentName:"ul"},"This will only work if you have at least 1 product already in your catalog"),(0,r.kt)("li",{parentName:"ul"},"Only works on Business accounts")),(0,r.kt)("h4",{id:"parameters-121"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.CustomProduct"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomProduct")))))),(0,r.kt)("h4",{id:"returns-170"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendemoji"},"sendEmoji"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendEmoji"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"emojiId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a discord emoji to a chat as a sticker"),(0,r.kt)("h4",{id:"parameters-122"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emojiId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The discord emoji id without indentifying chars. In discord you would write ",(0,r.kt)("inlineCode",{parentName:"td"},":who:"),", here use ",(0,r.kt)("inlineCode",{parentName:"td"},"who"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"message id of the message you want this sticker to reply to. {@license:insiders@}")))),(0,r.kt)("h4",{id:"returns-171"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendfile"},"sendFile"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendFile"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"),(0,r.kt)("p",null,"Please note that any file that resolves to mime-type ",(0,r.kt)("inlineCode",{parentName:"p"},"octet-stream")," will, by default, resolve to an MP4 file."),(0,r.kt)("p",null,"If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.kt)("a",{parentName:"p",href:"https://www.iana.org/assignments/media-types/media-types.xhtml"},"https://www.iana.org/assignments/media-types/media-types.xhtml")),(0,r.kt)("h4",{id:"parameters-123"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx With an ",(0,r.kt)("a",{parentName:"td",href:"https://gum.co/open-wa?tier=Insiders%20Program"},"INSIDERS LICENSE-KEY")," you can also tag people in groups with ",(0,r.kt)("inlineCode",{parentName:"td"},"@[number]"),". For example if you want to mention the user with the number ",(0,r.kt)("inlineCode",{parentName:"td"},"44771234567"),", just add ",(0,r.kt)("inlineCode",{parentName:"td"},"@44771234567")," in the caption.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file as a push to talk file.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false ","[INSIDERS]"," set this to try silent tag someone in the caption")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-172"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendfilefromurl"},"sendFileFromUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendFileFromUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a file by Url or custom options"),(0,r.kt)("h4",{id:"parameters-124"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"},"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string 'video.mp4'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file as a push to talk file.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-173"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendgiphy"},"sendGiphy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendGiphy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"giphyMediaUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-125"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"giphyMediaUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"},"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif")," => ",(0,r.kt)("a",{parentName:"td",href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"},"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")))),(0,r.kt)("h4",{id:"returns-174"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendgiphyassticker"},"sendGiphyAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendGiphyAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"giphyMediaUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a giphy GIF as an animated sticker."),(0,r.kt)("h4",{id:"parameters-126"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"giphyMediaUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"URL")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL ","|"," string This is the giphy media url and has to be in the format ",(0,r.kt)("inlineCode",{parentName:"td"},"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif")," or it can be just the id ",(0,r.kt)("inlineCode",{parentName:"td"},"RJKHjCAdsAfQPn03qQ"))))),(0,r.kt)("h4",{id:"returns-175"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimage"},"sendImage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a image to given chat, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-127"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false ","[INSIDERS]"," set this to try silent tag someone in the caption")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-176"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimageassticker"},"sendImageAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."),(0,r.kt)("h4",{id:"parameters-128"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata")))))),(0,r.kt)("h4",{id:"returns-177"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimageasstickerasreply-insiders"},"sendImageAsStickerAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageAsStickerAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"This function takes an image and sends it as a sticker to the recipient as a reply to another message."),(0,r.kt)("h4",{id:"parameters-129"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The recipient id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sticker metadata")))),(0,r.kt)("h4",{id:"returns-178"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimagewithproduct"},"sendImageWithProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageWithProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"bizNumber"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends product with image to chat"),(0,r.kt)("h4",{id:"parameters-130"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the caption you want to add to this message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bizNumber")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the @c.us number of the business account from which you want to grab the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the id of the product within the main catalog of the aforementioned business")))),(0,r.kt)("h4",{id:"returns-179"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlinkwithautopreview"},"sendLinkWithAutoPreview"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendLinkWithAutoPreview"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"thumbnail?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Automatically sends a link with the auto generated link preview. You can also add a custom message."),(0,r.kt)("h4",{id:"parameters-131"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string A link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Custom text as body of the message, this needs to include the link or it will be appended after the link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumbnail?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.")))),(0,r.kt)("h4",{id:"returns-180"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlistmessage"},"sendListMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendListMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sections"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"actionText"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."),(0,r.kt)("p",{parentName:"admonition"},"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE")),(0,r.kt)("p",null,"Send a list message. This will not work when being sent from business accounts!"),(0,r.kt)("h4",{id:"parameters-132"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sections")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.Section"},(0,r.kt)("inlineCode",{parentName:"a"},"Section")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Sections of rows for the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title of the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The description of the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"actionText")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The action text of the list message")))),(0,r.kt)("h4",{id:"returns-181"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlocation"},"sendLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"lat"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"lng"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"loc"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"address?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Note: ",(0,r.kt)("inlineCode",{parentName:"p"},"address")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"url")," are parameters available to insiders only."),(0,r.kt)("p",null,"Sends a location message to given chat"),(0,r.kt)("h4",{id:"parameters-133"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lat")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"latitude: '51.5074'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lng")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"longitude: '0.1278'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"loc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"location text: 'LONDON!'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"address text: '1 Regents Park!'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"address text link: '",(0,r.kt)("a",{parentName:"td",href:"https://example.com'"},"https://example.com'"))))),(0,r.kt)("h4",{id:"returns-182"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmessagewiththumb"},"sendMessageWithThumb"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMessageWithThumb"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"thumb"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a link to a chat that includes a link preview."),(0,r.kt)("h4",{id:"parameters-134"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link you want to send")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title of the link")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The long description of the link preview")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chat you want to send this message to.")))),(0,r.kt)("h4",{id:"returns-183"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmp4assticker"},"sendMp4AsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMp4AsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"processOptions?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."),(0,r.kt)("h4",{id:"parameters-135"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL, Base64, URL (string GET), Relative filepath (string), or Buffer of the mp4 file")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"processOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"Mp4StickerConversionProcessOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultProcessOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"message id of the message you want this sticker to reply to. {@license:insiders@}")))),(0,r.kt)("h4",{id:"returns-184"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmultiplecontacts-insiders"},"sendMultipleContacts ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMultipleContacts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactIds"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Sends multiple contacts as a single message"),(0,r.kt)("h4",{id:"parameters-136"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactIds")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-185"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendpaymentrequest"},"sendPaymentRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPaymentRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"amount"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"[UNTESTED - REQUIRES FEEDBACK]","\nSends a payment request message to given chat"),(0,r.kt)("h4",{id:"parameters-137"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"amount")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"number the amount to request in 1000 format (e.g \xa310 => 10000)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The 3 letter currency code")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string optional message to send with the payment request")))),(0,r.kt)("h4",{id:"returns-186"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendpoll"},"sendPoll"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPoll"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowMultiSelect?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a poll to a group chat"),(0,r.kt)("h4",{id:"parameters-138"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id - a group chat is required")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the name of the poll")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"an array of poll options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"A message to quote when sending the poll")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowMultiSelect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not to allow multiple selections. default false")))),(0,r.kt)("h4",{id:"returns-187"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendproduct-insiders"},"sendProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Send a product to a chat"),(0,r.kt)("h4",{id:"parameters-139"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chatId")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the product")))),(0,r.kt)("h4",{id:"returns-188"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"MessageID"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendptt"},"sendPtt"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPtt"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."),(0,r.kt)("h4",{id:"parameters-140"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"base64 data:image/xxx;base64,xxx or the path of the file you want to send.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")))),(0,r.kt)("h4",{id:"returns-189"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendrawwebpassticker"},"sendRawWebpAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendRawWebpAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"webpBase64"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"animated?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"You can use this to send a raw webp file."),(0,r.kt)("h4",{id:"parameters-141"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webpBase64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 The base64 string of the webp file. Not DataURl")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"animated")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Boolean Set to true if the webp is animated. Default ",(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-190"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendrawwebpasstickerasreply-insiders"},"sendRawWebpAsStickerAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendRawWebpAsStickerAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"webpBase64"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"animated?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"You can use this to send a raw webp file."),(0,r.kt)("h4",{id:"parameters-142"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"MessageId Message ID of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webpBase64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 The base64 string of the webp file. Not DataURl")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"animated")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Boolean Set to true if the webp is animated. Default ",(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-191"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendreplywithmentions"},"sendReplyWithMentions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendReplyWithMentions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"replyMessageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mentions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'),(0,r.kt)("h4",{id:"parameters-143"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"replyMessageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mentions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can optionally add an array of contact IDs to tag only specific people")))),(0,r.kt)("h4",{id:"returns-192"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendseen"},"sendSeen"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendSeen"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets a chat status to seen. Marks all messages as ack: 3"),(0,r.kt)("h4",{id:"parameters-144"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-193"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendstickerfromurl"},"sendStickerfromUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendStickerfromUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a sticker (including GIF) from a given URL"),(0,r.kt)("h4",{id:"parameters-145"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-194"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendstickerfromurlasreply-insiders"},"sendStickerfromUrlAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendStickerfromUrlAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Sends a sticker from a given URL"),(0,r.kt)("h4",{id:"parameters-146"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The recipient id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the image")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-195"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtext-restricted"},"sendText ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendText"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Sends a text message to given chat"),(0,r.kt)("p",null,"A license is ",(0,r.kt)("strong",{parentName:"p"},"NOT")," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."),(0,r.kt)("h4",{id:"parameters-147"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")))),(0,r.kt)("h4",{id:"returns-196"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtextwithmentions"},"sendTextWithMentions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendTextWithMentions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mentions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'),(0,r.kt)("h4",{id:"parameters-148"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mentions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can optionally add an array of contact IDs to tag only specific people")))),(0,r.kt)("h4",{id:"returns-197"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendvcard"},"sendVCard"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendVCard"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"vcard"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactNumber?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Send VCARD"),(0,r.kt)("h4",{id:"parameters-149"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vcard")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"vcard as a string, you can send multiple contacts vcard also.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The display name for the contact. Ignored on multiple vcards")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactNumber?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g: ",(0,r.kt)("inlineCode",{parentName:"td"},"4477777777777")," Ignored on multiple vcards")))),(0,r.kt)("h4",{id:"returns-198"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendvideoasgif"},"sendVideoAsGif"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendVideoAsGif"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a video to given chat as a gif, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-150"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))))),(0,r.kt)("h4",{id:"returns-199"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendyoutubelink"},"sendYoutubeLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendYoutubeLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"thumbnail?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."),(0,r.kt)("h4",{id:"parameters-151"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string A youtube link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Custom text as body of the message, this needs to include the link or it will be appended after the link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumbnail?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.")))),(0,r.kt)("h4",{id:"returns-200"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatbackgroundcolourhex-insiders"},"setChatBackgroundColourHex ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatBackgroundColourHex"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hex"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Set the wallpaper background colour"),(0,r.kt)("h4",{id:"parameters-152"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"'#FFF123'")))),(0,r.kt)("h4",{id:"returns-201"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatephemeral-insiders"},"setChatEphemeral ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatEphemeral"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ephemeral"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Turn the ephemeral setting in a chat to on or off"),(0,r.kt)("h4",{id:"parameters-153"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ID of the chat")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ephemeral")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.EphemeralDuration"},(0,r.kt)("inlineCode",{parentName:"a"},"EphemeralDuration"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")," to turn on the ephemeral setting to 1 day, ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," to turn off the ephemeral setting. Other options: ",(0,r.kt)("inlineCode",{parentName:"td"},"604800 \\| 7776000"))))),(0,r.kt)("h4",{id:"returns-202"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," true if the setting was set, ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat does not exist"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatstate"},"setChatState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatState"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets the chat state"),(0,r.kt)("h4",{id:"parameters-154"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatState"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatState"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-203"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupapprovalmode"},"setGroupApprovalMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupApprovalMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requireApproval"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Turn on or off the approval requirement for new members to join a group"),(0,r.kt)("h4",{id:"parameters-155"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requireApproval")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"set to true to turn on the approval requirement, false to turn off")))),(0,r.kt)("h4",{id:"returns-204"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupdescription"},"setGroupDescription"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupDescription"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the group chant description"),(0,r.kt)("h4",{id:"parameters-156"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The new group description")))),(0,r.kt)("h4",{id:"returns-205"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupedittoadminsonly"},"setGroupEditToAdminsOnly"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupEditToAdminsOnly"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyAdmins"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change who can and cannot edit a groups details"),(0,r.kt)("h4",{id:"parameters-157"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyAdmins")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group")))),(0,r.kt)("h4",{id:"returns-206"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupicon"},"setGroupIcon"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupIcon"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the icon for the group chat"),(0,r.kt)("h4",{id:"parameters-158"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"mailto:123123123123_1312313123@g.us"},"123123123123_1312313123@g.us")," The id of the group")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-207"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupiconbyurl"},"setGroupIconByUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupIconByUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the icon for the group chat"),(0,r.kt)("h4",{id:"parameters-159"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"mailto:123123123123_1312313123@g.us"},"123123123123_1312313123@g.us")," The id of the group")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))))),(0,r.kt)("h4",{id:"returns-208"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgrouptitle-insiders"},"setGroupTitle ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupTitle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Change the group chat title"),(0,r.kt)("h4",{id:"parameters-160"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The new group title")))),(0,r.kt)("h4",{id:"returns-209"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgrouptoadminsonly"},"setGroupToAdminsOnly"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupToAdminsOnly"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyAdmins"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change who can and cannot speak in a group"),(0,r.kt)("h4",{id:"parameters-161"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyAdmins")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group")))),(0,r.kt)("h4",{id:"returns-210"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmyname"},"setMyName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMyName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"newName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Set your profile name"),(0,r.kt)("p",null,"Please note, this does not work on business accounts!"),(0,r.kt)("h4",{id:"parameters-162"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"String new name to set for your profile")))),(0,r.kt)("h4",{id:"returns-211"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmystatus"},"setMyStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMyStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"newStatus"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"set your about me"),(0,r.kt)("h4",{id:"parameters-163"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newStatus")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"String new profile status")))),(0,r.kt)("h4",{id:"returns-212"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setpresence"},"setPresence"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setPresence"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"available"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Set presence to available or unavailable."),(0,r.kt)("h4",{id:"parameters-164"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"available")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);")))),(0,r.kt)("h4",{id:"returns-213"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setprofilepic"},"setProfilePic"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setProfilePic"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets the profile pic of the host number."),(0,r.kt)("h4",{id:"parameters-165"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string data url image string.")))),(0,r.kt)("h4",{id:"returns-214"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," success if true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"simulaterecording"},"simulateRecording"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"simulateRecording"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"on"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Simulate '...recording' in chat"),(0,r.kt)("h4",{id:"parameters-166"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"on")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"turn on similated recording, false to turn it off you need to manually turn this off.")))),(0,r.kt)("h4",{id:"returns-215"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"simulatetyping"},"simulateTyping"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"simulateTyping"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"on"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Simulate '...typing' in chat"),(0,r.kt)("h4",{id:"parameters-167"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"on")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"turn on similated typing, false to turn it off you need to manually turn this off.")))),(0,r.kt)("h4",{id:"returns-216"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"starmessage"},"starMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"starMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Star a message"),(0,r.kt)("h4",{id:"parameters-168"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to star")))),(0,r.kt)("h4",{id:"returns-217"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"synccontacts"},"syncContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"syncContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Syncs contacts with phone. This promise does not resolve so it will instantly return true."),(0,r.kt)("h4",{id:"returns-218"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tageveryone-insiders"},"tagEveryone ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"tagEveryone"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"formatting?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageBeforeTags?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Tags everyone in the group with a message"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Mention"))),(0,r.kt)("p",null,"to indicate the actual tag."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"@mention ")),(0,r.kt)("h4",{id:"parameters-169"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@g.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message to add under all of the tags")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"formatting?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The formatting of the tags. Use")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageBeforeTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"set to ",(0,r.kt)("inlineCode",{parentName:"td"},"true")," to show the message before all of the tags")))),(0,r.kt)("h4",{id:"returns-219"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"testbuttons"},"testButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"testButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.")),(0,r.kt)("p",null,"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"),(0,r.kt)("h4",{id:"parameters-170"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-220"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"testcallback"},"testCallback"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"testCallback"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"callbackToTest"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"testData"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Use this simple command to test firing callback events."),(0,r.kt)("h4",{id:"parameters-171"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callbackToTest")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"testData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-221"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the callback was not registered/does not exist"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unmutechat-insiders"},"unmuteChat ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"unmuteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Unmutes a conversation."),(0,r.kt)("h4",{id:"parameters-172"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-222"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked or error code or message"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unstarmessage"},"unstarMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"unstarMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Unstar a message"),(0,r.kt)("h4",{id:"parameters-173"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to unstar")))),(0,r.kt)("h4",{id:"returns-223"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updatewebhook"},"updateWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"webhookId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"events"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/api_Client.Client#removewebhook"},"removeWebhook"),"."),(0,r.kt)("p",null,"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."),(0,r.kt)("h4",{id:"parameters-174"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webhookId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"events")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"all"'))))),(0,r.kt)("h4",{id:"returns-224"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitallqempty"},"waitAllQEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitAllQEmpty"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"[]",">"),(0,r.kt)("p",null,"Wait for all queues to be empty"),(0,r.kt)("h4",{id:"returns-225"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitwhqidle"},"waitWhQIdle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitWhQIdle"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."),(0,r.kt)("h4",{id:"returns-226"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h2",{id:"events"},"Events"),(0,r.kt)("h3",{id:"onack"},"onAck"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAck"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to messages acknowledgement Changes"),(0,r.kt)("h4",{id:"parameters-175"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Message as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-227"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onaddedtogroup"},"onAddedToGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAddedToGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Fires callback with Chat object every time the host phone is added to a group."),(0,r.kt)("h4",{id:"parameters-176"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat (group chat) as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-228"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onanymessage"},"onAnyMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAnyMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to all new messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-177"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueOptions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Options"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"PQueue options. Set to ",(0,r.kt)("inlineCode",{parentName:"td"},"{}")," for default PQueue.")))),(0,r.kt)("h4",{id:"returns-229"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbattery"},"onBattery"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onBattery"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Listens to battery changes"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"}," This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"number"),(0,r.kt)("h4",{id:"parameters-178"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"battery"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-230"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbroadcast"},"onBroadcast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onBroadcast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to broadcast messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-179"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-231"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbutton"},"onButton"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onButton"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to button message responses"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-180"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-232"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oncallstate"},"onCallState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onCallState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to changes on call state"),(0,r.kt)("h4",{id:"parameters-181"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"call"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_call.Call"},(0,r.kt)("inlineCode",{parentName:"a"},"Call")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-233"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of call objects"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatdeleted"},"onChatDeleted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatDeleted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when a chat is deleted by the host account"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Chat"),(0,r.kt)("h4",{id:"parameters-182"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-234"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatopened-insiders"},"onChatOpened ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatOpened"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."),(0,r.kt)("h4",{id:"parameters-183"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ChatId as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-235"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatstate-insiders"},"onChatState ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to chat state, including when a specific user is recording and typing within a group chat."),(0,r.kt)("p",null,"Here is an example of the fired object:"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n')),(0,r.kt)("h4",{id:"parameters-184"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chatState"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatState"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatState")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-236"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oncontactadded-insiders"},"onContactAdded ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onContactAdded"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with contact id when a new contact is added on the host phone."),(0,r.kt)("h4",{id:"parameters-185"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-237"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onglobalparticipantschanged"},"onGlobalParticipantsChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGlobalParticipantsChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."),(0,r.kt)("h4",{id:"parameters-186"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"participantChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel"},(0,r.kt)("inlineCode",{parentName:"a"},"ParticipantChangedEventModel")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ParticipantChangedEventModel as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-238"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ongroupapprovalrequest"},"onGroupApprovalRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGroupApprovalRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listents to group approval requests. Emits a message object. Use it with ",(0,r.kt)("inlineCode",{parentName:"p"},"message.isGroupApprovalRequest()")," to check if it is a group approval request."),(0,r.kt)("h4",{id:"parameters-187"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"groupApprovalRequestMessage"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Message as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-239"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ongroupchange"},"onGroupChange"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGroupChange"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."),(0,r.kt)("h4",{id:"parameters-188"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"genericGroupChangeEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"GenericGroupChangeEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ParticipantChangedEventModel as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-240"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onincomingcall"},"onIncomingCall"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onIncomingCall"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to new incoming calls"),(0,r.kt)("h4",{id:"parameters-189"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"call"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_call.Call"},(0,r.kt)("inlineCode",{parentName:"a"},"Call")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-241"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of call request objects"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlabel"},"onLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to label change events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Label"),(0,r.kt)("h4",{id:"parameters-190"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"label"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-242"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlivelocation"},"onLiveLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLiveLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Listens to live locations from a chat that already has valid live locations"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Emits"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"")," LiveLocationChangedEvent"),(0,r.kt)("h4",{id:"parameters-191"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"the chat from which you want to subscribes to live location updates")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"liveLocationChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback that takes in a LiveLocationChangedEvent")))),(0,r.kt)("h4",{id:"returns-243"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean, if returns false then there were no valid live locations in the chat of chatId"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlogout"},"onLogout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLogout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"priority?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Listens to a log out event"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("h4",{id:"parameters-192"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"loggedOut?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks")))),(0,r.kt)("h4",{id:"returns-244"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onmessage"},"onMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to incoming messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-193"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueOptions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Options"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"PQueue options. Set to ",(0,r.kt)("inlineCode",{parentName:"td"},"{}")," for default PQueue.")))),(0,r.kt)("h4",{id:"returns-245"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onmessagedeleted"},"onMessageDeleted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onMessageDeleted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when a message is deleted by a recipient or the host account"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-194"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-246"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onparticipantschanged"},"onParticipantsChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onParticipantsChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"legacy?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"),(0,r.kt)("h4",{id:"parameters-195"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id: ",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxxx-yyyy@c.us"},"xxxxx-yyyy@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"participantChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel"},(0,r.kt)("inlineCode",{parentName:"a"},"ParticipantChangedEventModel")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"legacy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-247"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of participantChangedEvent"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onplugged"},"onPlugged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onPlugged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when host device is plugged/unplugged"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"boolean true if plugged, false if unplugged"),(0,r.kt)("h4",{id:"parameters-196"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"plugged"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-248"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onpollvote"},"onPollVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onPollVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to poll vote events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"PollData"),(0,r.kt)("h4",{id:"parameters-197"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"pollDate"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-249"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onreaction-insiders"},"onReaction ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onReaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to reaction add and change events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"ReactionEvent"),(0,r.kt)("h4",{id:"parameters-198"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"reactionEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_reactions.ReactionEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"ReactionEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-250"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onremovedfromgroup-insiders"},"onRemovedFromGroup ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onRemovedFromGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with Chat object every time the host phone is removed to a group."),(0,r.kt)("h4",{id:"parameters-199"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat (group chat) as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-251"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onstatechanged"},"onStateChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onStateChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to changes in state"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"STATE observable sream of states"),(0,r.kt)("h4",{id:"parameters-200"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"state"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-252"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onstory-restricted"},"onStory ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onStory"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Listens to when a contact posts a new story."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"e.g "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n")),(0,r.kt)("h4",{id:"parameters-201"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"story"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-253"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs_v_3=self.webpackChunkdocs_v_3||[]).push([[7927],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,u=k["".concat(d,".").concat(N)]||k[N]||m[N]||i;return a?n.createElement(u,l(l({ref:t},s),{},{components:a})):n.createElement(u,l({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=k;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p.mdxType="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"api_Client.Client",title:"Class: Client",sidebar_label:"Client",custom_edit_url:null},l=void 0,p={unversionedId:"api/classes/api_Client.Client",id:"api/classes/api_Client.Client",title:"Class: Client",description:"api/Client.Client",source:"@site/docs/api/classes/api_Client.Client.md",sourceDirName:"api/classes",slug:"/api/classes/api_Client.Client",permalink:"/docs/api/classes/api_Client.Client",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"api_Client.Client",title:"Class: Client",sidebar_label:"Client",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"PREPROCESSORS",permalink:"/docs/api/enums/structures_preProcessors.PREPROCESSORS"},next:{title:"AddParticipantError",permalink:"/docs/api/classes/api_model_errors.AddParticipantError"}},d={},o=[{value:"Methods",id:"methods",level:2},{value:'B
insiders
',id:"b-insiders",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"acceptGroupJoinRequest",id:"acceptgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"addLabel",id:"addlabel",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"addParticipant",id:"addparticipant",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"approveGroupJoinRequest",id:"approvegroupjoinrequest",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"archiveChat",id:"archivechat",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"autoReject",id:"autoreject",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"awaitMessages",id:"awaitmessages",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"checkNumberStatus",id:"checknumberstatus",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:'checkReadReceipts
insiders
',id:"checkreadreceipts-insiders",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"clearAllChats",id:"clearallchats",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"clearChat",id:"clearchat",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"contactBlock",id:"contactblock",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"contactUnblock",id:"contactunblock",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:'createCommunity
insiders
',id:"createcommunity-insiders",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"createGroup",id:"creategroup",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:'createLabel
insiders
',id:"createlabel-insiders",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"createMessageCollector",id:"createmessagecollector",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:'createNewProduct
insiders
',id:"createnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"cutChatCache",id:"cutchatcache",level:3},{value:"Returns",id:"returns-19",level:4},{value:"cutMsgCache",id:"cutmsgcache",level:3},{value:"Returns",id:"returns-20",level:4},{value:"darkMode",id:"darkmode",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-21",level:4},{value:"decryptMedia",id:"decryptmedia",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-22",level:4},{value:"deleteAllStatus",id:"deleteallstatus",level:3},{value:"Returns",id:"returns-23",level:4},{value:'deleteAllStories
restricted
',id:"deleteallstories-restricted",level:3},{value:"Returns",id:"returns-24",level:4},{value:"deleteChat",id:"deletechat",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-25",level:4},{value:"deleteMessage",id:"deletemessage",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-26",level:4},{value:"deleteStaleChats",id:"deletestalechats",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-27",level:4},{value:"deleteStatus",id:"deletestatus",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-28",level:4},{value:'deleteStory
restricted
',id:"deletestory-restricted",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"demoteParticipant",id:"demoteparticipant",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"download",id:"download",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"downloadFileWithCredentials",id:"downloadfilewithcredentials",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"downloadProfilePicFromMessage",id:"downloadprofilepicfrommessage",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"editMessage",id:"editmessage",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-34",level:4},{value:'editProduct
insiders
',id:"editproduct-insiders",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-35",level:4},{value:"emitUnreadMessages",id:"emitunreadmessages",level:3},{value:"Returns",id:"returns-36",level:4},{value:"forceRefocus",id:"forcerefocus",level:3},{value:"Returns",id:"returns-37",level:4},{value:'forceStaleMediaUpdate
insiders
',id:"forcestalemediaupdate-insiders",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-38",level:4},{value:"forceUpdateConnectionState",id:"forceupdateconnectionstate",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-39",level:4},{value:"forceUpdateLiveLocation",id:"forceupdatelivelocation",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-40",level:4},{value:"forwardMessages",id:"forwardmessages",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-41",level:4},{value:"gc",id:"gc",level:3},{value:"Returns",id:"returns-42",level:4},{value:"getAllChatIds",id:"getallchatids",level:3},{value:"Returns",id:"returns-43",level:4},{value:"getAllChats",id:"getallchats",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-44",level:4},{value:"getAllChatsWithMessages",id:"getallchatswithmessages",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-45",level:4},{value:"getAllCommunities",id:"getallcommunities",level:3},{value:"Returns",id:"returns-46",level:4},{value:"getAllContacts",id:"getallcontacts",level:3},{value:"Returns",id:"returns-47",level:4},{value:"getAllGroups",id:"getallgroups",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-48",level:4},{value:"getAllLabels",id:"getalllabels",level:3},{value:"Returns",id:"returns-49",level:4},{value:"getAllMessagesInChat",id:"getallmessagesinchat",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-50",level:4},{value:"getAllNewMessages",id:"getallnewmessages",level:3},{value:"Returns",id:"returns-51",level:4},{value:"getAllUnreadMessages",id:"getallunreadmessages",level:3},{value:"Returns",id:"returns-52",level:4},{value:"getAmountOfLoadedMessages",id:"getamountofloadedmessages",level:3},{value:"Returns",id:"returns-53",level:4},{value:"getBatteryLevel",id:"getbatterylevel",level:3},{value:"Returns",id:"returns-54",level:4},{value:"getBlockedIds",id:"getblockedids",level:3},{value:"Returns",id:"returns-55",level:4},{value:"getBusinessProfile",id:"getbusinessprofile",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-56",level:4},{value:"getBusinessProfilesProducts",id:"getbusinessprofilesproducts",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-57",level:4},{value:"getChat",id:"getchat",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-58",level:4},{value:"getChatById",id:"getchatbyid",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-59",level:4},{value:"getChatWithNonContacts",id:"getchatwithnoncontacts",level:3},{value:"Returns",id:"returns-60",level:4},{value:"getChatsByLabel",id:"getchatsbylabel",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-61",level:4},{value:'getCommonGroups
insiders
',id:"getcommongroups-insiders",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-62",level:4},{value:"getCommunityAdminIds",id:"getcommunityadminids",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-63",level:4},{value:"getCommunityAdmins",id:"getcommunityadmins",level:3},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-64",level:4},{value:"getCommunityInfo",id:"getcommunityinfo",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-65",level:4},{value:"getCommunityParticipantIds",id:"getcommunityparticipantids",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-66",level:4},{value:"getCommunityParticipants",id:"getcommunityparticipants",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-67",level:4},{value:"getConfig",id:"getconfig",level:3},{value:"Returns",id:"returns-68",level:4},{value:"getConnectionState",id:"getconnectionstate",level:3},{value:"Returns",id:"returns-69",level:4},{value:"getContact",id:"getcontact",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-70",level:4},{value:"getEventSignature",id:"geteventsignature",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-71",level:4},{value:"getFeatures",id:"getfeatures",level:3},{value:"Returns",id:"returns-72",level:4},{value:"getGeneratedUserAgent",id:"getgenerateduseragent",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-73",level:4},{value:"getGptArray",id:"getgptarray",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-74",level:4},{value:"getGroupAdmins",id:"getgroupadmins",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-75",level:4},{value:"getGroupApprovalRequests",id:"getgroupapprovalrequests",level:3},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-76",level:4},{value:"getGroupInfo",id:"getgroupinfo",level:3},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-77",level:4},{value:"getGroupInviteLink",id:"getgroupinvitelink",level:3},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-78",level:4},{value:"getGroupMembers",id:"getgroupmembers",level:3},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-79",level:4},{value:"getGroupMembersId",id:"getgroupmembersid",level:3},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-80",level:4},{value:"getHostNumber",id:"gethostnumber",level:3},{value:"Returns",id:"returns-81",level:4},{value:"getIndicatedNewMessages",id:"getindicatednewmessages",level:3},{value:"Returns",id:"returns-82",level:4},{value:"getInstanceId",id:"getinstanceid",level:3},{value:"Returns",id:"returns-83",level:4},{value:"getIsPlugged",id:"getisplugged",level:3},{value:"Returns",id:"returns-84",level:4},{value:"getIssueLink",id:"getissuelink",level:3},{value:"Returns",id:"returns-85",level:4},{value:"getKickedGroups",id:"getkickedgroups",level:3},{value:"Returns",id:"returns-86",level:4},{value:"getLastMsgTimestamps",id:"getlastmsgtimestamps",level:3},{value:"Returns",id:"returns-87",level:4},{value:"getLastSeen",id:"getlastseen",level:3},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-88",level:4},{value:"getLicenseLink",id:"getlicenselink",level:3},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-89",level:4},{value:"getLicenseType",id:"getlicensetype",level:3},{value:"Returns",id:"returns-90",level:4},{value:"getListenerQueues",id:"getlistenerqueues",level:3},{value:"Returns",id:"returns-91",level:4},{value:"getMe",id:"getme",level:3},{value:"Returns",id:"returns-92",level:4},{value:"getMessageById",id:"getmessagebyid",level:3},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-93",level:4},{value:'getMessageInfo
insiders
',id:"getmessageinfo-insiders",level:3},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-94",level:4},{value:"getMessageReaders",id:"getmessagereaders",level:3},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-95",level:4},{value:"getMyLastMessage",id:"getmylastmessage",level:3},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-96",level:4},{value:"getMyStatusArray",id:"getmystatusarray",level:3},{value:"Returns",id:"returns-97",level:4},{value:'getMyStoryArray
restricted
',id:"getmystoryarray-restricted",level:3},{value:"Returns",id:"returns-98",level:4},{value:'getOrder
insiders
',id:"getorder-insiders",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-99",level:4},{value:"getPage",id:"getpage",level:3},{value:"Returns",id:"returns-100",level:4},{value:"getPollData",id:"getpolldata",level:3},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-101",level:4},{value:"getProcessStats",id:"getprocessstats",level:3},{value:"Returns",id:"returns-102",level:4},{value:"getProfilePicFromServer",id:"getprofilepicfromserver",level:3},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-103",level:4},{value:"getSessionId",id:"getsessionid",level:3},{value:"Returns",id:"returns-104",level:4},{value:"getSessionInfo",id:"getsessioninfo",level:3},{value:"Returns",id:"returns-105",level:4},{value:"getSingleProperty",id:"getsingleproperty",level:3},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-106",level:4},{value:"getSnapshot",id:"getsnapshot",level:3},{value:"Parameters",id:"parameters-71",level:4},{value:"Returns",id:"returns-107",level:4},{value:"getStarredMessages",id:"getstarredmessages",level:3},{value:"Parameters",id:"parameters-72",level:4},{value:"Returns",id:"returns-108",level:4},{value:"getStatus",id:"getstatus",level:3},{value:"Parameters",id:"parameters-73",level:4},{value:"Returns",id:"returns-109",level:4},{value:"getStickerDecryptable",id:"getstickerdecryptable",level:3},{value:"Parameters",id:"parameters-74",level:4},{value:"Returns",id:"returns-110",level:4},{value:'getStoryViewers
restricted
',id:"getstoryviewers-restricted",level:3},{value:"Parameters",id:"parameters-75",level:4},{value:"Returns",id:"returns-111",level:4},{value:"getTunnelCode",id:"gettunnelcode",level:3},{value:"Returns",id:"returns-112",level:4},{value:"getUnreadMessages",id:"getunreadmessages",level:3},{value:"Parameters",id:"parameters-76",level:4},{value:"Returns",id:"returns-113",level:4},{value:"getUnsentMessages",id:"getunsentmessages",level:3},{value:"Returns",id:"returns-114",level:4},{value:"getVCards",id:"getvcards",level:3},{value:"Parameters",id:"parameters-77",level:4},{value:"Returns",id:"returns-115",level:4},{value:"getWAVersion",id:"getwaversion",level:3},{value:"Returns",id:"returns-116",level:4},{value:"ghostForward",id:"ghostforward",level:3},{value:"Parameters",id:"parameters-78",level:4},{value:"Returns",id:"returns-117",level:4},{value:"healthCheck",id:"healthcheck",level:3},{value:"Returns",id:"returns-118",level:4},{value:"iAmAdmin",id:"iamadmin",level:3},{value:"Returns",id:"returns-119",level:4},{value:"inviteInfo",id:"inviteinfo",level:3},{value:"Parameters",id:"parameters-79",level:4},{value:"Returns",id:"returns-120",level:4},{value:"isChatMuted",id:"ischatmuted",level:3},{value:"Parameters",id:"parameters-80",level:4},{value:"Returns",id:"returns-121",level:4},{value:"isChatOnline",id:"ischatonline",level:3},{value:"Parameters",id:"parameters-81",level:4},{value:"Returns",id:"returns-122",level:4},{value:"isConnected",id:"isconnected",level:3},{value:"Returns",id:"returns-123",level:4},{value:'isGroupIdUnsafe
insiders
',id:"isgroupidunsafe-insiders",level:3},{value:"Parameters",id:"parameters-82",level:4},{value:"Returns",id:"returns-124",level:4},{value:"isPhoneDisconnected",id:"isphonedisconnected",level:3},{value:"Returns",id:"returns-125",level:4},{value:"joinGroupViaLink",id:"joingroupvialink",level:3},{value:"Parameters",id:"parameters-83",level:4},{value:"Returns",id:"returns-126",level:4},{value:"joinWebBeta",id:"joinwebbeta",level:3},{value:"Parameters",id:"parameters-84",level:4},{value:"Returns",id:"returns-127",level:4},{value:"kill",id:"kill",level:3},{value:"Parameters",id:"parameters-85",level:4},{value:"Returns",id:"returns-128",level:4},{value:"leaveGroup",id:"leavegroup",level:3},{value:"Parameters",id:"parameters-86",level:4},{value:"Returns",id:"returns-129",level:4},{value:"listWebhooks",id:"listwebhooks",level:3},{value:"Returns",id:"returns-130",level:4},{value:"loadAllEarlierMessages",id:"loadallearliermessages",level:3},{value:"Parameters",id:"parameters-87",level:4},{value:"Returns",id:"returns-131",level:4},{value:"loadAndGetAllMessagesInChat",id:"loadandgetallmessagesinchat",level:3},{value:"Parameters",id:"parameters-88",level:4},{value:"Returns",id:"returns-132",level:4},{value:"loadEarlierMessages",id:"loadearliermessages",level:3},{value:"Parameters",id:"parameters-89",level:4},{value:"Returns",id:"returns-133",level:4},{value:"loadEarlierMessagesTillDate",id:"loadearliermessagestilldate",level:3},{value:"Parameters",id:"parameters-90",level:4},{value:"Returns",id:"returns-134",level:4},{value:"logger",id:"logger",level:3},{value:"Returns",id:"returns-135",level:4},{value:"logout",id:"logout",level:3},{value:"Parameters",id:"parameters-91",level:4},{value:"Returns",id:"returns-136",level:4},{value:"markAllRead",id:"markallread",level:3},{value:"Returns",id:"returns-137",level:4},{value:"markAsUnread",id:"markasunread",level:3},{value:"Parameters",id:"parameters-92",level:4},{value:"Returns",id:"returns-138",level:4},{value:"metrics",id:"metrics",level:3},{value:"Returns",id:"returns-139",level:4},{value:"middleware",id:"middleware",level:3},{value:"Parameters",id:"parameters-93",level:4},{value:"Returns",id:"returns-140",level:4},{value:"Parameters",id:"parameters-94",level:5},{value:"Returns",id:"returns-141",level:5},{value:'muteChat
insiders
',id:"mutechat-insiders",level:3},{value:"Parameters",id:"parameters-95",level:4},{value:"Returns",id:"returns-142",level:4},{value:'onNewProduct
insiders
',id:"onnewproduct-insiders",level:3},{value:"Parameters",id:"parameters-96",level:4},{value:"Returns",id:"returns-143",level:4},{value:'onOrder
insiders
',id:"onorder-insiders",level:3},{value:"Parameters",id:"parameters-97",level:4},{value:"Returns",id:"returns-144",level:4},{value:"pinChat",id:"pinchat",level:3},{value:"Parameters",id:"parameters-98",level:4},{value:"Returns",id:"returns-145",level:4},{value:'postImageStatus
restricted
',id:"postimagestatus-restricted",level:3},{value:"Parameters",id:"parameters-99",level:4},{value:"Returns",id:"returns-146",level:4},{value:'postTextStatus
restricted
',id:"posttextstatus-restricted",level:3},{value:"Parameters",id:"parameters-100",level:4},{value:"Returns",id:"returns-147",level:4},{value:'postVideoStatus
restricted
',id:"postvideostatus-restricted",level:3},{value:"Parameters",id:"parameters-101",level:4},{value:"Returns",id:"returns-148",level:4},{value:"prepEventData",id:"prepeventdata",level:3},{value:"Parameters",id:"parameters-102",level:4},{value:"Returns",id:"returns-149",level:4},{value:"promoteParticipant",id:"promoteparticipant",level:3},{value:"Parameters",id:"parameters-103",level:4},{value:"Returns",id:"returns-150",level:4},{value:"react",id:"react",level:3},{value:"Parameters",id:"parameters-104",level:4},{value:"Returns",id:"returns-151",level:4},{value:"refresh",id:"refresh",level:3},{value:"Returns",id:"returns-152",level:4},{value:"registerWebhook",id:"registerwebhook",level:3},{value:"Parameters",id:"parameters-105",level:4},{value:"Returns",id:"returns-153",level:4},{value:"rejectGroupJoinRequest",id:"rejectgroupjoinrequest",level:3},{value:"Parameters",id:"parameters-106",level:4},{value:"Returns",id:"returns-154",level:4},{value:"removeAllListeners",id:"removealllisteners",level:3},{value:"Returns",id:"returns-155",level:4},{value:"removeLabel",id:"removelabel",level:3},{value:"Parameters",id:"parameters-107",level:4},{value:"Returns",id:"returns-156",level:4},{value:"removeListener",id:"removelistener",level:3},{value:"Parameters",id:"parameters-108",level:4},{value:"Returns",id:"returns-157",level:4},{value:"removeParticipant",id:"removeparticipant",level:3},{value:"Parameters",id:"parameters-109",level:4},{value:"Returns",id:"returns-158",level:4},{value:"removeProduct",id:"removeproduct",level:3},{value:"Parameters",id:"parameters-110",level:4},{value:"Returns",id:"returns-159",level:4},{value:"removeWebhook",id:"removewebhook",level:3},{value:"Parameters",id:"parameters-111",level:4},{value:"Returns",id:"returns-160",level:4},{value:"reply",id:"reply",level:3},{value:"Parameters",id:"parameters-112",level:4},{value:"Returns",id:"returns-161",level:4},{value:'reportSpam
restricted
',id:"reportspam-restricted",level:3},{value:"Parameters",id:"parameters-113",level:4},{value:"Returns",id:"returns-162",level:4},{value:"resizePage",id:"resizepage",level:3},{value:"Parameters",id:"parameters-114",level:4},{value:"Returns",id:"returns-163",level:4},{value:"revokeGroupInviteLink",id:"revokegroupinvitelink",level:3},{value:"Parameters",id:"parameters-115",level:4},{value:"Returns",id:"returns-164",level:4},{value:"sendAdvancedButtons",id:"sendadvancedbuttons",level:3},{value:"Parameters",id:"parameters-116",level:4},{value:"Returns",id:"returns-165",level:4},{value:"sendAudio",id:"sendaudio",level:3},{value:"Parameters",id:"parameters-117",level:4},{value:"Returns",id:"returns-166",level:4},{value:"sendBanner",id:"sendbanner",level:3},{value:"Parameters",id:"parameters-118",level:4},{value:"Returns",id:"returns-167",level:4},{value:"sendButtons",id:"sendbuttons",level:3},{value:"Parameters",id:"parameters-119",level:4},{value:"Returns",id:"returns-168",level:4},{value:"sendContact",id:"sendcontact",level:3},{value:"Parameters",id:"parameters-120",level:4},{value:"Returns",id:"returns-169",level:4},{value:"sendCustomProduct",id:"sendcustomproduct",level:3},{value:"Parameters",id:"parameters-121",level:4},{value:"Returns",id:"returns-170",level:4},{value:"sendEmoji",id:"sendemoji",level:3},{value:"Parameters",id:"parameters-122",level:4},{value:"Returns",id:"returns-171",level:4},{value:"sendFile",id:"sendfile",level:3},{value:"Parameters",id:"parameters-123",level:4},{value:"Returns",id:"returns-172",level:4},{value:"sendFileFromUrl",id:"sendfilefromurl",level:3},{value:"Parameters",id:"parameters-124",level:4},{value:"Returns",id:"returns-173",level:4},{value:"sendGiphy",id:"sendgiphy",level:3},{value:"Parameters",id:"parameters-125",level:4},{value:"Returns",id:"returns-174",level:4},{value:"sendGiphyAsSticker",id:"sendgiphyassticker",level:3},{value:"Parameters",id:"parameters-126",level:4},{value:"Returns",id:"returns-175",level:4},{value:"sendImage",id:"sendimage",level:3},{value:"Parameters",id:"parameters-127",level:4},{value:"Returns",id:"returns-176",level:4},{value:"sendImageAsSticker",id:"sendimageassticker",level:3},{value:"Parameters",id:"parameters-128",level:4},{value:"Returns",id:"returns-177",level:4},{value:'sendImageAsStickerAsReply
insiders
',id:"sendimageasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-129",level:4},{value:"Returns",id:"returns-178",level:4},{value:"sendImageWithProduct",id:"sendimagewithproduct",level:3},{value:"Parameters",id:"parameters-130",level:4},{value:"Returns",id:"returns-179",level:4},{value:"sendLinkWithAutoPreview",id:"sendlinkwithautopreview",level:3},{value:"Parameters",id:"parameters-131",level:4},{value:"Returns",id:"returns-180",level:4},{value:"sendListMessage",id:"sendlistmessage",level:3},{value:"Parameters",id:"parameters-132",level:4},{value:"Returns",id:"returns-181",level:4},{value:"sendLocation",id:"sendlocation",level:3},{value:"Parameters",id:"parameters-133",level:4},{value:"Returns",id:"returns-182",level:4},{value:"sendMessageWithThumb",id:"sendmessagewiththumb",level:3},{value:"Parameters",id:"parameters-134",level:4},{value:"Returns",id:"returns-183",level:4},{value:"sendMp4AsSticker",id:"sendmp4assticker",level:3},{value:"Parameters",id:"parameters-135",level:4},{value:"Returns",id:"returns-184",level:4},{value:'sendMultipleContacts
insiders
',id:"sendmultiplecontacts-insiders",level:3},{value:"Parameters",id:"parameters-136",level:4},{value:"Returns",id:"returns-185",level:4},{value:"sendPaymentRequest",id:"sendpaymentrequest",level:3},{value:"Parameters",id:"parameters-137",level:4},{value:"Returns",id:"returns-186",level:4},{value:"sendPoll",id:"sendpoll",level:3},{value:"Parameters",id:"parameters-138",level:4},{value:"Returns",id:"returns-187",level:4},{value:'sendProduct
insiders
',id:"sendproduct-insiders",level:3},{value:"Parameters",id:"parameters-139",level:4},{value:"Returns",id:"returns-188",level:4},{value:"sendPtt",id:"sendptt",level:3},{value:"Parameters",id:"parameters-140",level:4},{value:"Returns",id:"returns-189",level:4},{value:"sendRawWebpAsSticker",id:"sendrawwebpassticker",level:3},{value:"Parameters",id:"parameters-141",level:4},{value:"Returns",id:"returns-190",level:4},{value:'sendRawWebpAsStickerAsReply
insiders
',id:"sendrawwebpasstickerasreply-insiders",level:3},{value:"Parameters",id:"parameters-142",level:4},{value:"Returns",id:"returns-191",level:4},{value:"sendReplyWithMentions",id:"sendreplywithmentions",level:3},{value:"Parameters",id:"parameters-143",level:4},{value:"Returns",id:"returns-192",level:4},{value:"sendSeen",id:"sendseen",level:3},{value:"Parameters",id:"parameters-144",level:4},{value:"Returns",id:"returns-193",level:4},{value:"sendStickerfromUrl",id:"sendstickerfromurl",level:3},{value:"Parameters",id:"parameters-145",level:4},{value:"Returns",id:"returns-194",level:4},{value:'sendStickerfromUrlAsReply
insiders
',id:"sendstickerfromurlasreply-insiders",level:3},{value:"Parameters",id:"parameters-146",level:4},{value:"Returns",id:"returns-195",level:4},{value:'sendText
restricted
',id:"sendtext-restricted",level:3},{value:"Parameters",id:"parameters-147",level:4},{value:"Returns",id:"returns-196",level:4},{value:"sendTextWithMentions",id:"sendtextwithmentions",level:3},{value:"Parameters",id:"parameters-148",level:4},{value:"Returns",id:"returns-197",level:4},{value:"sendVCard",id:"sendvcard",level:3},{value:"Parameters",id:"parameters-149",level:4},{value:"Returns",id:"returns-198",level:4},{value:"sendVideoAsGif",id:"sendvideoasgif",level:3},{value:"Parameters",id:"parameters-150",level:4},{value:"Returns",id:"returns-199",level:4},{value:"sendYoutubeLink",id:"sendyoutubelink",level:3},{value:"Parameters",id:"parameters-151",level:4},{value:"Returns",id:"returns-200",level:4},{value:'setChatBackgroundColourHex
insiders
',id:"setchatbackgroundcolourhex-insiders",level:3},{value:"Parameters",id:"parameters-152",level:4},{value:"Returns",id:"returns-201",level:4},{value:'setChatEphemeral
insiders
',id:"setchatephemeral-insiders",level:3},{value:"Parameters",id:"parameters-153",level:4},{value:"Returns",id:"returns-202",level:4},{value:"setChatState",id:"setchatstate",level:3},{value:"Parameters",id:"parameters-154",level:4},{value:"Returns",id:"returns-203",level:4},{value:"setGroupApprovalMode",id:"setgroupapprovalmode",level:3},{value:"Parameters",id:"parameters-155",level:4},{value:"Returns",id:"returns-204",level:4},{value:"setGroupDescription",id:"setgroupdescription",level:3},{value:"Parameters",id:"parameters-156",level:4},{value:"Returns",id:"returns-205",level:4},{value:"setGroupEditToAdminsOnly",id:"setgroupedittoadminsonly",level:3},{value:"Parameters",id:"parameters-157",level:4},{value:"Returns",id:"returns-206",level:4},{value:"setGroupIcon",id:"setgroupicon",level:3},{value:"Parameters",id:"parameters-158",level:4},{value:"Returns",id:"returns-207",level:4},{value:"setGroupIconByUrl",id:"setgroupiconbyurl",level:3},{value:"Parameters",id:"parameters-159",level:4},{value:"Returns",id:"returns-208",level:4},{value:'setGroupTitle
insiders
',id:"setgrouptitle-insiders",level:3},{value:"Parameters",id:"parameters-160",level:4},{value:"Returns",id:"returns-209",level:4},{value:"setGroupToAdminsOnly",id:"setgrouptoadminsonly",level:3},{value:"Parameters",id:"parameters-161",level:4},{value:"Returns",id:"returns-210",level:4},{value:"setMyName",id:"setmyname",level:3},{value:"Parameters",id:"parameters-162",level:4},{value:"Returns",id:"returns-211",level:4},{value:"setMyStatus",id:"setmystatus",level:3},{value:"Parameters",id:"parameters-163",level:4},{value:"Returns",id:"returns-212",level:4},{value:"setPresence",id:"setpresence",level:3},{value:"Parameters",id:"parameters-164",level:4},{value:"Returns",id:"returns-213",level:4},{value:"setProfilePic",id:"setprofilepic",level:3},{value:"Parameters",id:"parameters-165",level:4},{value:"Returns",id:"returns-214",level:4},{value:"simulateRecording",id:"simulaterecording",level:3},{value:"Parameters",id:"parameters-166",level:4},{value:"Returns",id:"returns-215",level:4},{value:"simulateTyping",id:"simulatetyping",level:3},{value:"Parameters",id:"parameters-167",level:4},{value:"Returns",id:"returns-216",level:4},{value:"starMessage",id:"starmessage",level:3},{value:"Parameters",id:"parameters-168",level:4},{value:"Returns",id:"returns-217",level:4},{value:"syncContacts",id:"synccontacts",level:3},{value:"Returns",id:"returns-218",level:4},{value:'tagEveryone
insiders
',id:"tageveryone-insiders",level:3},{value:"Parameters",id:"parameters-169",level:4},{value:"Returns",id:"returns-219",level:4},{value:"testButtons",id:"testbuttons",level:3},{value:"Parameters",id:"parameters-170",level:4},{value:"Returns",id:"returns-220",level:4},{value:"testCallback",id:"testcallback",level:3},{value:"Parameters",id:"parameters-171",level:4},{value:"Returns",id:"returns-221",level:4},{value:'unmuteChat
insiders
',id:"unmutechat-insiders",level:3},{value:"Parameters",id:"parameters-172",level:4},{value:"Returns",id:"returns-222",level:4},{value:"unstarMessage",id:"unstarmessage",level:3},{value:"Parameters",id:"parameters-173",level:4},{value:"Returns",id:"returns-223",level:4},{value:"updateWebhook",id:"updatewebhook",level:3},{value:"Parameters",id:"parameters-174",level:4},{value:"Returns",id:"returns-224",level:4},{value:"waitAllQEmpty",id:"waitallqempty",level:3},{value:"Returns",id:"returns-225",level:4},{value:"waitWhQIdle",id:"waitwhqidle",level:3},{value:"Returns",id:"returns-226",level:4},{value:"Events",id:"events",level:2},{value:"onAck",id:"onack",level:3},{value:"Parameters",id:"parameters-175",level:4},{value:"Returns",id:"returns-227",level:4},{value:"onAddedToGroup",id:"onaddedtogroup",level:3},{value:"Parameters",id:"parameters-176",level:4},{value:"Returns",id:"returns-228",level:4},{value:"onAnyMessage",id:"onanymessage",level:3},{value:"Parameters",id:"parameters-177",level:4},{value:"Returns",id:"returns-229",level:4},{value:"onBattery",id:"onbattery",level:3},{value:"Parameters",id:"parameters-178",level:4},{value:"Returns",id:"returns-230",level:4},{value:"onBroadcast",id:"onbroadcast",level:3},{value:"Parameters",id:"parameters-179",level:4},{value:"Returns",id:"returns-231",level:4},{value:"onButton",id:"onbutton",level:3},{value:"Parameters",id:"parameters-180",level:4},{value:"Returns",id:"returns-232",level:4},{value:"onCallState",id:"oncallstate",level:3},{value:"Parameters",id:"parameters-181",level:4},{value:"Returns",id:"returns-233",level:4},{value:"onChatDeleted",id:"onchatdeleted",level:3},{value:"Parameters",id:"parameters-182",level:4},{value:"Returns",id:"returns-234",level:4},{value:'onChatOpened
insiders
',id:"onchatopened-insiders",level:3},{value:"Parameters",id:"parameters-183",level:4},{value:"Returns",id:"returns-235",level:4},{value:'onChatState
insiders
',id:"onchatstate-insiders",level:3},{value:"Parameters",id:"parameters-184",level:4},{value:"Returns",id:"returns-236",level:4},{value:'onContactAdded
insiders
',id:"oncontactadded-insiders",level:3},{value:"Parameters",id:"parameters-185",level:4},{value:"Returns",id:"returns-237",level:4},{value:"onGlobalParticipantsChanged",id:"onglobalparticipantschanged",level:3},{value:"Parameters",id:"parameters-186",level:4},{value:"Returns",id:"returns-238",level:4},{value:"onGroupApprovalRequest",id:"ongroupapprovalrequest",level:3},{value:"Parameters",id:"parameters-187",level:4},{value:"Returns",id:"returns-239",level:4},{value:"onGroupChange",id:"ongroupchange",level:3},{value:"Parameters",id:"parameters-188",level:4},{value:"Returns",id:"returns-240",level:4},{value:"onIncomingCall",id:"onincomingcall",level:3},{value:"Parameters",id:"parameters-189",level:4},{value:"Returns",id:"returns-241",level:4},{value:"onLabel",id:"onlabel",level:3},{value:"Parameters",id:"parameters-190",level:4},{value:"Returns",id:"returns-242",level:4},{value:"onLiveLocation",id:"onlivelocation",level:3},{value:"Parameters",id:"parameters-191",level:4},{value:"Returns",id:"returns-243",level:4},{value:"onLogout",id:"onlogout",level:3},{value:"Parameters",id:"parameters-192",level:4},{value:"Returns",id:"returns-244",level:4},{value:"onMessage",id:"onmessage",level:3},{value:"Parameters",id:"parameters-193",level:4},{value:"Returns",id:"returns-245",level:4},{value:"onMessageDeleted",id:"onmessagedeleted",level:3},{value:"Parameters",id:"parameters-194",level:4},{value:"Returns",id:"returns-246",level:4},{value:"onParticipantsChanged",id:"onparticipantschanged",level:3},{value:"Parameters",id:"parameters-195",level:4},{value:"Returns",id:"returns-247",level:4},{value:"onPlugged",id:"onplugged",level:3},{value:"Parameters",id:"parameters-196",level:4},{value:"Returns",id:"returns-248",level:4},{value:"onPollVote",id:"onpollvote",level:3},{value:"Parameters",id:"parameters-197",level:4},{value:"Returns",id:"returns-249",level:4},{value:'onReaction
insiders
',id:"onreaction-insiders",level:3},{value:"Parameters",id:"parameters-198",level:4},{value:"Returns",id:"returns-250",level:4},{value:'onRemovedFromGroup
insiders
',id:"onremovedfromgroup-insiders",level:3},{value:"Parameters",id:"parameters-199",level:4},{value:"Returns",id:"returns-251",level:4},{value:"onStateChanged",id:"onstatechanged",level:3},{value:"Parameters",id:"parameters-200",level:4},{value:"Returns",id:"returns-252",level:4},{value:'onStory
restricted
',id:"onstory-restricted",level:3},{value:"Parameters",id:"parameters-201",level:4},{value:"Returns",id:"returns-253",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/api_Client"},"api/Client"),".Client"),(0,r.kt)("h2",{id:"methods"},"Methods"),(0,r.kt)("h3",{id:"b-insiders"},"B ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"B"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"payload"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.")),(0,r.kt)("p",null,"Use a raw payload within your open-wa session"),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"payload")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{any} returns: MessageId")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"acceptgroupjoinrequest"},"acceptGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"acceptGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Accepts a request from a recipient to join a group. Takes the message ID of the request message."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addlabel"},"addLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Adds label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addparticipant"},"addParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Add participant to Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the contacts, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_CONTACT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"approvegroupjoinrequest"},"approveGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"approveGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Approves a group join request"),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The contact id of the person who is requesting to join the group")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"archivechat"},"archiveChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"archiveChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean true => archive, false => unarchive")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked, false: didnt work (probably already in desired state)"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"autoreject"},"autoReject"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"autoReject"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring."),(0,r.kt)("p",null,"Update: Due to the nature of MD, the host account will continue ringing."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional message to send to the calling account when their call is detected and rejected")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"awaitmessages"},"awaitMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"awaitMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"c"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_Collector.Collection"},(0,r.kt)("inlineCode",{parentName:"a"},"Collection")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">",">"),(0,r.kt)("p",null,"[FROM DISCORDJS]","\nSimilar to createMessageCollector but in promise form.\nResolves with a collection of messages that pass the specified filter."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// Await !vote messages\nconst filter = m => m.body.startsWith('!vote');\n// Errors: ['time'] treats ending because of the time limit as an error\nchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\n .then(collected => console.log(collected.size))\n .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));\n")),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"c")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Mesasge/Chat or Chat Id to base this message colletor on")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/structures_Collector.CollectorFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorFilter")),"<[",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"]",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The filter function to use")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/structures_Collector.AwaitMessagesOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"AwaitMessagesOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional options to pass to the internal collector")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_Collector.Collection"},(0,r.kt)("inlineCode",{parentName:"a"},"Collection")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checknumberstatus"},"checkNumberStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkNumberStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.NumberCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"NumberCheck")),">"),(0,r.kt)("p",null,"Checks if a number is a valid WA number"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.NumberCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"NumberCheck")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"checkreadreceipts-insiders"},"checkReadReceipts ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"checkReadReceipts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Check if a recipient has read receipts on."),(0,r.kt)("p",null,"This will only work if you have chats sent back and forth between you and the contact 1-1."),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Id of the contact with which you have an existing conversation with messages already.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," true or false or a string with an explaintaion of why it wasn't able to determine the read receipts."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"clearallchats"},"clearAllChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"clearAllChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ts?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots."),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ts?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"number A chat that has had a message after ts (epoch timestamp) will not be cleared.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"clearchat"},"clearChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"clearChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Delete all messages from the chat."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"contactblock"},"contactBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"contactBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Block contact"),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"contactunblock"},"contactUnblock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"contactUnblock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Unblock contact"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createcommunity-insiders"},"createCommunity ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createCommunity"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"communitySubject"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"icon"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"existingGroups?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"newGroups?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5C"},"\\`${number}@g.us\\`\\")),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Create a new community"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The community name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communitySubject")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"icon")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL of a 1:1 ratio jpeg for the community icon")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"existingGroups")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"[]")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of existing group IDs, that are not already part of a community, to add to this new community.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newGroups?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup"},(0,r.kt)("inlineCode",{parentName:"a"},"NewCommunityGroup")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of new group objects that")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5C"},"\\`${number}@g.us\\`\\")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"creategroup"},"createGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contacts"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChatCreationResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatCreationResponse")),">"),(0,r.kt)("p",null,"Create a group and add contacts to it"),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"group name: 'New group'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contacts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChatCreationResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatCreationResponse")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createlabel-insiders"},"createLabel ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Adds label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," if something went wrong, or the id (usually a number as a string) of the new label (for example ",(0,r.kt)("inlineCode",{parentName:"p"},'"58"'),")"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createmessagecollector"},"createMessageCollector"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createMessageCollector"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"c"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filter"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_MessageCollector.MessageCollector"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageCollector"))),(0,r.kt)("p",null,"Returns a new message collector for the chat which is related to the first parameter c"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"c")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Mesasge/Chat or Chat Id to base this message colletor on")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filter")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/structures_Collector.CollectorFilter"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorFilter")),"<[",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"]",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A function that consumes a ","[Message]"," and returns a boolean which determines whether or not the message shall be collected.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/structures_Collector.CollectorOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"CollectorOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/structures_MessageCollector.MessageCollector"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageCollector"))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"createnewproduct-insiders"},"createNewProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"createNewProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"price"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"images"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"internalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isHidden?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Add a product to your catalog"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"price")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The price of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The 3-letter currenct code for the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"images")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional, the description of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the product for more information")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"internalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The internal/backoffice id of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isHidden?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not the product is shown publicly in your catalog")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("p",null,"product object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cutchatcache"},"cutChatCache"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cutChatCache"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"after"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"before"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } }",">"),(0,r.kt)("p",null,"This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache as much as possible, reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.kt)("inlineCode",{parentName:"p"},"getAmountOfLoadedMessages")," to intelligently control the session message cache."),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"after"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"before"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"chats"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"msgs"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," } }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"cutmsgcache"},"cutMsgCache"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"cutMsgCache"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.\nCalling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.\nYou should use this in conjunction with ",(0,r.kt)("inlineCode",{parentName:"p"},"getAmountOfLoadedMessages")," to intelligently control the session message cache."),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"darkmode"},"darkMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"darkMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"activate"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Start dark mode ","[NOW GENERALLY AVAILABLE]"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"activate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"true to activate dark mode, false to deactivate")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decryptmedia"},"decryptMedia"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decryptMedia"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"Decrypts a media message."),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"This can be the serialized MessageId or the whole Message object. It is advised to just use the serialized message ID.")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise<[[DataURL]]>")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deleteallstatus"},"deleteAllStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteAllStatus"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deleteallstories-restricted"},"deleteAllStories ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteAllStories"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Deletes all your existing stories."),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. True if it worked."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletechat"},"deleteChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Delete the conversation from your WA"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletemessage"},"deleteMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyLocal?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Deletes message of given message id"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chat id from which to delete the message.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The specific message id of the message to be deleted")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyLocal")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If it should only delete locally (message remains on the other recipienct's phone). Defaults to false.")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"nothing"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestalechats"},"deleteStaleChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStaleChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"startingFrom?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Deletes chats from a certain index (default 1000). E.g if this startingFrom param is ",(0,r.kt)("inlineCode",{parentName:"p"},"100")," then all chats from index ",(0,r.kt)("inlineCode",{parentName:"p"},"100")," onwards will be deleted."),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"startingFrom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the chat index to start from. Please do not set this to anything less than 10 @default: ",(0,r.kt)("inlineCode",{parentName:"td"},"1000"))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestatus"},"deleteStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"statusesToDelete"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"statusesToDelete")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]")))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"deletestory-restricted"},"deleteStory ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"deleteStory"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"statusesToDelete"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Consumes a list of id strings of stories to delete."),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"statusesToDelete")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"string [] ","|"," string an array of ids of stories to delete.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. True if it worked."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"demoteparticipant"},"demoteParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"demoteParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Demote Admin of Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"download"},"download"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"download"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"optionsOverride?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"A convinience method to download the DataURL of a file"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"optionsOverride")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can use this to override the ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"axios request config"))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"downloadfilewithcredentials"},"downloadFileWithCredentials"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"downloadFileWithCredentials"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"Download via the browsers authenticated session via URL."),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"base64 string (non-data url)"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"downloadprofilepicfrommessage"},"downloadProfilePicFromMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"downloadProfilePicFromMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("p",null,"Download profile pics from the message object."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"}," const filename = `profilepic_${message.from}.jpeg`;\n const data = await client.downloadProfilePicFromMessage(message);\n const dataUri = `data:image/jpeg;base64,${data}`;\n fs.writeFile(filename, mData, 'base64', function(err) {\n if (err) {\n return console.log(err);\n }\n console.log('The file was saved!');\n });\n")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"editmessage"},"editMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"editMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"NOTE: This is experimental, most accounts do not have access to this feature in their apps."),(0,r.kt)("p",null,"Edit an existing message"),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message ID to edit")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The new text content")))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"editproduct-insiders"},"editProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"editProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"price?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"images?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"internalId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"isHidden?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Edit a product in your catalog"),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The catalog ID of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The name of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"price?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The price of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The 3-letter currenct code for the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"images?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"optional, the description of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the product for more information")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"internalId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The internal/backoffice id of the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isHidden?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not the product is shown publicly in your catalog")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),">"),(0,r.kt)("p",null,"product object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"emitunreadmessages"},"emitUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"emitUnreadMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"Fires all unread messages to the onMessage listener.\nMake sure to call this AFTER setting your listeners."),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"array of message IDs"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcerefocus"},"forceRefocus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceRefocus"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"This is a convinient method to click the ",(0,r.kt)("inlineCode",{parentName:"p"},"Use Here")," button in the WA web session."),(0,r.kt)("p",null,"Use this when STATE is ",(0,r.kt)("inlineCode",{parentName:"p"},"CONFLICT"),". You can read more about managing state here:"),(0,r.kt)("p",null,"Detecting Logouts"),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forcestalemediaupdate-insiders"},"forceStaleMediaUpdate ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceStaleMediaUpdate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message."),(0,r.kt)("p",null,"if you run this without a valid insiders key, it will return false and cause an error upon decryption."),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Message OR ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forceupdateconnectionstate"},"forceUpdateConnectionState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceUpdateConnectionState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"killBeforeReconnect?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"Forces the session to update the connection state."),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"killBeforeReconnect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"updated connection state"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forceupdatelivelocation"},"forceUpdateLiveLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forceUpdateLiveLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),"[]",">"),(0,r.kt)("p",null,"A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.\nPlease note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation)."),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Id of the chat you want to force the phone to get the livelocation data for.")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," | boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"forwardmessages"},"forwardMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"forwardMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"skipMyMessages"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("p",null,"Forward an array of messages to a specific chat using the message ids or Objects"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"this can be any mixture of message ids or message objects")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"skipMyMessages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This indicates whether or not to skip your own messages from the array")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gc"},"gc"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"gc"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"It calls the JavaScript garbage collector"),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Nothing."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchatids"},"getAllChatIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChatIds"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"retrieves all Chat Ids"),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"array of ","[ChatId]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchats"},"getAllChats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChats"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessageOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"Retrieves all chats"),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessageOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of ","[Chat]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallchatswithmessages"},"getAllChatsWithMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllChatsWithMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessageOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Retrieves all chats with messages"),(0,r.kt)("p",null,"Please use ",(0,r.kt)("inlineCode",{parentName:"p"},"getAllUnreadMessages")," instead of this to see all messages indicated by the green dots in the chat."),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessageOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of ","[Chat]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallcommunities"},"getAllCommunities"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllCommunities"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5B%5D%5C"},"\\`${number}@g.us\\`[]\\")),(0,r.kt)("p",null,"Retrieve all commmunity Ids"),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),(0,r.kt)("a",{parentName:"p",href:"mailto:%5C%60$%7Bnumber%7D@g.us%5C%60%5B%5D%5C"},"\\`${number}@g.us\\`[]\\")),(0,r.kt)("p",null,"array of group ids"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallcontacts"},"getAllContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Retrieves all contacts"),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"array of ","[Contact]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallgroups"},"getAllGroups"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllGroups"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"withNewMessagesOnly?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"Retrieve all groups"),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withNewMessagesOnly")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,"array of groups"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalllabels"},"getAllLabels"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllLabels"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),"[]",">"),(0,r.kt)("p",null,"Returns all labels and the corresponding tagged items."),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallmessagesinchat"},"getAllMessagesInChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllMessagesInChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all Messages in a chat that have been loaded within the WA web instance."),(0,r.kt)("p",null,"This does not load every single message in the chat history."),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallnewmessages"},"getAllNewMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllNewMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all new Messages. where isNewMsg==true"),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getallunreadmessages"},"getAllUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAllUnreadMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages. where ack==-1"),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getamountofloadedmessages"},"getAmountOfLoadedMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAmountOfLoadedMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache."),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbatterylevel"},"getBatteryLevel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBatteryLevel"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Retrieves Battery Level"),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockedids"},"getBlockedIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockedIds"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,"retrieves an array of IDs of accounts blocked by the host account."),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbusinessprofile"},"getBusinessProfile"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBusinessProfile"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.BusinessProfile"},(0,r.kt)("inlineCode",{parentName:"a"},"BusinessProfile")),">"),(0,r.kt)("p",null,"Get the business info of a given contact id"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of business profile (i.e the number with @c.us)")))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.BusinessProfile"},(0,r.kt)("inlineCode",{parentName:"a"},"BusinessProfile")),">"),(0,r.kt)("p",null,"None"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getbusinessprofilesproducts"},"getBusinessProfilesProducts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBusinessProfilesProducts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Find any product listings of the given number. Use this to query a catalog"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of business profile (i.e the number with @c.us)")))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"None"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchat"},"getChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Retrieves chat object of given contact id"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatbyid"},"getChatById"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatById"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Retrieves chat object of given contact id"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatwithnoncontacts"},"getChatWithNonContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatWithNonContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns a list of contact with whom the host number has an existing chat who are also not contacts."),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getchatsbylabel"},"getChatsByLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getChatsByLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("p",null,'Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".'),(0,r.kt)("p",null,"This method is case insenstive and only works on business host accounts."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Label"))),(0,r.kt)("p",null,"The label name"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommongroups-insiders"},"getCommonGroups ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommonGroups"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[]",">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves the groups that you have in common with a contact"),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[]",">"),(0,r.kt)("p",null,"Promise returning an array of common groups {\nid:string,\ntitle:string\n}"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityadminids"},"getCommunityAdminIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityAdminIds"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community admin Ids"),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityadmins"},"getCommunityAdmins"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityAdmins"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community admins as Contact objects"),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"admins"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityinfo"},"getCommunityInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata")),"[] }",">"),(0,r.kt)("p",null,"Returns the community metadata. Like group metadata but with a ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups")," property which is the group metadata of the community subgroups."),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"subGroups"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_group_metadata.GroupMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupMetadata")),"[] }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityparticipantids"},"getCommunityParticipantIds"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityParticipantIds"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community members Ids"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcommunityparticipants"},"getCommunityParticipants"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCommunityParticipants"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"communityId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("p",null,"Retrieves community members as Contact objects"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"communityId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"community id")))),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"participants"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"subgroup"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getconfig"},"getConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getConfig"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.ConfigObject"},(0,r.kt)("inlineCode",{parentName:"a"},"ConfigObject"))),(0,r.kt)("p",null,"Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed"),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.ConfigObject"},(0,r.kt)("inlineCode",{parentName:"a"},"ConfigObject"))),(0,r.kt)("p",null,"SessionInfo"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getconnectionstate"},"getConnectionState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getConnectionState"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("p",null,"Returns the connection state"),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcontact"},"getContact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getContact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),">"),(0,r.kt)("p",null,"Retrieves contact detail object of given contact id"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),">"),(0,r.kt)("p",null,"contact detial as promise"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"geteventsignature"},"getEventSignature"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getEventSignature"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"simpleListener?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"simpleListener?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))))),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getfeatures"},"getFeatures"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getFeatures"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not."),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgenerateduseragent"},"getGeneratedUserAgent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGeneratedUserAgent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"userA?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Get the generated user agent, this is so you can send it to the decryption module."),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"userA?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"String useragent of wa-web session"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgptarray"},"getGptArray"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGptArray"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"last?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"role"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"user"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"assistant"')," }[]",">"),(0,r.kt)("p",null,"Returns a properly formatted array of messages from to send to the openai api"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"last")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"10")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The amount of previous messages to retrieve. Defaults to 10")))),(0,r.kt)("h4",{id:"returns-74"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"role"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"user"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"assistant"')," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupadmins"},"getGroupAdmins"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupAdmins"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Get Admins of a Group"),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")))),(0,r.kt)("h4",{id:"returns-75"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupapprovalrequests"},"getGroupApprovalRequests"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupApprovalRequests"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Gets the contact IDs of members requesting approval to join the group"),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")))))),(0,r.kt)("h4",{id:"returns-76"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupinfo"},"getGroupInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns the title and description of a given group id."),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-77"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupinvitelink"},"getGroupInviteLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupInviteLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves an invite link for a group chat. returns false if chat is not a group."),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-78"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupmembers"},"getGroupMembers"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupMembers"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns group members ","[Contact]"," objects"),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")))))),(0,r.kt)("h4",{id:"returns-79"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getgroupmembersid"},"getGroupMembersId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getGroupMembersId"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("p",null,"Retrieves group members as ","[Id]"," objects"),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-80"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethostnumber"},"getHostNumber"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostNumber"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves the host device number. Use this number when registering for a license key"),(0,r.kt)("h4",{id:"returns-81"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getindicatednewmessages"},"getIndicatedNewMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIndicatedNewMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'[{\n"id": "000000000000@g.us", //the id of the chat\n"indicatedNewMessages": [] //array of messages, not including any messages by the host phone\n}]\n')),(0,r.kt)("h4",{id:"returns-82"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"list of messages"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinstanceid"},"getInstanceId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInstanceId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Get the INSTANCE_ID of the current session"),(0,r.kt)("h4",{id:"returns-83"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getisplugged"},"getIsPlugged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIsPlugged"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves whether or not phone is plugged in (i.e on charge)"),(0,r.kt)("h4",{id:"returns-84"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Number"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getissuelink"},"getIssueLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getIssueLink"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Generate a pre-filled github issue link to easily report a bug"),(0,r.kt)("h4",{id:"returns-85"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getkickedgroups"},"getKickedGroups"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getKickedGroups"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("p",null,"Returns an array of group ids where the host account has been kicked"),(0,r.kt)("h4",{id:"returns-86"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlastmsgtimestamps"},"getLastMsgTimestamps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLastMsgTimestamps"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"t"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }[]",">"),(0,r.kt)("p",null,"Get an array of chatIds with their respective last message's timestamp."),(0,r.kt)("p",null,"This is useful for determining what chats are old/stale and need to be deleted."),(0,r.kt)("h4",{id:"returns-87"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"t"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlastseen"},"getLastSeen"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLastSeen"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"They have set it so you cannot see their last seen via privacy settings."),(0,r.kt)("li",{parentName:"ol"},"You do not have an existing chat with the contact."),(0,r.kt)("li",{parentName:"ol"},"The chatId is for a group\nIn both of those instances this method will return undefined.")),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chat.")))),(0,r.kt)("h4",{id:"returns-88"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"number timestamp when chat was last online or undefined."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlicenselink"},"getLicenseLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLicenseLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Generate a license link"),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-89"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlicensetype"},"getLicenseType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getLicenseType"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model_config.LicenseType"},(0,r.kt)("inlineCode",{parentName:"a"},"LicenseType")),">"),(0,r.kt)("p",null,"Returns the the type of license key used by the session."),(0,r.kt)("h4",{id:"returns-90"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/enums/api_model_config.LicenseType"},(0,r.kt)("inlineCode",{parentName:"a"},"LicenseType")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getlistenerqueues"},"getListenerQueues"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getListenerQueues"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"If you have set ",(0,r.kt)("inlineCode",{parentName:"p"},"onAnyMessage")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"onMessage")," with the second parameter (PQueue options) then you may want to inspect their respective PQueue's."),(0,r.kt)("h4",{id:"returns-91"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAck")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAddedToGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onAnyMessage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onBattery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onBroadcast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onButton")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onCallState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatDeleted")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatOpened")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onChatState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onContactAdded")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGlobalParticipantsChanged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGroupApprovalRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onGroupChange")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onIncomingCall")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onLabel")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onLogout")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onMessage")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onMessageDeleted")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onNewProduct")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onOrder")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onPlugged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onPollVote")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onReaction")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRemovedFromGroup")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onStateChanged")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onStory")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">")))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getme"},"getMe"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMe"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object with all of your host device details"),(0,r.kt)("h4",{id:"returns-92"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessagebyid"},"getMessageById"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageById"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Retrieves message object of given message id"),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-93"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessageinfo-insiders"},"getMessageInfo ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.MessageInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageInfo")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Get the detailed message info for a group message sent out by the host account."),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message Id")))),(0,r.kt)("h4",{id:"returns-94"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.MessageInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageInfo")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmessagereaders"},"getMessageReaders"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMessageReaders"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("p",null,"Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!\nEach of these contact objects have a property ",(0,r.kt)("inlineCode",{parentName:"p"},"t")," which represents the time at which that contact read the message."),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message id")))),(0,r.kt)("h4",{id:"returns-95"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_contact.Contact"},(0,r.kt)("inlineCode",{parentName:"a"},"Contact")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmylastmessage"},"getMyLastMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyLastMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"Retrieves the last message sent by the host account in any given chat or globally."),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"This is optional. If no chat Id is set then the last message sent by the host account will be returned.")))),(0,r.kt)("h4",{id:"returns-96"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object or ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," if the host account's last message could not be found."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmystatusarray"},"getMyStatusArray"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyStatusArray"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Alias for deleteStory"),(0,r.kt)("h4",{id:"returns-97"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getmystoryarray-restricted"},"getMyStoryArray ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getMyStoryArray"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves all existing stories."),(0,r.kt)("p",null,"Only works with a Story License Key"),(0,r.kt)("h4",{id:"returns-98"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getorder-insiders"},"getOrder ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getOrder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves an order object"),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-99"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),">"),(0,r.kt)("p",null,"order object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpage"},"getPage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPage"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Page")),(0,r.kt)("h4",{id:"returns-100"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Page")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpolldata"},"getPollData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPollData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),">"),(0,r.kt)("p",null,"Returns poll data including results and votes."),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message id of the Poll")))),(0,r.kt)("h4",{id:"returns-101"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprocessstats"},"getProcessStats"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProcessStats"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Get the stats of the current process and the corresponding browser process."),(0,r.kt)("h4",{id:"returns-102"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getprofilepicfromserver"},"getProfilePicFromServer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getProfilePicFromServer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Retrieves chat picture"),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-103"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Url of the chat picture or undefined if there is no picture for the chat."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsessionid"},"getSessionId"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSessionId"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"returns-104"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsessioninfo"},"getSessionInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSessionInfo"),"(): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.SessionInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"SessionInfo"))),(0,r.kt)("p",null,"Get the session info"),(0,r.kt)("h4",{id:"returns-105"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.SessionInfo"},(0,r.kt)("inlineCode",{parentName:"a"},"SessionInfo"))),(0,r.kt)("p",null,"SessionInfo"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsingleproperty"},"getSingleProperty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSingleProperty"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"namespace"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"property"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters."),(0,r.kt)("p",null,"Example - get message read state (ack):"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const ack = await client.getSingleProperty('Msg',\"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB\",'ack')\n")),(0,r.kt)("h4",{id:"parameters-70"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"namespace")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_Client.namespace"},(0,r.kt)("inlineCode",{parentName:"a"},"namespace"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of the object to get from the specific namespace")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"property")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the single property key to get from the object.")))),(0,r.kt)("h4",{id:"returns-106"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"any If the property or the id cannot be found, it will return a 404"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsnapshot"},"getSnapshot"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSnapshot"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,"Returns a PNG DataURL screenshot of the session"),(0,r.kt)("h4",{id:"parameters-71"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Chat ID to open before taking a snapshot")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Width of the viewport for the snapshot. Height also required if you want to resize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Height of the viewport for the snapshot. Width also required if you want to resize.")))),(0,r.kt)("h4",{id:"returns-107"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstarredmessages"},"getStarredMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStarredMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retrieves the starred messages in a given chat"),(0,r.kt)("h4",{id:"parameters-72"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Chat ID to filter starred messages by")))),(0,r.kt)("h4",{id:"returns-108"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"message object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstatus"},"getStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"Get the status of a contact"),(0,r.kt)("h4",{id:"parameters-73"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"{string} to '",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"' returns: {id: string,status: string}")))),(0,r.kt)("h4",{id:"returns-109"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstickerdecryptable"},"getStickerDecryptable"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStickerDecryptable"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers."),(0,r.kt)("p",null,"If you run this without a valid insiders key, it will return false and cause an error upon decryption."),(0,r.kt)("h4",{id:"parameters-74"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message ID ",(0,r.kt)("inlineCode",{parentName:"td"},"message.id"))))),(0,r.kt)("h4",{id:"returns-110"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),">"),(0,r.kt)("p",null,"message object OR ",(0,r.kt)("inlineCode",{parentName:"p"},"false")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getstoryviewers-restricted"},"getStoryViewers ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getStoryViewers"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: MessageId]"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]; }",">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Retrieves an array of user ids that have 'read' your story."),(0,r.kt)("h4",{id:"parameters-75"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The id of the story")))),(0,r.kt)("h4",{id:"returns-111"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[] ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: MessageId]"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]; }",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettunnelcode"},"getTunnelCode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTunnelCode"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The EASY API uses this string to secure a subdomain on the openwa public tunnel service."),(0,r.kt)("h4",{id:"returns-112"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getunreadmessages"},"getUnreadMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getUnreadMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"use_unread_count"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.SingleChat"},(0,r.kt)("inlineCode",{parentName:"a"},"SingleChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[] & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChat"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[]",">"),(0,r.kt)("p",null,"Retrieves all unread Messages"),(0,r.kt)("h4",{id:"parameters-76"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"use_unread_count")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-113"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.SingleChat"},(0,r.kt)("inlineCode",{parentName:"a"},"SingleChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[] & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_chat.GroupChat"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChat"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"messages"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[] }[]",">"),(0,r.kt)("p",null,"any"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getunsentmessages"},"getUnsentMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getUnsentMessages"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)"),(0,r.kt)("h4",{id:"returns-114"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getvcards"},"getVCards"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getVCards"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"msgId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"Extracts vcards from a message.This works on messages of typ ",(0,r.kt)("inlineCode",{parentName:"p"},"vcard")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"multi_vcard")),(0,r.kt)("h4",{id:"parameters-77"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"msgId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string id of the message to extract the vcards from")))),(0,r.kt)("h4",{id:"returns-115"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]",">"),(0,r.kt)("p",null,"[vcard]"," "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},'[\n{\ndisplayName:"Contact name",\nvcard: "loong vcard string"\n}\n]\n')),(0,r.kt)("p",null,"or false if no valid vcards found."),(0,r.kt)("p",null,"Please use ",(0,r.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/vcf"},"vcf")," to convert a vcard string into a json object"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwaversion"},"getWAVersion"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWAVersion"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"returns-116"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ghostforward"},"ghostForward"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ghostForward"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Ghost forwarding is like a normal forward but as if it were sent from the host phone ","[i.e it doesn't show up as forwarded.]","\nAny potential abuse of this method will see it become paywalled."),(0,r.kt)("h4",{id:"parameters-78"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")))))),(0,r.kt)("h4",{id:"returns-117"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"healthcheck"},"healthCheck"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"healthCheck"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.HealthCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"HealthCheck")),">"),(0,r.kt)("p",null,"Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session."),(0,r.kt)("h4",{id:"returns-118"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_sessionInfo.HealthCheck"},(0,r.kt)("inlineCode",{parentName:"a"},"HealthCheck")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iamadmin"},"iAmAdmin"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"iAmAdmin"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("p",null,"Returns an array of group ids where the host account is admin"),(0,r.kt)("h4",{id:"returns-119"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"inviteinfo"},"inviteInfo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"inviteInfo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Get the details of a group through the invite link"),(0,r.kt)("h4",{id:"parameters-79"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This can be an invite link or invite code")))),(0,r.kt)("h4",{id:"returns-120"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ischatmuted"},"isChatMuted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isChatMuted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if a chat is muted"),(0,r.kt)("h4",{id:"parameters-80"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the chat you want to check")))),(0,r.kt)("h4",{id:"returns-121"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean. ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat does not exist."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ischatonline"},"isChatOnline"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isChatOnline"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Checks if a chat contact is online. Not entirely sure if this works with groups."),(0,r.kt)("p",null,"It will return ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the chat is ",(0,r.kt)("inlineCode",{parentName:"p"},"online"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat is ",(0,r.kt)("inlineCode",{parentName:"p"},"offline"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"PRIVATE")," if the privacy settings of the contact do not allow you to see their status and ",(0,r.kt)("inlineCode",{parentName:"p"},"NO_CHAT")," if you do not currently have a chat with that contact."),(0,r.kt)("h4",{id:"parameters-81"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-122"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isconnected"},"isConnected"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isConnected"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Retrieves if the phone is online. Please note that this may not be real time."),(0,r.kt)("h4",{id:"returns-123"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isgroupidunsafe-insiders"},"isGroupIdUnsafe ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isGroupIdUnsafe"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Checks whether or not the group id provided is known to be unsafe by the contributors of the library."),(0,r.kt)("h4",{id:"parameters-82"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat you want to deteremine is unsafe")))),(0,r.kt)("h4",{id:"returns-124"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isphonedisconnected"},"isPhoneDisconnected"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isPhoneDisconnected"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,'Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return ',(0,r.kt)("inlineCode",{parentName:"p"},"true"),"."),(0,r.kt)("h4",{id:"returns-125"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"joingroupvialink"},"joinGroupViaLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"joinGroupViaLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"returnChatObj?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,"Joins a group via the invite link, code, or message"),(0,r.kt)("h4",{id:"parameters-83"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"This param is the string which includes the invite link or code. The following work: - Follow this link to join my WA group: ",(0,r.kt)("a",{parentName:"td",href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"},"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ")," - ",(0,r.kt)("a",{parentName:"td",href:"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ"},"https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ")," - DHTGJUfFJAV9MxOpZO1fBZ If you have been removed from the group previously, it will return ",(0,r.kt)("inlineCode",{parentName:"td"},"401"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"returnChatObj?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata.")))),(0,r.kt)("h4",{id:"returns-126"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," Either false if it didn't work, or the group id."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"joinwebbeta"},"joinWebBeta"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"joinWebBeta"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"join"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Join or leave the wa web beta program. Will return true of operation was successful."),(0,r.kt)("h4",{id:"parameters-84"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"join")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"true to join the beta, false to leave")))),(0,r.kt)("h4",{id:"returns-127"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"kill"},"kill"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"kill"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"reason?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Shuts down the page and browser"),(0,r.kt)("h4",{id:"parameters-85"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"reason")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"MANUALLY_KILLED"'))))),(0,r.kt)("h4",{id:"returns-128"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"leavegroup"},"leaveGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"leaveGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes the host device from the group"),(0,r.kt)("h4",{id:"parameters-86"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id")))),(0,r.kt)("h4",{id:"returns-129"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listwebhooks"},"listWebhooks"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"listWebhooks"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),"[]",">"),(0,r.kt)("p",null,"Retreives an array of webhook objects"),(0,r.kt)("h4",{id:"returns-130"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadallearliermessages"},"loadAllEarlierMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadAllEarlierMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load all messages in chat object from server."),(0,r.kt)("h4",{id:"parameters-87"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-131"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadandgetallmessagesinchat"},"loadAndGetAllMessagesInChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadAndGetAllMessagesInChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeMe"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"includeNotifications"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"loads and Retrieves all Messages in a chat"),(0,r.kt)("h4",{id:"parameters-88"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeMe")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"includeNotifications")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns-132"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"any"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadearliermessages"},"loadEarlierMessages"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadEarlierMessages"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time"),(0,r.kt)("h4",{id:"parameters-89"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")))))),(0,r.kt)("h4",{id:"returns-133"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message []"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"loadearliermessagestilldate"},"loadEarlierMessagesTillDate"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"loadEarlierMessagesTillDate"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"timestamp"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Load all messages until a given timestamp in chat object from server."),(0,r.kt)("h4",{id:"parameters-90"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"timestamp")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"in seconds")))),(0,r.kt)("h4",{id:"returns-134"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),"[]",">"),(0,r.kt)("p",null,"Message[]"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logger"},"logger"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"logger"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Grab the logger for this session/process"),(0,r.kt)("h4",{id:"returns-135"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"logout"},"logout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"logout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"preserveSessionData?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Logs out from the session."),(0,r.kt)("h4",{id:"parameters-91"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preserveSessionData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"skip session.data.json file invalidation Please be careful when using this as it can exit the whole process depending on your config")))),(0,r.kt)("h4",{id:"returns-136"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"markallread"},"markAllRead"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"markAllRead"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Runs sendSeen on all chats"),(0,r.kt)("h4",{id:"returns-137"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"markasunread"},"markAsUnread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"markAsUnread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets a chat status to unread. May be useful to get host's attention"),(0,r.kt)("h4",{id:"parameters-92"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-138"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"metrics"},"metrics"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"metrics"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns some metrics of the session/page."),(0,r.kt)("h4",{id:"returns-139"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"middleware"},"middleware"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"middleware"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"useSessionIdInPath?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"PORT?"),"): (",(0,r.kt)("inlineCode",{parentName:"p"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Request"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"ParamsDictionary"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ParsedQs"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Response"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">",", ",(0,r.kt)("inlineCode",{parentName:"p"},"next"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"NextFunction"),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example\nHow to use the middleware:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"\nimport { create } from '@open-wa/wa-automate';\nconst express = require('express')\nconst app = express()\napp.use(express.json())\nconst PORT = 8082;\n\nfunction start(client){\n app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)\n app.listen(PORT, function () {\n console.log(`\\n\u2022 Listening on port ${PORT}!`);\n });\n ...\n}\n\ncreate({\n sessionId:'session1'\n}).then(start)\n\n")),(0,r.kt)("p",null,"All requests need to be ",(0,r.kt)("inlineCode",{parentName:"p"},"POST")," requests. You use the API the same way you would with ",(0,r.kt)("inlineCode",{parentName:"p"},"client"),". The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body."),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"}," await client.sendText('4477777777777@c.us','test')\n //returns \"true_4477777777777@c.us_3EB0645E623D91006252\"\n")),(0,r.kt)("p",null,"as a request with a path:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const axios = require('axios').default;\naxios.post('localhost:8082/sendText', {\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n })\n")),(0,r.kt)("p",null,"or as a request without a path:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"const axios = require('axios').default;\naxios.post('localhost:8082', {\n method:'sendText',\n args: [\n \"4477777777777@c.us\", \n \"test\" \n ]\n})\n")),(0,r.kt)("p",null,"As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions"),(0,r.kt)("p",null,"Example:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'const axios = require(\'axios\').default;\naxios.post(\'localhost:8082\', {\n method:\'sendText\',\n args: {\n "to":"4477777777777@c.us", \n "content":"test" \n }\n})\n')),(0,r.kt)("h4",{id:"parameters-93"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useSessionIdInPath")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean Set this to true if you want to keep each session in it's own path. For example, if you have a session with id ",(0,r.kt)("inlineCode",{parentName:"td"},"host")," if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path ",(0,r.kt)("inlineCode",{parentName:"td"},"host"),". E.g ",(0,r.kt)("inlineCode",{parentName:"td"},"localhost:8082/sendText")," becomes ",(0,r.kt)("inlineCode",{parentName:"td"},"localhost:8082/host/sendText"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PORT?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-140"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"fn")),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"next"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h5",{id:"parameters-94"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Request"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParamsDictionary"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedQs"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Response"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"next")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextFunction"))))),(0,r.kt)("h5",{id:"returns-141"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mutechat-insiders"},"muteChat ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"muteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"muteDuration"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called."),(0,r.kt)("h4",{id:"parameters-95"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation you want to mute")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"muteDuration")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatMuteDuration"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatMuteDuration"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatMuteDuration enum of the time you want this chat to be muted for.")))),(0,r.kt)("h4",{id:"returns-142"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked or error code or message"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onnewproduct-insiders"},"onNewProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onNewProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to new orders. Only works on business accounts"),(0,r.kt)("h4",{id:"parameters-96"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"product"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.Product"},(0,r.kt)("inlineCode",{parentName:"a"},"Product")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-143"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onorder-insiders"},"onOrder ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onOrder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to new orders. Only works on business accounts"),(0,r.kt)("h4",{id:"parameters-97"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"order"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.Order"},(0,r.kt)("inlineCode",{parentName:"a"},"Order")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-144"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pinchat"},"pinChat"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"pinChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pin"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Pin/Unpin chats"),(0,r.kt)("h4",{id:"parameters-98"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the conversation")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-145"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postimagestatus-restricted"},"postImageStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postImageStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Posts an image story."),(0,r.kt)("h4",{id:"parameters-99"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"data url string ",(0,r.kt)("inlineCode",{parentName:"td"},"data:[][;charset=][;base64],"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The caption for the story")))),(0,r.kt)("h4",{id:"returns-146"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttextstatus-restricted"},"postTextStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postTextStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"textRgba"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"backgroundRgba"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"font"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Sends a formatted text story."),(0,r.kt)("h4",{id:"parameters-100"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text to be displayed in the story")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textRgba")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},'The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backgroundRgba")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},'The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"')),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"font")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from: 0: Sans Serif 1: Serif 2: ",(0,r.kt)("a",{parentName:"td",href:"https://fonts.google.com/specimen/Norican"},"Norican Regular")," 3: ",(0,r.kt)("a",{parentName:"td",href:"https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm"},"Bryndan Write")," 4: ",(0,r.kt)("a",{parentName:"td",href:"https://www.dafont.com/bebas-neue.font"},"Bebasneue Regular")," 5: ",(0,r.kt)("a",{parentName:"td",href:"https://www.fontsquirrel.com/fonts/oswald"},"Oswald Heavy"))))),(0,r.kt)("h4",{id:"returns-147"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postvideostatus-restricted"},"postVideoStatus ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"postVideoStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Posts a video story."),(0,r.kt)("h4",{id:"parameters-101"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"data url string ",(0,r.kt)("inlineCode",{parentName:"td"},"data:[][;charset=][;base64],"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The caption for the story")))),(0,r.kt)("h4",{id:"returns-148"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," returns status id if it worked, false if it didn't"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"prepeventdata"},"prepEventData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prepEventData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"event"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"extras?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.EventPayload"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPayload"))),(0,r.kt)("h4",{id:"parameters-102"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"JsonObject"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"event")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"extras?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"JsonObject"))))),(0,r.kt)("h4",{id:"returns-149"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.EventPayload"},(0,r.kt)("inlineCode",{parentName:"a"},"EventPayload"))),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"promoteparticipant"},"promoteParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"promoteParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Promote Participant to Admin in Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-103"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-150"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"react"},"react"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"react"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"emoji"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"React to a message"),(0,r.kt)("h4",{id:"parameters-104"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to react to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emoji")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"1 single emoji to add to the message as a reacion")))),(0,r.kt)("h4",{id:"returns-151"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"refresh"},"refresh"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"refresh"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory\nThis will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged"),(0,r.kt)("h4",{id:"returns-152"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"registerwebhook"},"registerWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"registerWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"events"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"concurrency?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"The client can now automatically handle webhooks. Use this method to register webhooks."),(0,r.kt)("h4",{id:"parameters-105"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The webhook url")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"events")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"all"')),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of SimpleListener enums or ",(0,r.kt)("inlineCode",{parentName:"td"},"all")," (to register all possible listeners)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"concurrency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"5")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the amount of concurrent requests to be handled by the built in queue. Default is 5.")))),(0,r.kt)("h4",{id:"returns-153"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"A webhook object. This will include a webhook ID and an array of all successfully registered Listeners."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rejectgroupjoinrequest"},"rejectGroupJoinRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"rejectGroupJoinRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupChatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Rejects a group join request"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"})),(0,r.kt)("h4",{id:"parameters-106"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupChatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The group chat id *")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The contact id of the person who is requesting to join the group *")))),(0,r.kt)("h4",{id:"returns-154"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removealllisteners"},"removeAllListeners"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeAllListeners"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"returns-155"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelabel"},"removeLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"label"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes label from chat, message or contact. Only for business accounts."),(0,r.kt)("h4",{id:"parameters-107"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-156"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removelistener"},"removeListener"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeListener"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"listener"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"//////////////////////// LISTENERS"),(0,r.kt)("h4",{id:"parameters-108"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"listener")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))))),(0,r.kt)("h4",{id:"returns-157"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeparticipant"},"removeParticipant"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeParticipant"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"participantId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Remove participant of Group"),(0,r.kt)("p",null,"If not a group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_GROUP_CHAT"),"."),(0,r.kt)("p",null,"If the chat does not exist, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"GROUP_DOES_NOT_EXIST")),(0,r.kt)("p",null,"If the participantId does not exist in the group chat, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"NOT_A_PARTICIPANT")),(0,r.kt)("p",null,"If the host account is not an administrator, returns ",(0,r.kt)("inlineCode",{parentName:"p"},"INSUFFICIENT_PERMISSIONS")),(0,r.kt)("h4",{id:"parameters-109"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"0000000000-00000000@g.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"participantId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"000000000000@c.us"))))),(0,r.kt)("h4",{id:"returns-158"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removeproduct"},"removeProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Remove a product from the host account's catalog"),(0,r.kt)("h4",{id:"parameters-110"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the product")))),(0,r.kt)("h4",{id:"returns-159"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removewebhook"},"removeWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"webhookId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Removes a webhook."),(0,r.kt)("p",null,"Returns ",(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the webhook was found and removed. ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Retruns"))),(0,r.kt)("p",null,"boolean"),(0,r.kt)("h4",{id:"parameters-111"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webhookId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ID of the webhook")))),(0,r.kt)("h4",{id:"returns-160"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reply"},"reply"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sendSeen?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly."),(0,r.kt)("h4",{id:"parameters-112"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string chatid")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string reply text")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the msg id to reply to.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sendSeen?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean If set to true, the chat will 'blue tick' all messages before sending the reply")))),(0,r.kt)("h4",{id:"returns-161"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," false if didn't work, otherwise returns message id."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"reportspam-restricted"},"reportSpam ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"reportSpam"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"id"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Report a contact for spam, block them and attempt to clear chat."),(0,r.kt)("h4",{id:"parameters-113"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")))),(0,r.kt)("h4",{id:"returns-162"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"resizepage"},"resizePage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"resizePage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Easily resize page on the fly. Useful if you're showing screenshots in a web-app."),(0,r.kt)("h4",{id:"parameters-114"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1920"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"1080"))))),(0,r.kt)("h4",{id:"returns-163"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revokegroupinvitelink"},"revokeGroupInviteLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revokeGroupInviteLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Revokes the current invite link for a group chat. Any previous links will stop working"),(0,r.kt)("h4",{id:"parameters-115"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-164"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendadvancedbuttons"},"sendAdvancedButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendAdvancedButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"body"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"buttons"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"footer"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.\nWA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts."),(0,r.kt)("p",{parentName:"admonition"},"THIS IS NOT WORKING FOR GROUPS YET."),(0,r.kt)("p",{parentName:"admonition"},"ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.")),(0,r.kt)("p",null,"Send advanced buttons with media body. This is an insiders feature for MD accounts."),(0,r.kt)("p",null,"Body can be location, image, video or document. Buttons can be quick reply, url or call buttons."),(0,r.kt)("h4",{id:"parameters-116"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"body")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.LocationButtonBody"},(0,r.kt)("inlineCode",{parentName:"a"},"LocationButtonBody"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The body of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"buttons")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.AdvancedButton"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedButton")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of buttons - limit is 3!")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"footer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The footer of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Required if body is a file!!")))),(0,r.kt)("h4",{id:"returns-165"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendaudio"},"sendAudio"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendAudio"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send an audio file with the default audio player (not PTT/voice message)"),(0,r.kt)("h4",{id:"parameters-117"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")))),(0,r.kt)("h4",{id:"returns-166"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendbanner"},"sendBanner"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendBanner"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"base64"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a banner image"),(0,r.kt)("p",null,"Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones."),(0,r.kt)("h4",{id:"parameters-118"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"base64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"base64 encoded jpeg")))),(0,r.kt)("h4",{id:"returns-167"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendbuttons"},"sendButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"body"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"buttons"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"footer?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.\nTHIS IS NOT WORKING FOR GROUPS YET."),(0,r.kt)("p",{parentName:"admonition"},"BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.")),(0,r.kt)("p",null,"Send generic quick reply buttons. This is an insiders feature for MD accounts."),(0,r.kt)("h4",{id:"parameters-119"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"body")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.LocationButtonBody"},(0,r.kt)("inlineCode",{parentName:"a"},"LocationButtonBody"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The body of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"buttons")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.Button"},(0,r.kt)("inlineCode",{parentName:"a"},"Button")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of buttons - limit is 3!")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title/header of the buttons message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"footer?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The footer of the buttons message")))),(0,r.kt)("h4",{id:"returns-168"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendcontact"},"sendContact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendContact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages."),(0,r.kt)("h4",{id:"parameters-120"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-169"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendcustomproduct"},"sendCustomProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendCustomProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productData"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Feature Currently only available with Premium License accounts."),(0,r.kt)("p",null,"Send a custom product to a chat. Please see CustomProduct for details."),(0,r.kt)("p",null,"Caveats:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"URL will not work (unable to click), you will have to send another message with the URL."),(0,r.kt)("li",{parentName:"ul"},'Recipient will see a thin banner under picture that says "Something went wrong"'),(0,r.kt)("li",{parentName:"ul"},"This will only work if you have at least 1 product already in your catalog"),(0,r.kt)("li",{parentName:"ul"},"Only works on Business accounts")),(0,r.kt)("h4",{id:"parameters-121"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_product.CustomProduct"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomProduct")))))),(0,r.kt)("h4",{id:"returns-170"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendemoji"},"sendEmoji"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendEmoji"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"emojiId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a discord emoji to a chat as a sticker"),(0,r.kt)("h4",{id:"parameters-122"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"emojiId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The discord emoji id without indentifying chars. In discord you would write ",(0,r.kt)("inlineCode",{parentName:"td"},":who:"),", here use ",(0,r.kt)("inlineCode",{parentName:"td"},"who"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"message id of the message you want this sticker to reply to. {@license:insiders@}")))),(0,r.kt)("h4",{id:"returns-171"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendfile"},"sendFile"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendFile"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage"),(0,r.kt)("p",null,"Please note that any file that resolves to mime-type ",(0,r.kt)("inlineCode",{parentName:"p"},"octet-stream")," will, by default, resolve to an MP4 file."),(0,r.kt)("p",null,"If you want a specific filetype, then explcitly select the correct mime-type from ",(0,r.kt)("a",{parentName:"p",href:"https://www.iana.org/assignments/media-types/media-types.xhtml"},"https://www.iana.org/assignments/media-types/media-types.xhtml")),(0,r.kt)("h4",{id:"parameters-123"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx With an ",(0,r.kt)("a",{parentName:"td",href:"https://gum.co/open-wa?tier=Insiders%20Program"},"INSIDERS LICENSE-KEY")," you can also tag people in groups with ",(0,r.kt)("inlineCode",{parentName:"td"},"@[number]"),". For example if you want to mention the user with the number ",(0,r.kt)("inlineCode",{parentName:"td"},"44771234567"),", just add ",(0,r.kt)("inlineCode",{parentName:"td"},"@44771234567")," in the caption.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file as a push to talk file.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false ","[INSIDERS]"," set this to try silent tag someone in the caption")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-172"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendfilefromurl"},"sendFileFromUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendFileFromUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a file by Url or custom options"),(0,r.kt)("h4",{id:"parameters-124"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"},"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string 'video.mp4'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file as a push to talk file.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-173"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendgiphy"},"sendGiphy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendGiphy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"giphyMediaUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-125"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"giphyMediaUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif"},"https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif")," => ",(0,r.kt)("a",{parentName:"td",href:"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"},"https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")))),(0,r.kt)("h4",{id:"returns-174"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendgiphyassticker"},"sendGiphyAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendGiphyAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"giphyMediaUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a giphy GIF as an animated sticker."),(0,r.kt)("h4",{id:"parameters-126"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"giphyMediaUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"URL")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL ","|"," string This is the giphy media url and has to be in the format ",(0,r.kt)("inlineCode",{parentName:"td"},"https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif")," or it can be just the id ",(0,r.kt)("inlineCode",{parentName:"td"},"RJKHjCAdsAfQPn03qQ"))))),(0,r.kt)("h4",{id:"returns-175"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimage"},"sendImage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"waitForId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ptt?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withoutPreview?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"viewOnce?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a image to given chat, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-127"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"waitForId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ptt?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withoutPreview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean default: false ","[INSIDERS]"," set this to try silent tag someone in the caption")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"viewOnce?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-176"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimageassticker"},"sendImageAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.\nThe advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format."),(0,r.kt)("h4",{id:"parameters-128"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata")))))),(0,r.kt)("h4",{id:"returns-177"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimageasstickerasreply-insiders"},"sendImageAsStickerAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageAsStickerAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"This function takes an image and sends it as a sticker to the recipient as a reply to another message."),(0,r.kt)("h4",{id:"parameters-129"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The recipient id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sticker metadata")))),(0,r.kt)("h4",{id:"returns-178"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendimagewithproduct"},"sendImageWithProduct"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendImageWithProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"bizNumber"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends product with image to chat"),(0,r.kt)("h4",{id:"parameters-130"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the caption you want to add to this message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"bizNumber")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the @c.us number of the business account from which you want to grab the product")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string the id of the product within the main catalog of the aforementioned business")))),(0,r.kt)("h4",{id:"returns-179"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlinkwithautopreview"},"sendLinkWithAutoPreview"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendLinkWithAutoPreview"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"thumbnail?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"customSize?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Automatically sends a link with the auto generated link preview. You can also add a custom message."),(0,r.kt)("h4",{id:"parameters-131"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string A link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Custom text as body of the message, this needs to include the link or it will be appended after the link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumbnail?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Send this link preview message in response to a given quoted message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Anchor the size of the thumbnail (e.g {height: 100, width: 100})")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-180"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlistmessage"},"sendListMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendListMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sections"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"actionText"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"It is not currently possible to send a listmessage to a group chat. This is a WA limitation.\nPlease DO NOT get a license solely for access to list messages in group chats."),(0,r.kt)("p",{parentName:"admonition"},"LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE")),(0,r.kt)("p",null,"Send a list message. This will not work when being sent from business accounts!"),(0,r.kt)("h4",{id:"parameters-132"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sections")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_button.Section"},(0,r.kt)("inlineCode",{parentName:"a"},"Section")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Sections of rows for the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title of the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The description of the list message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"actionText")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The action text of the list message")))),(0,r.kt)("h4",{id:"returns-181"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendlocation"},"sendLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"lat"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"lng"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"loc"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"address?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Note: ",(0,r.kt)("inlineCode",{parentName:"p"},"address")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"url")," are parameters available to insiders only."),(0,r.kt)("p",null,"Sends a location message to given chat"),(0,r.kt)("h4",{id:"parameters-133"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lat")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"latitude: '51.5074'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lng")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"longitude: '0.1278'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"loc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"location text: 'LONDON!'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"address?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"address text: '1 Regents Park!'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"address text link: '",(0,r.kt)("a",{parentName:"td",href:"https://example.com'"},"https://example.com'"))))),(0,r.kt)("h4",{id:"returns-182"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmessagewiththumb"},"sendMessageWithThumb"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMessageWithThumb"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"thumb"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"customSize?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a link to a chat that includes a link preview."),(0,r.kt)("h4",{id:"parameters-134"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link you want to send")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The title of the link")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The long description of the link preview")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chat you want to send this message to.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Send this link preview message in response to a given quoted message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Anchor the size of the thumbnail (e.g {height: 100, width: 100})")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-183"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmp4assticker"},"sendMp4AsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMp4AsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"processOptions?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files."),(0,r.kt)("h4",{id:"parameters-135"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Buffer")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL, Base64, URL (string GET), Relative filepath (string), or Buffer of the mp4 file")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"processOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"Mp4StickerConversionProcessOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultProcessOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"message id of the message you want this sticker to reply to. {@license:insiders@}")))),(0,r.kt)("h4",{id:"returns-184"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendmultiplecontacts-insiders"},"sendMultipleContacts ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendMultipleContacts"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactIds"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Sends multiple contacts as a single message"),(0,r.kt)("h4",{id:"parameters-136"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactIds")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-185"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendpaymentrequest"},"sendPaymentRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPaymentRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"amount"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"currency"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"message?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"[UNTESTED - REQUIRES FEEDBACK]","\nSends a payment request message to given chat"),(0,r.kt)("h4",{id:"parameters-137"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"amount")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"number the amount to request in 1000 format (e.g \xa310 => 10000)")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"currency")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The 3 letter currency code")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string optional message to send with the payment request")))),(0,r.kt)("h4",{id:"returns-186"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendpoll"},"sendPoll"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPoll"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowMultiSelect?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Send a poll to a group chat"),(0,r.kt)("h4",{id:"parameters-138"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id - a group chat is required")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the name of the poll")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"an array of poll options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"A message to quote when sending the poll")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowMultiSelect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether or not to allow multiple selections. default false")))),(0,r.kt)("h4",{id:"returns-187"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendproduct-insiders"},"sendProduct ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendProduct"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"productId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Send a product to a chat"),(0,r.kt)("h4",{id:"parameters-139"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The chatId")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"productId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the product")))),(0,r.kt)("h4",{id:"returns-188"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"MessageID"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendptt"},"sendPtt"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendPtt"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Attempts to send a file as a voice note. Useful if you want to send an mp3 file."),(0,r.kt)("h4",{id:"parameters-140"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"base64 data:image/xxx;base64,xxx or the path of the file you want to send.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")))),(0,r.kt)("h4",{id:"returns-189"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise ")," This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendrawwebpassticker"},"sendRawWebpAsSticker"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendRawWebpAsSticker"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"webpBase64"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"animated?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"You can use this to send a raw webp file."),(0,r.kt)("h4",{id:"parameters-141"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webpBase64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 The base64 string of the webp file. Not DataURl")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"animated")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Boolean Set to true if the webp is animated. Default ",(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-190"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendrawwebpasstickerasreply-insiders"},"sendRawWebpAsStickerAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendRawWebpAsStickerAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"webpBase64"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"animated?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"You can use this to send a raw webp file."),(0,r.kt)("h4",{id:"parameters-142"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"ChatId The chat id you want to send the webp sticker to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"MessageId Message ID of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webpBase64")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Base64 The base64 string of the webp file. Not DataURl")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"animated")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Boolean Set to true if the webp is animated. Default ",(0,r.kt)("inlineCode",{parentName:"td"},"false"))))),(0,r.kt)("h4",{id:"returns-191"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendreplywithmentions"},"sendReplyWithMentions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendReplyWithMentions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"replyMessageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mentions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,'Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'),(0,r.kt)("h4",{id:"parameters-143"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"replyMessageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"id of message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mentions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can optionally add an array of contact IDs to tag only specific people")))),(0,r.kt)("h4",{id:"returns-192"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendseen"},"sendSeen"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendSeen"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets a chat status to seen. Marks all messages as ack: 3"),(0,r.kt)("h4",{id:"parameters-144"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))))),(0,r.kt)("h4",{id:"returns-193"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendstickerfromurl"},"sendStickerfromUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendStickerfromUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a sticker (including GIF) from a given URL"),(0,r.kt)("h4",{id:"parameters-145"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-194"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendstickerfromurlasreply-insiders"},"sendStickerfromUrlAsReply ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendStickerfromUrlAsReply"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"stickerMetadata?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Sends a sticker from a given URL"),(0,r.kt)("h4",{id:"parameters-146"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The recipient id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url of the image")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the message to reply to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"stickerMetadata?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_media.StickerMetadata"},(0,r.kt)("inlineCode",{parentName:"a"},"StickerMetadata"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-195"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtext-restricted"},"sendText ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendText"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Sends a text message to given chat"),(0,r.kt)("p",null,"A license is ",(0,r.kt)("strong",{parentName:"p"},"NOT")," required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers."),(0,r.kt)("h4",{id:"parameters-147"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")))),(0,r.kt)("h4",{id:"returns-196"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendtextwithmentions"},"sendTextWithMentions"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendTextWithMentions"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"mentions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,'Sends a text message to given chat that includes mentions.\nIn order to use this method correctly you will need to send the text like this:\n"@4474747474747 how are you?"\nBasically, add a @ symbol before the number of the contact you want to mention.'),(0,r.kt)("h4",{id:"parameters-148"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mentions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ContactId"},(0,r.kt)("inlineCode",{parentName:"a"},"ContactId")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"You can optionally add an array of contact IDs to tag only specific people")))),(0,r.kt)("h4",{id:"returns-197"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendvcard"},"sendVCard"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendVCard"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"vcard"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"contactNumber?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Send VCARD"),(0,r.kt)("h4",{id:"parameters-149"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:000000000000@c.us"},"000000000000@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"vcard")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"vcard as a string, you can send multiple contacts vcard also.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The display name for the contact. Ignored on multiple vcards")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contactNumber?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g: ",(0,r.kt)("inlineCode",{parentName:"td"},"4477777777777")," Ignored on multiple vcards")))),(0,r.kt)("h4",{id:"returns-198"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendvideoasgif"},"sendVideoAsGif"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendVideoAsGif"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"file"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"filename"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"caption"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Sends a video to given chat as a gif, with caption or not, using base64"),(0,r.kt)("h4",{id:"parameters-150"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"chat id ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"file")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.AdvancedFile"},(0,r.kt)("inlineCode",{parentName:"a"},"AdvancedFile"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ",(0,r.kt)("inlineCode",{parentName:"td"},"./")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"../"),") path of the file you want to send. With the latest version, you can now set this to a normal URL (for example ","[GET]"," ",(0,r.kt)("inlineCode",{parentName:"td"},"https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg"),").")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"filename")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"caption")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string xxxxx")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string ",(0,r.kt)("a",{parentName:"td",href:"mailto:true_0000000000@c.us_JHB2HB23HJ4B234HJB"},"true_0000000000@c.us_JHB2HB23HJ4B234HJB")," to send as a reply to a message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))))),(0,r.kt)("h4",{id:"returns-199"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sendyoutubelink"},"sendYoutubeLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"sendYoutubeLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"thumbnail?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"quotedMsgId?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"customSize?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,"Automatically sends a youtube link with the auto generated link preview. You can also add a custom message."),(0,r.kt)("h4",{id:"parameters-151"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string A youtube link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Custom text as body of the message, this needs to include the link or it will be appended after the link.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"thumbnail?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Base64"},(0,r.kt)("inlineCode",{parentName:"a"},"Base64"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"quotedMsgId?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Send this link preview message in response to a given quoted message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"[INSIDERS]"," Anchor the size of the thumbnail (e.g {height: 100, width: 100})")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.height")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customSize.width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-200"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatbackgroundcolourhex-insiders"},"setChatBackgroundColourHex ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatBackgroundColourHex"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hex"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Set the wallpaper background colour"),(0,r.kt)("h4",{id:"parameters-152"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"'#FFF123'")))),(0,r.kt)("h4",{id:"returns-201"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatephemeral-insiders"},"setChatEphemeral ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatEphemeral"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ephemeral"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Turn the ephemeral setting in a chat to on or off"),(0,r.kt)("h4",{id:"parameters-153"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The ID of the chat")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ephemeral")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.EphemeralDuration"},(0,r.kt)("inlineCode",{parentName:"a"},"EphemeralDuration"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")," to turn on the ephemeral setting to 1 day, ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," to turn off the ephemeral setting. Other options: ",(0,r.kt)("inlineCode",{parentName:"td"},"604800 \\| 7776000"))))),(0,r.kt)("h4",{id:"returns-202"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," true if the setting was set, ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the chat does not exist"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setchatstate"},"setChatState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setChatState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatState"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets the chat state"),(0,r.kt)("h4",{id:"parameters-154"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatState")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatState"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatState"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-203"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupapprovalmode"},"setGroupApprovalMode"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupApprovalMode"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requireApproval"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Turn on or off the approval requirement for new members to join a group"),(0,r.kt)("h4",{id:"parameters-155"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requireApproval")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"set to true to turn on the approval requirement, false to turn off")))),(0,r.kt)("h4",{id:"returns-204"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupdescription"},"setGroupDescription"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupDescription"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the group chant description"),(0,r.kt)("h4",{id:"parameters-156"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"description")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The new group description")))),(0,r.kt)("h4",{id:"returns-205"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupedittoadminsonly"},"setGroupEditToAdminsOnly"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupEditToAdminsOnly"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyAdmins"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change who can and cannot edit a groups details"),(0,r.kt)("h4",{id:"parameters-157"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyAdmins")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group")))),(0,r.kt)("h4",{id:"returns-206"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupicon"},"setGroupIcon"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupIcon"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"image"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the icon for the group chat"),(0,r.kt)("h4",{id:"parameters-158"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"mailto:123123123123_1312313123@g.us"},"123123123123_1312313123@g.us")," The id of the group")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"image")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-207"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgroupiconbyurl"},"setGroupIconByUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupIconByUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"requestConfig?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change the icon for the group chat"),(0,r.kt)("h4",{id:"parameters-159"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"mailto:123123123123_1312313123@g.us"},"123123123123_1312313123@g.us")," The id of the group")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"requestConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AxiosRequestConfig"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/axios/axios#request-config"},"https://github.com/axios/axios#request-config"))))),(0,r.kt)("h4",{id:"returns-208"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgrouptitle-insiders"},"setGroupTitle ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupTitle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Change the group chat title"),(0,r.kt)("h4",{id:"parameters-160"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"title")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"string The new group title")))),(0,r.kt)("h4",{id:"returns-209"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setgrouptoadminsonly"},"setGroupToAdminsOnly"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setGroupToAdminsOnly"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"onlyAdmins"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Change who can and cannot speak in a group"),(0,r.kt)("h4",{id:"parameters-161"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:0000000000-00000000@g.us"},"0000000000-00000000@g.us"),"' the group id.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onlyAdmins")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group")))),(0,r.kt)("h4",{id:"returns-210"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true if action completed successfully."),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmyname"},"setMyName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMyName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"newName"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Set your profile name"),(0,r.kt)("p",null,"Please note, this does not work on business accounts!"),(0,r.kt)("h4",{id:"parameters-162"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"String new name to set for your profile")))),(0,r.kt)("h4",{id:"returns-211"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setmystatus"},"setMyStatus"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setMyStatus"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"newStatus"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"set your about me"),(0,r.kt)("h4",{id:"parameters-163"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"newStatus")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"String new profile status")))),(0,r.kt)("h4",{id:"returns-212"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setpresence"},"setPresence"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setPresence"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"available"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Set presence to available or unavailable."),(0,r.kt)("h4",{id:"parameters-164"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"available")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);")))),(0,r.kt)("h4",{id:"returns-213"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setprofilepic"},"setProfilePic"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setProfilePic"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Sets the profile pic of the host number."),(0,r.kt)("h4",{id:"parameters-165"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.DataURL"},(0,r.kt)("inlineCode",{parentName:"a"},"DataURL"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"string data url image string.")))),(0,r.kt)("h4",{id:"returns-214"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")," success if true"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"simulaterecording"},"simulateRecording"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"simulateRecording"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"on"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Simulate '...recording' in chat"),(0,r.kt)("h4",{id:"parameters-166"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"on")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"turn on similated recording, false to turn it off you need to manually turn this off.")))),(0,r.kt)("h4",{id:"returns-215"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"simulatetyping"},"simulateTyping"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"simulateTyping"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"to"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"on"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Simulate '...typing' in chat"),(0,r.kt)("h4",{id:"parameters-167"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"'",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxx@c.us"},"xxxx@c.us"),"'")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"on")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"turn on similated typing, false to turn it off you need to manually turn this off.")))),(0,r.kt)("h4",{id:"returns-216"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"starmessage"},"starMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"starMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Star a message"),(0,r.kt)("h4",{id:"parameters-168"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to star")))),(0,r.kt)("h4",{id:"returns-217"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"synccontacts"},"syncContacts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"syncContacts"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Syncs contacts with phone. This promise does not resolve so it will instantly return true."),(0,r.kt)("h4",{id:"returns-218"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tageveryone-insiders"},"tagEveryone ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"tagEveryone"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hideTags?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"formatting?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"messageBeforeTags?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Tags everyone in the group with a message"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Mention"))),(0,r.kt)("p",null,"to indicate the actual tag."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"@mention ")),(0,r.kt)("h4",{id:"parameters-169"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"group chat id: ",(0,r.kt)("inlineCode",{parentName:"td"},"xxxxx@g.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.Content"},(0,r.kt)("inlineCode",{parentName:"a"},"Content"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"text message to add under all of the tags")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hideTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Removes all tags within the message")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"formatting?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The formatting of the tags. Use")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageBeforeTags?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"set to ",(0,r.kt)("inlineCode",{parentName:"td"},"true")," to show the message before all of the tags")))),(0,r.kt)("h4",{id:"returns-219"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId")),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"testbuttons"},"testButtons"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"testButtons"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("admonition",{type:"danger"},(0,r.kt)("p",{parentName:"admonition"},"Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.")),(0,r.kt)("p",null,"Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658"),(0,r.kt)("h4",{id:"parameters-170"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-220"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"testcallback"},"testCallback"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"testCallback"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"callbackToTest"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"testData"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Use this simple command to test firing callback events."),(0,r.kt)("h4",{id:"parameters-171"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callbackToTest")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"testData")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-221"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," if the callback was not registered/does not exist"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unmutechat-insiders"},"unmuteChat ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"unmuteChat"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Unmutes a conversation."),(0,r.kt)("h4",{id:"parameters-172"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId")))))),(0,r.kt)("h4",{id:"returns-222"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean true: worked or error code or message"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"unstarmessage"},"unstarMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"unstarMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"messageId"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Unstar a message"),(0,r.kt)("h4",{id:"parameters-173"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"messageId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.MessageId"},(0,r.kt)("inlineCode",{parentName:"a"},"MessageId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Message ID of the message you want to unstar")))),(0,r.kt)("h4",{id:"returns-223"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"updatewebhook"},"updateWebhook"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"updateWebhook"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"webhookId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"events"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("p",null,"Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/api_Client.Client#removewebhook"},"removeWebhook"),"."),(0,r.kt)("p",null,"In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials."),(0,r.kt)("h4",{id:"parameters-174"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"webhookId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"events")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_events.SimpleListener"},(0,r.kt)("inlineCode",{parentName:"a"},"SimpleListener")),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},'"all"'))))),(0,r.kt)("h4",{id:"returns-224"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/api_model_config.Webhook"},(0,r.kt)("inlineCode",{parentName:"a"},"Webhook")),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitallqempty"},"waitAllQEmpty"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitAllQEmpty"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"[]",">"),(0,r.kt)("p",null,"Wait for all queues to be empty"),(0,r.kt)("h4",{id:"returns-225"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),"[]",">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"waitwhqidle"},"waitWhQIdle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"waitWhQIdle"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process."),(0,r.kt)("h4",{id:"returns-226"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"true")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h2",{id:"events"},"Events"),(0,r.kt)("h3",{id:"onack"},"onAck"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAck"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to messages acknowledgement Changes"),(0,r.kt)("h4",{id:"parameters-175"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Message as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-227"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onaddedtogroup"},"onAddedToGroup"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAddedToGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Fires callback with Chat object every time the host phone is added to a group."),(0,r.kt)("h4",{id:"parameters-176"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat (group chat) as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-228"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onanymessage"},"onAnyMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onAnyMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to all new messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-177"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueOptions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Options"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"PQueue options. Set to ",(0,r.kt)("inlineCode",{parentName:"td"},"{}")," for default PQueue.")))),(0,r.kt)("h4",{id:"returns-229"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbattery"},"onBattery"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onBattery"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Deprecated"))),(0,r.kt)("p",null,"Listens to battery changes"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"}," This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"number"),(0,r.kt)("h4",{id:"parameters-178"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"battery"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-230"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbroadcast"},"onBroadcast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onBroadcast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to broadcast messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-179"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-231"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onbutton"},"onButton"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onButton"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to button message responses"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-180"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-232"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oncallstate"},"onCallState"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onCallState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to changes on call state"),(0,r.kt)("h4",{id:"parameters-181"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"call"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_call.Call"},(0,r.kt)("inlineCode",{parentName:"a"},"Call")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-233"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of call objects"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatdeleted"},"onChatDeleted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatDeleted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when a chat is deleted by the host account"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Chat"),(0,r.kt)("h4",{id:"parameters-182"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-234"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatopened-insiders"},"onChatOpened ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatOpened"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode."),(0,r.kt)("h4",{id:"parameters-183"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ChatId as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-235"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onchatstate-insiders"},"onChatState ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onChatState"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to chat state, including when a specific user is recording and typing within a group chat."),(0,r.kt)("p",null,"Here is an example of the fired object:"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'{\n"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring\n"user": "22222222222@c.us", //the user that is causing this state\n"state": "composing, //can also be \'available\', \'unavailable\', \'recording\' or \'composing\'\n}\n')),(0,r.kt)("h4",{id:"parameters-184"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chatState"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model_chat.ChatState"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatState")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-236"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"oncontactadded-insiders"},"onContactAdded ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onContactAdded"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with contact id when a new contact is added on the host phone."),(0,r.kt)("h4",{id:"parameters-185"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-237"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onglobalparticipantschanged"},"onGlobalParticipantsChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGlobalParticipantsChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to."),(0,r.kt)("h4",{id:"parameters-186"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"participantChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel"},(0,r.kt)("inlineCode",{parentName:"a"},"ParticipantChangedEventModel")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ParticipantChangedEventModel as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-238"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ongroupapprovalrequest"},"onGroupApprovalRequest"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGroupApprovalRequest"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listents to group approval requests. Emits a message object. Use it with ",(0,r.kt)("inlineCode",{parentName:"p"},"message.isGroupApprovalRequest()")," to check if it is a group approval request."),(0,r.kt)("h4",{id:"parameters-187"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"groupApprovalRequestMessage"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Message as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-239"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ongroupchange"},"onGroupChange"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onGroupChange"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed."),(0,r.kt)("h4",{id:"parameters-188"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"genericGroupChangeEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"GenericGroupChangeEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a ParticipantChangedEventModel as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-240"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onincomingcall"},"onIncomingCall"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onIncomingCall"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to new incoming calls"),(0,r.kt)("h4",{id:"parameters-189"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"call"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_call.Call"},(0,r.kt)("inlineCode",{parentName:"a"},"Call")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-241"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of call request objects"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlabel"},"onLabel"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLabel"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to label change events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Label"),(0,r.kt)("h4",{id:"parameters-190"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"label"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_label.Label"},(0,r.kt)("inlineCode",{parentName:"a"},"Label")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-242"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlivelocation"},"onLiveLocation"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLiveLocation"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"chatId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Listens to live locations from a chat that already has valid live locations"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Emits"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"")," LiveLocationChangedEvent"),(0,r.kt)("h4",{id:"parameters-191"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"chatId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.ChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"ChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"the chat from which you want to subscribes to live location updates")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"liveLocationChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"LiveLocationChangedEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback that takes in a LiveLocationChangedEvent")))),(0,r.kt)("h4",{id:"returns-243"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"boolean, if returns false then there were no valid live locations in the chat of chatId"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onlogout"},"onLogout"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onLogout"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"priority?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("p",null,"Listens to a log out event"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")),(0,r.kt)("h4",{id:"parameters-192"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"loggedOut?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"A priority of -1 will mean the callback will be triggered after all the non -1 callbacks")))),(0,r.kt)("h4",{id:"returns-244"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onmessage"},"onMessage"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onMessage"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"queueOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to incoming messages"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-193"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"queueOptions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Options"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"default"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"DefaultAddOptions"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"PQueue options. Set to ",(0,r.kt)("inlineCode",{parentName:"td"},"{}")," for default PQueue.")))),(0,r.kt)("h4",{id:"returns-245"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onmessagedeleted"},"onMessageDeleted"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onMessageDeleted"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when a message is deleted by a recipient or the host account"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"Message"),(0,r.kt)("h4",{id:"parameters-194"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"message"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-246"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onparticipantschanged"},"onParticipantsChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onParticipantsChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"legacy?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote"),(0,r.kt)("h4",{id:"parameters-195"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"groupId")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_aliases.GroupChatId"},(0,r.kt)("inlineCode",{parentName:"a"},"GroupChatId"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"group id: ",(0,r.kt)("a",{parentName:"td",href:"mailto:xxxxx-yyyy@c.us"},"xxxxx-yyyy@c.us"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"participantChangedEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel"},(0,r.kt)("inlineCode",{parentName:"a"},"ParticipantChangedEventModel")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"legacy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-247"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Observable stream of participantChangedEvent"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onplugged"},"onPlugged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onPlugged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to when host device is plugged/unplugged"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"boolean true if plugged, false if unplugged"),(0,r.kt)("h4",{id:"parameters-196"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"plugged"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-248"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onpollvote"},"onPollVote"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onPollVote"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to poll vote events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"PollData"),(0,r.kt)("h4",{id:"parameters-197"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"pollDate"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.PollData"},(0,r.kt)("inlineCode",{parentName:"a"},"PollData")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-249"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onreaction-insiders"},"onReaction ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onReaction"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Listens to reaction add and change events"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"ReactionEvent"),(0,r.kt)("h4",{id:"parameters-198"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"reactionEvent"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_reactions.ReactionEvent"},(0,r.kt)("inlineCode",{parentName:"a"},"ReactionEvent")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-250"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onremovedfromgroup-insiders"},"onRemovedFromGroup ",(0,r.kt)("div",{class:"label license insiders"},"insiders")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onRemovedFromGroup"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require insiders license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=Insiders%20Program"},"correct license"),".")),(0,r.kt)("p",null,"Fires callback with Chat object every time the host phone is removed to a group."),(0,r.kt)("h4",{id:"parameters-199"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"chat"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/types/api_model_chat.Chat"},(0,r.kt)("inlineCode",{parentName:"a"},"Chat")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback function that handles a Chat (group chat) as the first and only parameter.")))),(0,r.kt)("h4",{id:"returns-251"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"true")," if the callback was registered"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onstatechanged"},"onStateChanged"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onStateChanged"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("p",null,"Listens to changes in state"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"STATE observable sream of states"),(0,r.kt)("h4",{id:"parameters-200"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"state"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/api_model.STATE"},(0,r.kt)("inlineCode",{parentName:"a"},"STATE")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-252"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"onstory-restricted"},"onStory ",(0,r.kt)("div",{class:"label license restricted"},"restricted")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"onStory"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fn"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"),(0,r.kt)("admonition",{title:"May require restricted license",type:"license"},(0,r.kt)("p",{parentName:"admonition"},"Use this link to get the ",(0,r.kt)("a",{parentName:"p",href:"https://gum.co/open-wa?wanted=true&tier=1%20Restricted%20License"},"correct license"),".")),(0,r.kt)("p",null,"Listens to when a contact posts a new story."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Fires"))),(0,r.kt)("p",null,"e.g "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"{\nfrom: '123456789@c.us'\nid: 'false_132234234234234@status.broadcast'\n}\n")),(0,r.kt)("h4",{id:"parameters-201"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fn")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"story"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/api_model_message.Message"},(0,r.kt)("inlineCode",{parentName:"a"},"Message")),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void")),(0,r.kt)("td",{parentName:"tr",align:"left"},"callback")))),(0,r.kt)("h4",{id:"returns-253"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Listener"),">"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.575d75db.js b/assets/js/runtime~main.8432b93e.js similarity index 99% rename from assets/js/runtime~main.575d75db.js rename to assets/js/runtime~main.8432b93e.js index 8a831417aa..78e3457021 100644 --- a/assets/js/runtime~main.575d75db.js +++ b/assets/js/runtime~main.8432b93e.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,b,c,d,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=f,r.c=t,e=[],r.O=(a,b,c,d)=>{if(!b){var f=1/0;for(i=0;i=d)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[b,c,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var f={};a=a||[null,b({}),b([]),b(b)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(d,f),d},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",58:"a9a21e60",78:"d6baa543",110:"66406991",156:"9777d391",172:"91347036",190:"5f279a09",221:"0a2b83e7",261:"dbfd9f1c",319:"79bb96de",338:"f7e2c45c",353:"6d1f7a65",453:"30a24c52",490:"6875c492",533:"b2b675dd",636:"626be1ff",639:"fb625892",800:"3964a121",843:"7e2af6ab",948:"8717b14a",950:"e3562450",982:"feefca73",1057:"38ab6ee2",1084:"2a8f6777",1087:"1f67bc2c",1124:"7107a671",1161:"18ad8d0a",1202:"edb57414",1215:"5ba20bff",1234:"de7758a7",1267:"c40efc75",1332:"3752fa13",1425:"a31ecf28",1445:"be56b9dd",1460:"6b55e007",1477:"b2f554cd",1498:"e4469e1d",1520:"7da1a906",1522:"8583c809",1589:"ce48d423",1591:"613a5cbe",1598:"075e8322",1612:"810bf78a",1633:"031793e1",1650:"dad96364",1660:"311f89fc",1673:"0ada951f",1697:"99682ebf",1699:"8d3c303a",1713:"a7023ddc",1800:"ace1dd83",1832:"0102c4de",1841:"7c0ec990",1849:"7545896f",1858:"1dfc139e",1862:"a503c59e",1914:"d9f32620",2084:"b031493d",2086:"a3711c17",2178:"6b0bbcff",2225:"897eeab7",2267:"59362658",2296:"abd786b4",2362:"e273c56f",2435:"4e8909bc",2466:"aefd454f",2484:"d9aa8b54",2525:"dcbe1391",2532:"d470c38e",2535:"814f3328",2567:"20151b90",2682:"6b38d41d",2718:"dda3aacc",2763:"361d5fd3",2866:"dbe6ae54",2982:"b283dfd1",3069:"74e0c629",3070:"910b486a",3085:"1f391b9e",3089:"a6aa9e1f",3094:"06259b5a",3205:"a80da1cf",3237:"1df93b7f",3268:"d2173ddd",3296:"de8d2c71",3328:"9801e8e0",3371:"e9f1f3eb",3391:"b898f833",3393:"32db7aa9",3514:"73664a40",3528:"2b136cef",3561:"85bc840d",3583:"c3bba7fb",3587:"812cfb26",3608:"9e4087bc",3642:"4e88705c",3656:"1545e82e",3657:"009bda03",3723:"70e9b763",3724:"4af1c9f8",3745:"1cc99e83",3785:"1e8657d7",3809:"35bda421",3841:"b8787afe",3886:"cee7123a",3935:"31eac12e",3956:"e141fada",3985:"25785a05",4013:"01a85c17",4033:"29fec1eb",4051:"1061d0cb",4057:"901c4e03",4093:"28a4b851",4141:"f392fbee",4171:"9206a3c8",4197:"f66d2efd",4209:"99a5189f",4217:"c40ba483",4235:"d58e3925",4249:"f4fc2577",4282:"fad5a907",4312:"70b940aa",4323:"0057296d",4352:"6844db42",4390:"7bab1cea",4422:"ce3086a3",4423:"20fe70bf",4512:"c43380b9",4558:"0d185c55",4723:"4a1784a5",4767:"f4cb99bc",4771:"16edbca3",4806:"b272c48c",4819:"5f2ffadc",4898:"82482245",4935:"be3829be",5163:"e504a649",5180:"ae239516",5236:"68f5b48c",5259:"398d9877",5273:"076d78c3",5304:"041b2e46",5365:"6a99630b",5467:"003bdb9f",5618:"1bd56f10",5663:"26e043fd",5670:"581fbd5d",5716:"5dd8e3e5",5800:"c646b739",5806:"081334b1",5818:"fc263eb5",5852:"3412d847",5876:"d60a8fa9",5905:"827f4a75",5949:"f800f7d6",5980:"36651240",6e3:"3679a7ea",6019:"b377cc0a",6025:"8916592d",6041:"dbe3b6b9",6051:"6f941ca8",6079:"b8f6927d",6084:"25a0e36a",6103:"ccc49370",6118:"e534277c",6161:"2bac5a7d",6187:"dccac368",6325:"2f045be8",6361:"c79dd80a",6392:"6f5ae7fe",6451:"91a766d9",6466:"c1f86f2f",6494:"43d9cb87",6581:"5e79c81b",6626:"3ec55dbd",6687:"5ae858e0",6734:"b204b38f",6772:"e6655f86",6813:"a503d80d",6818:"35471870",6871:"6536dd99",6912:"3d9fd839",6914:"9b6b850a",6919:"21f9395a",6938:"608ae6a4",7178:"096bfee4",7201:"46b9fbf9",7216:"f9c23782",7231:"c0bee08d",7244:"fe0c2447",7281:"2b3b61c4",7306:"f6aebfbf",7378:"8ce29828",7414:"393be207",7674:"472f3add",7700:"03f1291b",7733:"714bdd88",7755:"6cdb92a9",7806:"94c93c28",7918:"17896441",7920:"1a4e3797",7927:"59764584",7974:"9624cbc9",7989:"1e667885",8031:"a176b9e0",8050:"86ea32bd",8287:"afb35310",8342:"1518a5cf",8423:"98ae8ac0",8449:"9544ed5c",8566:"b123e85d",8610:"0023ce3c",8618:"64b2afed",8636:"f4f34a3a",8638:"512c31f0",8649:"10749252",8745:"5ebba8c8",8783:"b54dd4a2",8786:"fab6482c",8813:"b6401aa7",8835:"743aea41",8868:"6051f1bd",8873:"18ce2a8b",8907:"6c29b1cc",9003:"925b3f96",9035:"4c9e35b1",9043:"16e530c8",9092:"5cc50a6c",9094:"421c8475",9110:"8e00a68b",9136:"7c769d76",9189:"81b45840",9303:"b77ce242",9321:"62967555",9342:"0e548efa",9464:"1c28c6e3",9477:"6848a17e",9514:"1be78505",9518:"1b16b82f",9539:"5b37cea1",9585:"8c389ce9",9642:"7661071f",9671:"0e384e19",9700:"e16015ca",9729:"98112ca5",9756:"d02ccc1d",9810:"5ee7b1bc",9909:"4cffb53f",9933:"ba313bbf",9977:"5471f4ea",9997:"fdb8937b"}[e]||e)+"."+{53:"1c20aed0",58:"5eb25600",78:"9cc84cdf",110:"2201c8e8",156:"f78b736f",172:"9bc7c575",190:"8fac3a02",221:"97bdcc04",261:"aa8c7663",319:"0b57cdd5",338:"6bb01986",353:"8565f62d",453:"a7cf4f2f",490:"ab94ca1c",533:"26ab2dba",636:"f30bedc5",639:"127bb637",800:"9c0853d0",843:"9aa6961d",948:"fd81774c",950:"052eac3e",982:"920efdae",1057:"7f57da5b",1084:"080e447b",1087:"03988b51",1124:"ebfee7d3",1161:"ad5fd70d",1202:"8d4ba3eb",1215:"e935c4c1",1234:"315b2755",1267:"51865eb3",1332:"95104426",1425:"7aa39b8c",1445:"832e17de",1460:"77f0e318",1477:"cb648b79",1498:"bf2f6667",1520:"7e437e41",1522:"96e7aceb",1589:"de2ec99b",1591:"53f0484b",1598:"0b3e0d74",1612:"837836e8",1633:"7e14aa1c",1650:"32c8ad0f",1660:"372261dc",1673:"923dbb36",1697:"9d524d7a",1699:"2d305ae8",1713:"3383889f",1800:"77bcc1e0",1832:"0d307906",1841:"55945805",1849:"66e08b13",1858:"8fabd6aa",1862:"52c5caec",1914:"e065e3a5",2084:"7dc0d343",2086:"568b2b80",2178:"b491649e",2225:"9a9ec384",2267:"d8532104",2296:"ea663671",2362:"5be00d93",2435:"3550b73c",2466:"3452ef5e",2484:"a2075e77",2525:"b462019b",2529:"7b0c59e6",2532:"b0c1a383",2535:"c088fc69",2567:"517d6eda",2682:"b788d518",2718:"ed772bef",2763:"cd327e0c",2866:"9bf0aa30",2982:"ba328cbb",3069:"43cda852",3070:"8a40e947",3085:"4da99c94",3089:"9f4742df",3094:"d526cda4",3205:"1225f963",3237:"c4ae56e3",3268:"a24ea638",3296:"7f04669f",3328:"12789c75",3371:"2290e9d4",3391:"1d5f38c9",3393:"7c86a20d",3514:"382911a7",3528:"bbfda15e",3561:"417f0e56",3583:"0fc71cf2",3587:"6558beb3",3608:"eca46b6d",3642:"20eef2f7",3656:"01198b3b",3657:"da894109",3723:"df8c1181",3724:"8037fe01",3745:"09c5d563",3785:"a874e23f",3809:"2a93a6e0",3841:"7eae9c2f",3886:"1f55e054",3935:"cf474dc6",3956:"9357016a",3985:"24a2b531",4013:"351c3900",4033:"0c71de0c",4051:"e4353e2d",4057:"100678af",4093:"21e9b85a",4141:"31216def",4171:"9dacfecb",4197:"c6265ad6",4209:"d6120e02",4217:"31234943",4235:"1b608767",4249:"497c559d",4282:"b394d9e3",4312:"7310f2a9",4323:"fa9fbc29",4352:"bdb7def9",4390:"5a5d61a0",4422:"6f31cb02",4423:"04c2c520",4512:"1300d5d5",4558:"13e1c2e2",4723:"f8fd08a9",4767:"d27de28b",4771:"8f40dc81",4806:"704ff913",4819:"1e42f844",4898:"fdc07bb6",4935:"1b400467",5163:"6d17091b",5180:"ae6049a9",5236:"19425008",5259:"9a54817d",5273:"13a60c46",5304:"d618beba",5365:"dacb4ec6",5467:"33250c11",5618:"7a3eab8e",5663:"488c914d",5670:"39a9c988",5716:"d8f66eb0",5800:"338d257e",5806:"b46b0bb9",5818:"bbcddb68",5837:"c2b428ac",5852:"85b10a4c",5876:"6a9f0e6c",5905:"92bef00d",5949:"ba7731f1",5980:"ea8da2a3",6e3:"15269599",6019:"701a8aad",6025:"33ce2958",6041:"35c37c60",6051:"ab784cf2",6079:"e6f0f213",6084:"4a57a009",6103:"29be24d0",6118:"0abde4b5",6161:"986572be",6187:"da21fce7",6325:"42070e3a",6361:"36e5397f",6392:"b1930eb4",6451:"a24e9998",6466:"02fe0021",6494:"8d254aab",6581:"906e59b1",6626:"7475d47c",6687:"02933825",6734:"1bcfcac2",6772:"1e090ba5",6780:"c3340af6",6813:"d8392ba3",6818:"51d7f4cd",6871:"d1f4494c",6912:"e03330f3",6914:"c72de3fa",6919:"bf9780a4",6938:"a58ea2e2",6945:"d19b1c29",7178:"261f9d66",7201:"b4aa1e52",7216:"941c62cc",7231:"4375bc90",7244:"3186e1dc",7281:"78e643c7",7306:"bebc1e85",7378:"ddcc3885",7414:"7833229c",7674:"60594f2e",7700:"bd9059b1",7733:"2d3076fc",7755:"e1192d8a",7806:"d60d82d5",7918:"9e573baf",7920:"2323a249",7927:"e365c4a5",7974:"707433f5",7989:"b7317c38",8031:"e5aa1911",8050:"e137c56a",8287:"222e74ea",8342:"66e88108",8423:"35e3483b",8449:"0f7fa560",8566:"6cbcb697",8610:"d685a506",8618:"102a8f78",8636:"97a7a7fb",8638:"240ad23b",8649:"a329f952",8714:"e67d8c44",8745:"3b864434",8783:"43704889",8786:"862e00d3",8813:"3cc17e95",8835:"b899c177",8868:"7738ce59",8873:"fffe5a0d",8894:"af7eccd4",8907:"fb77e2fe",9003:"74218df7",9035:"61626ae3",9043:"e644cc6b",9092:"4ce71671",9094:"9a443017",9110:"c121f6ca",9136:"2b1dc609",9189:"538ae6bb",9303:"0e64e5ac",9321:"9ca4a93b",9342:"9868197c",9464:"7ee2413e",9477:"dfb90823",9514:"25357d14",9518:"1d1ad1a5",9539:"15b610e7",9585:"b37d6285",9642:"6832f2b7",9671:"fcafe8ce",9700:"363ce273",9729:"7ae9b353",9756:"23105d50",9810:"a73230ad",9909:"bcd687d6",9933:"b87066f5",9977:"2290dfd1",9997:"357e8dfb"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},d="docs-v-3:",r.l=(e,a,b,f)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var d=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={10749252:"8649",17896441:"7918",35471870:"6818",36651240:"5980",59362658:"2267",59764584:"7927",62967555:"9321",66406991:"110",82482245:"4898",91347036:"172","935f2afb":"53",a9a21e60:"58",d6baa543:"78","9777d391":"156","5f279a09":"190","0a2b83e7":"221",dbfd9f1c:"261","79bb96de":"319",f7e2c45c:"338","6d1f7a65":"353","30a24c52":"453","6875c492":"490",b2b675dd:"533","626be1ff":"636",fb625892:"639","3964a121":"800","7e2af6ab":"843","8717b14a":"948",e3562450:"950",feefca73:"982","38ab6ee2":"1057","2a8f6777":"1084","1f67bc2c":"1087","7107a671":"1124","18ad8d0a":"1161",edb57414:"1202","5ba20bff":"1215",de7758a7:"1234",c40efc75:"1267","3752fa13":"1332",a31ecf28:"1425",be56b9dd:"1445","6b55e007":"1460",b2f554cd:"1477",e4469e1d:"1498","7da1a906":"1520","8583c809":"1522",ce48d423:"1589","613a5cbe":"1591","075e8322":"1598","810bf78a":"1612","031793e1":"1633",dad96364:"1650","311f89fc":"1660","0ada951f":"1673","99682ebf":"1697","8d3c303a":"1699",a7023ddc:"1713",ace1dd83:"1800","0102c4de":"1832","7c0ec990":"1841","7545896f":"1849","1dfc139e":"1858",a503c59e:"1862",d9f32620:"1914",b031493d:"2084",a3711c17:"2086","6b0bbcff":"2178","897eeab7":"2225",abd786b4:"2296",e273c56f:"2362","4e8909bc":"2435",aefd454f:"2466",d9aa8b54:"2484",dcbe1391:"2525",d470c38e:"2532","814f3328":"2535","20151b90":"2567","6b38d41d":"2682",dda3aacc:"2718","361d5fd3":"2763",dbe6ae54:"2866",b283dfd1:"2982","74e0c629":"3069","910b486a":"3070","1f391b9e":"3085",a6aa9e1f:"3089","06259b5a":"3094",a80da1cf:"3205","1df93b7f":"3237",d2173ddd:"3268",de8d2c71:"3296","9801e8e0":"3328",e9f1f3eb:"3371",b898f833:"3391","32db7aa9":"3393","73664a40":"3514","2b136cef":"3528","85bc840d":"3561",c3bba7fb:"3583","812cfb26":"3587","9e4087bc":"3608","4e88705c":"3642","1545e82e":"3656","009bda03":"3657","70e9b763":"3723","4af1c9f8":"3724","1cc99e83":"3745","1e8657d7":"3785","35bda421":"3809",b8787afe:"3841",cee7123a:"3886","31eac12e":"3935",e141fada:"3956","25785a05":"3985","01a85c17":"4013","29fec1eb":"4033","1061d0cb":"4051","901c4e03":"4057","28a4b851":"4093",f392fbee:"4141","9206a3c8":"4171",f66d2efd:"4197","99a5189f":"4209",c40ba483:"4217",d58e3925:"4235",f4fc2577:"4249",fad5a907:"4282","70b940aa":"4312","0057296d":"4323","6844db42":"4352","7bab1cea":"4390",ce3086a3:"4422","20fe70bf":"4423",c43380b9:"4512","0d185c55":"4558","4a1784a5":"4723",f4cb99bc:"4767","16edbca3":"4771",b272c48c:"4806","5f2ffadc":"4819",be3829be:"4935",e504a649:"5163",ae239516:"5180","68f5b48c":"5236","398d9877":"5259","076d78c3":"5273","041b2e46":"5304","6a99630b":"5365","003bdb9f":"5467","1bd56f10":"5618","26e043fd":"5663","581fbd5d":"5670","5dd8e3e5":"5716",c646b739:"5800","081334b1":"5806",fc263eb5:"5818","3412d847":"5852",d60a8fa9:"5876","827f4a75":"5905",f800f7d6:"5949","3679a7ea":"6000",b377cc0a:"6019","8916592d":"6025",dbe3b6b9:"6041","6f941ca8":"6051",b8f6927d:"6079","25a0e36a":"6084",ccc49370:"6103",e534277c:"6118","2bac5a7d":"6161",dccac368:"6187","2f045be8":"6325",c79dd80a:"6361","6f5ae7fe":"6392","91a766d9":"6451",c1f86f2f:"6466","43d9cb87":"6494","5e79c81b":"6581","3ec55dbd":"6626","5ae858e0":"6687",b204b38f:"6734",e6655f86:"6772",a503d80d:"6813","6536dd99":"6871","3d9fd839":"6912","9b6b850a":"6914","21f9395a":"6919","608ae6a4":"6938","096bfee4":"7178","46b9fbf9":"7201",f9c23782:"7216",c0bee08d:"7231",fe0c2447:"7244","2b3b61c4":"7281",f6aebfbf:"7306","8ce29828":"7378","393be207":"7414","472f3add":"7674","03f1291b":"7700","714bdd88":"7733","6cdb92a9":"7755","94c93c28":"7806","1a4e3797":"7920","9624cbc9":"7974","1e667885":"7989",a176b9e0:"8031","86ea32bd":"8050",afb35310:"8287","1518a5cf":"8342","98ae8ac0":"8423","9544ed5c":"8449",b123e85d:"8566","0023ce3c":"8610","64b2afed":"8618",f4f34a3a:"8636","512c31f0":"8638","5ebba8c8":"8745",b54dd4a2:"8783",fab6482c:"8786",b6401aa7:"8813","743aea41":"8835","6051f1bd":"8868","18ce2a8b":"8873","6c29b1cc":"8907","925b3f96":"9003","4c9e35b1":"9035","16e530c8":"9043","5cc50a6c":"9092","421c8475":"9094","8e00a68b":"9110","7c769d76":"9136","81b45840":"9189",b77ce242:"9303","0e548efa":"9342","1c28c6e3":"9464","6848a17e":"9477","1be78505":"9514","1b16b82f":"9518","5b37cea1":"9539","8c389ce9":"9585","7661071f":"9642","0e384e19":"9671",e16015ca:"9700","98112ca5":"9729",d02ccc1d:"9756","5ee7b1bc":"9810","4cffb53f":"9909",ba313bbf:"9933","5471f4ea":"9977",fdb8937b:"9997"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,b)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)b.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((b,d)=>c=e[a]=[b,d]));b.push(c[2]=d);var f=r.p+r.u(a),t=new Error;r.l(f,(b=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var d=b&&("load"===b.type?"missing":b.type),f=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",t.name="ChunkLoadError",t.type=d,t.request=f,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var c,d,f=b[0],t=b[1],o=b[2],n=0;if(f.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(b);n{"use strict";var e,a,b,c,d,f={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var b=t[e]={id:e,loaded:!1,exports:{}};return f[e].call(b.exports,b,b.exports,r),b.loaded=!0,b.exports}r.m=f,r.c=t,e=[],r.O=(a,b,c,d)=>{if(!b){var f=1/0;for(i=0;i=d)&&Object.keys(r.O).every((e=>r.O[e](b[o])))?b.splice(o--,1):(t=!1,d0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[b,c,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},b=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,c){if(1&c&&(e=this(e)),8&c)return e;if("object"==typeof e&&e){if(4&c&&e.__esModule)return e;if(16&c&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var f={};a=a||[null,b({}),b([]),b(b)];for(var t=2&c&&e;"object"==typeof t&&!~a.indexOf(t);t=b(t))Object.getOwnPropertyNames(t).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,r.d(d,f),d},r.d=(e,a)=>{for(var b in a)r.o(a,b)&&!r.o(e,b)&&Object.defineProperty(e,b,{enumerable:!0,get:a[b]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,b)=>(r.f[b](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",58:"a9a21e60",78:"d6baa543",110:"66406991",156:"9777d391",172:"91347036",190:"5f279a09",221:"0a2b83e7",261:"dbfd9f1c",319:"79bb96de",338:"f7e2c45c",353:"6d1f7a65",453:"30a24c52",490:"6875c492",533:"b2b675dd",636:"626be1ff",639:"fb625892",800:"3964a121",843:"7e2af6ab",948:"8717b14a",950:"e3562450",982:"feefca73",1057:"38ab6ee2",1084:"2a8f6777",1087:"1f67bc2c",1124:"7107a671",1161:"18ad8d0a",1202:"edb57414",1215:"5ba20bff",1234:"de7758a7",1267:"c40efc75",1332:"3752fa13",1425:"a31ecf28",1445:"be56b9dd",1460:"6b55e007",1477:"b2f554cd",1498:"e4469e1d",1520:"7da1a906",1522:"8583c809",1589:"ce48d423",1591:"613a5cbe",1598:"075e8322",1612:"810bf78a",1633:"031793e1",1650:"dad96364",1660:"311f89fc",1673:"0ada951f",1697:"99682ebf",1699:"8d3c303a",1713:"a7023ddc",1800:"ace1dd83",1832:"0102c4de",1841:"7c0ec990",1849:"7545896f",1858:"1dfc139e",1862:"a503c59e",1914:"d9f32620",2084:"b031493d",2086:"a3711c17",2178:"6b0bbcff",2225:"897eeab7",2267:"59362658",2296:"abd786b4",2362:"e273c56f",2435:"4e8909bc",2466:"aefd454f",2484:"d9aa8b54",2525:"dcbe1391",2532:"d470c38e",2535:"814f3328",2567:"20151b90",2682:"6b38d41d",2718:"dda3aacc",2763:"361d5fd3",2866:"dbe6ae54",2982:"b283dfd1",3069:"74e0c629",3070:"910b486a",3085:"1f391b9e",3089:"a6aa9e1f",3094:"06259b5a",3205:"a80da1cf",3237:"1df93b7f",3268:"d2173ddd",3296:"de8d2c71",3328:"9801e8e0",3371:"e9f1f3eb",3391:"b898f833",3393:"32db7aa9",3514:"73664a40",3528:"2b136cef",3561:"85bc840d",3583:"c3bba7fb",3587:"812cfb26",3608:"9e4087bc",3642:"4e88705c",3656:"1545e82e",3657:"009bda03",3723:"70e9b763",3724:"4af1c9f8",3745:"1cc99e83",3785:"1e8657d7",3809:"35bda421",3841:"b8787afe",3886:"cee7123a",3935:"31eac12e",3956:"e141fada",3985:"25785a05",4013:"01a85c17",4033:"29fec1eb",4051:"1061d0cb",4057:"901c4e03",4093:"28a4b851",4141:"f392fbee",4171:"9206a3c8",4197:"f66d2efd",4209:"99a5189f",4217:"c40ba483",4235:"d58e3925",4249:"f4fc2577",4282:"fad5a907",4312:"70b940aa",4323:"0057296d",4352:"6844db42",4390:"7bab1cea",4422:"ce3086a3",4423:"20fe70bf",4512:"c43380b9",4558:"0d185c55",4723:"4a1784a5",4767:"f4cb99bc",4771:"16edbca3",4806:"b272c48c",4819:"5f2ffadc",4898:"82482245",4935:"be3829be",5163:"e504a649",5180:"ae239516",5236:"68f5b48c",5259:"398d9877",5273:"076d78c3",5304:"041b2e46",5365:"6a99630b",5467:"003bdb9f",5618:"1bd56f10",5663:"26e043fd",5670:"581fbd5d",5716:"5dd8e3e5",5800:"c646b739",5806:"081334b1",5818:"fc263eb5",5852:"3412d847",5876:"d60a8fa9",5905:"827f4a75",5949:"f800f7d6",5980:"36651240",6e3:"3679a7ea",6019:"b377cc0a",6025:"8916592d",6041:"dbe3b6b9",6051:"6f941ca8",6079:"b8f6927d",6084:"25a0e36a",6103:"ccc49370",6118:"e534277c",6161:"2bac5a7d",6187:"dccac368",6325:"2f045be8",6361:"c79dd80a",6392:"6f5ae7fe",6451:"91a766d9",6466:"c1f86f2f",6494:"43d9cb87",6581:"5e79c81b",6626:"3ec55dbd",6687:"5ae858e0",6734:"b204b38f",6772:"e6655f86",6813:"a503d80d",6818:"35471870",6871:"6536dd99",6912:"3d9fd839",6914:"9b6b850a",6919:"21f9395a",6938:"608ae6a4",7178:"096bfee4",7201:"46b9fbf9",7216:"f9c23782",7231:"c0bee08d",7244:"fe0c2447",7281:"2b3b61c4",7306:"f6aebfbf",7378:"8ce29828",7414:"393be207",7674:"472f3add",7700:"03f1291b",7733:"714bdd88",7755:"6cdb92a9",7806:"94c93c28",7918:"17896441",7920:"1a4e3797",7927:"59764584",7974:"9624cbc9",7989:"1e667885",8031:"a176b9e0",8050:"86ea32bd",8287:"afb35310",8342:"1518a5cf",8423:"98ae8ac0",8449:"9544ed5c",8566:"b123e85d",8610:"0023ce3c",8618:"64b2afed",8636:"f4f34a3a",8638:"512c31f0",8649:"10749252",8745:"5ebba8c8",8783:"b54dd4a2",8786:"fab6482c",8813:"b6401aa7",8835:"743aea41",8868:"6051f1bd",8873:"18ce2a8b",8907:"6c29b1cc",9003:"925b3f96",9035:"4c9e35b1",9043:"16e530c8",9092:"5cc50a6c",9094:"421c8475",9110:"8e00a68b",9136:"7c769d76",9189:"81b45840",9303:"b77ce242",9321:"62967555",9342:"0e548efa",9464:"1c28c6e3",9477:"6848a17e",9514:"1be78505",9518:"1b16b82f",9539:"5b37cea1",9585:"8c389ce9",9642:"7661071f",9671:"0e384e19",9700:"e16015ca",9729:"98112ca5",9756:"d02ccc1d",9810:"5ee7b1bc",9909:"4cffb53f",9933:"ba313bbf",9977:"5471f4ea",9997:"fdb8937b"}[e]||e)+"."+{53:"1c20aed0",58:"5eb25600",78:"9cc84cdf",110:"2201c8e8",156:"f78b736f",172:"9bc7c575",190:"8fac3a02",221:"97bdcc04",261:"aa8c7663",319:"0b57cdd5",338:"6bb01986",353:"8565f62d",453:"a7cf4f2f",490:"ab94ca1c",533:"26ab2dba",636:"f30bedc5",639:"127bb637",800:"9c0853d0",843:"9aa6961d",948:"fd81774c",950:"052eac3e",982:"920efdae",1057:"7f57da5b",1084:"080e447b",1087:"03988b51",1124:"ebfee7d3",1161:"ad5fd70d",1202:"8d4ba3eb",1215:"e935c4c1",1234:"315b2755",1267:"51865eb3",1332:"95104426",1425:"7aa39b8c",1445:"832e17de",1460:"77f0e318",1477:"cb648b79",1498:"bf2f6667",1520:"7e437e41",1522:"96e7aceb",1589:"de2ec99b",1591:"53f0484b",1598:"0b3e0d74",1612:"837836e8",1633:"7e14aa1c",1650:"32c8ad0f",1660:"372261dc",1673:"923dbb36",1697:"9d524d7a",1699:"2d305ae8",1713:"3383889f",1800:"77bcc1e0",1832:"0d307906",1841:"55945805",1849:"66e08b13",1858:"8fabd6aa",1862:"52c5caec",1914:"e065e3a5",2084:"7dc0d343",2086:"568b2b80",2178:"b491649e",2225:"9a9ec384",2267:"d8532104",2296:"ea663671",2362:"5be00d93",2435:"3550b73c",2466:"3452ef5e",2484:"a2075e77",2525:"b462019b",2529:"7b0c59e6",2532:"b0c1a383",2535:"c088fc69",2567:"517d6eda",2682:"b788d518",2718:"ed772bef",2763:"cd327e0c",2866:"9bf0aa30",2982:"ba328cbb",3069:"43cda852",3070:"8a40e947",3085:"4da99c94",3089:"9f4742df",3094:"d526cda4",3205:"1225f963",3237:"c4ae56e3",3268:"a24ea638",3296:"7f04669f",3328:"12789c75",3371:"2290e9d4",3391:"1d5f38c9",3393:"7c86a20d",3514:"382911a7",3528:"bbfda15e",3561:"417f0e56",3583:"0fc71cf2",3587:"6558beb3",3608:"eca46b6d",3642:"20eef2f7",3656:"01198b3b",3657:"da894109",3723:"df8c1181",3724:"8037fe01",3745:"09c5d563",3785:"a874e23f",3809:"2a93a6e0",3841:"7eae9c2f",3886:"1f55e054",3935:"cf474dc6",3956:"9357016a",3985:"24a2b531",4013:"351c3900",4033:"0c71de0c",4051:"e4353e2d",4057:"100678af",4093:"21e9b85a",4141:"31216def",4171:"9dacfecb",4197:"c6265ad6",4209:"d6120e02",4217:"31234943",4235:"1b608767",4249:"497c559d",4282:"b394d9e3",4312:"7310f2a9",4323:"fa9fbc29",4352:"bdb7def9",4390:"5a5d61a0",4422:"6f31cb02",4423:"04c2c520",4512:"1300d5d5",4558:"13e1c2e2",4723:"f8fd08a9",4767:"d27de28b",4771:"8f40dc81",4806:"704ff913",4819:"1e42f844",4898:"fdc07bb6",4935:"1b400467",5163:"6d17091b",5180:"ae6049a9",5236:"19425008",5259:"9a54817d",5273:"13a60c46",5304:"d618beba",5365:"dacb4ec6",5467:"33250c11",5618:"7a3eab8e",5663:"488c914d",5670:"39a9c988",5716:"d8f66eb0",5800:"338d257e",5806:"b46b0bb9",5818:"bbcddb68",5837:"c2b428ac",5852:"85b10a4c",5876:"6a9f0e6c",5905:"92bef00d",5949:"ba7731f1",5980:"ea8da2a3",6e3:"15269599",6019:"701a8aad",6025:"33ce2958",6041:"35c37c60",6051:"ab784cf2",6079:"e6f0f213",6084:"4a57a009",6103:"29be24d0",6118:"0abde4b5",6161:"986572be",6187:"da21fce7",6325:"42070e3a",6361:"36e5397f",6392:"b1930eb4",6451:"a24e9998",6466:"02fe0021",6494:"8d254aab",6581:"906e59b1",6626:"7475d47c",6687:"02933825",6734:"1bcfcac2",6772:"1e090ba5",6780:"c3340af6",6813:"d8392ba3",6818:"51d7f4cd",6871:"d1f4494c",6912:"e03330f3",6914:"c72de3fa",6919:"bf9780a4",6938:"a58ea2e2",6945:"d19b1c29",7178:"261f9d66",7201:"b4aa1e52",7216:"941c62cc",7231:"4375bc90",7244:"3186e1dc",7281:"78e643c7",7306:"bebc1e85",7378:"ddcc3885",7414:"7833229c",7674:"60594f2e",7700:"bd9059b1",7733:"2d3076fc",7755:"e1192d8a",7806:"d60d82d5",7918:"9e573baf",7920:"2323a249",7927:"2fff5709",7974:"707433f5",7989:"b7317c38",8031:"e5aa1911",8050:"e137c56a",8287:"222e74ea",8342:"66e88108",8423:"35e3483b",8449:"0f7fa560",8566:"6cbcb697",8610:"d685a506",8618:"102a8f78",8636:"97a7a7fb",8638:"240ad23b",8649:"a329f952",8714:"e67d8c44",8745:"3b864434",8783:"43704889",8786:"862e00d3",8813:"3cc17e95",8835:"b899c177",8868:"7738ce59",8873:"fffe5a0d",8894:"af7eccd4",8907:"fb77e2fe",9003:"74218df7",9035:"61626ae3",9043:"e644cc6b",9092:"4ce71671",9094:"9a443017",9110:"c121f6ca",9136:"2b1dc609",9189:"538ae6bb",9303:"0e64e5ac",9321:"9ca4a93b",9342:"9868197c",9464:"7ee2413e",9477:"dfb90823",9514:"25357d14",9518:"1d1ad1a5",9539:"15b610e7",9585:"b37d6285",9642:"6832f2b7",9671:"fcafe8ce",9700:"363ce273",9729:"7ae9b353",9756:"23105d50",9810:"a73230ad",9909:"bcd687d6",9933:"b87066f5",9977:"2290dfd1",9997:"357e8dfb"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),c={},d="docs-v-3:",r.l=(e,a,b,f)=>{if(c[e])c[e].push(a);else{var t,o;if(void 0!==b)for(var n=document.getElementsByTagName("script"),i=0;i{t.onerror=t.onload=null,clearTimeout(s);var d=c[e];if(delete c[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(b))),a)return a(b)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=l.bind(null,t.onerror),t.onload=l.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.p="/",r.gca=function(e){return e={10749252:"8649",17896441:"7918",35471870:"6818",36651240:"5980",59362658:"2267",59764584:"7927",62967555:"9321",66406991:"110",82482245:"4898",91347036:"172","935f2afb":"53",a9a21e60:"58",d6baa543:"78","9777d391":"156","5f279a09":"190","0a2b83e7":"221",dbfd9f1c:"261","79bb96de":"319",f7e2c45c:"338","6d1f7a65":"353","30a24c52":"453","6875c492":"490",b2b675dd:"533","626be1ff":"636",fb625892:"639","3964a121":"800","7e2af6ab":"843","8717b14a":"948",e3562450:"950",feefca73:"982","38ab6ee2":"1057","2a8f6777":"1084","1f67bc2c":"1087","7107a671":"1124","18ad8d0a":"1161",edb57414:"1202","5ba20bff":"1215",de7758a7:"1234",c40efc75:"1267","3752fa13":"1332",a31ecf28:"1425",be56b9dd:"1445","6b55e007":"1460",b2f554cd:"1477",e4469e1d:"1498","7da1a906":"1520","8583c809":"1522",ce48d423:"1589","613a5cbe":"1591","075e8322":"1598","810bf78a":"1612","031793e1":"1633",dad96364:"1650","311f89fc":"1660","0ada951f":"1673","99682ebf":"1697","8d3c303a":"1699",a7023ddc:"1713",ace1dd83:"1800","0102c4de":"1832","7c0ec990":"1841","7545896f":"1849","1dfc139e":"1858",a503c59e:"1862",d9f32620:"1914",b031493d:"2084",a3711c17:"2086","6b0bbcff":"2178","897eeab7":"2225",abd786b4:"2296",e273c56f:"2362","4e8909bc":"2435",aefd454f:"2466",d9aa8b54:"2484",dcbe1391:"2525",d470c38e:"2532","814f3328":"2535","20151b90":"2567","6b38d41d":"2682",dda3aacc:"2718","361d5fd3":"2763",dbe6ae54:"2866",b283dfd1:"2982","74e0c629":"3069","910b486a":"3070","1f391b9e":"3085",a6aa9e1f:"3089","06259b5a":"3094",a80da1cf:"3205","1df93b7f":"3237",d2173ddd:"3268",de8d2c71:"3296","9801e8e0":"3328",e9f1f3eb:"3371",b898f833:"3391","32db7aa9":"3393","73664a40":"3514","2b136cef":"3528","85bc840d":"3561",c3bba7fb:"3583","812cfb26":"3587","9e4087bc":"3608","4e88705c":"3642","1545e82e":"3656","009bda03":"3657","70e9b763":"3723","4af1c9f8":"3724","1cc99e83":"3745","1e8657d7":"3785","35bda421":"3809",b8787afe:"3841",cee7123a:"3886","31eac12e":"3935",e141fada:"3956","25785a05":"3985","01a85c17":"4013","29fec1eb":"4033","1061d0cb":"4051","901c4e03":"4057","28a4b851":"4093",f392fbee:"4141","9206a3c8":"4171",f66d2efd:"4197","99a5189f":"4209",c40ba483:"4217",d58e3925:"4235",f4fc2577:"4249",fad5a907:"4282","70b940aa":"4312","0057296d":"4323","6844db42":"4352","7bab1cea":"4390",ce3086a3:"4422","20fe70bf":"4423",c43380b9:"4512","0d185c55":"4558","4a1784a5":"4723",f4cb99bc:"4767","16edbca3":"4771",b272c48c:"4806","5f2ffadc":"4819",be3829be:"4935",e504a649:"5163",ae239516:"5180","68f5b48c":"5236","398d9877":"5259","076d78c3":"5273","041b2e46":"5304","6a99630b":"5365","003bdb9f":"5467","1bd56f10":"5618","26e043fd":"5663","581fbd5d":"5670","5dd8e3e5":"5716",c646b739:"5800","081334b1":"5806",fc263eb5:"5818","3412d847":"5852",d60a8fa9:"5876","827f4a75":"5905",f800f7d6:"5949","3679a7ea":"6000",b377cc0a:"6019","8916592d":"6025",dbe3b6b9:"6041","6f941ca8":"6051",b8f6927d:"6079","25a0e36a":"6084",ccc49370:"6103",e534277c:"6118","2bac5a7d":"6161",dccac368:"6187","2f045be8":"6325",c79dd80a:"6361","6f5ae7fe":"6392","91a766d9":"6451",c1f86f2f:"6466","43d9cb87":"6494","5e79c81b":"6581","3ec55dbd":"6626","5ae858e0":"6687",b204b38f:"6734",e6655f86:"6772",a503d80d:"6813","6536dd99":"6871","3d9fd839":"6912","9b6b850a":"6914","21f9395a":"6919","608ae6a4":"6938","096bfee4":"7178","46b9fbf9":"7201",f9c23782:"7216",c0bee08d:"7231",fe0c2447:"7244","2b3b61c4":"7281",f6aebfbf:"7306","8ce29828":"7378","393be207":"7414","472f3add":"7674","03f1291b":"7700","714bdd88":"7733","6cdb92a9":"7755","94c93c28":"7806","1a4e3797":"7920","9624cbc9":"7974","1e667885":"7989",a176b9e0:"8031","86ea32bd":"8050",afb35310:"8287","1518a5cf":"8342","98ae8ac0":"8423","9544ed5c":"8449",b123e85d:"8566","0023ce3c":"8610","64b2afed":"8618",f4f34a3a:"8636","512c31f0":"8638","5ebba8c8":"8745",b54dd4a2:"8783",fab6482c:"8786",b6401aa7:"8813","743aea41":"8835","6051f1bd":"8868","18ce2a8b":"8873","6c29b1cc":"8907","925b3f96":"9003","4c9e35b1":"9035","16e530c8":"9043","5cc50a6c":"9092","421c8475":"9094","8e00a68b":"9110","7c769d76":"9136","81b45840":"9189",b77ce242:"9303","0e548efa":"9342","1c28c6e3":"9464","6848a17e":"9477","1be78505":"9514","1b16b82f":"9518","5b37cea1":"9539","8c389ce9":"9585","7661071f":"9642","0e384e19":"9671",e16015ca:"9700","98112ca5":"9729",d02ccc1d:"9756","5ee7b1bc":"9810","4cffb53f":"9909",ba313bbf:"9933","5471f4ea":"9977",fdb8937b:"9997"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,b)=>{var c=r.o(e,a)?e[a]:void 0;if(0!==c)if(c)b.push(c[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((b,d)=>c=e[a]=[b,d]));b.push(c[2]=d);var f=r.p+r.u(a),t=new Error;r.l(f,(b=>{if(r.o(e,a)&&(0!==(c=e[a])&&(e[a]=void 0),c)){var d=b&&("load"===b.type?"missing":b.type),f=b&&b.target&&b.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+f+")",t.name="ChunkLoadError",t.type=d,t.request=f,c[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,b)=>{var c,d,f=b[0],t=b[1],o=b[2],n=0;if(f.some((a=>0!==e[a]))){for(c in t)r.o(t,c)&&(r.m[c]=t[c]);if(o)var i=o(r)}for(a&&a(b);n - +

· One min read
Sébastien Lorber
Yangshun Tay

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/archive.html b/blog/archive.html index fc44fb6815..e02d6c7067 100644 --- a/blog/archive.html +++ b/blog/archive.html @@ -14,13 +14,13 @@ - +

Archive

Archive

2019

2021

- + \ No newline at end of file diff --git a/blog/first-blog-post.html b/blog/first-blog-post.html index f1b4b4a4c7..4ac2b34fd1 100644 --- a/blog/first-blog-post.html +++ b/blog/first-blog-post.html @@ -14,13 +14,13 @@ - +

First Blog Post

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/long-blog-post.html b/blog/long-blog-post.html index 4380ad5a8a..568f5cd73b 100644 --- a/blog/long-blog-post.html +++ b/blog/long-blog-post.html @@ -14,13 +14,13 @@ - +

Long Blog Post

· 3 min read
Endilie Yacop Sucipto

This is the summary of a very long blog post,

Use a <!-- truncate --> comment to limit blog post size in the list view.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/mdx-blog-post.html b/blog/mdx-blog-post.html index b0614b772a..a72e95a39f 100644 --- a/blog/mdx-blog-post.html +++ b/blog/mdx-blog-post.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/blog/tags.html b/blog/tags.html index 401d8ef9fd..bf88b6ae48 100644 --- a/blog/tags.html +++ b/blog/tags.html @@ -14,13 +14,13 @@ - +

Tags

- + \ No newline at end of file diff --git a/blog/tags/docusaurus.html b/blog/tags/docusaurus.html index 5780e9087e..c4611b8955 100644 --- a/blog/tags/docusaurus.html +++ b/blog/tags/docusaurus.html @@ -14,13 +14,13 @@ - +

4 posts tagged with "docusaurus"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/tags/facebook.html b/blog/tags/facebook.html index 0ece074b99..a15f95f236 100644 --- a/blog/tags/facebook.html +++ b/blog/tags/facebook.html @@ -14,13 +14,13 @@ - +

One post tagged with "facebook"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hello.html b/blog/tags/hello.html index bf1658828e..1850042641 100644 --- a/blog/tags/hello.html +++ b/blog/tags/hello.html @@ -14,13 +14,13 @@ - +

2 posts tagged with "hello"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hola.html b/blog/tags/hola.html index 32c3b6223e..6b8531592c 100644 --- a/blog/tags/hola.html +++ b/blog/tags/hola.html @@ -14,13 +14,13 @@ - +

One post tagged with "hola"

View All Tags

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/welcome.html b/blog/welcome.html index c808fda413..ef181169ef 100644 --- a/blog/welcome.html +++ b/blog/welcome.html @@ -14,13 +14,13 @@ - +

Welcome

· One min read
Sébastien Lorber
Yangshun Tay

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/docs/Integrations/chatwoot.html b/docs/Integrations/chatwoot.html index 3640d1bfea..5e5ce8f9a1 100644 --- a/docs/Integrations/chatwoot.html +++ b/docs/Integrations/chatwoot.html @@ -14,13 +14,13 @@ - +

Chatwoot integrations

you can directly integrate open-wa/wa-automate directly using the easy-api or docker

  • before you start you need to have below details from chatwoot

    itemdescriptionexample
    chatwoot API URLit can be self-hosted or chatwoot hostedfor self-hosted http://localhost:3000 and can be https://app.chatwoot.com/platform/api/v1 for chatwoot hosted
    chatwoot access tokenyou can get it at the end of your chatwoot profile pagefor example 5lUC0KdzAl8iZO5aLsZHdx0i9rRix6qd
    optional full chatwoot API URLif you want to use an existing chatwoot inboxthe URL will look like this https://app.chatwoot.com/accounts/[account id]/inboxes/[inbox id]

  • if you want easy-api to automatically generate chatwoot inbox and configure it

    npx @open-wa/wa-automate -p [port number] -k "your easy-api API Key" --verbose --force-update-cw-webhook --chatwoot-url "https://app.chatwoot.com/platform/api/v1" --chatwoot-api-access-token "your chatwoot access token"

  • if you wan't to use and already generated inbox which was created using the above command then you need to provide the full chatwoot API URL which has the account ID and inbox id details.

    npx @open-wa/wa-automate -p [port number] -k "your easy-api API Key" --verbose --force-update-cw-webhook --chatwoot-url "https://app.chatwoot.com/accounts/[account id]/inboxes/[inbox id]" --chatwoot-api-access-token "your chatwoot access token"

- + \ No newline at end of file diff --git a/docs/advanced/best-practices.html b/docs/advanced/best-practices.html index b42e793804..ecd74e647c 100644 --- a/docs/advanced/best-practices.html +++ b/docs/advanced/best-practices.html @@ -14,13 +14,13 @@ - +

Best Practice

Since this is not an officially sanctioned solution it is temperamental to say the least. Here are some best practices:

  1. Keep the session alive
  2. Offload most work off of your @open-wa/wa-automate setup (i.e forward all events to a pubsub or something)
  3. Keep the phone nearby just in case you need to reauthenticate
  4. Use a chrome instance instead of the default chromium instance
  5. Use headless: false for easy & quick visual debugging
  6. Implement the unread messages functionality on creation of a session so you don't miss any messages upon any downtime.
  7. Implement a promise-queue
  8. Use a unique and valid custom user-agent
  9. await all @open-wa/wa-automate methods just in case
  10. Do not run your s@open-wa/wa-automate instance on a Windows machine.
  11. Always kill the session safely upon error or SIGINT.
  12. Regularly restart your process to manage memory consumption
  13. If memory leaks continue to be an issue then use cacheEnabled:false in the config to disable the cache on the page.
import { create, Client} from '@open-wa/wa-automate';
const { default: PQueue } = require("p-queue");

const queue = new PQueue({
  concurrency: 4,
  autoStart:false
   });

const proc = async message => {
  //do something with the message here
    console.log(message)
    return true;
}

const processMessage = message => queue.add(()=>proc(message));

async function start(client: Client) {
  const unreadMessages = await client.getAllUnreadMessages();
  unreadMessages.forEach(processMessage)
  ...
  await client.onMessage(processMessage);
  queue.start();
}

create().then(client => start(client));

//create takes 1 argument and that is the config object :
// https://docs.openwa.dev/interfaces/api_model_config.ConfigObject.html

create({
  // For Mac:
  executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
  // For Windows:
  // executablePath: 'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
  headless: false,
  autoRefresh:true,
  cacheEnabled:false,
  customUserAgent: 'some custom user agent'
})
.then(client => start(client));
- + \ No newline at end of file diff --git a/docs/api/classes/api_Client.Client.html b/docs/api/classes/api_Client.Client.html index 52dd77be7f..925b81007a 100644 --- a/docs/api/classes/api_Client.Client.html +++ b/docs/api/classes/api_Client.Client.html @@ -14,7 +14,7 @@ - + @@ -38,16 +38,16 @@ This will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged

Returns​

Promise<boolean>

registerWebhook​

▸ registerWebhook(url, events, requestConfig?, concurrency?): Promise<false | Webhook>

The client can now automatically handle webhooks. Use this method to register webhooks.

Parameters​

NameTypeDefault valueDescription
urlstringundefinedThe webhook url
eventsSimpleListener[] | "all"undefinedAn array of SimpleListener enums or all (to register all possible listeners)
requestConfigAxiosRequestConfig<any>{}{} By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
concurrencynumber5the amount of concurrent requests to be handled by the built in queue. Default is 5.

Returns​

Promise<false | Webhook>

A webhook object. This will include a webhook ID and an array of all successfully registered Listeners.

rejectGroupJoinRequest​

▸ rejectGroupJoinRequest(groupChatId, contactId): Promise<string | boolean>

Rejects a group join request

Parameters​

NameTypeDescription
groupChatIdGroupChatIdThe group chat id *
contactIdContactIdThe contact id of the person who is requesting to join the group *

Returns​

Promise<string | boolean>

Promise<boolean>

removeAllListeners​

▸ removeAllListeners(): boolean

Returns​

boolean

removeLabel​

▸ removeLabel(label, chatId): Promise<boolean>

Removes label from chat, message or contact. Only for business accounts.

Parameters​

NameType
labelstring
chatIdChatId

Returns​

Promise<boolean>

removeListener​

▸ removeListener(listener): boolean

//////////////////////// LISTENERS

Parameters​

NameType
listenerSimpleListener

Returns​

boolean

removeParticipant​

▸ removeParticipant(groupId, participantId): Promise<boolean>

Remove participant of Group

If not a group chat, returns NOT_A_GROUP_CHAT.

If the chat does not exist, returns GROUP_DOES_NOT_EXIST

If the participantId does not exist in the group chat, returns NOT_A_PARTICIPANT

If the host account is not an administrator, returns INSUFFICIENT_PERMISSIONS

Parameters​

NameTypeDescription
groupIdGroupChatId0000000000-00000000@g.us
participantIdContactId000000000000@c.us

Returns​

Promise<boolean>

removeProduct​

▸ removeProduct(productId): Promise<boolean>

Remove a product from the host account's catalog

Parameters​

NameTypeDescription
productIdstringThe id of the product

Returns​

Promise<boolean>

boolean

removeWebhook​

▸ removeWebhook(webhookId): Promise<boolean>

Removes a webhook.

Returns true if the webhook was found and removed. false if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks.

Retruns

boolean

Parameters​

NameTypeDescription
webhookIdstringThe ID of the webhook

Returns​

Promise<boolean>

reply​

▸ reply(to, content, quotedMsgId, sendSeen?): Promise<boolean | MessageId>

Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly.

Parameters​

NameTypeDescription
toChatIdstring chatid
contentContentstring reply text
quotedMsgIdMessageIdstring the msg id to reply to.
sendSeen?booleanboolean If set to true, the chat will 'blue tick' all messages before sending the reply

Returns​

Promise<boolean | MessageId>

Promise<MessageId | false> false if didn't work, otherwise returns message id.

reportSpam
restricted
​

▸ reportSpam(id): Promise<boolean>

🏅May require restricted license

Use this link to get the correct license.

Report a contact for spam, block them and attempt to clear chat.

Parameters​

NameTypeDescription
idChatId'000000000000@c.us'

Returns​

Promise<boolean>

resizePage​

▸ resizePage(width?, height?): Promise<boolean>

Easily resize page on the fly. Useful if you're showing screenshots in a web-app.

Parameters​

NameTypeDefault value
widthnumber1920
heightnumber1080

Returns​

Promise<boolean>

▸ revokeGroupInviteLink(chatId): Promise<string | boolean>

Revokes the current invite link for a group chat. Any previous links will stop working

Parameters​

NameType
chatIdChatId

Returns​

Promise<string | boolean>

Promise<boolean>

sendAdvancedButtons​

▸ sendAdvancedButtons(to, body, buttons, text, footer, filename): Promise<boolean | MessageId>

Deprecated

danger

Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA. WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.

THIS IS NOT WORKING FOR GROUPS YET.

ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.

Send advanced buttons with media body. This is an insiders feature for MD accounts.

Body can be location, image, video or document. Buttons can be quick reply, url or call buttons.

Parameters​

NameTypeDescription
toChatIdchat id
bodystring | LocationButtonBodyThe body of the buttons message
buttonsAdvancedButton[]Array of buttons - limit is 3!
textstring-
footerstringThe footer of the buttons message
filenamestringRequired if body is a file!!

Returns​

Promise<boolean | MessageId>

sendAudio​

▸ sendAudio(to, file, quotedMsgId?): Promise<MessageId>

Send an audio file with the default audio player (not PTT/voice message)

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFile-
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

Returns​

Promise<MessageId>

sendBanner​

▸ sendBanner(to, base64): Promise<boolean | MessageId>

Send a banner image

Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones.

Parameters​

NameTypeDescription
toChatId
base64Base64base64 encoded jpeg

Returns​

Promise<boolean | MessageId>

sendButtons​

▸ sendButtons(to, body, buttons, title?, footer?): Promise<boolean | MessageId>

Deprecated

danger

WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts. THIS IS NOT WORKING FOR GROUPS YET.

BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.

Send generic quick reply buttons. This is an insiders feature for MD accounts.

Parameters​

NameTypeDescription
toChatIdchat id
bodystring | LocationButtonBodyThe body of the buttons message
buttonsButton[]Array of buttons - limit is 3!
title?stringThe title/header of the buttons message
footer?stringThe footer of the buttons message

Returns​

Promise<boolean | MessageId>

sendContact​

▸ sendContact(to, contactId): Promise<boolean | MessageId>

Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages.

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
contactIdContactId | ContactId[]-

Returns​

Promise<boolean | MessageId>

sendCustomProduct​

▸ sendCustomProduct(to, image, productData): Promise<boolean | MessageId>

Deprecated

Feature Currently only available with Premium License accounts.

Send a custom product to a chat. Please see CustomProduct for details.

Caveats:

  • URL will not work (unable to click), you will have to send another message with the URL.
  • Recipient will see a thin banner under picture that says "Something went wrong"
  • This will only work if you have at least 1 product already in your catalog
  • Only works on Business accounts

Parameters​

NameType
toChatId
imageDataURL
productDataCustomProduct

Returns​

Promise<boolean | MessageId>

sendEmoji​

▸ sendEmoji(to, emojiId, messageId?): Promise<string | boolean | MessageId>

Send a discord emoji to a chat as a sticker

Parameters​

NameTypeDescription
toChatIdChatId The chat id you want to send the webp sticker to
emojiIdstringThe discord emoji id without indentifying chars. In discord you would write :who:, here use who
messageId?MessageIdmessage id of the message you want this sticker to reply to. {@license:insiders@}

Returns​

Promise<string | boolean | MessageId>

sendFile​

▸ sendFile(to, file, filename, caption, quotedMsgId?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?, requestConfig?): Promise<boolean | MessageId>

Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage

Please note that any file that resolves to mime-type octet-stream will, by default, resolve to an MP4 file.

If you want a specific filetype, then explcitly select the correct mime-type from https://www.iana.org/assignments/media-types/media-types.xhtml

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFileDataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).
filenamestringstring xxxxx
captionContentstring xxxxx With an INSIDERS LICENSE-KEY you can also tag people in groups with @[number]. For example if you want to mention the user with the number 44771234567, just add @44771234567 in the caption.
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
waitForId?booleanboolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
ptt?booleanboolean default: false set this to true if you want to send the file as a push to talk file.
withoutPreview?booleanboolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.
hideTags?booleanboolean default: false [INSIDERS] set this to try silent tag someone in the caption
viewOnce?boolean-
requestConfig?any-

Returns​

Promise<boolean | MessageId>

Promise <boolean | MessageId> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendFileFromUrl​

▸ sendFileFromUrl(to, url, filename, caption, quotedMsgId?, requestConfig?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?): Promise<boolean | MessageId>

Sends a file by Url or custom options

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
urlstringstring https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4
filenamestringstring 'video.mp4'
captionContentstring xxxxx
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
waitForId?booleanboolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
ptt?booleanboolean default: false set this to true if you want to send the file as a push to talk file.
withoutPreview?booleanboolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.
hideTags?boolean-
viewOnce?boolean-

Returns​

Promise<boolean | MessageId>

sendGiphy​

▸ sendGiphy(to, giphyMediaUrl, caption): Promise<MessageId>

Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
giphyMediaUrlstringstring https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif => https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4
captionContentstring xxxxx

Returns​

Promise<MessageId>

sendGiphyAsSticker​

▸ sendGiphyAsSticker(to, giphyMediaUrl): Promise<string | boolean | MessageId>

Send a giphy GIF as an animated sticker.

Parameters​

NameTypeDescription
toChatIdChatId
giphyMediaUrlstring | URLURL | string This is the giphy media url and has to be in the format https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif or it can be just the id RJKHjCAdsAfQPn03qQ

Returns​

Promise<string | boolean | MessageId>

sendImage​

▸ sendImage(to, file, filename, caption, quotedMsgId?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?, requestConfig?): Promise<boolean | MessageId>

Sends a image to given chat, with caption or not, using base64

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFileDataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).
filenamestringstring xxxxx
captionContentstring xxxxx
quotedMsgId?MessageId-
waitForId?boolean-
ptt?boolean-
withoutPreview?boolean-
hideTags?booleanboolean default: false [INSIDERS] set this to try silent tag someone in the caption
viewOnce?boolean-
requestConfig?any-

Returns​

Promise<boolean | MessageId>

Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendImageAsSticker​

▸ sendImageAsSticker(to, image, stickerMetadata?): Promise<string | boolean | MessageId>

This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes. -The advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format.

Parameters​

NameType
toChatId
imagestring | Base64 | DataURL | Buffer
stickerMetadata?StickerMetadata

Returns​

Promise<string | boolean | MessageId>

sendImageAsStickerAsReply
insiders
​

▸ sendImageAsStickerAsReply(to, image, messageId, stickerMetadata?): Promise<string | boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

This function takes an image and sends it as a sticker to the recipient as a reply to another message.

Parameters​

NameTypeDescription
toChatIdThe recipient id.
imagestring | Base64 | DataURL | Buffer-
messageIdMessageIdThe id of the message to reply to
stickerMetadata?StickerMetadataSticker metadata

Returns​

Promise<string | boolean | MessageId>

sendImageWithProduct​

▸ sendImageWithProduct(to, image, caption, bizNumber, productId): Promise<boolean | MessageId>

Sends product with image to chat

Parameters​

NameTypeDescription
toChatId-
imageBase64-
captionContentstring the caption you want to add to this message
bizNumberContactIdstring the @c.us number of the business account from which you want to grab the product
productIdstringstring the id of the product within the main catalog of the aforementioned business

Returns​

Promise<boolean | MessageId>

sendLinkWithAutoPreview​

▸ sendLinkWithAutoPreview(to, url, text?, thumbnail?): Promise<boolean | MessageId>

Automatically sends a link with the auto generated link preview. You can also add a custom message.

Parameters​

NameTypeDescription
toChatId-
urlstringstring A link.
text?Contentstring Custom text as body of the message, this needs to include the link or it will be appended after the link.
thumbnail?Base64Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.

Returns​

Promise<boolean | MessageId>

sendListMessage​

▸ sendListMessage(to, sections, title, description, actionText): Promise<boolean | MessageId>

Deprecated

danger

It is not currently possible to send a listmessage to a group chat. This is a WA limitation. -Please DO NOT get a license solely for access to list messages in group chats.

LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE

Send a list message. This will not work when being sent from business accounts!

Parameters​

NameTypeDescription
toChatId
sectionsSection[]The Sections of rows for the list message
titlestringThe title of the list message
descriptionstringThe description of the list message
actionTextstringThe action text of the list message

Returns​

Promise<boolean | MessageId>

sendLocation​

▸ sendLocation(to, lat, lng, loc, address?, url?): Promise<boolean | MessageId>

Note: address and url are parameters available to insiders only.

Sends a location message to given chat

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
latstringlatitude: '51.5074'
lngstringlongitude: '0.1278'
locstringlocation text: 'LONDON!'
address?stringaddress text: '1 Regents Park!'
url?stringaddress text link: 'https://example.com'

Returns​

Promise<boolean | MessageId>

sendMessageWithThumb​

▸ sendMessageWithThumb(thumb, url, title, description, text, chatId): Promise<boolean | MessageId>

Sends a link to a chat that includes a link preview.

Parameters​

NameTypeDescription
thumbstringThe base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param
urlstringThe link you want to send
titlestringThe title of the link
descriptionstringThe long description of the link preview
textContentThe text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
chatIdChatIdThe chat you want to send this message to.

Returns​

Promise<boolean | MessageId>

sendMp4AsSticker​

▸ sendMp4AsSticker(to, file, processOptions?, stickerMetadata?, messageId?): Promise<string | boolean | MessageId>

Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files.

Parameters​

NameTypeDefault valueDescription
toChatIdundefinedChatId The chat id you want to send the webp sticker to
filestring | Base64 | DataURL | BufferundefinedDataURL, Base64, URL (string GET), Relative filepath (string), or Buffer of the mp4 file
processOptionsMp4StickerConversionProcessOptionsdefaultProcessOptions-
stickerMetadata?StickerMetadataundefined-
messageId?MessageIdundefinedmessage id of the message you want this sticker to reply to. {@license:insiders@}

Returns​

Promise<string | boolean | MessageId>

sendMultipleContacts
insiders
​

▸ sendMultipleContacts(to, contactIds): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Sends multiple contacts as a single message

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
contactIdsContactId[]-

Returns​

Promise<boolean | MessageId>

sendPaymentRequest​

▸ sendPaymentRequest(to, amount, currency, message?): Promise<boolean | MessageId>

[UNTESTED - REQUIRES FEEDBACK] +The advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format.

Parameters​

NameType
toChatId
imagestring | Base64 | DataURL | Buffer
stickerMetadata?StickerMetadata

Returns​

Promise<string | boolean | MessageId>

sendImageAsStickerAsReply
insiders
​

▸ sendImageAsStickerAsReply(to, image, messageId, stickerMetadata?): Promise<string | boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

This function takes an image and sends it as a sticker to the recipient as a reply to another message.

Parameters​

NameTypeDescription
toChatIdThe recipient id.
imagestring | Base64 | DataURL | Buffer-
messageIdMessageIdThe id of the message to reply to
stickerMetadata?StickerMetadataSticker metadata

Returns​

Promise<string | boolean | MessageId>

sendImageWithProduct​

▸ sendImageWithProduct(to, image, caption, bizNumber, productId): Promise<boolean | MessageId>

Sends product with image to chat

Parameters​

NameTypeDescription
toChatId-
imageBase64-
captionContentstring the caption you want to add to this message
bizNumberContactIdstring the @c.us number of the business account from which you want to grab the product
productIdstringstring the id of the product within the main catalog of the aforementioned business

Returns​

Promise<boolean | MessageId>

sendLinkWithAutoPreview​

▸ sendLinkWithAutoPreview(to, url, text?, thumbnail?, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Automatically sends a link with the auto generated link preview. You can also add a custom message.

Parameters​

NameTypeDescription
toChatId-
urlstringstring A link.
text?Contentstring Custom text as body of the message, this needs to include the link or it will be appended after the link.
thumbnail?Base64Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
quotedMsgId?MessageId[INSIDERS] Send this link preview message in response to a given quoted message
customSize?Object[INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
customSize.heightnumber-
customSize.widthnumber-

Returns​

Promise<boolean | MessageId>

sendListMessage​

▸ sendListMessage(to, sections, title, description, actionText): Promise<boolean | MessageId>

Deprecated

danger

It is not currently possible to send a listmessage to a group chat. This is a WA limitation. +Please DO NOT get a license solely for access to list messages in group chats.

LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE

Send a list message. This will not work when being sent from business accounts!

Parameters​

NameTypeDescription
toChatId
sectionsSection[]The Sections of rows for the list message
titlestringThe title of the list message
descriptionstringThe description of the list message
actionTextstringThe action text of the list message

Returns​

Promise<boolean | MessageId>

sendLocation​

▸ sendLocation(to, lat, lng, loc, address?, url?): Promise<boolean | MessageId>

Note: address and url are parameters available to insiders only.

Sends a location message to given chat

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
latstringlatitude: '51.5074'
lngstringlongitude: '0.1278'
locstringlocation text: 'LONDON!'
address?stringaddress text: '1 Regents Park!'
url?stringaddress text link: 'https://example.com'

Returns​

Promise<boolean | MessageId>

sendMessageWithThumb​

▸ sendMessageWithThumb(thumb, url, title, description, text, chatId, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Sends a link to a chat that includes a link preview.

Parameters​

NameTypeDescription
thumbstringThe base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param
urlstringThe link you want to send
titlestringThe title of the link
descriptionstringThe long description of the link preview
textContentThe text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
chatIdChatIdThe chat you want to send this message to.
quotedMsgId?MessageId[INSIDERS] Send this link preview message in response to a given quoted message
customSize?Object[INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
customSize.heightnumber-
customSize.widthnumber-

Returns​

Promise<boolean | MessageId>

sendMp4AsSticker​

▸ sendMp4AsSticker(to, file, processOptions?, stickerMetadata?, messageId?): Promise<string | boolean | MessageId>

Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files.

Parameters​

NameTypeDefault valueDescription
toChatIdundefinedChatId The chat id you want to send the webp sticker to
filestring | Base64 | DataURL | BufferundefinedDataURL, Base64, URL (string GET), Relative filepath (string), or Buffer of the mp4 file
processOptionsMp4StickerConversionProcessOptionsdefaultProcessOptions-
stickerMetadata?StickerMetadataundefined-
messageId?MessageIdundefinedmessage id of the message you want this sticker to reply to. {@license:insiders@}

Returns​

Promise<string | boolean | MessageId>

sendMultipleContacts
insiders
​

▸ sendMultipleContacts(to, contactIds): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Sends multiple contacts as a single message

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
contactIdsContactId[]-

Returns​

Promise<boolean | MessageId>

sendPaymentRequest​

▸ sendPaymentRequest(to, amount, currency, message?): Promise<boolean | MessageId>

[UNTESTED - REQUIRES FEEDBACK] Sends a payment request message to given chat

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
amountnumbernumber the amount to request in 1000 format (e.g £10 => 10000)
currencystringstring The 3 letter currency code
message?stringstring optional message to send with the payment request

Returns​

Promise<boolean | MessageId>

sendPoll​

▸ sendPoll(to, name, options, quotedMsgId?, allowMultiSelect?): Promise<MessageId>

Send a poll to a group chat

Parameters​

NameTypeDescription
toGroupChatIdchat id - a group chat is required
namestringthe name of the poll
optionsstring[]an array of poll options
quotedMsgId?MessageIdA message to quote when sending the poll
allowMultiSelect?booleanWhether or not to allow multiple selections. default false

Returns​

Promise<MessageId>

sendProduct
insiders
​

▸ sendProduct(chatId, productId): Promise<MessageId>

🏅May require insiders license

Use this link to get the correct license.

Send a product to a chat

Parameters​

NameTypeDescription
chatIdChatIdThe chatId
productIdstringThe id of the product

Returns​

Promise<MessageId>

MessageID

sendPtt​

▸ sendPtt(to, file, quotedMsgId?): Promise<MessageId>

Attempts to send a file as a voice note. Useful if you want to send an mp3 file.

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFilebase64 data:image/xxx;base64,xxx or the path of the file you want to send.
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

Returns​

Promise<MessageId>

Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendRawWebpAsSticker​

▸ sendRawWebpAsSticker(to, webpBase64, animated?): Promise<string | boolean | MessageId>

You can use this to send a raw webp file.

Parameters​

NameTypeDefault valueDescription
toChatIdundefinedChatId The chat id you want to send the webp sticker to
webpBase64Base64undefinedBase64 The base64 string of the webp file. Not DataURl
animatedbooleanfalseBoolean Set to true if the webp is animated. Default false

Returns​

Promise<string | boolean | MessageId>

sendRawWebpAsStickerAsReply
insiders
​

▸ sendRawWebpAsStickerAsReply(to, messageId, webpBase64, animated?): Promise<string | boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

You can use this to send a raw webp file.

Parameters​

NameTypeDefault valueDescription
toChatIdundefinedChatId The chat id you want to send the webp sticker to
messageIdMessageIdundefinedMessageId Message ID of the message to reply to
webpBase64Base64undefinedBase64 The base64 string of the webp file. Not DataURl
animatedbooleanfalseBoolean Set to true if the webp is animated. Default false

Returns​

Promise<string | boolean | MessageId>

sendReplyWithMentions​

▸ sendReplyWithMentions(to, content, replyMessageId, hideTags?, mentions?): Promise<boolean | MessageId>

Sends a reply to given chat that includes mentions, replying to the provided replyMessageId. In order to use this method correctly you will need to send the text like this: "@4474747474747 how are you?" Basically, add a @ symbol before the number of the contact you want to mention.

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
contentContenttext message
replyMessageIdMessageIdid of message to reply to
hideTags?booleanRemoves all tags within the message
mentions?ContactId[]You can optionally add an array of contact IDs to tag only specific people

Returns​

Promise<boolean | MessageId>

sendSeen​

▸ sendSeen(chatId): Promise<boolean>

Sets a chat status to seen. Marks all messages as ack: 3

Parameters​

NameTypeDescription
chatIdChatIdchat id: xxxxx@c.us

Returns​

Promise<boolean>

sendStickerfromUrl​

▸ sendStickerfromUrl(to, url, requestConfig?, stickerMetadata?): Promise<string | boolean | MessageId>

Sends a sticker (including GIF) from a given URL

Parameters​

NameTypeDescription
toChatId-
urlstring-
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
stickerMetadata?StickerMetadata-

Returns​

Promise<string | boolean | MessageId>

Promise<MessageId | boolean>

sendStickerfromUrlAsReply
insiders
​

▸ sendStickerfromUrlAsReply(to, url, messageId, requestConfig?, stickerMetadata?): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Sends a sticker from a given URL

Parameters​

NameTypeDescription
toChatIdThe recipient id.
urlstringThe url of the image
messageIdMessageIdThe id of the message to reply to
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
stickerMetadata?StickerMetadata-

Returns​

Promise<boolean | MessageId>

Promise<MessageId | boolean>

sendText
restricted
​

▸ sendText(to, content): Promise<boolean | MessageId>

🏅May require restricted license

Use this link to get the correct license.

Sends a text message to given chat

A license is NOT required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers.

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
contentContenttext message

Returns​

Promise<boolean | MessageId>

sendTextWithMentions​

▸ sendTextWithMentions(to, content, hideTags?, mentions?): Promise<boolean | MessageId>

Sends a text message to given chat that includes mentions. In order to use this method correctly you will need to send the text like this: "@4474747474747 how are you?" -Basically, add a @ symbol before the number of the contact you want to mention.

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
contentContenttext message
hideTags?booleanRemoves all tags within the message
mentions?ContactId[]You can optionally add an array of contact IDs to tag only specific people

Returns​

Promise<boolean | MessageId>

sendVCard​

▸ sendVCard(chatId, vcard, contactName?, contactNumber?): Promise<boolean>

Send VCARD

Parameters​

NameTypeDescription
chatIdChatId'000000000000@c.us'
vcardstringvcard as a string, you can send multiple contacts vcard also.
contactName?stringThe display name for the contact. Ignored on multiple vcards
contactNumber?stringIf supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g: 4477777777777 Ignored on multiple vcards

Returns​

Promise<boolean>

sendVideoAsGif​

▸ sendVideoAsGif(to, file, filename, caption, quotedMsgId?, requestConfig?): Promise<MessageId>

Sends a video to given chat as a gif, with caption or not, using base64

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFileDataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).
filenamestringstring xxxxx
captionContentstring xxxxx
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<MessageId>

▸ sendYoutubeLink(to, url, text?, thumbnail?): Promise<boolean | MessageId>

Automatically sends a youtube link with the auto generated link preview. You can also add a custom message.

Parameters​

NameTypeDefault valueDescription
toChatIdundefined-
urlstringundefinedstring A youtube link.
textContent''string Custom text as body of the message, this needs to include the link or it will be appended after the link.
thumbnail?Base64undefinedstring Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.

Returns​

Promise<boolean | MessageId>

setChatBackgroundColourHex
insiders
​

▸ setChatBackgroundColourHex(hex): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Set the wallpaper background colour

Parameters​

NameTypeDescription
hexstring'#FFF123'

Returns​

Promise<boolean>

setChatEphemeral
insiders
​

▸ setChatEphemeral(chatId, ephemeral): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Turn the ephemeral setting in a chat to on or off

Parameters​

NameTypeDescription
chatIdChatIdThe ID of the chat
ephemeralboolean | EphemeralDurationtrue to turn on the ephemeral setting to 1 day, false to turn off the ephemeral setting. Other options: 604800 \| 7776000

Returns​

Promise<boolean>

Promise<boolean> true if the setting was set, false if the chat does not exist

setChatState​

▸ setChatState(chatState, chatId): Promise<boolean>

Sets the chat state

Parameters​

NameTypeDescription
chatStateChatStateThe state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).
chatIdChatId

Returns​

Promise<boolean>

setGroupApprovalMode​

▸ setGroupApprovalMode(groupId, requireApproval): Promise<boolean>

Turn on or off the approval requirement for new members to join a group

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
requireApprovalbooleanset to true to turn on the approval requirement, false to turn off

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupDescription​

▸ setGroupDescription(groupId, description): Promise<boolean>

Change the group chant description

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
descriptionstringstring The new group description

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupEditToAdminsOnly​

▸ setGroupEditToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot edit a groups details

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
onlyAdminsbooleanboolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupIcon​

▸ setGroupIcon(groupId, image): Promise<boolean>

Change the icon for the group chat

Parameters​

NameTypeDescription
groupIdGroupChatId123123123123_1312313123@g.us The id of the group
imageDataURL-

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupIconByUrl​

▸ setGroupIconByUrl(groupId, url, requestConfig?): Promise<boolean>

Change the icon for the group chat

Parameters​

NameTypeDescription
groupIdGroupChatId123123123123_1312313123@g.us The id of the group
urlstring-
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupTitle
insiders
​

▸ setGroupTitle(groupId, title): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Change the group chat title

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
titlestringstring The new group title

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupToAdminsOnly​

▸ setGroupToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot speak in a group

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
onlyAdminsbooleanboolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setMyName​

▸ setMyName(newName): Promise<boolean>

Set your profile name

Please note, this does not work on business accounts!

Parameters​

NameTypeDescription
newNamestringString new name to set for your profile

Returns​

Promise<boolean>

setMyStatus​

▸ setMyStatus(newStatus): Promise<boolean | void>

set your about me

Parameters​

NameTypeDescription
newStatusstringString new profile status

Returns​

Promise<boolean | void>

setPresence​

▸ setPresence(available): Promise<boolean | void>

Set presence to available or unavailable.

Parameters​

NameTypeDescription
availablebooleanif true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);

Returns​

Promise<boolean | void>

setProfilePic​

▸ setProfilePic(data): Promise<boolean>

Sets the profile pic of the host number.

Parameters​

NameTypeDescription
dataDataURLstring data url image string.

Returns​

Promise<boolean>

Promise<boolean> success if true

simulateRecording​

▸ simulateRecording(to, on): Promise<boolean>

Simulate '...recording' in chat

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
onbooleanturn on similated recording, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

simulateTyping​

▸ simulateTyping(to, on): Promise<boolean>

Simulate '...typing' in chat

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
onbooleanturn on similated typing, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

starMessage​

▸ starMessage(messageId): Promise<boolean>

Star a message

Parameters​

NameTypeDescription
messageIdMessageIdMessage ID of the message you want to star

Returns​

Promise<boolean>

true

syncContacts​

▸ syncContacts(): Promise<boolean>

Syncs contacts with phone. This promise does not resolve so it will instantly return true.

Returns​

Promise<boolean>

tagEveryone
insiders
​

▸ tagEveryone(groupId, content, hideTags?, formatting?, messageBeforeTags?): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Tags everyone in the group with a message

Mention

to indicate the actual tag.

Default

@mention

Parameters​

NameTypeDescription
groupIdGroupChatIdgroup chat id: xxxxx@g.us
contentContenttext message to add under all of the tags
hideTags?booleanRemoves all tags within the message
formatting?stringThe formatting of the tags. Use
messageBeforeTags?booleanset to true to show the message before all of the tags

Returns​

Promise<boolean | MessageId>

Promise<MessageId>

testButtons​

▸ testButtons(chatId): Promise<any>

Deprecated

danger

Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.

Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658

Parameters​

NameType
chatIdChatId

Returns​

Promise<any>

testCallback​

▸ testCallback(callbackToTest, testData): Promise<boolean>

Use this simple command to test firing callback events.

Parameters​

NameType
callbackToTestSimpleListener
testDataany

Returns​

Promise<boolean>

false if the callback was not registered/does not exist

unmuteChat
insiders
​

▸ unmuteChat(chatId): Promise<string | number | boolean>

🏅May require insiders license

Use this link to get the correct license.

Unmutes a conversation.

Parameters​

NameType
chatIdChatId

Returns​

Promise<string | number | boolean>

boolean true: worked or error code or message

unstarMessage​

▸ unstarMessage(messageId): Promise<boolean>

Unstar a message

Parameters​

NameTypeDescription
messageIdMessageIdMessage ID of the message you want to unstar

Returns​

Promise<boolean>

true

updateWebhook​

▸ updateWebhook(webhookId, events): Promise<false | Webhook>

Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using removeWebhook.

In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials.

Parameters​

NameType
webhookIdstring
eventsSimpleListener[] | "all"

Returns​

Promise<false | Webhook>

waitAllQEmpty​

▸ waitAllQEmpty(): Promise<true | void[]>

Wait for all queues to be empty

Returns​

Promise<true | void[]>

waitWhQIdle​

▸ waitWhQIdle(): Promise<true | void>

Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.

Returns​

Promise<true | void>

Events​

onAck​

▸ onAck(fn): Promise<boolean | Listener>

Listens to messages acknowledgement Changes

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback function that handles a Message as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAddedToGroup​

▸ onAddedToGroup(fn): Promise<boolean | Listener>

Fires callback with Chat object every time the host phone is added to a group.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAnyMessage​

▸ onAnyMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to all new messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback
queueOptions?Options<default, DefaultAddOptions>PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

onBattery​

▸ onBattery(fn): Promise<boolean | Listener>

Deprecated

Listens to battery changes

caution

This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.

Fires

number

Parameters​

NameTypeDescription
fn(battery: number) => voidcallback

Returns​

Promise<boolean | Listener>

onBroadcast​

▸ onBroadcast(fn): Promise<boolean | Listener>

Listens to broadcast messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onButton​

▸ onButton(fn): Promise<boolean | Listener>

Listens to button message responses

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onCallState​

▸ onCallState(fn): Promise<boolean | Listener>

Listens to changes on call state

Parameters​

NameType
fn(call: Call) => void

Returns​

Promise<boolean | Listener>

Observable stream of call objects

onChatDeleted​

▸ onChatDeleted(fn): Promise<boolean | Listener>

Listens to when a chat is deleted by the host account

Fires

Chat

Parameters​

NameTypeDescription
fn(chat: Chat) => voidcallback

Returns​

Promise<boolean | Listener>

onChatOpened
insiders
​

▸ onChatOpened(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a ChatId as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onChatState
insiders
​

▸ onChatState(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to chat state, including when a specific user is recording and typing within a group chat.

Here is an example of the fired object:

Fires

{
"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring
"user": "22222222222@c.us", //the user that is causing this state
"state": "composing, //can also be 'available', 'unavailable', 'recording' or 'composing'
}

Parameters​

NameType
fn(chatState: ChatState) => void

Returns​

Promise<boolean | Listener>

onContactAdded
insiders
​

▸ onContactAdded(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with contact id when a new contact is added on the host phone.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGlobalParticipantsChanged​

▸ onGlobalParticipantsChanged(fn): Promise<boolean | Listener>

Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to.

Parameters​

NameTypeDescription
fn(participantChangedEvent: ParticipantChangedEventModel) => voidcallback function that handles a ParticipantChangedEventModel as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupApprovalRequest​

▸ onGroupApprovalRequest(fn): Promise<boolean | Listener>

Listents to group approval requests. Emits a message object. Use it with message.isGroupApprovalRequest() to check if it is a group approval request.

Parameters​

NameTypeDescription
fn(groupApprovalRequestMessage: Message) => voidcallback function that handles a Message as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupChange​

▸ onGroupChange(fn): Promise<boolean | Listener>

Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.

Parameters​

NameTypeDescription
fn(genericGroupChangeEvent: GenericGroupChangeEvent) => voidcallback function that handles a ParticipantChangedEventModel as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onIncomingCall​

▸ onIncomingCall(fn): Promise<boolean | Listener>

Listens to new incoming calls

Parameters​

NameType
fn(call: Call) => void

Returns​

Promise<boolean | Listener>

Observable stream of call request objects

onLabel​

▸ onLabel(fn): Promise<boolean | Listener>

Listens to label change events

Fires

Label

Parameters​

NameTypeDescription
fn(label: Label) => voidcallback

Returns​

Promise<boolean | Listener>

onLiveLocation​

▸ onLiveLocation(chatId, fn): Promise<boolean>

Listens to live locations from a chat that already has valid live locations

Emits

<LiveLocationChangedEvent> LiveLocationChangedEvent

Parameters​

NameTypeDescription
chatIdChatIdthe chat from which you want to subscribes to live location updates
fn(liveLocationChangedEvent: LiveLocationChangedEvent) => voidcallback that takes in a LiveLocationChangedEvent

Returns​

Promise<boolean>

boolean, if returns false then there were no valid live locations in the chat of chatId

onLogout​

▸ onLogout(fn, priority?): Promise<boolean>

Listens to a log out event

Fires

true

Parameters​

NameTypeDescription
fn(loggedOut?: boolean) => anycallback
priority?numberA priority of -1 will mean the callback will be triggered after all the non -1 callbacks

Returns​

Promise<boolean>

onMessage​

▸ onMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to incoming messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback
queueOptions?Options<default, DefaultAddOptions>PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

onMessageDeleted​

▸ onMessageDeleted(fn): Promise<boolean | Listener>

Listens to when a message is deleted by a recipient or the host account

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onParticipantsChanged​

▸ onParticipantsChanged(groupId, fn, legacy?): Promise<boolean | Listener>

Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote

Parameters​

NameTypeDefault valueDescription
groupIdGroupChatIdundefinedgroup id: xxxxx-yyyy@c.us
fn(participantChangedEvent: ParticipantChangedEventModel) => voidundefinedcallback
legacybooleanfalse-

Returns​

Promise<boolean | Listener>

Observable stream of participantChangedEvent

onPlugged​

▸ onPlugged(fn): Promise<boolean | Listener>

Listens to when host device is plugged/unplugged

Fires

boolean true if plugged, false if unplugged

Parameters​

NameTypeDescription
fn(plugged: boolean) => voidcallback

Returns​

Promise<boolean | Listener>

onPollVote​

▸ onPollVote(fn): Promise<boolean | Listener>

Listens to poll vote events

Fires

PollData

Parameters​

NameTypeDescription
fn(pollDate: PollData) => voidcallback

Returns​

Promise<boolean | Listener>

onReaction
insiders
​

▸ onReaction(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to reaction add and change events

Fires

ReactionEvent

Parameters​

NameTypeDescription
fn(reactionEvent: ReactionEvent) => voidcallback

Returns​

Promise<boolean | Listener>

onRemovedFromGroup
insiders
​

▸ onRemovedFromGroup(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with Chat object every time the host phone is removed to a group.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onStateChanged​

▸ onStateChanged(fn): Promise<boolean | Listener>

Listens to changes in state

Fires

STATE observable sream of states

Parameters​

NameType
fn(state: STATE) => void

Returns​

Promise<boolean | Listener>

onStory
restricted
​

▸ onStory(fn): Promise<boolean | Listener>

🏅May require restricted license

Use this link to get the correct license.

Listens to when a contact posts a new story.

Fires

e.g 

{
from: '123456789@c.us'
id: 'false_132234234234234@status.broadcast'
}

Parameters​

NameTypeDescription
fn(story: Message) => voidcallback

Returns​

Promise<boolean | Listener>

- +Basically, add a @ symbol before the number of the contact you want to mention.

Parameters​

NameTypeDescription
toChatIdchat id: xxxxx@c.us
contentContenttext message
hideTags?booleanRemoves all tags within the message
mentions?ContactId[]You can optionally add an array of contact IDs to tag only specific people

Returns​

Promise<boolean | MessageId>

sendVCard​

▸ sendVCard(chatId, vcard, contactName?, contactNumber?): Promise<boolean>

Send VCARD

Parameters​

NameTypeDescription
chatIdChatId'000000000000@c.us'
vcardstringvcard as a string, you can send multiple contacts vcard also.
contactName?stringThe display name for the contact. Ignored on multiple vcards
contactNumber?stringIf supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g: 4477777777777 Ignored on multiple vcards

Returns​

Promise<boolean>

sendVideoAsGif​

▸ sendVideoAsGif(to, file, filename, caption, quotedMsgId?, requestConfig?): Promise<MessageId>

Sends a video to given chat as a gif, with caption or not, using base64

Parameters​

NameTypeDescription
toChatIdchat id xxxxx@c.us
fileAdvancedFileDataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).
filenamestringstring xxxxx
captionContentstring xxxxx
quotedMsgId?MessageIdstring true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<MessageId>

▸ sendYoutubeLink(to, url, text?, thumbnail?, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Automatically sends a youtube link with the auto generated link preview. You can also add a custom message.

Parameters​

NameTypeDefault valueDescription
toChatIdundefined-
urlstringundefinedstring A youtube link.
textContent''string Custom text as body of the message, this needs to include the link or it will be appended after the link.
thumbnail?Base64undefinedstring Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
quotedMsgId?MessageIdundefined[INSIDERS] Send this link preview message in response to a given quoted message
customSize?Objectundefined[INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
customSize.heightnumberundefined-
customSize.widthnumberundefined-

Returns​

Promise<boolean | MessageId>

setChatBackgroundColourHex
insiders
​

▸ setChatBackgroundColourHex(hex): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Set the wallpaper background colour

Parameters​

NameTypeDescription
hexstring'#FFF123'

Returns​

Promise<boolean>

setChatEphemeral
insiders
​

▸ setChatEphemeral(chatId, ephemeral): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Turn the ephemeral setting in a chat to on or off

Parameters​

NameTypeDescription
chatIdChatIdThe ID of the chat
ephemeralboolean | EphemeralDurationtrue to turn on the ephemeral setting to 1 day, false to turn off the ephemeral setting. Other options: 604800 \| 7776000

Returns​

Promise<boolean>

Promise<boolean> true if the setting was set, false if the chat does not exist

setChatState​

▸ setChatState(chatState, chatId): Promise<boolean>

Sets the chat state

Parameters​

NameTypeDescription
chatStateChatStateThe state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).
chatIdChatId

Returns​

Promise<boolean>

setGroupApprovalMode​

▸ setGroupApprovalMode(groupId, requireApproval): Promise<boolean>

Turn on or off the approval requirement for new members to join a group

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
requireApprovalbooleanset to true to turn on the approval requirement, false to turn off

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupDescription​

▸ setGroupDescription(groupId, description): Promise<boolean>

Change the group chant description

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
descriptionstringstring The new group description

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupEditToAdminsOnly​

▸ setGroupEditToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot edit a groups details

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
onlyAdminsbooleanboolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupIcon​

▸ setGroupIcon(groupId, image): Promise<boolean>

Change the icon for the group chat

Parameters​

NameTypeDescription
groupIdGroupChatId123123123123_1312313123@g.us The id of the group
imageDataURL-

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupIconByUrl​

▸ setGroupIconByUrl(groupId, url, requestConfig?): Promise<boolean>

Change the icon for the group chat

Parameters​

NameTypeDescription
groupIdGroupChatId123123123123_1312313123@g.us The id of the group
urlstring-
requestConfigAxiosRequestConfig<any>{} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupTitle
insiders
​

▸ setGroupTitle(groupId, title): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Change the group chat title

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
titlestringstring The new group title

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupToAdminsOnly​

▸ setGroupToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot speak in a group

Parameters​

NameTypeDescription
groupIdGroupChatId'0000000000-00000000@g.us' the group id.
onlyAdminsbooleanboolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setMyName​

▸ setMyName(newName): Promise<boolean>

Set your profile name

Please note, this does not work on business accounts!

Parameters​

NameTypeDescription
newNamestringString new name to set for your profile

Returns​

Promise<boolean>

setMyStatus​

▸ setMyStatus(newStatus): Promise<boolean | void>

set your about me

Parameters​

NameTypeDescription
newStatusstringString new profile status

Returns​

Promise<boolean | void>

setPresence​

▸ setPresence(available): Promise<boolean | void>

Set presence to available or unavailable.

Parameters​

NameTypeDescription
availablebooleanif true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);

Returns​

Promise<boolean | void>

setProfilePic​

▸ setProfilePic(data): Promise<boolean>

Sets the profile pic of the host number.

Parameters​

NameTypeDescription
dataDataURLstring data url image string.

Returns​

Promise<boolean>

Promise<boolean> success if true

simulateRecording​

▸ simulateRecording(to, on): Promise<boolean>

Simulate '...recording' in chat

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
onbooleanturn on similated recording, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

simulateTyping​

▸ simulateTyping(to, on): Promise<boolean>

Simulate '...typing' in chat

Parameters​

NameTypeDescription
toChatId'xxxx@c.us'
onbooleanturn on similated typing, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

starMessage​

▸ starMessage(messageId): Promise<boolean>

Star a message

Parameters​

NameTypeDescription
messageIdMessageIdMessage ID of the message you want to star

Returns​

Promise<boolean>

true

syncContacts​

▸ syncContacts(): Promise<boolean>

Syncs contacts with phone. This promise does not resolve so it will instantly return true.

Returns​

Promise<boolean>

tagEveryone
insiders
​

▸ tagEveryone(groupId, content, hideTags?, formatting?, messageBeforeTags?): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Tags everyone in the group with a message

Mention

to indicate the actual tag.

Default

@mention

Parameters​

NameTypeDescription
groupIdGroupChatIdgroup chat id: xxxxx@g.us
contentContenttext message to add under all of the tags
hideTags?booleanRemoves all tags within the message
formatting?stringThe formatting of the tags. Use
messageBeforeTags?booleanset to true to show the message before all of the tags

Returns​

Promise<boolean | MessageId>

Promise<MessageId>

testButtons​

▸ testButtons(chatId): Promise<any>

Deprecated

danger

Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.

Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658

Parameters​

NameType
chatIdChatId

Returns​

Promise<any>

testCallback​

▸ testCallback(callbackToTest, testData): Promise<boolean>

Use this simple command to test firing callback events.

Parameters​

NameType
callbackToTestSimpleListener
testDataany

Returns​

Promise<boolean>

false if the callback was not registered/does not exist

unmuteChat
insiders
​

▸ unmuteChat(chatId): Promise<string | number | boolean>

🏅May require insiders license

Use this link to get the correct license.

Unmutes a conversation.

Parameters​

NameType
chatIdChatId

Returns​

Promise<string | number | boolean>

boolean true: worked or error code or message

unstarMessage​

▸ unstarMessage(messageId): Promise<boolean>

Unstar a message

Parameters​

NameTypeDescription
messageIdMessageIdMessage ID of the message you want to unstar

Returns​

Promise<boolean>

true

updateWebhook​

▸ updateWebhook(webhookId, events): Promise<false | Webhook>

Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using removeWebhook.

In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials.

Parameters​

NameType
webhookIdstring
eventsSimpleListener[] | "all"

Returns​

Promise<false | Webhook>

waitAllQEmpty​

▸ waitAllQEmpty(): Promise<true | void[]>

Wait for all queues to be empty

Returns​

Promise<true | void[]>

waitWhQIdle​

▸ waitWhQIdle(): Promise<true | void>

Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.

Returns​

Promise<true | void>

Events​

onAck​

▸ onAck(fn): Promise<boolean | Listener>

Listens to messages acknowledgement Changes

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback function that handles a Message as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAddedToGroup​

▸ onAddedToGroup(fn): Promise<boolean | Listener>

Fires callback with Chat object every time the host phone is added to a group.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAnyMessage​

▸ onAnyMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to all new messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback
queueOptions?Options<default, DefaultAddOptions>PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

onBattery​

▸ onBattery(fn): Promise<boolean | Listener>

Deprecated

Listens to battery changes

caution

This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.

Fires

number

Parameters​

NameTypeDescription
fn(battery: number) => voidcallback

Returns​

Promise<boolean | Listener>

onBroadcast​

▸ onBroadcast(fn): Promise<boolean | Listener>

Listens to broadcast messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onButton​

▸ onButton(fn): Promise<boolean | Listener>

Listens to button message responses

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onCallState​

▸ onCallState(fn): Promise<boolean | Listener>

Listens to changes on call state

Parameters​

NameType
fn(call: Call) => void

Returns​

Promise<boolean | Listener>

Observable stream of call objects

onChatDeleted​

▸ onChatDeleted(fn): Promise<boolean | Listener>

Listens to when a chat is deleted by the host account

Fires

Chat

Parameters​

NameTypeDescription
fn(chat: Chat) => voidcallback

Returns​

Promise<boolean | Listener>

onChatOpened
insiders
​

▸ onChatOpened(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a ChatId as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onChatState
insiders
​

▸ onChatState(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to chat state, including when a specific user is recording and typing within a group chat.

Here is an example of the fired object:

Fires

{
"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring
"user": "22222222222@c.us", //the user that is causing this state
"state": "composing, //can also be 'available', 'unavailable', 'recording' or 'composing'
}

Parameters​

NameType
fn(chatState: ChatState) => void

Returns​

Promise<boolean | Listener>

onContactAdded
insiders
​

▸ onContactAdded(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with contact id when a new contact is added on the host phone.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGlobalParticipantsChanged​

▸ onGlobalParticipantsChanged(fn): Promise<boolean | Listener>

Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to.

Parameters​

NameTypeDescription
fn(participantChangedEvent: ParticipantChangedEventModel) => voidcallback function that handles a ParticipantChangedEventModel as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupApprovalRequest​

▸ onGroupApprovalRequest(fn): Promise<boolean | Listener>

Listents to group approval requests. Emits a message object. Use it with message.isGroupApprovalRequest() to check if it is a group approval request.

Parameters​

NameTypeDescription
fn(groupApprovalRequestMessage: Message) => voidcallback function that handles a Message as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupChange​

▸ onGroupChange(fn): Promise<boolean | Listener>

Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.

Parameters​

NameTypeDescription
fn(genericGroupChangeEvent: GenericGroupChangeEvent) => voidcallback function that handles a ParticipantChangedEventModel as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onIncomingCall​

▸ onIncomingCall(fn): Promise<boolean | Listener>

Listens to new incoming calls

Parameters​

NameType
fn(call: Call) => void

Returns​

Promise<boolean | Listener>

Observable stream of call request objects

onLabel​

▸ onLabel(fn): Promise<boolean | Listener>

Listens to label change events

Fires

Label

Parameters​

NameTypeDescription
fn(label: Label) => voidcallback

Returns​

Promise<boolean | Listener>

onLiveLocation​

▸ onLiveLocation(chatId, fn): Promise<boolean>

Listens to live locations from a chat that already has valid live locations

Emits

<LiveLocationChangedEvent> LiveLocationChangedEvent

Parameters​

NameTypeDescription
chatIdChatIdthe chat from which you want to subscribes to live location updates
fn(liveLocationChangedEvent: LiveLocationChangedEvent) => voidcallback that takes in a LiveLocationChangedEvent

Returns​

Promise<boolean>

boolean, if returns false then there were no valid live locations in the chat of chatId

onLogout​

▸ onLogout(fn, priority?): Promise<boolean>

Listens to a log out event

Fires

true

Parameters​

NameTypeDescription
fn(loggedOut?: boolean) => anycallback
priority?numberA priority of -1 will mean the callback will be triggered after all the non -1 callbacks

Returns​

Promise<boolean>

onMessage​

▸ onMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to incoming messages

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback
queueOptions?Options<default, DefaultAddOptions>PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

onMessageDeleted​

▸ onMessageDeleted(fn): Promise<boolean | Listener>

Listens to when a message is deleted by a recipient or the host account

Fires

Message

Parameters​

NameTypeDescription
fn(message: Message) => voidcallback

Returns​

Promise<boolean | Listener>

onParticipantsChanged​

▸ onParticipantsChanged(groupId, fn, legacy?): Promise<boolean | Listener>

Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote

Parameters​

NameTypeDefault valueDescription
groupIdGroupChatIdundefinedgroup id: xxxxx-yyyy@c.us
fn(participantChangedEvent: ParticipantChangedEventModel) => voidundefinedcallback
legacybooleanfalse-

Returns​

Promise<boolean | Listener>

Observable stream of participantChangedEvent

onPlugged​

▸ onPlugged(fn): Promise<boolean | Listener>

Listens to when host device is plugged/unplugged

Fires

boolean true if plugged, false if unplugged

Parameters​

NameTypeDescription
fn(plugged: boolean) => voidcallback

Returns​

Promise<boolean | Listener>

onPollVote​

▸ onPollVote(fn): Promise<boolean | Listener>

Listens to poll vote events

Fires

PollData

Parameters​

NameTypeDescription
fn(pollDate: PollData) => voidcallback

Returns​

Promise<boolean | Listener>

onReaction
insiders
​

▸ onReaction(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to reaction add and change events

Fires

ReactionEvent

Parameters​

NameTypeDescription
fn(reactionEvent: ReactionEvent) => voidcallback

Returns​

Promise<boolean | Listener>

onRemovedFromGroup
insiders
​

▸ onRemovedFromGroup(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with Chat object every time the host phone is removed to a group.

Parameters​

NameTypeDescription
fn(chat: Chat) => anycallback function that handles a Chat (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onStateChanged​

▸ onStateChanged(fn): Promise<boolean | Listener>

Listens to changes in state

Fires

STATE observable sream of states

Parameters​

NameType
fn(state: STATE) => void

Returns​

Promise<boolean | Listener>

onStory
restricted
​

▸ onStory(fn): Promise<boolean | Listener>

🏅May require restricted license

Use this link to get the correct license.

Listens to when a contact posts a new story.

Fires

e.g 

{
from: '123456789@c.us'
id: 'false_132234234234234@status.broadcast'
}

Parameters​

NameTypeDescription
fn(story: Message) => voidcallback

Returns​

Promise<boolean | Listener>

+ \ No newline at end of file diff --git a/docs/api/classes/api_model_errors.AddParticipantError.html b/docs/api/classes/api_model_errors.AddParticipantError.html index ddb9dac68b..0218d311ba 100644 --- a/docs/api/classes/api_model_errors.AddParticipantError.html +++ b/docs/api/classes/api_model_errors.AddParticipantError.html @@ -14,13 +14,13 @@ - +

Class: AddParticipantError

api/model/errors.AddParticipantError

Hierarchy​

  • Error

    ↳ AddParticipantError

Constructors​

constructor​

• new AddParticipantError(message, data?)

Parameters​

NameType
messagestring
data?Object

Overrides​

Error.constructor

Properties​

cause​

• Optional cause: Error

Inherited from​

Error.cause

data​

• data: Object

Index signature​

▪ [contactId: string]: number

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

stack​

• Optional stack: string

Inherited from​

Error.stack

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

- + \ No newline at end of file diff --git a/docs/api/classes/api_model_errors.CustomError.html b/docs/api/classes/api_model_errors.CustomError.html index 3eafe3008f..721f8fc8b0 100644 --- a/docs/api/classes/api_model_errors.CustomError.html +++ b/docs/api/classes/api_model_errors.CustomError.html @@ -14,13 +14,13 @@ - +

Class: CustomError

api/model/errors.CustomError

A simple custom error class that takes the first parameter as the name using the ERROR_NAME enum

Hierarchy​

  • Error

    ↳ CustomError

Constructors​

constructor​

• new CustomError(name, message?, ...params)

Parameters​

NameType
nameERROR_NAME
message?string
...paramsany[]

Overrides​

Error.constructor

Properties​

cause​

• Optional cause: Error

Inherited from​

Error.cause

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

stack​

• Optional stack: string

Inherited from​

Error.stack

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

- + \ No newline at end of file diff --git a/docs/api/classes/api_model_errors.PageEvaluationTimeout.html b/docs/api/classes/api_model_errors.PageEvaluationTimeout.html index 1d237ed957..109e7d5acd 100644 --- a/docs/api/classes/api_model_errors.PageEvaluationTimeout.html +++ b/docs/api/classes/api_model_errors.PageEvaluationTimeout.html @@ -14,13 +14,13 @@ - +

Class: PageEvaluationTimeout

api/model/errors.PageEvaluationTimeout

Hierarchy​

  • Error

    ↳ PageEvaluationTimeout

Constructors​

constructor​

• new PageEvaluationTimeout(...args)

Parameters​

NameType
...argsany[]

Overrides​

Error.constructor

Properties​

cause​

• Optional cause: Error

Inherited from​

Error.cause

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

stack​

• Optional stack: string

Inherited from​

Error.stack

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

- + \ No newline at end of file diff --git a/docs/api/classes/api_model_errors.SessionExpiredError.html b/docs/api/classes/api_model_errors.SessionExpiredError.html index a688c408dc..4b8fc9967f 100644 --- a/docs/api/classes/api_model_errors.SessionExpiredError.html +++ b/docs/api/classes/api_model_errors.SessionExpiredError.html @@ -14,13 +14,13 @@ - +

Class: SessionExpiredError

api/model/errors.SessionExpiredError

Hierarchy​

  • Error

    ↳ SessionExpiredError

Constructors​

constructor​

• new SessionExpiredError()

Overrides​

Error.constructor

Properties​

cause​

• Optional cause: Error

Inherited from​

Error.cause

message​

• message: string

Inherited from​

Error.message

name​

• name: string

Inherited from​

Error.name

stack​

• Optional stack: string

Inherited from​

Error.stack

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

- + \ No newline at end of file diff --git a/docs/api/classes/connect.Collection.html b/docs/api/classes/connect.Collection.html index aa276ba349..be92b0c98e 100644 --- a/docs/api/classes/connect.Collection.html +++ b/docs/api/classes/connect.Collection.html @@ -14,7 +14,7 @@ - + @@ -48,7 +48,7 @@ The default sort order is according to string Unicode code points.

Example

collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Parameters​

NameTypeDescription
compareFunction?Comparator<K, V>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns​

Collection<K, V>

Inherited from​

BaseCollection.sort

sorted​

▸ sorted(compareFunction?): Collection<K, V>

The sorted method sorts the items of a collection and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.

Example

collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Parameters​

NameTypeDescription
compareFunction?Comparator<K, V>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns​

Collection<K, V>

Inherited from​

BaseCollection.sorted

sweep​

▸ sweep(fn): number

Removes items that satisfy the provided filter function.

Parameters​

NameTypeDescription
fn(value: V, key: K, collection: Collection<K, V>) => booleanFunction used to test (should return a boolean)

Returns​

number

The number of removed entries

Inherited from​

BaseCollection.sweep

▸ sweep<T>(fn, thisArg): number

Type parameters​

Name
T

Parameters​

NameType
fn(this: T, value: V, key: K, collection: Collection<K, V>) => boolean
thisArgT

Returns​

number

Inherited from​

BaseCollection.sweep

tap​

▸ tap(fn): Collection<K, V>

Runs a function on the collection and returns the collection.

Example

collection
 .tap(coll => console.log(coll.size))
 .filter(user => user.bot)
 .tap(coll => console.log(coll.size))

Parameters​

NameTypeDescription
fn(collection: Collection<K, V>) => voidFunction to execute

Returns​

Collection<K, V>

Inherited from​

BaseCollection.tap

▸ tap<T>(fn, thisArg): Collection<K, V>

Type parameters​

Name
T

Parameters​

NameType
fn(this: T, collection: Collection<K, V>) => void
thisArgT

Returns​

Collection<K, V>

Inherited from​

BaseCollection.tap

toJSON​

▸ toJSON(): any[]

Returns​

any[]

Overrides​

BaseCollection.toJSON

values​

▸ values(): IterableIterator<V>

Returns an iterable of values in the map

Returns​

IterableIterator<V>

Inherited from​

BaseCollection.values

- + \ No newline at end of file diff --git a/docs/api/classes/connect.Collector.html b/docs/api/classes/connect.Collector.html index 2ea9c3e029..11b114fead 100644 --- a/docs/api/classes/connect.Collector.html +++ b/docs/api/classes/connect.Collector.html @@ -14,7 +14,7 @@ - + @@ -68,7 +68,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

EventEmitter.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

EventEmitter.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

EventEmitter.setMaxListeners

- + \ No newline at end of file diff --git a/docs/api/classes/connect.MessageCollector.html b/docs/api/classes/connect.MessageCollector.html index e6b4996c63..e838e7b5f0 100644 --- a/docs/api/classes/connect.MessageCollector.html +++ b/docs/api/classes/connect.MessageCollector.html @@ -14,7 +14,7 @@ - + @@ -67,7 +67,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

Collector.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

Collector.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

Collector.setMaxListeners

- + \ No newline at end of file diff --git a/docs/api/classes/connect.SocketClient.html b/docs/api/classes/connect.SocketClient.html index 466e587592..532b625658 100644 --- a/docs/api/classes/connect.SocketClient.html +++ b/docs/api/classes/connect.SocketClient.html @@ -14,13 +14,13 @@ - +

Class: SocketClient

connect.SocketClient

[ALPHA - API will 100% change in the near future. Don't say I didn't warn you.]

An easy to use socket implementation that allows users to connect into remote instances of the EASY API.

How to use it:

  1. Make sure you're running an instance of the EASY API and make sure to start it with the --socket flag

        > docker run -e PORT=8080 -p 8080:8080 openwa/wa-automate:latest --socket

  2. Use this in your code:

        import { SocketClient } from "@open-wa/wa-automate";

        SocketClient.connect("http://localhost:8080").then(async client => {
            //now you can use the client similar to how you would use the http express middleware.

            //There are two main commands from this client

            // 1. client.listen - use this for your listeners

            await client.listen("onMessage", message => {
                ...
            })

            // 2. client.asj - ask the main host client to get things done

            await client.ask("sendText", {
                "to" : "44771234567@c.us",
                "content": "hellow socket"
            })

            // or you can send the arguments in order as an array (or tuple, as the cool kids would say)
            await client.ask("sendText", [
                "44771234567@c.us",
                "hellow socket"
            ])

        })

Constructors​

constructor​

• new SocketClient(url, apiKey?, ev?)

Parameters​

NameType
urlstring
apiKey?string
ev?boolean

Properties​

apiKey​

• apiKey: string

ev​

• ev: EventEmitter2

A local version of the ev EventEmitter2

listeners​

• listeners: Object

Type declaration​

NameType
onAck{ [id: string]: (data: any) => any; }
onAddedToGroup{ [id: string]: (data: any) => any; }
onAnyMessage{ [id: string]: (data: any) => any; }
onBattery{ [id: string]: (data: any) => any; }
onButton{ [id: string]: (data: any) => any; }
onChatDeleted{ [id: string]: (data: any) => any; }
onChatOpened{ [id: string]: (data: any) => any; }
onChatState{ [id: string]: (data: any) => any; }
onContactAdded{ [id: string]: (data: any) => any; }
onGlobalParticipantsChanged{ [id: string]: (data: any) => any; }
onIncomingCall{ [id: string]: (data: any) => any; }
onLogout{ [id: string]: (data: any) => any; }
onMessage{ [id: string]: (data: any) => any; }
onMessageDeleted{ [id: string]: (data: any) => any; }
onOrder{ [id: string]: (data: any) => any; }
onPlugged{ [id: string]: (data: any) => any; }
onRemovedFromGroup{ [id: string]: (data: any) => any; }
onStateChanged{ [id: string]: (data: any) => any; }
onStory{ [id: string]: (data: any) => any; }

socket​

• socket: Socket<DefaultEventsMap, DefaultEventsMap>

url​

• url: string

Methods​

ask​

▸ ask<M, P>(method, args?): Promise<unknown>

Type parameters​

NameType
Mextends keyof Client
Pextends [] | [c: Message | ChatId | Chat, filter: CollectorFilter<[Message]>, options: CollectorOptions] | [c: Message | ChatId | Chat, filter: CollectorFilter<[Message]>, options?: AwaitMessagesOptions] | [chatId: ChatId, payload: Object] | [listener: SimpleListener] | [message?: string] | [url: string, optionsOverride?: any] | [fn: Function] | [fn: Function, queueOptions?: Options<default, DefaultAddOptions>] | [fn: Function, queueOptions?: Options<default, DefaultAddOptions>] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [groupId: `${number}-${number}@g.us`, fn: Function, legacy?: boolean] | [chatId: ChatId, fn: Function] | [available: boolean] | [newStatus: string] | [label: string] | [label: string, chatId: ChatId] | [label: string, chatId: ChatId] | [label: string] | [chatId: ChatId, vcard: string, contactName: string, contactNumber?: string] | [newName: string] | [chatState: ChatState, chatId: ChatId] | [chatId: ChatId] | [to: ChatId, content: string] | [to: ChatId, content: string, hideTags?: boolean] | [to: ChatId, amount: number, currency: string, message?: string] | [to: ChatId, body: string, buttons: Button[], title: string, footer?: string] | [to: ChatId, base64: string] | [to: ChatId, sections: Section[], title: string, description: string, actionText: string] | [to: ChatId, content: string, replyMessageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [groupId: `${number}-${number}@g.us`, content: string, hideTags?: boolean] | [thumb: string, url: string, title: string, description: string, text: string, chatId: ChatId] | [to: ChatId, lat: string, lng: string, loc: string] | [userA?: string] | [message: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}` | Message] | [to: ChatId, file: string, filename: string, caption: string, quotedMsgId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean] | [to: ChatId, url: string, text?: string, thumbnail?: string] | [to: ChatId, url: string, text?: string, thumbnail?: string] | [to: ChatId, content: string, quotedMsgId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, sendSeen?: boolean] | [contactId: `${number}@c.us`] | [to: ChatId, file: string, filename: string, caption: string, quotedMsgId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean] | [groupChatId: `${number}-${number}@g.us`] | [to: ChatId, file: string, quotedMsgId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [to: ChatId, file: string, quotedMsgId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [to: ChatId, file: string, filename: string, caption: string, quotedMsgId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, requestConfig?: AxiosRequestConfig<any>] | [to: ChatId, giphyMediaUrl: string, caption: string] | [to: ChatId, url: string, filename: string, caption: string, quotedMsgId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, requestConfig?: AxiosRequestConfig<any>, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean] | [id: `${number}@c.us`] | [to: ChatId, image: string, caption: string, bizNumber: `${number}@c.us`, productId: string] | [to: ChatId, image: string, productData: CustomProduct] | [to: ChatId, contactId: `${number}@c.us` | `${number}@c.us`[]] | [to: ChatId, contactIds: `${number}@c.us`[]] | [to: ChatId, on: boolean] | [id: ChatId, archive: boolean] | [id: ChatId, pin: boolean] | [chatId: ChatId, muteDuration: ChatMuteDuration] | [chatId: ChatId] | [chatId: ChatId] | [to: ChatId, messages: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}` | (`false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`)[], skipMyMessages: boolean] | [to: ChatId, messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [withNewMessageOnly?: boolean] | [withNewMessageOnly?: boolean] | [withNewMessagesOnly?: boolean] | [groupId: `${number}-${number}@g.us`] | [groupId: `${number}-${number}@g.us`] | [link: string, returnChatObj?: boolean] | [id: `${number}@c.us`] | [id: ChatId] | [id: `${number}@c.us`] | [groupId: `${number}-${number}@g.us`] | [msgId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [groupId: `${number}-${number}@g.us`] | [contactId: `${number}@c.us`] | [contactId: `${number}@c.us`] | [messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [id: string] | [name: string, price: number, currency: string, images: string[], description: string, url?: string, internalId?: string, isHidden?: boolean] | [productId: string, name?: string, price?: number, currency?: string, images?: string[], description?: string, url?: string, internalId?: string, isHidden?: boolean] | [chatId: ChatId, productId: string] | [productId: string] | [chatId?: ChatId] | [messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [contactId: `${number}@c.us`] | [contactId: `${number}@c.us`] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [contactId: `${number}@c.us`] | [contactId: `${number}@c.us`] | [contactId: `${number}@c.us`] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [link: string] | [chatId: ChatId] | [chatId: ChatId, messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}` | (`false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`)[], onlyLocal?: boolean] | [contactId: `${number}@c.us`] | [includeMe: boolean, includeNotifications: boolean, use_unread_count: boolean] | [chatId: ChatId, includeMe: boolean, includeNotifications: boolean] | [chatId: ChatId, includeMe: boolean, includeNotifications: boolean] | [groupName: string, contacts: `${number}@c.us` | `${number}@c.us`[]] | [groupId: `${number}-${number}@g.us`, participantId: `${number}@c.us`] | [groupId: `${number}-${number}@g.us`, image: string] | [groupId: `${number}-${number}@g.us`, url: string, requestConfig?: AxiosRequestConfig<any>] | [groupId: `${number}-${number}@g.us`, participantId: `${number}@c.us` | `${number}@c.us`[]] | [groupId: `${number}-${number}@g.us`, participantId: `${number}@c.us` | `${number}@c.us`[]] | [groupId: `${number}-${number}@g.us`, participantId: `${number}@c.us` | `${number}@c.us`[]] | [groupId: `${number}-${number}@g.us`, onlyAdmins: boolean] | [groupId: `${number}-${number}@g.us`, onlyAdmins: boolean] | [groupId: `${number}-${number}@g.us`, description: string] | [groupId: `${number}-${number}@g.us`, title: string] | [groupId: `${number}-${number}@g.us`] | [hex: string] | [activate: boolean] | [messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [to: ChatId, url: string, requestConfig?: AxiosRequestConfig<any>, stickerMetadata?: StickerMetadata] | [to: ChatId, url: string, messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, requestConfig?: AxiosRequestConfig<any>, stickerMetadata?: StickerMetadata] | [to: ChatId, image: string | Buffer, messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, stickerMetadata?: StickerMetadata] | [namespace: namespace, id: string, property: string] | [to: ChatId, image: string | Buffer, stickerMetadata?: StickerMetadata] | [to: ChatId, file: string | Buffer, processOptions?: Mp4StickerConversionProcessOptions, stickerMetadata?: StickerMetadata, messageId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [to: ChatId, emojiId: string, messageId?: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`] | [to: ChatId, webpBase64: string, animated?: boolean] | [to: ChatId, messageId: `false_${number}-${number}@g.us_${string}` | `false_${number}@c.us_${string}` | `true_${number}-${number}@g.us_${string}` | `true_${number}@c.us_${string}`, webpBase64: string, animated?: boolean] | [chatId: ChatId, ephemeral: boolean] | [to: ChatId, giphyMediaUrl: string | URL] | [text: string, textRgba: string, backgroundRgba: string, font: number] | [data: string, caption: string] | [data: string, caption: string] | [statusesToDelete: string | string[]] | [id: string] | [ts?: number] | [startingFrom?: number] | [message: Message] | [url: string] | [data: string] | [useSessionIdInPath?: boolean] | [webhookId: string] | [webhookId: string, events: "all" | SimpleListener[]] | [url: string, events: "all" | SimpleListener[], requestConfig?: AxiosRequestConfig<any>, concurrency?: number]

Parameters​

NameType
methodM
args?any[] | P | { [k: string]: unknown; }

Returns​

Promise<unknown>

awaitMessages​

▸ awaitMessages(c, filter, options?): Promise<Collection<string, Message>>

Parameters​

NameType
cMessage | ChatId | Chat
filterCollectorFilter<[Message]>
options?AwaitMessagesOptions

Returns​

Promise<Collection<string, Message>>

createMessageCollector​

▸ createMessageCollector(c, filter, options): Promise<MessageCollector>

Parameters​

NameType
cMessage | ChatId | Chat
filterCollectorFilter<[Message]>
optionsCollectorOptions

Returns​

Promise<MessageCollector>

listen​

▸ listen(listener, callback): Promise<string>

Set a callback on a simple listener

Parameters​

NameTypeDescription
listenerSimpleListenerThe listener name (e.g onMessage, onAnyMessage, etc.)
callback(data: unknown) => voidThe callback you need to run on the selected listener

Returns​

Promise<string>

The id of the callback

stopListener​

▸ stopListener(listener, callbackId): boolean

Discard a callback

Parameters​

NameTypeDescription
listenerSimpleListenerThe listener name (e.g onMessage, onAnyMessage, etc.)
callbackIdstringThe ID from listen

Returns​

boolean

boolean - true if the callback was found and discarded, false if the callback is not found

connect​

▸ Static connect(url, apiKey?, ev?): Promise<SocketClient & Client>

The main way to create the socket based client.

Parameters​

NameTypeDescription
urlstringURL of the socket server (i.e the EASY API instance address)
apiKey?stringoptional api key if set
ev?boolean-

Returns​

Promise<SocketClient & Client>

SocketClient

- + \ No newline at end of file diff --git a/docs/api/classes/connect_socket.SocketClient.html b/docs/api/classes/connect_socket.SocketClient.html index 06303a5d4b..c6a46c209d 100644 --- a/docs/api/classes/connect_socket.SocketClient.html +++ b/docs/api/classes/connect_socket.SocketClient.html @@ -14,13 +14,13 @@ - +

Class: SocketClient

connect/socket.SocketClient

[ALPHA - API will 100% change in the near future. Don't say I didn't warn you.]

An easy to use socket implementation that allows users to connect into remote instances of the EASY API.

How to use it:

  1. Make sure you're running an instance of the EASY API and make sure to start it with the --socket flag

        > docker run -e PORT=8080 -p 8080:8080 openwa/wa-automate:latest --socket

  2. Use this in your code:

        import { SocketClient } from "@open-wa/wa-automate";
        
        SocketClient.connect("http://localhost:8080").then(async client => {
            //now you can use the client similar to how you would use the http express middleware.

            //There are two main commands from this client

            // 1. client.listen - use this for your listeners
            
            await client.listen("onMessage", message => {
                ...
            })

            // 2. client.asj - ask the main host client to get things done

            await client.ask("sendText", {
                "to" : "44771234567@c.us",
                "content": "hellow socket"
            })

            // or you can send the arguments in order as an array (or tuple, as the cool kids would say)
            await client.ask("sendText", [
                "44771234567@c.us",
                "hellow socket"
            ])

        })

Constructors​

constructor​

• new SocketClient(url, apiKey?, ev?)

Parameters​

NameType
urlstring
apiKey?string
ev?boolean

Properties​

apiKey​

• apiKey: string

ev​

• ev: EventEmitter2

A local version of the ev EventEmitter2

listeners​

• listeners: Object = {}

Type declaration​

NameType
onAck{ [id: string]: (data: any) => any; }
onAddedToGroup{ [id: string]: (data: any) => any; }
onAnyMessage{ [id: string]: (data: any) => any; }
onBattery{ [id: string]: (data: any) => any; }
onBroadcast{ [id: string]: (data: any) => any; }
onButton{ [id: string]: (data: any) => any; }
onChatDeleted{ [id: string]: (data: any) => any; }
onChatOpened{ [id: string]: (data: any) => any; }
onChatState{ [id: string]: (data: any) => any; }
onContactAdded{ [id: string]: (data: any) => any; }
onGlobalParticipantsChanged{ [id: string]: (data: any) => any; }
onIncomingCall{ [id: string]: (data: any) => any; }
onLabel{ [id: string]: (data: any) => any; }
onLogout{ [id: string]: (data: any) => any; }
onMessage{ [id: string]: (data: any) => any; }
onMessageDeleted{ [id: string]: (data: any) => any; }
onNewProduct{ [id: string]: (data: any) => any; }
onOrder{ [id: string]: (data: any) => any; }
onPlugged{ [id: string]: (data: any) => any; }
onReaction{ [id: string]: (data: any) => any; }
onRemovedFromGroup{ [id: string]: (data: any) => any; }
onStateChanged{ [id: string]: (data: any) => any; }
onStory{ [id: string]: (data: any) => any; }

socket​

• socket: Socket<DefaultEventsMap, DefaultEventsMap>

url​

• url: string

Methods​

ask​

▸ ask<M, P>(method, args?): Promise<unknown>

Type parameters​

NameType
Mextends keyof Client
Pextends [] | [fn: Function, queueOptions?: Options<default, DefaultAddOptions>] | [fn: Function, priority?: number] | [reason: string] | [fn: Function, queueOptions?: Options<default, DefaultAddOptions>] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [fn: Function] | [simpleListener?: SimpleListener] | [messageId: MessageId] | [messageId: MessageId] | [to: ChatId, url: string, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig: AxiosRequestConfig<any>, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean] | [to: ChatId, url: string, text?: Content, thumbnail?: Base64] | [thumb: string, url: string, title: string, description: string, text: Content, chatId: ChatId] | [chatId: ChatId] | [to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean] | [to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean] | [groupId: GroupChatId] | [contactId: ContactId] | [groupId: GroupChatId, image: DataURL] | [to: ChatId, image: string | Base64 | DataURL | Buffer, stickerMetadata?: StickerMetadata] | [to: ChatId, messageId: MessageId, webpBase64: Base64, animated: boolean] | [to: ChatId, webpBase64: Base64, animated: boolean] | [url: string] | [to: ChatId, emojiId: string, messageId?: MessageId] | [data: JsonObject, event: SimpleListener, extras?: JsonObject] | [c: ChatId | Message | Chat, filter: CollectorFilter<[Message]>, options: CollectorOptions] | [message: MessageId | Message] | [to: ChatId, lat: string, lng: string, loc: string, address?: string, url?: string] | [to: ChatId, content: Content] | [to: ChatId, body: string | LocationButtonBody, buttons: Button[], title?: string, footer?: string] | [message?: string] | [url: string, events: SimpleListener[] | "all", requestConfig: AxiosRequestConfig<any>, concurrency: number] | [useSessionIdInPath: boolean] | [chatId: ChatId, payload: Object] | [c: ChatId | Message | Chat, filter: CollectorFilter<[Message]>, options: AwaitMessagesOptions] | [listener: SimpleListener] | [url: string, optionsOverride: any] | [groupId: GroupChatId, fn: Function, legacy: boolean] | [chatId: ChatId, fn: Function] | [callbackToTest: SimpleListener, testData: any] | [available: boolean] | [newStatus: string] | [label: string] | [label: string, chatId: ChatId] | [label: string, chatId: ChatId] | [label: string] | [chatId: ChatId, vcard: string, contactName?: string, contactNumber?: string] | [newName: string] | [chatState: ChatState, chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [to: ChatId, content: Content, hideTags?: boolean, mentions?: ContactId[]] | [to: ChatId, amount: number, currency: string, message?: string] | [to: ChatId, body: string | LocationButtonBody, buttons: AdvancedButton[], text: string, footer: string, filename: string] | [to: ChatId, base64: Base64] | [to: ChatId, sections: Section[], title: string, description: string, actionText: string] | [to: ChatId, content: Content, replyMessageId: MessageId, hideTags?: boolean, mentions?: ContactId[]] | [groupId: GroupChatId, content: Content, hideTags?: boolean, formatting?: string, messageBeforeTags?: boolean] | [userA?: string] | [to: ChatId, url: string, text: Content, thumbnail?: Base64] | [to: ChatId, content: Content, quotedMsgId: MessageId, sendSeen?: boolean] | [contactId: ContactId] | [groupChatId: GroupChatId] | [to: ChatId, file: DataURL | FilePath, quotedMsgId: MessageId] | [to: ChatId, file: DataURL | FilePath, quotedMsgId?: MessageId] | [to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig: AxiosRequestConfig<any>] | [to: ChatId, giphyMediaUrl: string, caption: Content] | [chatId?: ChatId] | [id: ContactId] | [to: ChatId, image: Base64, caption: Content, bizNumber: ContactId, productId: string] | [to: ChatId, image: DataURL, productData: CustomProduct] | [to: ChatId, contactId: ContactId | ContactId[]] | [to: ChatId, contactIds: ContactId[]] | [to: ChatId, on: boolean] | [to: ChatId, on: boolean] | [id: ChatId, archive: boolean] | [id: ChatId, pin: boolean] | [chatId: ChatId, muteDuration: ChatMuteDuration] | [chatId: ChatId] | [chatId: ChatId] | [to: ChatId, messages: MessageId | MessageId[], skipMyMessages: boolean] | [to: ChatId, messageId: MessageId] | [preserveSessionData: boolean] | [withNewMessageOnly: boolean] | [withNewMessageOnly: boolean] | [withNewMessagesOnly: boolean] | [groupId: GroupChatId] | [link: string, returnChatObj?: boolean] | [id: ContactId] | [id: ChatId] | [id: ContactId] | [groupId: GroupChatId] | [msgId: MessageId] | [groupId: GroupChatId] | [contactId: ContactId] | [messageId: MessageId] | [id: string | MessageId] | [name: string, price: number, currency: string, images: string[], description: string, url?: string, internalId?: string, isHidden?: boolean] | [productId: string, name?: string, price?: number, currency?: string, images?: DataURL[], description?: string, url?: string, internalId?: string, isHidden?: boolean] | [chatId: ChatId, productId: string] | [productId: string] | [chatId?: ChatId] | [chatId?: ChatId] | [messageId: MessageId] | [messageId: MessageId] | [messageId: MessageId, emoji: string] | [messageId: MessageId] | [contactId: ContactId] | [contactId: ContactId] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [contactId: ContactId] | [contactId: ContactId] | [contactId: ContactId] | [contactId: ContactId, timestamp: number] | [chatId: ChatId] | [chatId: ChatId] | [chatId: ChatId] | [link: string] | [chatId: ChatId] | [chatId: ChatId, messageId: MessageId | MessageId[], onlyLocal: boolean] | [contactId: ContactId] | [includeMe: boolean, includeNotifications: boolean, use_unread_count: boolean] | [chatId: ChatId, includeMe: boolean, includeNotifications: boolean] | [chatId: ChatId, includeMe: boolean, includeNotifications: boolean] | [groupName: string, contacts: ContactId | ContactId[]] | [groupId: GroupChatId, participantId: ContactId] | [groupId: GroupChatId, url: string, requestConfig: AxiosRequestConfig<any>] | [groupId: GroupChatId, participantId: ContactId | ContactId[]] | [groupId: GroupChatId, participantId: ContactId | ContactId[]] | [groupId: GroupChatId, participantId: ContactId | ContactId[]] | [groupId: GroupChatId, onlyAdmins: boolean] | [groupId: GroupChatId, onlyAdmins: boolean] | [groupId: GroupChatId, description: string] | [groupId: GroupChatId, title: string] | [groupId: GroupChatId] | [hex: string] | [activate: boolean] | [messageId: MessageId] | [to: ChatId, url: string, requestConfig: AxiosRequestConfig<any>, stickerMetadata?: StickerMetadata] | [to: ChatId, url: string, messageId: MessageId, requestConfig: AxiosRequestConfig<any>, stickerMetadata?: StickerMetadata] | [to: ChatId, image: string | Base64 | DataURL | Buffer, messageId: MessageId, stickerMetadata?: StickerMetadata] | [namespace: namespace, id: string, property: string] | [to: ChatId, file: string | Base64 | DataURL | Buffer, processOptions: Mp4StickerConversionProcessOptions, stickerMetadata?: StickerMetadata, messageId?: MessageId] | [chatId: ChatId, ephemeral: boolean | EphemeralDuration] | [to: ChatId, giphyMediaUrl: string | URL] | [text: Content, textRgba: string, backgroundRgba: string, font: number] | [data: DataURL, caption: Content] | [data: DataURL, caption: Content] | [statusesToDelete: string | string[]] | [id: string] | [ts?: number] | [startingFrom?: number] | [message: Message] | [data: DataURL] | [webhookId: string] | [webhookId: string, events: SimpleListener[] | "all"]

Parameters​

NameType
methodM
args?any[] | P | { [k: string]: unknown; }

Returns​

Promise<unknown>

createMessageCollector​

▸ createMessageCollector(c, filter, options): Promise<MessageCollector>

Parameters​

NameType
cChatId | Message | Chat
filterCollectorFilter<[Message]>
optionsCollectorOptions

Returns​

Promise<MessageCollector>

listen​

▸ listen(listener, callback): Promise<string>

Set a callback on a simple listener

Parameters​

NameTypeDescription
listenerSimpleListenerThe listener name (e.g onMessage, onAnyMessage, etc.)
callback(data: unknown) => voidThe callback you need to run on the selected listener

Returns​

Promise<string>

The id of the callback

stopListener​

▸ stopListener(listener, callbackId): boolean

Discard a callback

Parameters​

NameTypeDescription
listenerSimpleListenerThe listener name (e.g onMessage, onAnyMessage, etc.)
callbackIdstringThe ID from listen

Returns​

boolean

boolean - true if the callback was found and discarded, false if the callback is not found

connect​

▸ Static connect(url, apiKey?, ev?): Promise<SocketClient & Client>

The main way to create the socket based client.

Parameters​

NameTypeDescription
urlstringURL of the socket server (i.e the EASY API instance address)
apiKey?stringoptional api key if set
ev?boolean-

Returns​

Promise<SocketClient & Client>

SocketClient

- + \ No newline at end of file diff --git a/docs/api/classes/logging_custom_transport.LogToEvTransport.html b/docs/api/classes/logging_custom_transport.LogToEvTransport.html index 8edd4a9c8c..7e2dcafb71 100644 --- a/docs/api/classes/logging_custom_transport.LogToEvTransport.html +++ b/docs/api/classes/logging_custom_transport.LogToEvTransport.html @@ -14,7 +14,7 @@ - + @@ -91,7 +91,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

TransportStream.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

TransportStream.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

TransportStream.setMaxListeners

toWeb​

▸ Static toWeb(streamWritable): WritableStream<any>

A utility method for creating a web WritableStream from a Writable.

Since

v17.0.0

Parameters​

NameType
streamWritableWritable

Returns​

WritableStream<any>

Inherited from​

TransportStream.toWeb

- + \ No newline at end of file diff --git a/docs/api/classes/logging_custom_transport.NoOpTransport.html b/docs/api/classes/logging_custom_transport.NoOpTransport.html index f5863982d1..e14fe18419 100644 --- a/docs/api/classes/logging_custom_transport.NoOpTransport.html +++ b/docs/api/classes/logging_custom_transport.NoOpTransport.html @@ -14,7 +14,7 @@ - + @@ -91,7 +91,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

TransportStream.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

TransportStream.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

TransportStream.setMaxListeners

toWeb​

▸ Static toWeb(streamWritable): WritableStream<any>

A utility method for creating a web WritableStream from a Writable.

Since

v17.0.0

Parameters​

NameType
streamWritableWritable

Returns​

WritableStream<any>

Inherited from​

TransportStream.toWeb

- + \ No newline at end of file diff --git a/docs/api/classes/structures_Collector.Collection.html b/docs/api/classes/structures_Collector.Collection.html index d22e3b8959..4f776624fb 100644 --- a/docs/api/classes/structures_Collector.Collection.html +++ b/docs/api/classes/structures_Collector.Collection.html @@ -14,7 +14,7 @@ - + @@ -48,7 +48,7 @@ The default sort order is according to string Unicode code points.

Example

collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Parameters​

NameTypeDescription
compareFunction?Comparator<K, V>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns​

Collection<K, V>

Inherited from​

BaseCollection.sort

sorted​

▸ sorted(compareFunction?): Collection<K, V>

The sorted method sorts the items of a collection and returns it. The sort is not necessarily stable in Node 10 or older. The default sort order is according to string Unicode code points.

Example

collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp);

Parameters​

NameTypeDescription
compareFunction?Comparator<K, V>Specifies a function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each element.

Returns​

Collection<K, V>

Inherited from​

BaseCollection.sorted

sweep​

▸ sweep(fn): number

Removes items that satisfy the provided filter function.

Parameters​

NameTypeDescription
fn(value: V, key: K, collection: Collection<K, V>) => booleanFunction used to test (should return a boolean)

Returns​

number

The number of removed entries

Inherited from​

BaseCollection.sweep

▸ sweep<T>(fn, thisArg): number

Type parameters​

Name
T

Parameters​

NameType
fn(this: T, value: V, key: K, collection: Collection<K, V>) => boolean
thisArgT

Returns​

number

Inherited from​

BaseCollection.sweep

tap​

▸ tap(fn): Collection<K, V>

Runs a function on the collection and returns the collection.

Example

collection
 .tap(coll => console.log(coll.size))
 .filter(user => user.bot)
 .tap(coll => console.log(coll.size))

Parameters​

NameTypeDescription
fn(collection: Collection<K, V>) => voidFunction to execute

Returns​

Collection<K, V>

Inherited from​

BaseCollection.tap

▸ tap<T>(fn, thisArg): Collection<K, V>

Type parameters​

Name
T

Parameters​

NameType
fn(this: T, collection: Collection<K, V>) => void
thisArgT

Returns​

Collection<K, V>

Inherited from​

BaseCollection.tap

toJSON​

▸ toJSON(): any[]

Returns​

any[]

Overrides​

BaseCollection.toJSON

values​

▸ values(): IterableIterator<V>

Returns an iterable of values in the map

Returns​

IterableIterator<V>

Inherited from​

BaseCollection.values

combineEntries​

▸ Static combineEntries<K, V>(entries, combine): Collection<K, V>

Creates a Collection from a list of entries.

Example

Collection.combineEntries([["a", 1], ["b", 2], ["a", 2]], (x, y) => x + y);
// returns Collection { "a" => 3, "b" => 2 }

Type parameters​

Name
K
V

Parameters​

NameTypeDescription
entriesIterable<[K, V]>The list of entries
combine(firstValue: V, secondValue: V, key: K) => VFunction to combine an existing entry with a new one

Returns​

Collection<K, V>

Inherited from​

BaseCollection.combineEntries

- + \ No newline at end of file diff --git a/docs/api/classes/structures_Collector.Collector.html b/docs/api/classes/structures_Collector.Collector.html index f461443f33..3ba16b8ac0 100644 --- a/docs/api/classes/structures_Collector.Collector.html +++ b/docs/api/classes/structures_Collector.Collector.html @@ -14,7 +14,7 @@ - + @@ -68,7 +68,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

EventEmitter.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

EventEmitter.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

EventEmitter.setMaxListeners

- + \ No newline at end of file diff --git a/docs/api/classes/structures_MessageCollector.MessageCollector.html b/docs/api/classes/structures_MessageCollector.MessageCollector.html index 130ac789e3..8289a06666 100644 --- a/docs/api/classes/structures_MessageCollector.MessageCollector.html +++ b/docs/api/classes/structures_MessageCollector.MessageCollector.html @@ -14,7 +14,7 @@ - + @@ -67,7 +67,7 @@ semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events');

async function run() {
  const ee = new EventEmitter();

  process.nextTick(() => {
    ee.emit('myevent', 42);
  });

  const [value] = await once(ee, 'myevent');
  console.log(value);

  const err = new Error('kaboom');
  process.nextTick(() => {
    ee.emit('error', err);
  });

  try {
    await once(ee, 'myevent');
  } catch (err) {
    console.log('error happened', err);
  }
}

run();

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.log('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events');

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Since

v11.13.0, v10.16.0

Parameters​

NameType
emitterNodeEventTarget
eventNamestring | symbol
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

Collector.once

▸ Static once(emitter, eventName, options?): Promise<any[]>

Parameters​

NameType
emitterDOMEventTarget
eventNamestring
options?StaticEventEmitterOptions

Returns​

Promise<any[]>

Inherited from​

Collector.once

setMaxListeners​

▸ Static setMaxListeners(n?, ...eventTargets): void

const {
  setMaxListeners,
  EventEmitter
} = require('events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

Since

v15.4.0

Parameters​

NameTypeDescription
n?numberA non-negative number. The maximum number of listeners per EventTarget event.
...eventTargets(EventEmitter | DOMEventTarget)[]-

Returns​

void

Inherited from​

Collector.setMaxListeners

- + \ No newline at end of file diff --git a/docs/api/enums/api_Client.namespace.html b/docs/api/enums/api_Client.namespace.html index 50b2e4ec97..ff655cba45 100644 --- a/docs/api/enums/api_Client.namespace.html +++ b/docs/api/enums/api_Client.namespace.html @@ -14,13 +14,13 @@ - +

Enumeration: namespace

api/Client.namespace

Enumeration Members​

Chat​

• Chat = "Chat"

Contact​

• Contact = "Contact"

GroupMetadata​

• GroupMetadata = "GroupMetadata"

Msg​

• Msg = "Msg"

- + \ No newline at end of file diff --git a/docs/api/enums/api_functions_exposed_enum.ExposedFn.html b/docs/api/enums/api_functions_exposed_enum.ExposedFn.html index 8e00dc9a1d..4c58f2da94 100644 --- a/docs/api/enums/api_functions_exposed_enum.ExposedFn.html +++ b/docs/api/enums/api_functions_exposed_enum.ExposedFn.html @@ -14,13 +14,13 @@ - +

Enumeration: ExposedFn

api/functions/exposed.enum.ExposedFn

Enumeration Members​

OnAnyMessage​

• OnAnyMessage = "onAnyMessage"

OnMessage​

• OnMessage = "onMessage"

onAck​

• onAck = "onAck"

onParticipantsChanged​

• onParticipantsChanged = "onParticipantsChanged"

onStateChanged​

• onStateChanged = "onStateChanged"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model.Events.html b/docs/api/enums/api_model.Events.html index 23d8daad2e..1b03720ba1 100644 --- a/docs/api/enums/api_model.Events.html +++ b/docs/api/enums/api_model.Events.html @@ -14,13 +14,13 @@ - +

Enumeration: Events

api/model.Events

Events that can be emitted by the client

Enumeration Members​

AUTHENTICATED​

• AUTHENTICATED = "authenticated"

AUTHENTICATION_FAILURE​

• AUTHENTICATION_FAILURE = "auth_failure"

DISCONNECTED​

• DISCONNECTED = "disconnected"

GROUP_JOIN​

• GROUP_JOIN = "group_join"

GROUP_LEAVE​

• GROUP_LEAVE = "group_leave"

GROUP_UPDATE​

• GROUP_UPDATE = "group_update"

MESSAGE_ACK​

• MESSAGE_ACK = "message_ack"

MESSAGE_CREATE​

• MESSAGE_CREATE = "message_create"

MESSAGE_RECEIVED​

• MESSAGE_RECEIVED = "message"

MESSAGE_REVOKED_EVERYONE​

• MESSAGE_REVOKED_EVERYONE = "message_revoke_everyone"

MESSAGE_REVOKED_ME​

• MESSAGE_REVOKED_ME = "message_revoke_me"

QR_RECEIVED​

• QR_RECEIVED = "qr"

READY​

• READY = "ready"

STATE_CHANGED​

• STATE_CHANGED = "change_state"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model.STATE.html b/docs/api/enums/api_model.STATE.html index 0ba4db16e6..a32fd98e5d 100644 --- a/docs/api/enums/api_model.STATE.html +++ b/docs/api/enums/api_model.STATE.html @@ -14,13 +14,13 @@ - +

Enumeration: STATE

api/model.STATE

The state of the WA Web session. You can listen to session state changes using onStateChanged. Just to be clear, some of these states aren't understood completely.

Enumeration Members​

CONFLICT​

• CONFLICT = "CONFLICT"

Another WA web session has been opened for this account somewhere else.

CONNECTED​

• CONNECTED = "CONNECTED"

The session is successfully connected and ready to send and receive messages.

DEPRECATED_VERSION​

• DEPRECATED_VERSION = "DEPRECATED_VERSION"

WA web updates every fortnight (or so). This state would be emitted then.

DISCONNECTED​

• DISCONNECTED = "DISCONNECTED"

This is fired when the connection between web and the host account primary device is disconnected. This is fired frequently to save battery.

OPENING​

• OPENING = "OPENING"

This probably shows up when reloading an already authenticated session.

PAIRING​

• PAIRING = "PAIRING"

This probably shows up immediately after the QR code is scanned

PROXYBLOCK​

• PROXYBLOCK = "PROXYBLOCK"

This state probably represented a block on the proxy address your app is using.

SMB_TOS_BLOCK​

• SMB_TOS_BLOCK = "SMB_TOS_BLOCK"

This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. This is a different version of a Terms of Service Block from what we know. It may also show up when the host account is banned.

SYNCING​

• SYNCING = "SYNCING"

This is fired when the QR code is scanned

TIMEOUT​

• TIMEOUT = "TIMEOUT"

The trigger for this state is as of yet unknown

TOS_BLOCK​

• TOS_BLOCK = "TOS_BLOCK"

This usually shows up when the session has been blocked by WA due to some issue with the browser/user agent. It literally stands for Terms of Service Block. It may also show up when the host account is banned.

UNLAUNCHED​

• UNLAUNCHED = "UNLAUNCHED"

The same (probably replacement) for CONFLICT

UNPAIRED​

• UNPAIRED = "UNPAIRED"

When UNPAIRED the page is waiting for a QR Code scan. If your state becomes UNPAIRED then the session is most likely signed out by the host account.

UNPAIRED_IDLE​

• UNPAIRED_IDLE = "UNPAIRED_IDLE"

This state is fired when the QR code has not been scanned for a long time (about 1 minute). On the page it will show "Click to reload QR code"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model.Status.html b/docs/api/enums/api_model.Status.html index fa9128c227..2227bd32ba 100644 --- a/docs/api/enums/api_model.Status.html +++ b/docs/api/enums/api_model.Status.html @@ -14,13 +14,13 @@ - +

Enumeration: Status

api/model.Status

Client status

Enumeration Members​

AUTHENTICATING​

• AUTHENTICATING = 1

INITIALIZING​

• INITIALIZING = 0

READY​

• READY = 3

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_call.CallState.html b/docs/api/enums/api_model_call.CallState.html index 85b7ca3348..3ffd9af862 100644 --- a/docs/api/enums/api_model_call.CallState.html +++ b/docs/api/enums/api_model_call.CallState.html @@ -14,13 +14,13 @@ - +

Enumeration: CallState

api/model/call.CallState

Enumeration Members​

ACTIVE​

• ACTIVE = "ACTIVE"

CONNECTING​

• CONNECTING = "CONNECTING"

CONNECTION_LOST​

• CONNECTION_LOST = "CONNECTION_LOST"

ENDED​

• ENDED = "ENDED"

FAILED​

• FAILED = "FAILED"

HANDLED_REMOTELY​

• HANDLED_REMOTELY = "HANDLED_REMOTELY"

INCOMING_RING​

• INCOMING_RING = "INCOMING_RING"

NOT_ANSWERED​

• NOT_ANSWERED = "NOT_ANSWERED"

OUTGOING_CALLING​

• OUTGOING_CALLING = "OUTGOING_CALLING"

OUTGOING_RING​

• OUTGOING_RING = "OUTGOING_RING"

REJECTED​

• REJECTED = "REJECTED"

REMOTE_CALL_IN_PROGRESS​

• REMOTE_CALL_IN_PROGRESS = "REMOTE_CALL_IN_PROGRESS"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_chat.ChatMuteDuration.html b/docs/api/enums/api_model_chat.ChatMuteDuration.html index 4d57175eca..4b7eba4868 100644 --- a/docs/api/enums/api_model_chat.ChatMuteDuration.html +++ b/docs/api/enums/api_model_chat.ChatMuteDuration.html @@ -14,13 +14,13 @@ - +

Enumeration: ChatMuteDuration

api/model/chat.ChatMuteDuration

Valid durations for muting a chat using muteChat

Enumeration Members​

EIGHT_HOURS​

• EIGHT_HOURS = "EIGHT_HOURS"

Mutes chat for 8 hours

FOREVER​

• FOREVER = "FOREVER"

Mutes chat forever

ONE_WEEK​

• ONE_WEEK = "ONE_WEEK"

Mutes chat for 1 week

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_chat.ChatState.html b/docs/api/enums/api_model_chat.ChatState.html index 98f23d25d9..604fc9a0cc 100644 --- a/docs/api/enums/api_model_chat.ChatState.html +++ b/docs/api/enums/api_model_chat.ChatState.html @@ -14,13 +14,13 @@ - +

Enumeration: ChatState

api/model/chat.ChatState

The ChatState represents the state you'd normally see represented under the chat name in the app.

Enumeration Members​

PAUSED​

• PAUSED = 2

online

RECORDING​

• RECORDING = 1

recording audio...

TYPING​

• TYPING = 0

typing...

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_chat.ChatTypes.html b/docs/api/enums/api_model_chat.ChatTypes.html index 22e2bbedef..a8dd25605c 100644 --- a/docs/api/enums/api_model_chat.ChatTypes.html +++ b/docs/api/enums/api_model_chat.ChatTypes.html @@ -14,13 +14,13 @@ - +

Enumeration: ChatTypes

api/model/chat.ChatTypes

Chat types

Enumeration Members​

GROUP​

• GROUP = "group"

SOLO​

• SOLO = "solo"

UNKNOWN​

• UNKNOWN = "unknown"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.CLOUD_PROVIDERS.html b/docs/api/enums/api_model_config.CLOUD_PROVIDERS.html index 39110e3ac6..9b4af62114 100644 --- a/docs/api/enums/api_model_config.CLOUD_PROVIDERS.html +++ b/docs/api/enums/api_model_config.CLOUD_PROVIDERS.html @@ -14,13 +14,13 @@ - +

Enumeration: CLOUD_PROVIDERS

api/model/config.CLOUD_PROVIDERS

Enumeration Members​

AWS​

• AWS = "AWS"

CONTABO​

• CONTABO = "CONTABO"

DO​

• DO = "DO"

GCP​

• GCP = "GCP"

MINIO​

• MINIO = "MINIO"

WASABI​

• WASABI = "WASABI"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.DIRECTORY_STRATEGY.html b/docs/api/enums/api_model_config.DIRECTORY_STRATEGY.html index f191dca85b..3b3886e762 100644 --- a/docs/api/enums/api_model_config.DIRECTORY_STRATEGY.html +++ b/docs/api/enums/api_model_config.DIRECTORY_STRATEGY.html @@ -14,13 +14,13 @@ - +

Enumeration: DIRECTORY_STRATEGY

api/model/config.DIRECTORY_STRATEGY

Enumeration Members​

CHAT​

• CHAT = "CHAT"

E.g /447123456789/

CHAT_DATE​

• CHAT_DATE = "CHAT_DATE"

E.g /447123456789/2021-08-16/

DATE​

• DATE = "DATE"

E.g /2021-08-16/

DATE_CHAT​

• DATE_CHAT = "DATE_CHAT"

E.g /2021-08-16/447123456789/

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.LicenseType.html b/docs/api/enums/api_model_config.LicenseType.html index 0f7673b80a..0c40a4b1fa 100644 --- a/docs/api/enums/api_model_config.LicenseType.html +++ b/docs/api/enums/api_model_config.LicenseType.html @@ -14,13 +14,13 @@ - +

Enumeration: LicenseType

api/model/config.LicenseType

Enumeration Members​

B2B_RESTRICTED_VOLUME_LICENSE​

• B2B_RESTRICTED_VOLUME_LICENSE = "B2B_RESTRICTED_VOLUME_LICENSE"

CUSTOM​

• CUSTOM = "CUSTOM"

IMAGE_STORY​

• IMAGE_STORY = "Image Story License Key"

INSIDER​

• INSIDER = "Insiders Program"

NONE​

• NONE = "NONE"

PREMIUM​

• PREMIUM = "Premium License Key"

TEXT_STORY​

• TEXT_STORY = "Text Story License Key"

VIDEO_STORY​

• VIDEO_STORY = "Video Story License Key"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.NotificationLanguage.html b/docs/api/enums/api_model_config.NotificationLanguage.html index a35de7b8a1..4d3c0f7fc0 100644 --- a/docs/api/enums/api_model_config.NotificationLanguage.html +++ b/docs/api/enums/api_model_config.NotificationLanguage.html @@ -14,13 +14,13 @@ - +

Enumeration: NotificationLanguage

api/model/config.NotificationLanguage

The available languages for the host security notification

Enumeration Members​

DEDE​

• DEDE = "de-de"

ENGB​

• ENGB = "en-gb"

ES​

• ES = "es"

IDID​

• IDID = "id-id"

ITIT​

• ITIT = "it-it"

NLNL​

• NLNL = "nl-nl"

PTBR​

• PTBR = "pt-br"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.OnError.html b/docs/api/enums/api_model_config.OnError.html index 08e3a0fec6..00da22857e 100644 --- a/docs/api/enums/api_model_config.OnError.html +++ b/docs/api/enums/api_model_config.OnError.html @@ -14,13 +14,13 @@ - +

Enumeration: OnError

api/model/config.OnError

Enumeration Members​

AS_STRING​

• AS_STRING = "AS_STRING"

Return it as a string

LOG_AND_FALSE​

• LOG_AND_FALSE = "LOG_AND_FALSE"

Log the error and return false

LOG_AND_STRING​

• LOG_AND_STRING = "LOG_AND_STRING"

Log the error AND return the string

NOTHING​

• NOTHING = "NOTHING"

Do nothing.

RETURN_ERROR​

• RETURN_ERROR = "RETURN_ERROR"

Return the error object

RETURN_FALSE​

• RETURN_FALSE = "RETURN_FALSE"

Do not log anything, just return false

THROW​

• THROW = "THROW"

throw the error

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.QRFormat.html b/docs/api/enums/api_model_config.QRFormat.html index 678b1953f5..68aafa7ada 100644 --- a/docs/api/enums/api_model_config.QRFormat.html +++ b/docs/api/enums/api_model_config.QRFormat.html @@ -14,13 +14,13 @@ - +

Enumeration: QRFormat

api/model/config.QRFormat

The different types of qr code output.

Enumeration Members​

JPEG​

• JPEG = "jpeg"

PNG​

• PNG = "png"

WEBM​

• WEBM = "webm"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_config.QRQuality.html b/docs/api/enums/api_model_config.QRQuality.html index c79c7abd2b..ac981a9cf7 100644 --- a/docs/api/enums/api_model_config.QRQuality.html +++ b/docs/api/enums/api_model_config.QRQuality.html @@ -14,13 +14,13 @@ - +

Enumeration: QRQuality

api/model/config.QRQuality

The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.

Enumeration Members​

EIGHT​

• EIGHT = 0.8

FIVE​

• FIVE = 0.5

FOUR​

• FOUR = 0.4

NINE​

• NINE = 0.9

ONE​

• ONE = 0.1

SEVEN​

• SEVEN = 0.7

SIX​

• SIX = 0.6

TEN​

• TEN = 1

THREE​

• THREE = 0.3

TWO​

• TWO = 0.2

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_errors.AddParticipantErrorStatusCode.html b/docs/api/enums/api_model_errors.AddParticipantErrorStatusCode.html index e266affc1c..874882c132 100644 --- a/docs/api/enums/api_model_errors.AddParticipantErrorStatusCode.html +++ b/docs/api/enums/api_model_errors.AddParticipantErrorStatusCode.html @@ -14,13 +14,13 @@ - +

Enumeration: AddParticipantErrorStatusCode

api/model/errors.AddParticipantErrorStatusCode

Add Participants Status Code Enum

Enumeration Members​

ALREADY_IN_GROUP​

• ALREADY_IN_GROUP = 409

Participant could not be added to group because they are already in the group

GROUP_FULL​

• GROUP_FULL = 500

Participant could not be added to group because the group is full

PRIVACY_SETTINGS​

• PRIVACY_SETTINGS = 403

Participant could not be added to group because their privacy settings do not allow you to add them.

RECENTLY_LEFT​

• RECENTLY_LEFT = 408

Participant could not be added to group because they recently left.

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_errors.ERROR_NAME.html b/docs/api/enums/api_model_errors.ERROR_NAME.html index 2eee2f5c8b..ff7e7d3cad 100644 --- a/docs/api/enums/api_model_errors.ERROR_NAME.html +++ b/docs/api/enums/api_model_errors.ERROR_NAME.html @@ -14,13 +14,13 @@ - +

Enumeration: ERROR_NAME

api/model/errors.ERROR_NAME

Enum of error names specific to this library

Enumeration Members​

BAD_STICKER_METADATA​

• BAD_STICKER_METADATA = "BAD_STICKER_METADATA"

The sticker metadata parameter is wrong.

FILE_NOT_FOUND​

• FILE_NOT_FOUND = "FILE_NOT_FOUND"

File was not found at given path.

INVALID_LABEL​

• INVALID_LABEL = "INVALID_LABEL"

Label does not exist

MEDIA_MISSING​

• MEDIA_MISSING = "MEDIA_MISSING"

Expected media is missing.

MISSING_URL​

• MISSING_URL = "MISSING_URL"

An expected URL is missing

NOT_MEDIA​

• NOT_MEDIA = "NOT_MEDIA"

The message is not a media message.

PAGE_CLOSED​

• PAGE_CLOSED = "PAGE_CLOSED"

The puppeteer page has been closed or the client has lost the connection with the page. This can happen if your computer/server has gone to sleep and waken up. Please restart your session.

SENDTEXT_FAILURE​

• SENDTEXT_FAILURE = "SENDTEXT_FAILURE"

Unable to send text

STATE_ERROR​

• STATE_ERROR = "STATE_ERROR"

The client state is preventing the command from completing.

STICKER_NOT_DECRYPTED​

• STICKER_NOT_DECRYPTED = "STICKER_NOT_DECRYPTED"

The attempt to decrypt a sticker message has failed.

STICKER_TOO_LARGE​

• STICKER_TOO_LARGE = "STICKER_TOO_LARGE"

The sticker file exceeds the maximum 1MB limit

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_events.SimpleListener.html b/docs/api/enums/api_model_events.SimpleListener.html index 0c9121ba1c..3651a09aaa 100644 --- a/docs/api/enums/api_model_events.SimpleListener.html +++ b/docs/api/enums/api_model_events.SimpleListener.html @@ -14,7 +14,7 @@ - + @@ -27,7 +27,7 @@ Represents onReaction

RemovedFromGroup​

• RemovedFromGroup = "onRemovedFromGroup"

Requires licence Represents onRemovedFromGroup

StateChanged​

• StateChanged = "onStateChanged"

Represents onStateChanged

Story​

• Story = "onStory"

Requires licence Represents onStory

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_group_metadata.GroupNotificationTypes.html b/docs/api/enums/api_model_group_metadata.GroupNotificationTypes.html index 5f16488ef1..37867a67a2 100644 --- a/docs/api/enums/api_model_group_metadata.GroupNotificationTypes.html +++ b/docs/api/enums/api_model_group_metadata.GroupNotificationTypes.html @@ -14,13 +14,13 @@ - +

Enumeration: GroupNotificationTypes

api/model/group-metadata.GroupNotificationTypes

Group notification types

Enumeration Members​

ADD​

• ADD = "add"

ANNOUNCE​

• ANNOUNCE = "announce"

DESCRIPTION​

• DESCRIPTION = "description"

INVITE​

• INVITE = "invite"

LEAVE​

• LEAVE = "leave"

PICTURE​

• PICTURE = "picture"

REMOVE​

• REMOVE = "remove"

RESTRICT​

• RESTRICT = "restrict"

SUBJECT​

• SUBJECT = "subject"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_group_metadata.groupChangeEvent.html b/docs/api/enums/api_model_group_metadata.groupChangeEvent.html index 65e29a01d6..b027cfe532 100644 --- a/docs/api/enums/api_model_group_metadata.groupChangeEvent.html +++ b/docs/api/enums/api_model_group_metadata.groupChangeEvent.html @@ -14,13 +14,13 @@ - +

Enumeration: groupChangeEvent

api/model/group-metadata.groupChangeEvent

Enumeration Members​

add​

• add = "add"

remove​

• remove = "remove"

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_message.MessageAck.html b/docs/api/enums/api_model_message.MessageAck.html index 7581b00d7e..5e41684868 100644 --- a/docs/api/enums/api_model_message.MessageAck.html +++ b/docs/api/enums/api_model_message.MessageAck.html @@ -14,13 +14,13 @@ - +

Enumeration: MessageAck

api/model/message.MessageAck

Message ACK

Enumeration Members​

ACK_DEVICE​

• ACK_DEVICE = 2

ACK_ERROR​

• ACK_ERROR = -1

ACK_PENDING​

• ACK_PENDING = 0

ACK_PLAYED​

• ACK_PLAYED = 4

ACK_READ​

• ACK_READ = 3

ACK_SERVER​

• ACK_SERVER = 1

- + \ No newline at end of file diff --git a/docs/api/enums/api_model_message.MessageTypes.html b/docs/api/enums/api_model_message.MessageTypes.html index 1f64ad3f4f..5af4868ab5 100644 --- a/docs/api/enums/api_model_message.MessageTypes.html +++ b/docs/api/enums/api_model_message.MessageTypes.html @@ -14,13 +14,13 @@ - +

Enumeration: MessageTypes

api/model/message.MessageTypes

Message types

Enumeration Members​

AUDIO​

• AUDIO = "audio"

BUTTONS_RESPONSE​

• BUTTONS_RESPONSE = "buttons_response"

CONTACT_CARD​

• CONTACT_CARD = "vcard"

CONTACT_CARD_MULTI​

• CONTACT_CARD_MULTI = "multi_vcard"

DOCUMENT​

• DOCUMENT = "document"

IMAGE​

• IMAGE = "image"

LIST_RESPONSE​

• LIST_RESPONSE = "list_response"

LOCATION​

• LOCATION = "location"

ORDER​

• ORDER = "order"

REVOKED​

• REVOKED = "revoked"

STICKER​

• STICKER = "sticker"

TEXT​

• TEXT = "chat"

UNKNOWN​

• UNKNOWN = "unknown"

VIDEO​

• VIDEO = "video"

VOICE​

• VOICE = "ptt"

- + \ No newline at end of file diff --git a/docs/api/enums/connect.SimpleListener.html b/docs/api/enums/connect.SimpleListener.html index eed2836d62..f8c69014af 100644 --- a/docs/api/enums/connect.SimpleListener.html +++ b/docs/api/enums/connect.SimpleListener.html @@ -14,7 +14,7 @@ - + @@ -24,7 +24,7 @@ Represents onContactAdded

Plugged​

• Plugged = "onPlugged"

Represents onPlugged

RemovedFromGroup​

• RemovedFromGroup = "onRemovedFromGroup"

Requires licence Represents onRemovedFromGroup

StateChanged​

• StateChanged = "onStateChanged"

Represents onStateChanged

Story​

• Story = "onStory"

Requires licence Represents onStory

- + \ No newline at end of file diff --git a/docs/api/enums/structures_Dialog.ValidationType.html b/docs/api/enums/structures_Dialog.ValidationType.html index 39b2a856f0..d42461789f 100644 --- a/docs/api/enums/structures_Dialog.ValidationType.html +++ b/docs/api/enums/structures_Dialog.ValidationType.html @@ -14,13 +14,13 @@ - +

Enumeration: ValidationType

structures/Dialog.ValidationType

Enumeration Members​

CHECK​

• CHECK = "check"

LENGTH​

• LENGTH = "length"

REGEX​

• REGEX = "regex"

- + \ No newline at end of file diff --git a/docs/api/enums/structures_preProcessors.PREPROCESSORS.html b/docs/api/enums/structures_preProcessors.PREPROCESSORS.html index 038832dfda..759caba565 100644 --- a/docs/api/enums/structures_preProcessors.PREPROCESSORS.html +++ b/docs/api/enums/structures_preProcessors.PREPROCESSORS.html @@ -14,14 +14,14 @@ - +

Enumeration: PREPROCESSORS

structures/preProcessors.PREPROCESSORS

A set of easy to use, built-in message processors.

Check out the processor code here

Enumeration Members​

AUTO_DECRYPT​

• AUTO_DECRYPT = "AUTO_DECRYPT"

Replaces the media thumbnail base64 in body with the actual file's DataURL.

AUTO_DECRYPT_SAVE​

• AUTO_DECRYPT_SAVE = "AUTO_DECRYPT_SAVE"

Automatically saves the file in a folder named /media relative to the process working directory.

PLEASE NOTE, YOU WILL NEED TO MANUALLY CLEAR THIS FOLDER!!!

BODY_ONLY​

• BODY_ONLY = "BODY_ONLY"

A preprocessor that limits the amount of base64 data is present in the message object by removing duplication of body in content by replacing content with "".

SCRUB​

• SCRUB = "SCRUB"

This preprocessor scrubs body and content from media messages. This would be useful if you want to reduce the message object size because neither of these values represent the actual file, only the thumbnail.

UPLOAD_CLOUD​

• UPLOAD_CLOUD = "UPLOAD_CLOUD"

Uploads file to a cloud storage provider (GCP/AWS for now).

If this preprocessor is set then you have to also set cloudUploadOptions in the config.

- + \ No newline at end of file diff --git a/docs/api/functions/controllers_data_dir_watcher.setupDataDirWatcher.html b/docs/api/functions/controllers_data_dir_watcher.setupDataDirWatcher.html index 989ccfa732..5ea149b47c 100644 --- a/docs/api/functions/controllers_data_dir_watcher.setupDataDirWatcher.html +++ b/docs/api/functions/controllers_data_dir_watcher.setupDataDirWatcher.html @@ -14,13 +14,13 @@ - +

Function: setupDataDirWatcher

controllers/data_dir_watcher.setupDataDirWatcher

▸ setupDataDirWatcher(config): Promise<void>

Parameters​

NameType
configConfigObject

Returns​

Promise<void>

- + \ No newline at end of file diff --git a/docs/api/functions/controllers_initializer.create.html b/docs/api/functions/controllers_initializer.create.html index c6ff1c1730..65bc8e9c0a 100644 --- a/docs/api/functions/controllers_initializer.create.html +++ b/docs/api/functions/controllers_initializer.create.html @@ -14,13 +14,13 @@ - +

Function: create

controllers/initializer.create

▸ create(config?): Promise<Client>

Used to initialize the client session.

Note It is required to set all config variables as ConfigObject that includes both sessionId. Setting the session id as the first variable is no longer valid

e.g

create({
sessionId: 'main',
customUserAgent: ' 'WhatsApp/2.16.352 Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/13.0.3 Safari/605.1.15',
blockCrashLogs true,
...
})....

Parameters​

NameTypeDescription
configConfigObject | AdvancedConfigAdvancedConfig The extended custom configuration

Returns​

Promise<Client>

- + \ No newline at end of file diff --git a/docs/api/functions/controllers_initializer.timeout.html b/docs/api/functions/controllers_initializer.timeout.html index ca5e6e5b37..9cdde1ae69 100644 --- a/docs/api/functions/controllers_initializer.timeout.html +++ b/docs/api/functions/controllers_initializer.timeout.html @@ -14,13 +14,13 @@ - +

Function: timeout

controllers/initializer.timeout

▸ timeout(ms): Promise<string>

Parameters​

NameType
msnumber

Returns​

Promise<string>

- + \ No newline at end of file diff --git a/docs/api/functions/controllers_patch_manager.earlyInjectionCheck.html b/docs/api/functions/controllers_patch_manager.earlyInjectionCheck.html index 736d36247c..7f14823b93 100644 --- a/docs/api/functions/controllers_patch_manager.earlyInjectionCheck.html +++ b/docs/api/functions/controllers_patch_manager.earlyInjectionCheck.html @@ -14,13 +14,13 @@ - +

Function: earlyInjectionCheck

controllers/patch_manager.earlyInjectionCheck

▸ earlyInjectionCheck(page): Promise<(page: Page) => boolean>

Parameters​

NameType
pagePage

Returns​

Promise<(page: Page) => boolean>

- + \ No newline at end of file diff --git a/docs/api/functions/controllers_patch_manager.getAndInjectLicense.html b/docs/api/functions/controllers_patch_manager.getAndInjectLicense.html index 2243af2e89..c38a35edba 100644 --- a/docs/api/functions/controllers_patch_manager.getAndInjectLicense.html +++ b/docs/api/functions/controllers_patch_manager.getAndInjectLicense.html @@ -14,13 +14,13 @@ - +

Function: getAndInjectLicense

controllers/patch_manager.getAndInjectLicense

▸ getAndInjectLicense(page, config, me, debugInfo, spinner?, preloadedLicense?): Promise<boolean>

Parameters​

NameType
pagePage
configConfigObject
meObject
me._serializedstring
debugInfoSessionInfo
spinner?Spin
preloadedLicense?string | false

Returns​

Promise<boolean>

- + \ No newline at end of file diff --git a/docs/api/functions/logging_logging.addRotateFileLogTransport.html b/docs/api/functions/logging_logging.addRotateFileLogTransport.html index 13734ba616..56e76ff48e 100644 --- a/docs/api/functions/logging_logging.addRotateFileLogTransport.html +++ b/docs/api/functions/logging_logging.addRotateFileLogTransport.html @@ -14,13 +14,13 @@ - +

Function: addRotateFileLogTransport

logging/logging.addRotateFileLogTransport

▸ addRotateFileLogTransport(options?): void

Parameters​

NameType
optionsany

Returns​

void

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_button.AdvancedButton.html b/docs/api/interfaces/api_model_button.AdvancedButton.html index c58ac96966..5c26d26be7 100644 --- a/docs/api/interfaces/api_model_button.AdvancedButton.html +++ b/docs/api/interfaces/api_model_button.AdvancedButton.html @@ -14,13 +14,13 @@ - +

Interface: AdvancedButton

api/model/button.AdvancedButton

Properties​

id​

• Optional id: string

number​

• Optional number: string

text​

• text: string

url​

• Optional url: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_button.Button.html b/docs/api/interfaces/api_model_button.Button.html index 18757613ac..eafc484008 100644 --- a/docs/api/interfaces/api_model_button.Button.html +++ b/docs/api/interfaces/api_model_button.Button.html @@ -14,13 +14,13 @@ - +

Interface: Button

api/model/button.Button

Properties​

id​

• id: string

text​

• text: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_button.LocationButtonBody.html b/docs/api/interfaces/api_model_button.LocationButtonBody.html index b8262f30a3..2f902562c7 100644 --- a/docs/api/interfaces/api_model_button.LocationButtonBody.html +++ b/docs/api/interfaces/api_model_button.LocationButtonBody.html @@ -14,13 +14,13 @@ - +

Interface: LocationButtonBody

api/model/button.LocationButtonBody

Properties​

caption​

• caption: string

lat​

• lat: number

lng​

• lng: number

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_button.Row.html b/docs/api/interfaces/api_model_button.Row.html index 7a068ae5bf..728f4a3297 100644 --- a/docs/api/interfaces/api_model_button.Row.html +++ b/docs/api/interfaces/api_model_button.Row.html @@ -14,13 +14,13 @@ - +

Interface: Row

api/model/button.Row

Properties​

description​

• description: string

rowId​

• rowId: string

title​

• title: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_button.Section.html b/docs/api/interfaces/api_model_button.Section.html index 48952ffa01..d656d6a4bc 100644 --- a/docs/api/interfaces/api_model_button.Section.html +++ b/docs/api/interfaces/api_model_button.Section.html @@ -14,13 +14,13 @@ - +

Interface: Section

api/model/button.Section

Properties​

rows​

• rows: Row[]

title​

• title: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_call.Call.html b/docs/api/interfaces/api_model_call.Call.html index 38b0f0fa81..0883a9d9a0 100644 --- a/docs/api/interfaces/api_model_call.Call.html +++ b/docs/api/interfaces/api_model_call.Call.html @@ -14,13 +14,13 @@ - +

Interface: Call

api/model/call.Call

Properties​

State​

• State: CallState

State of the call

canHandleLocally​

• canHandleLocally: boolean

id​

• id: string

The id of the call

isGroup​

• isGroup: boolean

Whether or not the call is a group call

isVideo​

• isVideo: boolean

Whether or not the call is a video call

offerTime​

• offerTime: number

The epoch timestamp of the call. You will have to multiply this by 1000 to get the actual epoch timestamp

outgoing​

• outgoing: boolean

The direction of the call.

participants​

• participants: ContactId[]

The other participants on a group call

peerJid​

• peerJid: ContactId

The id of the account calling

webClientShouldHandle​

• webClientShouldHandle: boolean

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.BaseChat.html b/docs/api/interfaces/api_model_chat.BaseChat.html index 33ad6eb9dd..b9213c7d09 100644 --- a/docs/api/interfaces/api_model_chat.BaseChat.html +++ b/docs/api/interfaces/api_model_chat.BaseChat.html @@ -14,13 +14,13 @@ - +

Interface: BaseChat

api/model/chat.BaseChat

Hierarchy​

Properties​

ack​

• Optional ack: any

archive​

• archive: boolean

canSend​

• Optional canSend: boolean

Whether your host account is able to send messages to this chat

changeNumberNewJid​

• changeNumberNewJid: any

changeNumberOldJid​

• changeNumberOldJid: any

contact​

• contact: Contact

The contact related to this chat

formattedTitle​

• Optional formattedTitle: string

The title of the chat

groupMetadata​

• groupMetadata: GroupMetadata

Group metadata for this chat

isAnnounceGrpRestrict​

• isAnnounceGrpRestrict: any

If the chat is a group chat is restricted

isOnline​

• Optional isOnline: any

Deprecated

This is unreliable. Use the method isChatOnline instead.

isReadOnly​

• isReadOnly: boolean

Whether the chat is a group chat and the group is restricted

kind​

• kind: string

labels​

• labels: any

The labels attached to this chat.

lastReceivedKey​

• lastReceivedKey: any

The ID of the last message received in this chat

lastSeen​

• Optional lastSeen: any

Deprecated

This is unreliable. Use the method getLastSeen instead.

modifyTag​

• modifyTag: number

msgs​

• msgs: any

The messages in the chat

muteExpiration​

• muteExpiration: number

The expiration timestamp of the chat mute

name​

• name: string

The name of the chat

notSpam​

• notSpam: boolean

Whether the chat is marked as spam

pendingMsgs​

• pendingMsgs: boolean

Messages that are pending to be sent

pic​

• Optional pic: string

URL of the chat picture if available

pin​

• pin: number

Whether the chat is pinned

presence​

• presence: any

The presence state of the chat participant

t​

• t: number

The timestamp of the last interaction in the chat

unreadCount​

• unreadCount: number

The number of undread messages in this chat

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.GroupChat.html b/docs/api/interfaces/api_model_chat.GroupChat.html index b394a57cd4..c1dcc42365 100644 --- a/docs/api/interfaces/api_model_chat.GroupChat.html +++ b/docs/api/interfaces/api_model_chat.GroupChat.html @@ -14,13 +14,13 @@ - +

Interface: GroupChat

api/model/chat.GroupChat

Hierarchy​

Properties​

ack​

• Optional ack: any

Inherited from​

BaseChat.ack

archive​

• archive: boolean

Inherited from​

BaseChat.archive

canSend​

• Optional canSend: boolean

Whether your host account is able to send messages to this chat

Inherited from​

BaseChat.canSend

changeNumberNewJid​

• changeNumberNewJid: any

Inherited from​

BaseChat.changeNumberNewJid

changeNumberOldJid​

• changeNumberOldJid: any

Inherited from​

BaseChat.changeNumberOldJid

contact​

• contact: Contact

The contact related to this chat

Inherited from​

BaseChat.contact

formattedTitle​

• Optional formattedTitle: string

The title of the chat

Inherited from​

BaseChat.formattedTitle

groupMetadata​

• groupMetadata: GroupMetadata

Group metadata for this chat

Inherited from​

BaseChat.groupMetadata

id​

• id: GroupChatId

The id of the chat

isAnnounceGrpRestrict​

• isAnnounceGrpRestrict: any

If the chat is a group chat is restricted

Inherited from​

BaseChat.isAnnounceGrpRestrict

isGroup​

• isGroup: true

Whether the chat is a group chat

isOnline​

• Optional isOnline: any

Deprecated

This is unreliable. Use the method isChatOnline instead.

Inherited from​

BaseChat.isOnline

isReadOnly​

• isReadOnly: boolean

Whether the chat is a group chat and the group is restricted

Inherited from​

BaseChat.isReadOnly

kind​

• kind: string

Inherited from​

BaseChat.kind

labels​

• labels: any

The labels attached to this chat.

Inherited from​

BaseChat.labels

lastReceivedKey​

• lastReceivedKey: any

The ID of the last message received in this chat

Inherited from​

BaseChat.lastReceivedKey

lastSeen​

• Optional lastSeen: any

Deprecated

This is unreliable. Use the method getLastSeen instead.

Inherited from​

BaseChat.lastSeen

modifyTag​

• modifyTag: number

Inherited from​

BaseChat.modifyTag

msgs​

• msgs: any

The messages in the chat

Inherited from​

BaseChat.msgs

muteExpiration​

• muteExpiration: number

The expiration timestamp of the chat mute

Inherited from​

BaseChat.muteExpiration

name​

• name: string

The name of the chat

Inherited from​

BaseChat.name

notSpam​

• notSpam: boolean

Whether the chat is marked as spam

Inherited from​

BaseChat.notSpam

pendingMsgs​

• pendingMsgs: boolean

Messages that are pending to be sent

Inherited from​

BaseChat.pendingMsgs

pic​

• Optional pic: string

URL of the chat picture if available

Inherited from​

BaseChat.pic

pin​

• pin: number

Whether the chat is pinned

Inherited from​

BaseChat.pin

presence​

• presence: any

The presence state of the chat participant

Inherited from​

BaseChat.presence

t​

• t: number

The timestamp of the last interaction in the chat

Inherited from​

BaseChat.t

unreadCount​

• unreadCount: number

The number of undread messages in this chat

Inherited from​

BaseChat.unreadCount

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.GroupChatCreationParticipantAddResponse.html b/docs/api/interfaces/api_model_chat.GroupChatCreationParticipantAddResponse.html index f62cab4545..727088e872 100644 --- a/docs/api/interfaces/api_model_chat.GroupChatCreationParticipantAddResponse.html +++ b/docs/api/interfaces/api_model_chat.GroupChatCreationParticipantAddResponse.html @@ -14,13 +14,13 @@ - +

Interface: GroupChatCreationParticipantAddResponse

api/model/chat.GroupChatCreationParticipantAddResponse

Properties​

code​

• code: 200 | 400 | 403

The resultant status code for adding the participant.

200 if the participant was added successfully during the creation of the group.

403 if the participant does not allow their account to be added to group chats. If you receive a 403, you will also get an invite_code and invite_code_exp

invite_code​

• Optional invite_code: string

If the participant is not allowed to be added to group chats due to their privacy settings, you will receive an invite_code which you can send to them via a text.

invite_code_exp​

• Optional invite_code_exp: string

The expiry ts of the invite_code. It is a number wrapped in a string, in order to get the proper time you can use this:

  new Date(Number(invite_code_exp)*1000)
- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.GroupChatCreationResponse.html b/docs/api/interfaces/api_model_chat.GroupChatCreationResponse.html index a99f8b3f10..783e917792 100644 --- a/docs/api/interfaces/api_model_chat.GroupChatCreationResponse.html +++ b/docs/api/interfaces/api_model_chat.GroupChatCreationResponse.html @@ -14,13 +14,13 @@ - +

Interface: GroupChatCreationResponse

api/model/chat.GroupChatCreationResponse

Properties​

gid​

• gid: GroupChatId

The group chat id

participants​

• participants: { ContactId?: GroupChatCreationParticipantAddResponse }[]

The initial requested participants and their corresponding add responses

status​

• status: 200 | 400

The resultant status code of the group chat creation.

200 if the group was created successfully.

400 if the initial participant does not exist

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent.html b/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent.html index 454ad3dd81..8d7d16f796 100644 --- a/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent.html +++ b/docs/api/interfaces/api_model_chat.LiveLocationChangedEvent.html @@ -14,13 +14,13 @@ - +

Interface: LiveLocationChangedEvent

api/model/chat.LiveLocationChangedEvent

Properties​

accuracy​

• accuracy: number

degrees​

• degrees: any

id​

• id: string

lastUpdated​

• lastUpdated: number

lat​

• lat: number

lng​

• lng: number

msgId​

• Optional msgId: string

The message id that was sent when the liveLocation session was started.

speed​

• speed: number

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_chat.SingleChat.html b/docs/api/interfaces/api_model_chat.SingleChat.html index 35ffd3dd34..28da30041f 100644 --- a/docs/api/interfaces/api_model_chat.SingleChat.html +++ b/docs/api/interfaces/api_model_chat.SingleChat.html @@ -14,13 +14,13 @@ - +

Interface: SingleChat

api/model/chat.SingleChat

Hierarchy​

Properties​

ack​

• Optional ack: any

Inherited from​

BaseChat.ack

archive​

• archive: boolean

Inherited from​

BaseChat.archive

canSend​

• Optional canSend: boolean

Whether your host account is able to send messages to this chat

Inherited from​

BaseChat.canSend

changeNumberNewJid​

• changeNumberNewJid: any

Inherited from​

BaseChat.changeNumberNewJid

changeNumberOldJid​

• changeNumberOldJid: any

Inherited from​

BaseChat.changeNumberOldJid

contact​

• contact: Contact

The contact related to this chat

Inherited from​

BaseChat.contact

formattedTitle​

• Optional formattedTitle: string

The title of the chat

Inherited from​

BaseChat.formattedTitle

groupMetadata​

• groupMetadata: GroupMetadata

Group metadata for this chat

Inherited from​

BaseChat.groupMetadata

id​

• id: ContactId

The id of the chat

isAnnounceGrpRestrict​

• isAnnounceGrpRestrict: any

If the chat is a group chat is restricted

Inherited from​

BaseChat.isAnnounceGrpRestrict

isGroup​

• isGroup: false

Whether the chat is a group chat

isOnline​

• Optional isOnline: any

Deprecated

This is unreliable. Use the method isChatOnline instead.

Inherited from​

BaseChat.isOnline

isReadOnly​

• isReadOnly: boolean

Whether the chat is a group chat and the group is restricted

Inherited from​

BaseChat.isReadOnly

kind​

• kind: string

Inherited from​

BaseChat.kind

labels​

• labels: any

The labels attached to this chat.

Inherited from​

BaseChat.labels

lastReceivedKey​

• lastReceivedKey: any

The ID of the last message received in this chat

Inherited from​

BaseChat.lastReceivedKey

lastSeen​

• Optional lastSeen: any

Deprecated

This is unreliable. Use the method getLastSeen instead.

Inherited from​

BaseChat.lastSeen

modifyTag​

• modifyTag: number

Inherited from​

BaseChat.modifyTag

msgs​

• msgs: any

The messages in the chat

Inherited from​

BaseChat.msgs

muteExpiration​

• muteExpiration: number

The expiration timestamp of the chat mute

Inherited from​

BaseChat.muteExpiration

name​

• name: string

The name of the chat

Inherited from​

BaseChat.name

notSpam​

• notSpam: boolean

Whether the chat is marked as spam

Inherited from​

BaseChat.notSpam

pendingMsgs​

• pendingMsgs: boolean

Messages that are pending to be sent

Inherited from​

BaseChat.pendingMsgs

pic​

• Optional pic: string

URL of the chat picture if available

Inherited from​

BaseChat.pic

pin​

• pin: number

Whether the chat is pinned

Inherited from​

BaseChat.pin

presence​

• presence: any

The presence state of the chat participant

Inherited from​

BaseChat.presence

t​

• t: number

The timestamp of the last interaction in the chat

Inherited from​

BaseChat.t

unreadCount​

• unreadCount: number

The number of undread messages in this chat

Inherited from​

BaseChat.unreadCount

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.ConfigObject.html b/docs/api/interfaces/api_model_config.ConfigObject.html index 4ee9bc04e8..9b78779087 100644 --- a/docs/api/interfaces/api_model_config.ConfigObject.html +++ b/docs/api/interfaces/api_model_config.ConfigObject.html @@ -14,7 +14,7 @@ - + @@ -35,7 +35,7 @@ This sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event.

You can capture the event like so:

import {create, ev} from '@open-wa/wa-automate';

     ev.on('sessionData.**', async (sessionData, sessionId) =>{
         console.log(sessionId, sessionData)
     })

//or as base64 encoded string

     ev.on('sessionDataBase64.**', async (sessionDatastring, sessionId) =>{
         console.log(sessionId, sessionDatastring)
     })

NOTE: You can set sessionData as an evironmental variable also! The variable name has to be [sessionId (default = 'session) in all caps]_DATA_JSON. You have to make sure to surround your session data with single quotes to maintain the formatting.

For example:

sessionId = 'session'

To set env var:

   export SESSION_DATA_JSON=`...`

where ... is copied from session.data.json this will be a string most likley starting in ey... and ending with ==

Setting the sessionData in the environmental variable will override the sessionData object in the config.

sessionDataBucketAuth​

• Optional sessionDataBucketAuth: string

Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions.

sessionDataPath​

• Optional sessionDataPath: string

The path relative to the current working directory (i.e where you run the command to start your process). This will be used to store and read your .data.json files. defualt to ''

sessionId​

• Optional sessionId: string

This is the name of the session. You have to make sure that this is unique for every session.

Default

session

skipBrokenMethodsCheck​

• Optional skipBrokenMethodsCheck: boolean

If set to true, skipBrokenMethodsCheck will bypass the health check before startup. It is highly suggested to not set this to true.

Default

false

skipSessionSave​

• Optional skipSessionSave: boolean

If true, the process will not save a data.json file. This means that sessions will not be saved and you will need to pass sessionData as a config param or create the session data.json file yourself

Default

false

skipUpdateCheck​

• Optional skipUpdateCheck: boolean

If set to true, skipUpdateCheck will bypass the latest version check. This saves some time on boot (around 150 ms).

Default

false

stickerServerEndpoint​

• Optional stickerServerEndpoint: string | boolean

Redundant until self-hostable sticker server is available.

Default

https://sticker-api.openwa.dev

throwErrorOnTosBlock​

• Optional throwErrorOnTosBlock: boolean

Setting this to true will throw an error if a session is not able to get a QR code or is unable to restart a session.

throwOnExpiredSessionData​

• Optional throwOnExpiredSessionData: boolean

This will make the create command return false if the detected session data is expired.

This will mean, the process will not attempt to automatically get a new QR code.

Default

false

useChrome​

• Optional useChrome: boolean

If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath.

Default

false

useNativeProxy​

• Optional useNativeProxy: boolean

Some sessions may experience issues with sending media when using proxies. Using the native proxy system instead of the recommended 3rd party library may fix these issues.

Default

false

useStealth​

• Optional useStealth: boolean

This flag allows you to disable or enable the use of the puppeteer stealth plugin. It is a good idea to use it, however it can cause issues sometimes. Set this to false if you are experiencing browser.setMaxListeneres issue. For now the default for this is false.

Default

false

viewport​

• Optional viewport: Object

Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g --viewport 1920x1080.

Type declaration​

NameTypeDescription
height?numberPage height in pixels Default 900
width?numberPage width in pixels Default 1440

waitForRipeSession​

• Optional waitForRipeSession: boolean

wait for a valid headful session. Not required in recent versions. default: true

waitForRipeSessionTimeout​

• Optional waitForRipeSessionTimeout: number

This determines how long the process should wait for a session to load fully before continuing the launch process. Set this to 0 to wait forever. Default is 5 seconds.

Default

5

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.DevTools.html b/docs/api/interfaces/api_model_config.DevTools.html index c3fec97ea9..75ad37070f 100644 --- a/docs/api/interfaces/api_model_config.DevTools.html +++ b/docs/api/interfaces/api_model_config.DevTools.html @@ -14,13 +14,13 @@ - +

Interface: DevTools

api/model/config.DevTools

Properties​

pass​

• pass: string

Password for devtools

user​

• user: string

Username for devtools

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.EventPayload.html b/docs/api/interfaces/api_model_config.EventPayload.html index bd0732ba97..bdc04ea130 100644 --- a/docs/api/interfaces/api_model_config.EventPayload.html +++ b/docs/api/interfaces/api_model_config.EventPayload.html @@ -14,13 +14,13 @@ - +

Interface: EventPayload

api/model/config.EventPayload

Indexable​

▪ [k: string]: any

Properties​

data​

• data: any

event​

• event: SimpleListener

id​

• id: string

sessionId​

• sessionId: string

ts​

• ts: number

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.ProxyServerCredentials.html b/docs/api/interfaces/api_model_config.ProxyServerCredentials.html index 6148d5c898..218d661e19 100644 --- a/docs/api/interfaces/api_model_config.ProxyServerCredentials.html +++ b/docs/api/interfaces/api_model_config.ProxyServerCredentials.html @@ -14,13 +14,13 @@ - +

Interface: ProxyServerCredentials

api/model/config.ProxyServerCredentials

Properties​

address​

• address: string

Proxy Server address. This can include the port e.g '127.0.0.1:5005'

password​

• password: string

Password for Proxy Server authentication

protocol​

• Optional protocol: string

The protocol on which the proxy is running. E.g http, https, socks4 or socks5. This is optional and can be automatically determined from the address.

username​

• username: string

Username for Proxy Server authentication

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.SessionData.html b/docs/api/interfaces/api_model_config.SessionData.html index f7771f7833..1b8dc2efc7 100644 --- a/docs/api/interfaces/api_model_config.SessionData.html +++ b/docs/api/interfaces/api_model_config.SessionData.html @@ -14,13 +14,13 @@ - +

Interface: SessionData

api/model/config.SessionData

Properties​

WABrowserId​

• Optional WABrowserId: string

WASecretBundle​

• Optional WASecretBundle: string

WAToken1​

• Optional WAToken1: string

WAToken2​

• Optional WAToken2: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_config.Webhook.html b/docs/api/interfaces/api_model_config.Webhook.html index 812d2a5c30..efb97547d3 100644 --- a/docs/api/interfaces/api_model_config.Webhook.html +++ b/docs/api/interfaces/api_model_config.Webhook.html @@ -14,13 +14,13 @@ - +

Interface: Webhook

api/model/config.Webhook

Properties​

events​

• events: SimpleListener[]

An array of events that are registered to be sent to this webhook.

id​

• id: string

The ID of the given webhook setup. Use this ID with removeWebhook

requestConfig​

• Optional requestConfig: AxiosRequestConfig<any>

The optional AxiosRequestConfig to use for firing the webhook event. This can be useful if you want to add some authentication when POSTing data to your server.

For example, if your webhook requires the username admin and password 1234 for authentication, you can set the requestConfig to:

{
  auth: {
    username: "admin",
    password: "1234",
  }
}

Please note, for security reasons, this is not returned when listing webhooks however it is returned when registering a webhook for verification purposes.

ts​

• ts: number

Time when the webhook was registered in epoch time

url​

• url: string

The endpoint to send (POST) the event to.

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.BizCategory.html b/docs/api/interfaces/api_model_contact.BizCategory.html index 46abb77c6d..8e33d4ba50 100644 --- a/docs/api/interfaces/api_model_contact.BizCategory.html +++ b/docs/api/interfaces/api_model_contact.BizCategory.html @@ -14,13 +14,13 @@ - +

Interface: BizCategory

api/model/contact.BizCategory

Properties​

id​

• id: string

localized_display_name​

• localized_display_name: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.BizProfileOptions.html b/docs/api/interfaces/api_model_contact.BizProfileOptions.html index a1a031842a..5def0831c7 100644 --- a/docs/api/interfaces/api_model_contact.BizProfileOptions.html +++ b/docs/api/interfaces/api_model_contact.BizProfileOptions.html @@ -14,13 +14,13 @@ - +

Interface: BizProfileOptions

api/model/contact.BizProfileOptions

Properties​

cartEnabled​

• cartEnabled: boolean

commerceExperience​

• commerceExperience: "catalog" | "none" | "shop"

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.BusinessHours.html b/docs/api/interfaces/api_model_contact.BusinessHours.html index be7343e2e5..4904f33283 100644 --- a/docs/api/interfaces/api_model_contact.BusinessHours.html +++ b/docs/api/interfaces/api_model_contact.BusinessHours.html @@ -14,13 +14,13 @@ - +

Interface: BusinessHours

api/model/contact.BusinessHours

Properties​

config​

• config: Object

Type declaration​

NameType
fri{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
fri.hoursnumber[][]
fri.mode"specific_hours" | "open_24h" | "appointment_only"
mon{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
mon.hoursnumber[][]
mon.mode"specific_hours" | "open_24h" | "appointment_only"
sat{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
sat.hoursnumber[][]
sat.mode"specific_hours" | "open_24h" | "appointment_only"
sun{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
sun.hoursnumber[][]
sun.mode"specific_hours" | "open_24h" | "appointment_only"
thu{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
thu.hoursnumber[][]
thu.mode"specific_hours" | "open_24h" | "appointment_only"
tue{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
tue.hoursnumber[][]
tue.mode"specific_hours" | "open_24h" | "appointment_only"
wed{ hours: number[][] ; mode: "specific_hours" | "open_24h" | "appointment_only" }
wed.hoursnumber[][]
wed.mode"specific_hours" | "open_24h" | "appointment_only"

timezone​

• timezone: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.BusinessProfile.html b/docs/api/interfaces/api_model_contact.BusinessProfile.html index 4987442ef1..f0021bb054 100644 --- a/docs/api/interfaces/api_model_contact.BusinessProfile.html +++ b/docs/api/interfaces/api_model_contact.BusinessProfile.html @@ -14,13 +14,13 @@ - +

Interface: BusinessProfile

api/model/contact.BusinessProfile

Properties​

address​

• address: string

The address of the business

businessHours​

• businessHours: BusinessHours

The operating hours of the business

catalogStatus​

• catalogStatus: string

The status of the business' catalog

categories​

• categories: BizCategory[]

The business' categories

coverPhoto​

• coverPhoto: Object

Type declaration​

NameTypeDescription
idstringThe id of the cover photo
urlstringThe URL of the cover photo. It might download as an .enc but just change the extension to .jpg

description​

• description: string

The business description

email​

• email: string

The business' email address

fbPage​

• fbPage: any

The facebook page of the business

id​

• id: ContactId

The Contact ID of the business

igProfessional​

• igProfessional: any

The instagram profile of the business

isProfileLinked​

• isProfileLinked: boolean

latitude​

• latitude: number

The latitude of the business location if set

longitude​

• longitude: number

The longitude of the business location if set

profileOptions​

• profileOptions: BizProfileOptions

The business' profile options

tag​

• tag: string

Some special string that identifies the business (?)

website​

• website: string[]

Array of strings that represent the business' websites

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.Contact.html b/docs/api/interfaces/api_model_contact.Contact.html index f7a561000f..d9c7964a74 100644 --- a/docs/api/interfaces/api_model_contact.Contact.html +++ b/docs/api/interfaces/api_model_contact.Contact.html @@ -14,14 +14,14 @@ - +

Interface: Contact

api/model/contact.Contact

Properties​

businessProfile​

• Optional businessProfile: BusinessProfile

If the contact is a business, the business information will be added to the contact object.

In some circumstances this will be out of date or lacking certain fields. In those cases you have to use client.getBusinessProfile

formattedName​

• formattedName: string

id​

• id: ContactId

isBusiness​

• isBusiness: boolean

isEnterprise​

• isEnterprise: boolean

Most likely true when the account has a green tick. See verifiedLevel also.

isMe​

• isMe: boolean

isMyContact​

• isMyContact: boolean

isOnline​

• Optional isOnline: boolean

isPSA​

• isPSA: boolean

isUser​

• isUser: boolean

isWAContact​

• isWAContact: boolean

labels​

• labels: string[]

lastSeen​

• Optional lastSeen: number

msgs​

• msgs: Message[]

name​

• name: string

plaintextDisabled​

• plaintextDisabled: boolean

profilePicThumbObj​

• profilePicThumbObj: Object

Type declaration​

NameType
eurlstring
idId
imgstring
imgFullstring
rawstring
tagstring

pushname​

• pushname: string

shortName​

• shortName: string

statusMute​

• statusMute: boolean

type​

• type: string

verifiedLevel​

• verifiedLevel: number

0 = not verified 2 = verified (most likely represents a blue tick)

verifiedName​

• verifiedName: string

The business account name verified by WA.

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_contact.NumberCheck.html b/docs/api/interfaces/api_model_contact.NumberCheck.html index fd6a38cb63..c2c91308e5 100644 --- a/docs/api/interfaces/api_model_contact.NumberCheck.html +++ b/docs/api/interfaces/api_model_contact.NumberCheck.html @@ -14,13 +14,13 @@ - +

Interface: NumberCheck

api/model/contact.NumberCheck

Properties​

canReceiveMessage​

• canReceiveMessage: boolean

id​

• id: Id

isBusiness​

• isBusiness: boolean

numberExists​

• numberExists: boolean

status​

• status: 200 | 404

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent.html b/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent.html index 769275f54a..1af424e6de 100644 --- a/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent.html +++ b/docs/api/interfaces/api_model_group_metadata.GenericGroupChangeEvent.html @@ -14,13 +14,13 @@ - +

Interface: GenericGroupChangeEvent

api/model/group-metadata.GenericGroupChangeEvent

Properties​

author​

• author: Contact

The contact who triggered this event. (E.g the contact who changed the group picture)

body​

• body: string

Some more information about the event

groupMetadata​

• groupMetadata: GroupMetadata

groupPic​

• groupPic: string

Base 64 encoded image

id​

• id: MessageId

type​

• type: "picutre" | "create" | "delete" | "subject" | "revoke_invite" | "description" | "restrict" | "announce" | "no_frequently_forwarded" | "announce_msg_bounce" | "add" | "remove" | "demote" | "promote" | "invite" | "leave" | "modify" | "v4_add_invite_sent" | "v4_add_invite_join" | "growth_locked" | "growth_unlocked" | "linked_group_join"

Type of the event

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_group_metadata.GroupMetadata.html b/docs/api/interfaces/api_model_group_metadata.GroupMetadata.html index 94effad3e0..2cfbd7ffee 100644 --- a/docs/api/interfaces/api_model_group_metadata.GroupMetadata.html +++ b/docs/api/interfaces/api_model_group_metadata.GroupMetadata.html @@ -14,13 +14,13 @@ - +

Interface: GroupMetadata

api/model/group-metadata.GroupMetadata

Properties​

creation​

• creation: number

The timestamp of when the group was created

defaultSubgroup​

• defaultSubgroup: boolean

Communities have a default group chat

desc​

• Optional desc: string

The description of the group

descOwner​

• Optional descOwner: ContactId

The account that set the description last.

groupType​

• groupType: "DEAFULT" | "SUBGROUP" | "COMMUNITY"

The type of group

id​

• id: GroupChatId

The chat id of the group GroupChatId

isParentGroup​

• Optional isParentGroup: boolean

Is this group a parent group (a.k.a community)

isParentGroupClosed​

• isParentGroupClosed: boolean

joinedSubgroups​

• joinedSubgroups: `${number}@g.us`[]

List of Group IDs that the host account has joined as part of this community

owner​

• owner: NonSerializedId

The id of the owner of the group ContactId

participants​

• participants: Participant[]

An array of participants in the group

pendingParticipants​

• pendingParticipants: Participant[]

Unknown.

support​

• Optional support: boolean

Not sure what this represents

suspended​

• Optional suspended: boolean

Not sure what this represents

trusted​

• Optional trusted: boolean

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup.html b/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup.html index 62ea617d8f..a207e2670b 100644 --- a/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup.html +++ b/docs/api/interfaces/api_model_group_metadata.NewCommunityGroup.html @@ -14,13 +14,13 @@ - +

Interface: NewCommunityGroup

api/model/group-metadata.NewCommunityGroup

Used when creating a new community with.

Properties​

ephemeralDuration​

• Optional ephemeralDuration: number

icon​

• Optional icon: DataURL

subject​

• subject: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_group_metadata.Participant.html b/docs/api/interfaces/api_model_group_metadata.Participant.html index 2ddf101d46..1a09fcb9b1 100644 --- a/docs/api/interfaces/api_model_group_metadata.Participant.html +++ b/docs/api/interfaces/api_model_group_metadata.Participant.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel.html b/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel.html index 0b6651f949..a69b5c2046 100644 --- a/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel.html +++ b/docs/api/interfaces/api_model_group_metadata.ParticipantChangedEventModel.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_id.Id.html b/docs/api/interfaces/api_model_id.Id.html index 180a4aacc8..f78cb4149c 100644 --- a/docs/api/interfaces/api_model_id.Id.html +++ b/docs/api/interfaces/api_model_id.Id.html @@ -14,13 +14,13 @@ - +

Interface: Id

api/model/id.Id

Properties​

_serialized​

• _serialized: string

server​

• server: string

user​

• user: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_label.Label.html b/docs/api/interfaces/api_model_label.Label.html index 1b11d1fcbe..05ae6ff068 100644 --- a/docs/api/interfaces/api_model_label.Label.html +++ b/docs/api/interfaces/api_model_label.Label.html @@ -14,13 +14,13 @@ - +

Interface: Label

api/model/label.Label

Properties​

id​

• id: string

The internal ID of the label. Usually a number represented as a string e.g "1"

items​

• items: { id: ChatId | MessageId ; type: "Chat" | "Contact" | "Message" }[]

The items that are tagged with this label

name​

• name: string

The text contents of the label

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.Message.html b/docs/api/interfaces/api_model_message.Message.html index 26025bc073..8fdf96a8d7 100644 --- a/docs/api/interfaces/api_model_message.Message.html +++ b/docs/api/interfaces/api_model_message.Message.html @@ -14,14 +14,14 @@ - +

Interface: Message

api/model/message.Message

Properties​

ack​

• ack: MessageAck

The acknolwedgement state of a message MessageAck

author​

• author: string

body​

• body: string

The body of the message. If the message type is chat , body will be the text of the chat. If the message type is some sort of media, then this body will be the thumbnail of the media.

broadcast​

• broadcast: boolean

If the message is sent as a broadcast

buttons​

• Optional buttons: Button[]

Buttons associated with the message

caption​

• caption: string

If the message is of a media type, it may also have a caption

chat​

• chat: Chat

The chat object

chatId​

• chatId: ChatId

clientUrl​

• clientUrl: string

Deprecated

Ironically, you should be using deprecatedMms3Url instead

cloudUrl​

• Optional cloudUrl: string

The URL of the file after being uploaded to the cloud using a cloud upload message preprocessor.

content​

• content: string

ctwaContext​

• Optional ctwaContext: Object

Type declaration​

NameType
isSuspiciousLinkboolean
mediaTypenumber
sourceUrlstring
thumbnailstring

deprecatedMms3Url​

• deprecatedMms3Url: string

duration​

• Optional duration: string | number

The length of the media in the message, if it exists.

filePath​

• Optional filePath: string

When config.messagePreprocessor: "AUTO_DECRYPT_SAVE" is set, media is decrypted and saved on disk in a folder called media relative to the current working directory.

This is the filePath of the decrypted file.

filehash​

• Optional filehash: string

Used to checking the integrity of the decrypted media.

filename​

• Optional filename: string

The given filename of the file

from​

• from: ChatId

The chat from which the message was sent

fromMe​

• fromMe: boolean

If the message is from the host account

id​

• id: MessageId

The id of the message. Consists of the Chat ID and a unique string.

Example:

false_447123456789@c.us_7D914FEA78BE10277743F4B785045C37

invis​

• invis: boolean

isAnimated​

• isAnimated: boolean

isForwarded​

• isForwarded: boolean

If the message has been forwarded

isGroupJoinRequest​

• Optional isGroupJoinRequest: GroupChatId

When a user requests to join a group wihtin a community the request is received by the host as a message. This boolean will allow you to easily determine if the incoming message is a request to join a group.

If this is true then you need to determine within your own code whether or not to accept the user to the group which is indicated with quotedRemoteJid using addParticipant.

isGroupMsg​

• isGroupMsg: boolean

isMMS​

• isMMS: boolean

isMedia​

• isMedia: boolean

isNewMsg​

• isNewMsg: boolean

isNotification​

• isNotification: boolean

isPSA​

• isPSA: boolean

isQuotedMsgAvailable​

• isQuotedMsgAvailable: boolean

If this message is quoting (replying to) another message

isViewOnce​

• isViewOnce: boolean

Is the message a "view once" message

labels​

• labels: string[]

The labels associated with the message (used with business accounts)

lat​

• Optional lat: string

The latitude of a location message

list​

• Optional list: Object

The list associated with the list message

Type declaration​

NameType
buttonTextstring
descriptionstring
sectionsSection[]
titlestring

listResponse​

• Optional listResponse: Row

List response associated with the message

lng​

• Optional lng: string

The longitude of a location message

loc​

• Optional loc: string

The text associated with a location message

mId​

• mId: string

The unique segment of the message id.

Example:

7D914FEA78BE10277743F4B785045C37

mediaData​

• mediaData: unknown

mentionedJidList​

• mentionedJidList: ContactId[]

An array of all mentioned numbers in this message.

mimetype​

• Optional mimetype: string

notifyName​

• notifyName: string

pollOptions​

• Optional pollOptions: PollOption[]

The options of a poll

quoteMap​

• quoteMap: QuoteMap

Use this to traverse the quote chain.

quotedMsg​

• Optional quotedMsg: Message

quotedMsgObj​

• Optional quotedMsgObj: Message

quotedParentGroupJid​

• Optional quotedParentGroupJid: GroupChatId

The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by quotedRemoteJid

quotedRemoteJid​

• Optional quotedRemoteJid: string

The ID of the quoted group. Usually present when a user is requesting to join a group.

reactionByMe​

• Optional reactionByMe: ReactionSender

The reaction of the host account to this message

reactions​

• reactions: { aggregateEmoji: string ; hasReactionByMe: boolean ; id: string ; senders: ReactionSender[] }[]

recvFresh​

• recvFresh: boolean

selectedButtonId​

• selectedButtonId: string

The ID of the selected button

self​

• self: "in" | "out"

Indicates whether the message is coming into the session or going out of the session. You can have a message sent by the host account show as in when the message was sent from another session or from the host account device itself.

sender​

• sender: Contact

The contact object of the account that sent the message

senderId​

• Optional senderId: string

The ID of the message sender

shareDuration​

• shareDuration: number

star​

• star: boolean

stickerAuthor​

• Optional stickerAuthor: string

stickerPack​

• Optional stickerPack: string

t​

• t: number

The timestamp of the message

text​

• text: string

a convenient way to get the main text content from a message.

timestamp​

• timestamp: number

the timestanmp of the message

to​

• to: ChatId

The chat id to which the message is being sent

type​

• type: MessageTypes

The type of the message, see MessageTypes

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.MessageInfo.html b/docs/api/interfaces/api_model_message.MessageInfo.html index d4db885830..18443152c0 100644 --- a/docs/api/interfaces/api_model_message.MessageInfo.html +++ b/docs/api/interfaces/api_model_message.MessageInfo.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.MessageInfoInteraction.html b/docs/api/interfaces/api_model_message.MessageInfoInteraction.html index 8ee96882e4..ef89f395db 100644 --- a/docs/api/interfaces/api_model_message.MessageInfoInteraction.html +++ b/docs/api/interfaces/api_model_message.MessageInfoInteraction.html @@ -14,13 +14,13 @@ - +

Interface: MessageInfoInteraction

api/model/message.MessageInfoInteraction

Properties​

id​

• id: ContactId

The contact ID of the contact that interacted with the message.

t​

• t: number

The timestamp of the interaction. You have to x 1000 to use in a JS Date object.

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.PollData.html b/docs/api/interfaces/api_model_message.PollData.html index 1c2eeb23b1..65a89d064e 100644 --- a/docs/api/interfaces/api_model_message.PollData.html +++ b/docs/api/interfaces/api_model_message.PollData.html @@ -14,13 +14,13 @@ - +

Interface: PollData

api/model/message.PollData

Properties​

pollMessage​

• pollMessage: Message

The message object of the poll

pollOptions​

• pollOptions: PollOption & { count: number }[]

The poll options and their respective count of votes.

totalVotes​

• totalVotes: number

The total amount of votes recorded so far

votes​

• votes: PollVote[]

An arrray of vote objects

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.PollOption.html b/docs/api/interfaces/api_model_message.PollOption.html index 928ee3ab7f..eae994b46d 100644 --- a/docs/api/interfaces/api_model_message.PollOption.html +++ b/docs/api/interfaces/api_model_message.PollOption.html @@ -14,13 +14,13 @@ - +

Interface: PollOption

api/model/message.PollOption

Properties​

localId​

• localId: number

name​

• name: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.PollVote.html b/docs/api/interfaces/api_model_message.PollVote.html index cb6f72ad8e..33627bdd07 100644 --- a/docs/api/interfaces/api_model_message.PollVote.html +++ b/docs/api/interfaces/api_model_message.PollVote.html @@ -14,13 +14,13 @@ - +

Interface: PollVote

api/model/message.PollVote

Properties​

ack​

• ack: number

id​

• id: string

The message ID of this vote. For some reason this is different from the msgKey and includes exclamaition marks.

msgKey​

• msgKey: string

The message key of this vote

parentMsgKey​

• parentMsgKey: string

The Message ID of the original Poll message

pollOptions​

• pollOptions: PollOption[]

The original poll options available on the poll

selectedOptionLocalIds​

• selectedOptionLocalIds: number[]

The selected option IDs of the voter

selectedOptionValues​

• selectedOptionValues: string[]

The selected option values by this voter

sender​

• sender: ContactId

The contact ID of the voter

senderObj​

• senderObj: Contact

The contact object of the voter

senderTimestampMs​

• senderTimestampMs: number

Timestamp of the vote

stale​

• stale: boolean

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.QuoteMap.html b/docs/api/interfaces/api_model_message.QuoteMap.html index cdc68f5694..7f82935c1e 100644 --- a/docs/api/interfaces/api_model_message.QuoteMap.html +++ b/docs/api/interfaces/api_model_message.QuoteMap.html @@ -14,13 +14,13 @@ - +

Interface: QuoteMap

api/model/message.QuoteMap

Indexable​

▪ [messageId: string]: { body: string ; quotes?: MessageId }

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_message.ReactionSender.html b/docs/api/interfaces/api_model_message.ReactionSender.html index 085aeb87ff..1fe96bf1f7 100644 --- a/docs/api/interfaces/api_model_message.ReactionSender.html +++ b/docs/api/interfaces/api_model_message.ReactionSender.html @@ -14,13 +14,13 @@ - +

Interface: ReactionSender

api/model/message.ReactionSender

Properties​

ack​

• Optional ack: number

id​

• id: MessageId

The message ID of the reaction itself

isSendFailure​

• isSendFailure: boolean

msgKey​

• msgKey: MessageId

The message ID of the reaction itself

orphan​

• orphan: number

parentMsgKey​

• parentMsgKey: MessageId

The ID of the message being reacted to

reactionText​

• reactionText: string

The text of the reaction

read​

• read: boolean

If the reaction was seen/read

senderUserJid​

• senderUserJid: ContactId

The contact ID of the sender of the reaction

t​

• Optional t: number

The timestamp of the reaction

timestamp​

• timestamp: number

The timestamp of the reaction

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_product.CartItem.html b/docs/api/interfaces/api_model_product.CartItem.html index ddecf13a5d..417a4e248e 100644 --- a/docs/api/interfaces/api_model_product.CartItem.html +++ b/docs/api/interfaces/api_model_product.CartItem.html @@ -14,13 +14,13 @@ - +

Interface: CartItem

api/model/product.CartItem

Properties​

id​

• id: string

Product ID

name​

• name: string

Product name

qty​

• qty: number

Amount of this item in the cart

thumbnailId​

• thumbnailId: string

thumbnailUrl​

• thumbnailUrl: string

URL to .enc file of the thumbnail. Just change the filetype to .jpg to view the thumbnail

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_product.CustomProduct.html b/docs/api/interfaces/api_model_product.CustomProduct.html index d7ff971dfe..58d6ac06e9 100644 --- a/docs/api/interfaces/api_model_product.CustomProduct.html +++ b/docs/api/interfaces/api_model_product.CustomProduct.html @@ -14,7 +14,7 @@ - + @@ -23,7 +23,7 @@ SEK

description​

• description: string

The description of the product. This shows right under the price so it is useful for subscriptions/rentals. E.g:

(per day)\n\nCome and have a fantastic sailing adventure aboard our boat. \nShe is a Bavaria 35 sports cruiser and is powered by 2 economical Volvo D6’s with Bravo 2 outdrives as well as a bow thruster. This Makes maneuvering very easy. She can accommodate up to 8 people for day charters and for overnight charters she can accommodate 4 in comfort in 2 cabins.

name​

• name: string

The main title of the product. E.g: BAVARIA — 35 SPORTS CRUISER (2006)

priceAmount1000​

• priceAmount1000: number

The price amount multiplied by 1000. For example, for something costing 825 units of currency: 825000

url​

• Optional url: string

The URL of the product.

NOTE: At the moment, the URL DOES NOT WORK. It shows up for the recipient but they will not be able to click it. As a rememdy, it is added as a reply to the product message.

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_product.Order.html b/docs/api/interfaces/api_model_product.Order.html index 4174739ef5..577190385d 100644 --- a/docs/api/interfaces/api_model_product.Order.html +++ b/docs/api/interfaces/api_model_product.Order.html @@ -14,14 +14,14 @@ - +

Interface: Order

api/model/product.Order

Properties​

createdAt​

• createdAt: number

epoch ts divided by 1000

currency​

• currency: string

The ISO 4217 3 letter currency code. E.g (Swedish krona) SEK

id​

• id: string

Order ID

message​

• Optional message: Message

The message object associated with the order. Only populated in onOrder callback.

products​

• products: CartItem[]

An array of items in the cart

sellerJid​

• sellerJid: string

subtotal​

• subtotal: `${number}`

total​

• total: `${number}`

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_product.Product.html b/docs/api/interfaces/api_model_product.Product.html index fb0c3d34bf..7be8b54cb0 100644 --- a/docs/api/interfaces/api_model_product.Product.html +++ b/docs/api/interfaces/api_model_product.Product.html @@ -14,14 +14,14 @@ - +

Interface: Product

api/model/product.Product

Properties​

additionalImageCdnUrl​

• Optional additionalImageCdnUrl: string[]

Array of URLs of the other images of the product. Does not include the main image.

availability​

• Optional availability: number | "unknown"

The availiable quantity of this product.

Default

"unknown"`

catalogWid​

• Optional catalogWid: string

The id of the catalog in which this product is located.

currency​

• currency: string

The ISO 4217 3 letter currency code. E.g (Swedish krona) SEK

description​

• Optional description: string

The description of the product.

id​

• id: string

Product ID

imageCdnUrl​

• Optional imageCdnUrl: string

The url of the main image of the product.

NOTE: If downloading manually, the filetype must be changed to .jpg to view the image.

imageCount​

• Optional imageCount: number

The number of images of the product.

isHidden​

• Optional isHidden: boolean

true if the product is hidden from public view.

name​

• Optional name: string

The name of the product.

priceAmount1000​

• Optional priceAmount1000: number

The price of the product in 1000 units.

retailerId​

• Optional retailerId: string

The custom id of the product.

reviewStatus​

• Optional reviewStatus: "NO_REVIEW" | "PENDING" | "REJECTED" | "APPROVED" | "OUTDATED"

The review status of the product

t​

• Optional t: number

The timestamp when the product was created / 1000

url​

• Optional url: string

The URL of the product.

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_sessionInfo.HealthCheck.html b/docs/api/interfaces/api_model_sessionInfo.HealthCheck.html index b15765b5eb..0c46f64399 100644 --- a/docs/api/interfaces/api_model_sessionInfo.HealthCheck.html +++ b/docs/api/interfaces/api_model_sessionInfo.HealthCheck.html @@ -14,13 +14,13 @@ - +

Interface: HealthCheck

api/model/sessionInfo.HealthCheck

Properties​

batteryLow​

• Optional batteryLow: boolean

Returns true if "Phone battery low" message is detected

Healthy: false

isHere​

• Optional isHere: boolean

Returns true if "Use Here" button is not detected

Healthy: true

isPhoneDisconnected​

• Optional isPhoneDisconnected: boolean

Whether or not the "Phone is disconnected" message is showing within the web app.

Healthy: false

online​

• Optional online: boolean

Result of window.navigator.onLine

Healthy: true

queuedMessages​

• Optional queuedMessages: number

The number of messages queued up in the browser. Messages can start being queued up due to the web app awaiting a connection with the host device.

Healthy: 0

retryingIn​

• Optional retryingIn: number

Returns the number of seconds the "Retrying in ..." dialog is indicating. If the dialog is not showing, it will return 0.

Healthy: 0

state​

• Optional state: STATE

The state of the web app.

Healthy: 'CONNECTED'

tryingToReachPhone​

• Optional tryingToReachPhone: boolean

Returns true if "trying to reach phone" dialog is detected

Healthy: false

wapiInjected​

• Optional wapiInjected: boolean

Returns true if the WAPI object is detected.

Healthy: true

- + \ No newline at end of file diff --git a/docs/api/interfaces/api_model_sessionInfo.SessionInfo.html b/docs/api/interfaces/api_model_sessionInfo.SessionInfo.html index c60cfe9f4c..e8821bc69e 100644 --- a/docs/api/interfaces/api_model_sessionInfo.SessionInfo.html +++ b/docs/api/interfaces/api_model_sessionInfo.SessionInfo.html @@ -14,13 +14,13 @@ - +

Interface: SessionInfo

api/model/sessionInfo.SessionInfo

Properties​

ACC_TYPE​

• Optional ACC_TYPE: "PERSONAL" | "BUSINESS"

BROWSER_VERSION​

• BROWSER_VERSION: string

CLI​

• Optional CLI: boolean

INSTANCE_ID​

• Optional INSTANCE_ID: string

LATEST_VERSION​

• Optional LATEST_VERSION: boolean

LAUNCH_TIME_MS​

• Optional LAUNCH_TIME_MS: number

NUM​

• Optional NUM: string

NUM_HASH​

• Optional NUM_HASH: string

OS​

• Optional OS: string

OW_KEY​

• Optional OW_KEY: string

PAGE_UA​

• PAGE_UA: string

PATCH_HASH​

• Optional PATCH_HASH: string

PHONE_VERSION​

• Optional PHONE_VERSION: string

PPTR_VERSION​

• Optional PPTR_VERSION: string

RAM_INFO​

• Optional RAM_INFO: string

START_TS​

• Optional START_TS: number

WA_AUTOMATE_VERSION​

• WA_AUTOMATE_VERSION: string

WA_VERSION​

• WA_VERSION: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/connect.AwaitMessagesOptions.html b/docs/api/interfaces/connect.AwaitMessagesOptions.html index bb89daed69..96fde24dc8 100644 --- a/docs/api/interfaces/connect.AwaitMessagesOptions.html +++ b/docs/api/interfaces/connect.AwaitMessagesOptions.html @@ -14,13 +14,13 @@ - +

Interface: AwaitMessagesOptions

connect.AwaitMessagesOptions

Options to be applied to the collector.

Hierarchy​

Properties​

dispose​

• Optional dispose: boolean

Whether to dispose data when it's deleted

Inherited from​

CollectorOptions.dispose

errors​

• Optional errors: string[]

An array of "reasons" that would result in the awaitMessages command to throw an error.

idle​

• Optional idle: number

Max time allowed idle

Inherited from​

CollectorOptions.idle

max​

• Optional max: number

The maximum amount of items to collect

Inherited from​

CollectorOptions.max

maxProcessed​

• Optional maxProcessed: number

The maximum amount of items to process

Inherited from​

CollectorOptions.maxProcessed

time​

• Optional time: number

Max time to wait for items in milliseconds

Inherited from​

CollectorOptions.time

- + \ No newline at end of file diff --git a/docs/api/interfaces/connect.CollectorOptions.html b/docs/api/interfaces/connect.CollectorOptions.html index ff9116078c..f9ccc5f734 100644 --- a/docs/api/interfaces/connect.CollectorOptions.html +++ b/docs/api/interfaces/connect.CollectorOptions.html @@ -14,13 +14,13 @@ - +

Interface: CollectorOptions

connect.CollectorOptions

Options to be applied to the collector.

Hierarchy​

Properties​

dispose​

• Optional dispose: boolean

Whether to dispose data when it's deleted

idle​

• Optional idle: number

Max time allowed idle

max​

• Optional max: number

The maximum amount of items to collect

maxProcessed​

• Optional maxProcessed: number

The maximum amount of items to process

time​

• Optional time: number

Max time to wait for items in milliseconds

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Collector.AwaitMessagesOptions.html b/docs/api/interfaces/structures_Collector.AwaitMessagesOptions.html index d824d859f5..d4a59a4b14 100644 --- a/docs/api/interfaces/structures_Collector.AwaitMessagesOptions.html +++ b/docs/api/interfaces/structures_Collector.AwaitMessagesOptions.html @@ -14,13 +14,13 @@ - +

Interface: AwaitMessagesOptions

structures/Collector.AwaitMessagesOptions

Options to be applied to the collector.

Hierarchy​

Properties​

dispose​

• Optional dispose: boolean

Whether to dispose data when it's deleted

Inherited from​

CollectorOptions.dispose

errors​

• Optional errors: string[]

An array of "reasons" that would result in the awaitMessages command to throw an error.

idle​

• Optional idle: number

Max time allowed idle

Inherited from​

CollectorOptions.idle

max​

• Optional max: number

The maximum amount of items to collect

Inherited from​

CollectorOptions.max

maxProcessed​

• Optional maxProcessed: number

The maximum amount of items to process

Inherited from​

CollectorOptions.maxProcessed

time​

• Optional time: number

Max time to wait for items in milliseconds

Inherited from​

CollectorOptions.time

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Collector.CollectorOptions.html b/docs/api/interfaces/structures_Collector.CollectorOptions.html index 214249e74b..7dd1778012 100644 --- a/docs/api/interfaces/structures_Collector.CollectorOptions.html +++ b/docs/api/interfaces/structures_Collector.CollectorOptions.html @@ -14,13 +14,13 @@ - +

Interface: CollectorOptions

structures/Collector.CollectorOptions

Options to be applied to the collector.

Hierarchy​

Properties​

dispose​

• Optional dispose: boolean

Whether to dispose data when it's deleted

idle​

• Optional idle: number

Max time allowed idle

max​

• Optional max: number

The maximum amount of items to collect

maxProcessed​

• Optional maxProcessed: number

The maximum amount of items to process

time​

• Optional time: number

Max time to wait for items in milliseconds

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.CurrentDialogProps.html b/docs/api/interfaces/structures_Dialog.CurrentDialogProps.html index 39955188f9..0c022d8563 100644 --- a/docs/api/interfaces/structures_Dialog.CurrentDialogProps.html +++ b/docs/api/interfaces/structures_Dialog.CurrentDialogProps.html @@ -14,13 +14,13 @@ - +

Interface: CurrentDialogProps

structures/Dialog.CurrentDialogProps

Indexable​

▪ [k: string]: any

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogButtons.html b/docs/api/interfaces/structures_Dialog.DialogButtons.html index 4516f48b6f..3f6f01f144 100644 --- a/docs/api/interfaces/structures_Dialog.DialogButtons.html +++ b/docs/api/interfaces/structures_Dialog.DialogButtons.html @@ -14,13 +14,13 @@ - +

Interface: DialogButtons

structures/Dialog.DialogButtons

Properties​

label​

• label: string

value​

• value: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogListMessageRow.html b/docs/api/interfaces/structures_Dialog.DialogListMessageRow.html index 3f8b15f741..58abad89b9 100644 --- a/docs/api/interfaces/structures_Dialog.DialogListMessageRow.html +++ b/docs/api/interfaces/structures_Dialog.DialogListMessageRow.html @@ -14,13 +14,13 @@ - +

Interface: DialogListMessageRow

structures/Dialog.DialogListMessageRow

Properties​

description​

• description: string

title​

• title: string

value​

• value: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogListMessageSection.html b/docs/api/interfaces/structures_Dialog.DialogListMessageSection.html index 45453d722c..5d145c7061 100644 --- a/docs/api/interfaces/structures_Dialog.DialogListMessageSection.html +++ b/docs/api/interfaces/structures_Dialog.DialogListMessageSection.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogProperty.html b/docs/api/interfaces/structures_Dialog.DialogProperty.html index 4eb123765c..1a62ed8bc0 100644 --- a/docs/api/interfaces/structures_Dialog.DialogProperty.html +++ b/docs/api/interfaces/structures_Dialog.DialogProperty.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogState.html b/docs/api/interfaces/structures_Dialog.DialogState.html index bf1cb0e67e..066dd66346 100644 --- a/docs/api/interfaces/structures_Dialog.DialogState.html +++ b/docs/api/interfaces/structures_Dialog.DialogState.html @@ -14,13 +14,13 @@ - +

Interface: DialogState

structures/Dialog.DialogState

Properties​

currentProps​

• currentProps: any

currentStep​

• currentStep: number

errorMessage​

• errorMessage: string

isComplete​

• isComplete: boolean

isError​

• isError: boolean

lastInput​

• lastInput: any

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogTemplate.html b/docs/api/interfaces/structures_Dialog.DialogTemplate.html index e672e9faf7..8b4fac11b1 100644 --- a/docs/api/interfaces/structures_Dialog.DialogTemplate.html +++ b/docs/api/interfaces/structures_Dialog.DialogTemplate.html @@ -14,13 +14,13 @@ - +

Interface: DialogTemplate

structures/Dialog.DialogTemplate

Properties​

dialogId​

• dialogId: string

identifier​

• identifier: string

privateOnly​

• privateOnly: boolean

properties​

• properties: Object

Index signature​

▪ [key: string]: DialogProperty

startMessage​

• startMessage: string

successMessage​

• successMessage: string

- + \ No newline at end of file diff --git a/docs/api/interfaces/structures_Dialog.DialogValidation.html b/docs/api/interfaces/structures_Dialog.DialogValidation.html index beabffcdee..ce806863d9 100644 --- a/docs/api/interfaces/structures_Dialog.DialogValidation.html +++ b/docs/api/interfaces/structures_Dialog.DialogValidation.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules.html b/docs/api/modules.html index 98f885c13e..d7a6b36675 100644 --- a/docs/api/modules.html +++ b/docs/api/modules.html @@ -14,13 +14,13 @@ - +

Exports

Modules​

- + \ No newline at end of file diff --git a/docs/api/modules/api_Client.html b/docs/api/modules/api_Client.html index 7d9b4faf9c..4dc5af8f11 100644 --- a/docs/api/modules/api_Client.html +++ b/docs/api/modules/api_Client.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_functions_exposed_enum.html b/docs/api/modules/api_functions_exposed_enum.html index 2ea1e77706..8795820ede 100644 --- a/docs/api/modules/api_functions_exposed_enum.html +++ b/docs/api/modules/api_functions_exposed_enum.html @@ -14,13 +14,13 @@ - +

Module: api/functions/exposed.enum

Enumerations​

- + \ No newline at end of file diff --git a/docs/api/modules/api_model.html b/docs/api/modules/api_model.html index e1644a45a7..dc77fc6738 100644 --- a/docs/api/modules/api_model.html +++ b/docs/api/modules/api_model.html @@ -14,13 +14,13 @@ - +

Module: api/model

Enumerations​

Type Aliases​

References​

AccountNumber​

Re-exports AccountNumber

AddParticipantError​

Re-exports AddParticipantError

AddParticipantErrorStatusCode​

Re-exports AddParticipantErrorStatusCode

AdvancedConfig​

Re-exports AdvancedConfig

AdvancedFile​

Re-exports AdvancedFile

Base64​

Re-exports Base64

BaseChat​

Re-exports BaseChat

BizCategory​

Re-exports BizCategory

BizProfileOptions​

Re-exports BizProfileOptions

BusinessHours​

Re-exports BusinessHours

BusinessProfile​

Re-exports BusinessProfile

CLOUD_PROVIDERS​

Re-exports CLOUD_PROVIDERS

Call​

Re-exports Call

CallState​

Re-exports CallState

CartItem​

Re-exports CartItem

Chat​

Re-exports Chat

ChatId​

Re-exports ChatId

ChatMuteDuration​

Re-exports ChatMuteDuration

ChatServer​

Re-exports ChatServer

ChatState​

Re-exports ChatState

ChatTypes​

Re-exports ChatTypes

ConfigObject​

Re-exports ConfigObject

Contact​

Re-exports Contact

ContactId​

Re-exports ContactId

Content​

Re-exports Content

CountryCode​

Re-exports CountryCode

CustomError​

Re-exports CustomError

CustomProduct​

Re-exports CustomProduct

DIRECTORY_STRATEGY​

Re-exports DIRECTORY_STRATEGY

DataURL​

Re-exports DataURL

DevTools​

Re-exports DevTools

ERROR_NAME​

Re-exports ERROR_NAME

EphemeralDuration​

Re-exports EphemeralDuration

EventPayload​

Re-exports EventPayload

FilePath​

Re-exports FilePath

GetURL​

Re-exports GetURL

GroupChat​

Re-exports GroupChat

GroupChatCreationParticipantAddResponse​

Re-exports GroupChatCreationParticipantAddResponse

GroupChatCreationResponse​

Re-exports GroupChatCreationResponse

GroupChatId​

Re-exports GroupChatId

GroupChatServer​

Re-exports GroupChatServer

GroupId​

Re-exports GroupId

Label​

Re-exports Label

LicenseType​

Re-exports LicenseType

LiveLocationChangedEvent​

Re-exports LiveLocationChangedEvent

Message​

Re-exports Message

MessageAck​

Re-exports MessageAck

MessageId​

Re-exports MessageId

MessageInfo​

Re-exports MessageInfo

MessageInfoInteraction​

Re-exports MessageInfoInteraction

MessageTypes​

Re-exports MessageTypes

Mp4StickerConversionProcessOptions​

Re-exports Mp4StickerConversionProcessOptions

NonSerializedId​

Re-exports NonSerializedId

NotificationLanguage​

Re-exports NotificationLanguage

NumberCheck​

Re-exports NumberCheck

OnError​

Re-exports OnError

Order​

Re-exports Order

PageEvaluationTimeout​

Re-exports PageEvaluationTimeout

PollData​

Re-exports PollData

PollOption​

Re-exports PollOption

PollVote​

Re-exports PollVote

Product​

Re-exports Product

ProxyServerCredentials​

Re-exports ProxyServerCredentials

QRFormat​

Re-exports QRFormat

QRQuality​

Re-exports QRQuality

QuoteMap​

Re-exports QuoteMap

Reaction​

Re-exports Reaction

ReactionEvent​

Re-exports ReactionEvent

ReactionRecord​

Re-exports ReactionRecord

ReactionSender​

Re-exports ReactionSender

SessionData​

Re-exports SessionData

SessionExpiredError​

Re-exports SessionExpiredError

SimpleListener​

Re-exports SimpleListener

SingleChat​

Re-exports SingleChat

StickerMetadata​

Re-exports StickerMetadata

WaServers​

Re-exports WaServers

Webhook​

Re-exports Webhook

defaultProcessOptions​

Re-exports defaultProcessOptions

- + \ No newline at end of file diff --git a/docs/api/modules/api_model_aliases.html b/docs/api/modules/api_model_aliases.html index 3a0dc255f0..4c434468d8 100644 --- a/docs/api/modules/api_model_aliases.html +++ b/docs/api/modules/api_model_aliases.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_button.html b/docs/api/modules/api_model_button.html index 3e86c086bd..ae0fbd4eca 100644 --- a/docs/api/modules/api_model_button.html +++ b/docs/api/modules/api_model_button.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_call.html b/docs/api/modules/api_model_call.html index 6d3a17584f..4686bfe766 100644 --- a/docs/api/modules/api_model_call.html +++ b/docs/api/modules/api_model_call.html @@ -14,13 +14,13 @@ - +

Module: api/model/call

Enumerations​

Interfaces​

- + \ No newline at end of file diff --git a/docs/api/modules/api_model_chat.html b/docs/api/modules/api_model_chat.html index c9d6139fec..a9e43265f0 100644 --- a/docs/api/modules/api_model_chat.html +++ b/docs/api/modules/api_model_chat.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_config.html b/docs/api/modules/api_model_config.html index 168e682dee..cccfe038fe 100644 --- a/docs/api/modules/api_model_config.html +++ b/docs/api/modules/api_model_config.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_contact.html b/docs/api/modules/api_model_contact.html index 17f8bdaf9f..ede7c3d349 100644 --- a/docs/api/modules/api_model_contact.html +++ b/docs/api/modules/api_model_contact.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_errors.html b/docs/api/modules/api_model_errors.html index 113ffb14f6..c8126f58d0 100644 --- a/docs/api/modules/api_model_errors.html +++ b/docs/api/modules/api_model_errors.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_events.html b/docs/api/modules/api_model_events.html index 35e5957b10..40a4ae05ee 100644 --- a/docs/api/modules/api_model_events.html +++ b/docs/api/modules/api_model_events.html @@ -14,13 +14,13 @@ - +

Module: api/model/events

Enumerations​

- + \ No newline at end of file diff --git a/docs/api/modules/api_model_group_metadata.html b/docs/api/modules/api_model_group_metadata.html index 91aac62ebc..1c30b5de2d 100644 --- a/docs/api/modules/api_model_group_metadata.html +++ b/docs/api/modules/api_model_group_metadata.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_id.html b/docs/api/modules/api_model_id.html index 093b4e892d..b24e04413c 100644 --- a/docs/api/modules/api_model_id.html +++ b/docs/api/modules/api_model_id.html @@ -14,13 +14,13 @@ - +

Module: api/model/id

Interfaces​

- + \ No newline at end of file diff --git a/docs/api/modules/api_model_label.html b/docs/api/modules/api_model_label.html index 302202badf..40d443d46d 100644 --- a/docs/api/modules/api_model_label.html +++ b/docs/api/modules/api_model_label.html @@ -14,13 +14,13 @@ - +

Module: api/model/label

Interfaces​

- + \ No newline at end of file diff --git a/docs/api/modules/api_model_media.html b/docs/api/modules/api_model_media.html index f887546a3f..ac5bbfd9eb 100644 --- a/docs/api/modules/api_model_media.html +++ b/docs/api/modules/api_model_media.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_message.html b/docs/api/modules/api_model_message.html index 259ccf17cb..4e579eac60 100644 --- a/docs/api/modules/api_model_message.html +++ b/docs/api/modules/api_model_message.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_product.html b/docs/api/modules/api_model_product.html index aae433f77c..51fbb79d2a 100644 --- a/docs/api/modules/api_model_product.html +++ b/docs/api/modules/api_model_product.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_reactions.html b/docs/api/modules/api_model_reactions.html index 2c34fe7169..fb04b3db03 100644 --- a/docs/api/modules/api_model_reactions.html +++ b/docs/api/modules/api_model_reactions.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/api_model_sessionInfo.html b/docs/api/modules/api_model_sessionInfo.html index 09f816ad26..61ba6af2ac 100644 --- a/docs/api/modules/api_model_sessionInfo.html +++ b/docs/api/modules/api_model_sessionInfo.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/connect.html b/docs/api/modules/connect.html index 499ca1aaa1..211d162257 100644 --- a/docs/api/modules/connect.html +++ b/docs/api/modules/connect.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/connect_socket.html b/docs/api/modules/connect_socket.html index cabbe53964..a33833f59e 100644 --- a/docs/api/modules/connect_socket.html +++ b/docs/api/modules/connect_socket.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/controllers_data_dir_watcher.html b/docs/api/modules/controllers_data_dir_watcher.html index 8a997f28fc..0e78ba5f1d 100644 --- a/docs/api/modules/controllers_data_dir_watcher.html +++ b/docs/api/modules/controllers_data_dir_watcher.html @@ -14,13 +14,13 @@ - +

Module: controllers/data_dir_watcher

Functions​

- + \ No newline at end of file diff --git a/docs/api/modules/controllers_events.html b/docs/api/modules/controllers_events.html index 7d90421d6f..cfb34f1747 100644 --- a/docs/api/modules/controllers_events.html +++ b/docs/api/modules/controllers_events.html @@ -14,13 +14,13 @@ - +

Module: controllers/events

Variables​

- + \ No newline at end of file diff --git a/docs/api/modules/controllers_init_patch.html b/docs/api/modules/controllers_init_patch.html index 32030bff20..05b1059891 100644 --- a/docs/api/modules/controllers_init_patch.html +++ b/docs/api/modules/controllers_init_patch.html @@ -14,13 +14,13 @@ - +

Module: controllers/init_patch

- + \ No newline at end of file diff --git a/docs/api/modules/controllers_initializer.html b/docs/api/modules/controllers_initializer.html index 7a281a4b73..115ca47b26 100644 --- a/docs/api/modules/controllers_initializer.html +++ b/docs/api/modules/controllers_initializer.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/controllers_patch_manager.html b/docs/api/modules/controllers_patch_manager.html index 8de59986ed..fe054a731c 100644 --- a/docs/api/modules/controllers_patch_manager.html +++ b/docs/api/modules/controllers_patch_manager.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/logging_custom_transport.html b/docs/api/modules/logging_custom_transport.html index fdf6f35836..73457a10dd 100644 --- a/docs/api/modules/logging_custom_transport.html +++ b/docs/api/modules/logging_custom_transport.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/logging_logging.html b/docs/api/modules/logging_logging.html index 0369cfba8e..22288291f0 100644 --- a/docs/api/modules/logging_logging.html +++ b/docs/api/modules/logging_logging.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/structures_Collector.html b/docs/api/modules/structures_Collector.html index f6ca311793..fa5deb862f 100644 --- a/docs/api/modules/structures_Collector.html +++ b/docs/api/modules/structures_Collector.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/structures_Dialog.html b/docs/api/modules/structures_Dialog.html index 4d069343c4..d4a13aebbe 100644 --- a/docs/api/modules/structures_Dialog.html +++ b/docs/api/modules/structures_Dialog.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/modules/structures_MessageCollector.html b/docs/api/modules/structures_MessageCollector.html index f1396fa8e8..1edacadb67 100644 --- a/docs/api/modules/structures_MessageCollector.html +++ b/docs/api/modules/structures_MessageCollector.html @@ -14,13 +14,13 @@ - +

Module: structures/MessageCollector

Classes​

- + \ No newline at end of file diff --git a/docs/api/modules/structures_preProcessors.html b/docs/api/modules/structures_preProcessors.html index b8567d32bd..ef45044fa0 100644 --- a/docs/api/modules/structures_preProcessors.html +++ b/docs/api/modules/structures_preProcessors.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/api_model.EasyApiResponse.html b/docs/api/types/api_model.EasyApiResponse.html index e66e79cf3d..83db702fb8 100644 --- a/docs/api/types/api_model.EasyApiResponse.html +++ b/docs/api/types/api_model.EasyApiResponse.html @@ -14,13 +14,13 @@ - +

Type alias: EasyApiResponse

api/model.EasyApiResponse

Ƭ EasyApiResponse: Object

Type declaration​

NameType
responseany
successboolean
- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.AccountNumber.html b/docs/api/types/api_model_aliases.AccountNumber.html index f01d7ef145..0ac8c72847 100644 --- a/docs/api/types/api_model_aliases.AccountNumber.html +++ b/docs/api/types/api_model_aliases.AccountNumber.html @@ -14,13 +14,13 @@ - +

Type alias: AccountNumber

api/model/aliases.AccountNumber

Ƭ AccountNumber: `${number}`

The account number. It is made up of a country code and then the local number without the preceeding 0. For example, if a UK (+44) wa account is linked to the number 07123456789 then the account number will be 447123456789.

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.AdvancedFile.html b/docs/api/types/api_model_aliases.AdvancedFile.html index 466379016e..fef2e29ff6 100644 --- a/docs/api/types/api_model_aliases.AdvancedFile.html +++ b/docs/api/types/api_model_aliases.AdvancedFile.html @@ -14,13 +14,13 @@ - +

Type alias: AdvancedFile

api/model/aliases.AdvancedFile

Ƭ AdvancedFile: DataURL | FilePath | GetURL

Some file based actions in open-wa are powerful enough to take a dataurl, url or filepath

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.Base64.html b/docs/api/types/api_model_aliases.Base64.html index 24b074ab96..d39571151b 100644 --- a/docs/api/types/api_model_aliases.Base64.html +++ b/docs/api/types/api_model_aliases.Base64.html @@ -14,13 +14,13 @@ - +

Type alias: Base64

api/model/aliases.Base64

Ƭ Base64: Brand<string, "Base64">

Base64 is basically a file encoded as a string.

Base64 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. The term Base64 originates from a specific MIME content transfer encoding.

Learn more here: https://developer.mozilla.org/en-US/docs/Glossary/Base64

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.ChatId.html b/docs/api/types/api_model_aliases.ChatId.html index b3d94822bc..458426de40 100644 --- a/docs/api/types/api_model_aliases.ChatId.html +++ b/docs/api/types/api_model_aliases.ChatId.html @@ -14,14 +14,14 @@ - +

Type alias: ChatId

api/model/aliases.ChatId

Ƭ ChatId: ContactId | GroupChatId

A chat id ends with @c.us or @g.us for group chats.

Example:

A group chat: "447123456789-1445627445@g.us" A group chat: "447123456789@g.us"

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.ChatServer.html b/docs/api/types/api_model_aliases.ChatServer.html index 1eea971aa1..ca8ec3f6e3 100644 --- a/docs/api/types/api_model_aliases.ChatServer.html +++ b/docs/api/types/api_model_aliases.ChatServer.html @@ -14,13 +14,13 @@ - +

Type alias: ChatServer

api/model/aliases.ChatServer

Ƭ ChatServer: "c.us"

The suffix used to identify a non-group chat id

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.ContactId.html b/docs/api/types/api_model_aliases.ContactId.html index 162b525292..9a1e80e04b 100644 --- a/docs/api/types/api_model_aliases.ContactId.html +++ b/docs/api/types/api_model_aliases.ContactId.html @@ -14,13 +14,13 @@ - +

Type alias: ContactId

api/model/aliases.ContactId

Ƭ ContactId: Brand<`${AccountNumber}@${ChatServer}`, "ContactId">

A contact id ends with @c.us and only contains the number of the contact. For example, if the country code of a contact is 44 and their number is 7123456789 then the contact id would be 447123456789@c.us

Example:

"447123456789@c.us"

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.Content.html b/docs/api/types/api_model_aliases.Content.html index 789dc63675..f5f3010d9b 100644 --- a/docs/api/types/api_model_aliases.Content.html +++ b/docs/api/types/api_model_aliases.Content.html @@ -14,13 +14,13 @@ - +

Type alias: Content

api/model/aliases.Content

Ƭ Content: Brand<string, "Content">

This is a generic type alias for the content of a message

Example:

"hello!"

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.CountryCode.html b/docs/api/types/api_model_aliases.CountryCode.html index 4524d57b23..d00bd2bfa4 100644 --- a/docs/api/types/api_model_aliases.CountryCode.html +++ b/docs/api/types/api_model_aliases.CountryCode.html @@ -14,13 +14,13 @@ - +

Type alias: CountryCode

api/model/aliases.CountryCode

Ƭ CountryCode: 1 | 7 | 20 | 27 | 30 | 31 | 32 | 33 | 34 | 36 | 39 | 40 | 41 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 81 | 82 | 84 | 86 | 90 | 91 | 92 | 93 | 94 | 95 | 98 | 211 | 212 | 213 | 216 | 218 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 290 | 291 | 297 | 298 | 299 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 370 | 371 | 372 | 373 | 374 | 375 | 376 | 377 | 378 | 380 | 381 | 382 | 383 | 385 | 386 | 387 | 389 | 420 | 421 | 423 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 509 | 590 | 591 | 592 | 593 | 594 | 595 | 596 | 597 | 598 | 599 | 670 | 672 | 673 | 674 | 675 | 676 | 677 | 678 | 679 | 680 | 681 | 682 | 683 | 685 | 686 | 687 | 688 | 689 | 690 | 691 | 692 | 850 | 852 | 853 | 855 | 856 | 880 | 886 | 960 | 961 | 962 | 963 | 964 | 965 | 966 | 967 | 968 | 970 | 971 | 972 | 973 | 974 | 975 | 976 | 977 | 992 | 993 | 994 | 995 | 996 | 998

Type alias representing all available country codes

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.DataURL.html b/docs/api/types/api_model_aliases.DataURL.html index 89dbb9850f..a473a7e8ad 100644 --- a/docs/api/types/api_model_aliases.DataURL.html +++ b/docs/api/types/api_model_aliases.DataURL.html @@ -14,14 +14,14 @@ - +

Type alias: DataURL

api/model/aliases.DataURL

Ƭ DataURL: Brand<`data:${string};base64,${Base64}`, "DataURL">

Data URLs, URLs prefixed with the data: scheme, allow content creators to embed small files inline in documents. They were formerly known as "data URIs" until that name was retired by the WHATWG.

Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself:

Example: "data:[<mediatype>][;base64],<data>"

Learn more here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.FilePath.html b/docs/api/types/api_model_aliases.FilePath.html index 53bd18c516..28158b221f 100644 --- a/docs/api/types/api_model_aliases.FilePath.html +++ b/docs/api/types/api_model_aliases.FilePath.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.GetURL.html b/docs/api/types/api_model_aliases.GetURL.html index f24cd20139..3588743b89 100644 --- a/docs/api/types/api_model_aliases.GetURL.html +++ b/docs/api/types/api_model_aliases.GetURL.html @@ -14,13 +14,13 @@ - +

Type alias: GetURL

api/model/aliases.GetURL

Ƭ GetURL: Brand<string, "GetURL">

A URL of a file used with a GET request

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.GroupChatId.html b/docs/api/types/api_model_aliases.GroupChatId.html index 468e81b365..3312553b3f 100644 --- a/docs/api/types/api_model_aliases.GroupChatId.html +++ b/docs/api/types/api_model_aliases.GroupChatId.html @@ -14,13 +14,13 @@ - +

Type alias: GroupChatId

api/model/aliases.GroupChatId

Ƭ GroupChatId: `${AccountNumber}-${number}@${GroupChatServer}` | GroupId

A group chat ends with @g.us and usually has two parts, the timestamp of when it was created, and the user id of the number that created the group. For example [creator number]-[timestamp]@g.us

Example:

"447123456789-1445627445@g.us"

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.GroupChatServer.html b/docs/api/types/api_model_aliases.GroupChatServer.html index 3befb1387d..a82198750d 100644 --- a/docs/api/types/api_model_aliases.GroupChatServer.html +++ b/docs/api/types/api_model_aliases.GroupChatServer.html @@ -14,13 +14,13 @@ - +

Type alias: GroupChatServer

api/model/aliases.GroupChatServer

Ƭ GroupChatServer: "g.us"

The suffix used to identify a group chat id

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.GroupId.html b/docs/api/types/api_model_aliases.GroupId.html index 53ccf3b61e..9b1344f438 100644 --- a/docs/api/types/api_model_aliases.GroupId.html +++ b/docs/api/types/api_model_aliases.GroupId.html @@ -14,13 +14,13 @@ - +

Type alias: GroupId

api/model/aliases.GroupId

Ƭ GroupId: `${number}@${GroupChatServer}`

A new group or community has the format of a random number followed by @g.us

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.MessageId.html b/docs/api/types/api_model_aliases.MessageId.html index 68f917b7de..bf107ad1d6 100644 --- a/docs/api/types/api_model_aliases.MessageId.html +++ b/docs/api/types/api_model_aliases.MessageId.html @@ -14,13 +14,13 @@ - +

Type alias: MessageId

api/model/aliases.MessageId

Ƭ MessageId: Brand<`${boolean}_${ChatId}_${string}`, "MessageId">

The id of a message. The format is [boolean]_[ChatId]_[random character string]

Example:

"false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"

- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.NonSerializedId.html b/docs/api/types/api_model_aliases.NonSerializedId.html index 71a7252c03..b493389ece 100644 --- a/docs/api/types/api_model_aliases.NonSerializedId.html +++ b/docs/api/types/api_model_aliases.NonSerializedId.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/api_model_aliases.WaServers.html b/docs/api/types/api_model_aliases.WaServers.html index 7013d42b48..1892919618 100644 --- a/docs/api/types/api_model_aliases.WaServers.html +++ b/docs/api/types/api_model_aliases.WaServers.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/api_model_chat.Chat.html b/docs/api/types/api_model_chat.Chat.html index f1274309f9..d5c284c749 100644 --- a/docs/api/types/api_model_chat.Chat.html +++ b/docs/api/types/api_model_chat.Chat.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/api_model_chat.EphemeralDuration.html b/docs/api/types/api_model_chat.EphemeralDuration.html index d7737992e9..58f8ec4e16 100644 --- a/docs/api/types/api_model_chat.EphemeralDuration.html +++ b/docs/api/types/api_model_chat.EphemeralDuration.html @@ -14,13 +14,13 @@ - +

Type alias: EphemeralDuration

api/model/chat.EphemeralDuration

Ƭ EphemeralDuration: 86400 | 604800 | 7776000

Ephemeral duration can be 1 day, 7 days or 90 days. The default is 1 day.

- + \ No newline at end of file diff --git a/docs/api/types/api_model_config.AdvancedConfig.html b/docs/api/types/api_model_config.AdvancedConfig.html index 5cee9f5124..d4f5be066c 100644 --- a/docs/api/types/api_model_config.AdvancedConfig.html +++ b/docs/api/types/api_model_config.AdvancedConfig.html @@ -14,13 +14,13 @@ - +

Type alias: AdvancedConfig

api/model/config.AdvancedConfig

Ƭ AdvancedConfig: ConfigObject & { licenseKey: LicenseKeyConfig }

- + \ No newline at end of file diff --git a/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions.html b/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions.html index b955a54819..9de53d86a5 100644 --- a/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions.html +++ b/docs/api/types/api_model_media.Mp4StickerConversionProcessOptions.html @@ -14,13 +14,13 @@ - +

Type alias: Mp4StickerConversionProcessOptions

api/model/media.Mp4StickerConversionProcessOptions

Ƭ Mp4StickerConversionProcessOptions: Object

Type declaration​

NameTypeDescription
crop?booleanCentres and crops the video. default true
endTime?stringThe video end time of the sticker. By default, stickers are made from the first 5 seconds of the video Default 00:00:05.0
fps?numberDesired Frames per second of the sticker output Default 10
log?booleanPrints ffmpeg logs in the terminal Default false
loop?numberThe amount of times the video loops in the sticker. To save processing time, leave this as 0 default 0
square?numberA number representing the WxH of the output sticker (default 512x512). Lowering this number is a great way to process longer duration stickers. The max value is 512. default 512
startTime?stringThe video start time of the sticker Default 00:00:00.0
- + \ No newline at end of file diff --git a/docs/api/types/api_model_media.StickerMetadata.html b/docs/api/types/api_model_media.StickerMetadata.html index 31ce6941fa..0bdbd312ae 100644 --- a/docs/api/types/api_model_media.StickerMetadata.html +++ b/docs/api/types/api_model_media.StickerMetadata.html @@ -14,13 +14,13 @@ - +

Type alias: StickerMetadata

api/model/media.StickerMetadata

Ƭ StickerMetadata: Object

Type declaration​

NameTypeDescription
authorstringThe author of the sticker Default ``
circle?booleanApplies a circular mask to the sticker. Works on images only for now.
cornerRadius?numberThe corner radius of the sticker when stickerMetadata.circle is set to true. Default 100 Minimum 1 Maximum 100 Multiple Of 1
cropPosition?"top" | "right top" | "right" | "right bottom" | "bottom" | "left bottom" | "left" | "left top" | "north" | "northeast" | "east" | "southeast" | "south" | "southwest" | "west" | "northwest" | "center" | "centre" | "entropy" | "attention"Crop position Learn more: https://sharp.pixelplumbing.com/api-resize Default attention
discord?stringYour Discord ID to get onto the sticker leaderboard!
keepScale?booleanSetting this to true will skip the resizing/square-cropping of the sticker. It will instead 'letterbox' the image with a transparent background.
packstringThe pack of the sticker Default ``
removebg?boolean | "HQ"ALPHA FEATURE - NO GUARANTEES IT WILL WORK AS EXPECTED: REQUIRES AN INSIDERS LICENSE-KEY Attempt to remove the background of the sticker. Only valid for paid licenses. options: true - remove background after resizing HQ - remove background before resizing (i.e on original photo) Default false
- + \ No newline at end of file diff --git a/docs/api/types/api_model_reactions.Reaction.html b/docs/api/types/api_model_reactions.Reaction.html index 47baa2a996..ad5eddda00 100644 --- a/docs/api/types/api_model_reactions.Reaction.html +++ b/docs/api/types/api_model_reactions.Reaction.html @@ -14,13 +14,13 @@ - +

Type alias: Reaction

api/model/reactions.Reaction

Ƭ Reaction: Object

A reaction is identified the specific emoji.

Type declaration​

NameTypeDescription
aggregateEmojistringThe aggregate emoji used for the reaction.
hasReactionByMebooleanIf the reaction is also sent by the host account
idstringThe identifier of the reaction
sendersReactionRecord[]The senders of this spefcific reaction
- + \ No newline at end of file diff --git a/docs/api/types/api_model_reactions.ReactionEvent.html b/docs/api/types/api_model_reactions.ReactionEvent.html index 78a3417b4e..cc66c0d8e8 100644 --- a/docs/api/types/api_model_reactions.ReactionEvent.html +++ b/docs/api/types/api_model_reactions.ReactionEvent.html @@ -14,13 +14,13 @@ - +

Type alias: ReactionEvent

api/model/reactions.ReactionEvent

Ƭ ReactionEvent: Object

Emitted by onReaction

Type declaration​

NameTypeDescription
messageMessageThe message being reacted to
reactionByMeReactionThe reaction sent by the host account
reactionsReaction[]An array of all reactions
type"add" | "change"The type of the reaction event.
- + \ No newline at end of file diff --git a/docs/api/types/api_model_reactions.ReactionRecord.html b/docs/api/types/api_model_reactions.ReactionRecord.html index 499e9d29da..5d18484a8c 100644 --- a/docs/api/types/api_model_reactions.ReactionRecord.html +++ b/docs/api/types/api_model_reactions.ReactionRecord.html @@ -14,13 +14,13 @@ - +

Type alias: ReactionRecord

api/model/reactions.ReactionRecord

Ƭ ReactionRecord: Object

The specific reaction by a user

Type declaration​

NameTypeDescription
ackMessageAckThe acknowledgement of the reaction
idstringThe ID of the reaction
msgKeystring-
orphannumber-
parentMsgKeystring-
reactionTextstringThe text of the reaction
readbooleanIf the reaction has been read
senderUserJidContactIdThe ID of the reaction sender
timestampnumberThe timestamp of the reaction
- + \ No newline at end of file diff --git a/docs/api/types/connect.Client.html b/docs/api/types/connect.Client.html index 40486e9bd9..c2d946d9cb 100644 --- a/docs/api/types/connect.Client.html +++ b/docs/api/types/connect.Client.html @@ -14,13 +14,13 @@ - +

Type alias: Client

connect.Client

Ƭ Client: _Client

- + \ No newline at end of file diff --git a/docs/api/types/connect.ClientMethods.html b/docs/api/types/connect.ClientMethods.html index be3db5cb87..389b9b0344 100644 --- a/docs/api/types/connect.ClientMethods.html +++ b/docs/api/types/connect.ClientMethods.html @@ -14,13 +14,13 @@ - +

Type alias: ClientMethods

connect.ClientMethods

Ƭ ClientMethods: keyof _Client

A convenience type that includes all keys from the Client.

- + \ No newline at end of file diff --git a/docs/api/types/connect.CollectorFilter.html b/docs/api/types/connect.CollectorFilter.html index 9e4d77b0e6..1da15fe286 100644 --- a/docs/api/types/connect.CollectorFilter.html +++ b/docs/api/types/connect.CollectorFilter.html @@ -14,13 +14,13 @@ - +

Type alias: CollectorFilter<T>

connect.CollectorFilter

Ƭ CollectorFilter<T>: (...args: T) => boolean | Promise<boolean>

Type parameters​

NameType
Textends any[]

Type declaration​

▸ (...args): boolean | Promise<boolean>

Filter to be applied to the collector.

Parameters​
NameTypeDescription
...argsTAny arguments received by the listener
Returns​

boolean | Promise<boolean>

- + \ No newline at end of file diff --git a/docs/api/types/connect_socket.ClientMethods.html b/docs/api/types/connect_socket.ClientMethods.html index 031357ef6d..99151e21e2 100644 --- a/docs/api/types/connect_socket.ClientMethods.html +++ b/docs/api/types/connect_socket.ClientMethods.html @@ -14,13 +14,13 @@ - +

Type alias: ClientMethods

connect/socket.ClientMethods

Ƭ ClientMethods: keyof Client

A convenience type that includes all keys from the Client.

- + \ No newline at end of file diff --git a/docs/api/types/logging_logging.ConfigLogTransport.html b/docs/api/types/logging_logging.ConfigLogTransport.html index d515a9e15d..b03a709a36 100644 --- a/docs/api/types/logging_logging.ConfigLogTransport.html +++ b/docs/api/types/logging_logging.ConfigLogTransport.html @@ -14,13 +14,13 @@ - +

Type alias: ConfigLogTransport

logging/logging.ConfigLogTransport

Ƭ ConfigLogTransport: Object

Type declaration​

NameTypeDescription
done?booleanIf the transport has already been added to the logger. The logging set up command handles this for you.
options?anyThe options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports.
type"syslog" | "console" | "file" | "ev"The type of winston transport. At the moment only file, console, ev and syslog are supported.
- + \ No newline at end of file diff --git a/docs/api/types/structures_Collector.CollectorFilter.html b/docs/api/types/structures_Collector.CollectorFilter.html index f123bec3f4..5471647908 100644 --- a/docs/api/types/structures_Collector.CollectorFilter.html +++ b/docs/api/types/structures_Collector.CollectorFilter.html @@ -14,13 +14,13 @@ - +

Type alias: CollectorFilter<T>

structures/Collector.CollectorFilter

Ƭ CollectorFilter<T>: (...args: T) => boolean | Promise<boolean>

Type parameters​

NameType
Textends any[]

Type declaration​

▸ (...args): boolean | Promise<boolean>

Filter to be applied to the collector.

Parameters​
NameTypeDescription
...argsTAny arguments received by the listener
Returns​

boolean | Promise<boolean>

- + \ No newline at end of file diff --git a/docs/api/types/structures_Dialog.CheckFunction.html b/docs/api/types/structures_Dialog.CheckFunction.html index 9c55adf314..795905835a 100644 --- a/docs/api/types/structures_Dialog.CheckFunction.html +++ b/docs/api/types/structures_Dialog.CheckFunction.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/structures_preProcessors.MPConfigType.html b/docs/api/types/structures_preProcessors.MPConfigType.html index 0d9d84f3b6..842e6aa383 100644 --- a/docs/api/types/structures_preProcessors.MPConfigType.html +++ b/docs/api/types/structures_preProcessors.MPConfigType.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/types/structures_preProcessors.MessagePreProcessor.html b/docs/api/types/structures_preProcessors.MessagePreProcessor.html index d7011de147..eb4044eac2 100644 --- a/docs/api/types/structures_preProcessors.MessagePreProcessor.html +++ b/docs/api/types/structures_preProcessors.MessagePreProcessor.html @@ -14,13 +14,13 @@ - +

Type alias: MessagePreProcessor

structures/preProcessors.MessagePreProcessor

Ƭ MessagePreProcessor: (message: Message, client?: Client, alreadyProcessed?: boolean) => Promise<Message>

Type declaration​

▸ (message, client?, alreadyProcessed?): Promise<Message>

A function that takes a message and returns a message.

Parameters​
NameTypeDescription
messageMessageThe message to be processed
client?ClientThe client that received the message
alreadyProcessed?booleanWhether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)
Returns​

Promise<Message>

- + \ No newline at end of file diff --git a/docs/api/variables/api_Client.useragent.html b/docs/api/variables/api_Client.useragent.html index dc1531d191..33b71d4b7f 100644 --- a/docs/api/variables/api_Client.useragent.html +++ b/docs/api/variables/api_Client.useragent.html @@ -14,13 +14,13 @@ - +

Variable: useragent

api/Client.useragent

• Const useragent: string

- + \ No newline at end of file diff --git a/docs/api/variables/api_model_media.defaultProcessOptions.html b/docs/api/variables/api_model_media.defaultProcessOptions.html index 91f684a481..11254cc0fb 100644 --- a/docs/api/variables/api_model_media.defaultProcessOptions.html +++ b/docs/api/variables/api_model_media.defaultProcessOptions.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/variables/controllers_events.ev.html b/docs/api/variables/controllers_events.ev.html index d51b4087db..0408dd423c 100644 --- a/docs/api/variables/controllers_events.ev.html +++ b/docs/api/variables/controllers_events.ev.html @@ -14,13 +14,13 @@ - +

Variable: ev

controllers/events.ev

• Const ev: EventEmitter2

This is the library's event emitter. Use this to listen to internal events of the library like so:

ev.on('event', callback)

The event you want to listen to is in the format of [namespace].[sessionId]

The event can include wildcards.

For example, to listen to all qr code events, the event will be qr.**. e.g:

ev.on('qr.**',...

Listen to all sessionData events

ev.on('sessionData.**',...

Listen to all events from session1

ev.on('**.session1',...

Listen to all events

ev.on('**.**',...

ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces

ev.on('**.**', (data, sessionId, namespace) => {

 console.log(`${namespace} event detected for session ${sessionId}`, data)

});
- + \ No newline at end of file diff --git a/docs/api/variables/controllers_initializer.configWithCases.html b/docs/api/variables/controllers_initializer.configWithCases.html index 7b09dd93c1..f073cfcb26 100644 --- a/docs/api/variables/controllers_initializer.configWithCases.html +++ b/docs/api/variables/controllers_initializer.configWithCases.html @@ -14,13 +14,13 @@ - +

Variable: configWithCases

controllers/initializer.configWithCases

• Const configWithCases: any

- + \ No newline at end of file diff --git a/docs/api/variables/controllers_initializer.pkg.html b/docs/api/variables/controllers_initializer.pkg.html index ba43191b28..3fc8776891 100644 --- a/docs/api/variables/controllers_initializer.pkg.html +++ b/docs/api/variables/controllers_initializer.pkg.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/variables/controllers_initializer.screenshot.html b/docs/api/variables/controllers_initializer.screenshot.html index 75edfc8c0e..6eb2ff5d15 100644 --- a/docs/api/variables/controllers_initializer.screenshot.html +++ b/docs/api/variables/controllers_initializer.screenshot.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/api/variables/logging_logging.log.html b/docs/api/variables/logging_logging.log.html index 12d30ebcd8..adce64c767 100644 --- a/docs/api/variables/logging_logging.log.html +++ b/docs/api/variables/logging_logging.log.html @@ -14,7 +14,7 @@ - + @@ -22,7 +22,7 @@

Variable: log

logging/logging.log

• Const log: Logger

You can access the log in your code and add your own custom transports https://github.com/winstonjs/winston#transports see Logger for more details.

Here is an example of adding the GCP stackdriver transport:

import { log } from '@open-wa/wa-automate'
import { LoggingWinston } from '@google-cloud/logging-winston';

const gcpTransport = new LoggingWinston({
    projectId: 'your-project-id',
    keyFilename: '/path/to/keyfile.json'
  });

...
log.add(
 gcpTransport
)

//Congrats! Now all of your session logs will also go to GCP Stackdriver
- + \ No newline at end of file diff --git a/docs/api/variables/structures_preProcessors.MessagePreprocessors.html b/docs/api/variables/structures_preProcessors.MessagePreprocessors.html index 25ad675189..739bc70d2e 100644 --- a/docs/api/variables/structures_preProcessors.MessagePreprocessors.html +++ b/docs/api/variables/structures_preProcessors.MessagePreprocessors.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/concepts/glossary.html b/docs/concepts/glossary.html index a8349e47f9..bf936b908a 100644 --- a/docs/concepts/glossary.html +++ b/docs/concepts/glossary.html @@ -14,13 +14,13 @@ - +

Glossary of terms

Session​

A session refers to a Client with a set [ConfigObject.sessionId]. The concept of a session transcends individual process instances. The sessionId is the unique identifier of the session and is the property which tells the open-wa process which re-authentication data (Session Data) to use to bring back a session without needing to re-scan the QR code.

Host Account​

A host account is essentially just a WA account which is used to authenticate a session. Sometimes you will see the term host account device, this refers to the specific mobile device that is used to scan the QR code

Head/headless/headful​

The concept of a head is widely used in many different computer-related contexts. In this context, head refers to the visual graphical chrome interface (as you would see with a monitor). By default, open-wa runs headless, meaning you can run the process which will spawn a browser instance which you cannot see. On the otherhand, you can set [ConfigObject.headless] to false in order to spwan a headful browser which you can interact with.

caution

If you set [ConfigObject.headless] to false on a VM which is headless itself (i.e there is no GUI for the VM), it will cause the process to error out.

Re-scan (rescan)​

A Re-scan (or rescan) refers to the end user action of having to scan the qr code after having already done it previously for that specific session ID in the same working directory. Sometimes you will have to re-scan when using MD because MD authentication state is tempremental at best. You will also have to re-scan if the host account device has logged out of the session.

Re-auth (reauth)​

A Re-auth (or reauth) refers to the library logging in to a session which has already been scanned/authenticated. The goal of this library is to consistently reauth a session. However, sometimes the library is not able to reauth. Re-auth is something the library attempts to do, whereas a re-scan is an end user action.

Session Data​

The Session Data refers to the data that is used to bring a session back online without having to re-scan the QR code. Session Data is portable for [Legacy] accounts. A session data file refers to a file that contains the session data, you can recognise a session data file by the file extension of data.json. If the session Id is "personal" the session data file will be personal.data.json.

Session Portability​

Session Portability refers to the ability for a session to be easily moved from one machine to another without the need to re-auth. This is acheived by moving the session data file and then re-starting the session process with the correct session ID.

note

Multi-device sessions are NOT portable. Track Please track [##2338] to see when MD sessions become portable.

Legacy​

Legacy refers to the original method of authenticating a session - where only one session can be "live" at a time and the host account device had to be connected to the internet to keep the session state connected. It is called "legacy" because we expect this method of extra device connection to be phased out in favour for MD.

MD (Multi-Device)​

Multi-device (or MD) (sessions), on the other hand refer to sessions (or host account devices) that have MD enabled. Currently, MD is opt-in via the beta. In the future, we expect this to be the default method of connecting extra devices to your host account. MD sessions do not require the host account device to be online.

caution

MD is missing several key features out of the box. MD sessions are not portable. If you move between browsers or machines, you WILL have to reauth. Please test it out before determining if it is right for you.

The IGNORE folder​

Although MD sessions are not portable, you shouldn't need to reauth in-place once set up. In order to bring the session back online, the library creates & uses an IGNORE folder, the reason it's called an IGNORE folder is because it's a folder that you should add to your .gitignore and it's formatted as IGNORE_[sessionId]. This folder houses all of the important data required for the browser to resurrect your authenticated session. These fodlers are extremely tempremental and any tampering can render them useless. These folders are locked to a specific machine and a specific browser instance - meaning you have to make sure you use the same browser and machine that the folder was originally created with.

tip

If you're constantly needing to reauth a session, delete this folder and then try again.

The EASY API / CLI​

TermMeaningContext
SessionAn instance of the ClientA
Host AccountA WA account that is used to authenticate a session``
- + \ No newline at end of file diff --git a/docs/concepts/how-it-works.html b/docs/concepts/how-it-works.html index 776c518b49..84f4c5bb5d 100644 --- a/docs/concepts/how-it-works.html +++ b/docs/concepts/how-it-works.html @@ -14,13 +14,13 @@ - +

How does this work?

wa-automate works by automating a chrome/chromium browser process, injecting some code into the web page and exposing functionality through the "Client". Think of it like a robot sitting in front of your whatsapp web and you're controlling that robot with an API or via code.

- + \ No newline at end of file diff --git a/docs/configuration/capture-qr.html b/docs/configuration/capture-qr.html index 3dec417b0f..b73cef37e1 100644 --- a/docs/configuration/capture-qr.html +++ b/docs/configuration/capture-qr.html @@ -14,13 +14,13 @@ - +

Capturing QR Code

An event is emitted every time the QR code is received by the system. You can grab hold of this event emitter by importing ev. You can capture this qr code and save it to a file.

import { ev } from '@open-wa/wa-automate';
const fs = require('fs');

ev.on('qr.**', async qrcode => {
  //qrcode is base64 encoded qr code image
  //now you can do whatever you want with it
  const imageBuffer = Buffer.from(
    qrcode.replace('data:image/png;base64,', ''),
    'base64'
  );
  fs.writeFileSync('qr_code.png', imageBuffer);
});
- + \ No newline at end of file diff --git a/docs/configuration/capture-sd.html b/docs/configuration/capture-sd.html index 660804d781..6e5f8e1461 100644 --- a/docs/configuration/capture-sd.html +++ b/docs/configuration/capture-sd.html @@ -14,13 +14,13 @@ - +

Capturing the session data

By default, the session data is saved as a [sessionId].data.json file in the process working directory, however, you can disable this ([ConfigObject.skipSessionSave]) and implement a custom handler for session data. It is important that you always update session data with the latest values. The default behaviour is to override the data.json file with the latest session data.

import { ev } from '@open-wa/wa-automate';
const fs = require('fs');

ev.on('sessionData.**', async (sessionData, sessionId) => {
    //do something with sessionData and sessionId
});
- + \ No newline at end of file diff --git a/docs/configuration/command-line-options.html b/docs/configuration/command-line-options.html index a6e305ff7d..b1a69bf40a 100644 --- a/docs/configuration/command-line-options.html +++ b/docs/configuration/command-line-options.html @@ -14,13 +14,13 @@ - +

EASY API CLI options

Options​

OptionTypeDescription
--no-apibooleanDon't expose the api. This may be useful if you just want to set the webhooks. (default: false)
--bot-press-urlstringThe Botpress URL that ends with your bot id.
--twilio-webhookstringSend twillio payloads to this URL. EASY API will also parse and processes twillio response message payloads.
--chatwoot-urlstringThe URL of the specific Chatwoot inbox you set up for this session
--chatwoot-api-access-tokenstringThe access token of the specific Chatwoot inbox you set up for this session
--force-update-cw-webhookbooleanUpdates the chatwoot inbox webhook with the --api-host value on every launch (default: false)
--portnumberSet the port for the api. Default to 8002. (default: 8002)
--forcePortnumberSometimes --port is overridden by environmental variables or the config file. Use this flag to force the port to be used.
--api-hoststringThe easy API may be sitting behind a reverse proxy. In this case set --api-host in order to make sure the api docs and api explorer are working properly. You will need to include the protocol as well.
--hoststringSet the hostname for the api documantation and statistics. Overrides --api-host. Default: localhost. (default: localhost)
--webhookstringWebhook to use for the listeners.
--verbosebooleanEnable console transport for internal logger. (default: false)
--evstringSend launch events to this URL.
--efstringFilters which namespaces trigger the webhook set in -e/--ev. (default: qr,STARTUP,MD_DETECT,qrUrl)
--allow-session-data-whbooleanBy default, if you set -e flag, the session data is not transferred to the webhook as it is extremely sensitive data. In order to bypass this security measure, use this flag. (default: false)
--keystringSpecify an api key to use as a check for all requests. If you add -k by itself, a key will be autogenerated for you.
--configstringThe relative json file that contains the config. By default the system will look for cli.config.json which will override any config variables set. Default: './cli.config.json'.
--sessionstringA base64 string representing the session data.
--keep-alivebooleanIf true, the system will force the session to refocus in this process. This will prevent you from opening a session elsewhere.
--use-session-id-in-pathbooleanIf true, all API paths will include the session id. default to false and the default session Id is 'session'.
--generate-api-docsbooleanGenerate postman collection and expose api docs to open in browser. (default: true)
--session-data-onlybooleanKill the process when the session data is saved. (default: false)
--skip-save-postman-collectionbooleanDon't save the postman collection. (default: false)
--headfulbooleanShow the browser window on your machine. (default: false)
--pre-auth-docsbooleanPre authenticate documentation site [High security risk].
--statsbooleanExposes API swagger-statistics. (default: false)
--pre-auth-docsbooleanGrab config options from the environment variables. (default: false)
--no-kill-on-logoutbooleanKeeps the process alive when host account logs out of session. default is false (default: false)
--debugbooleanPrint out the CLI flag values and the WA_* env vars. default is false (default: false)
--corsbooleanEnable all cors requests (default: false)
--socketbooleanExpose a socket.io middleware on the server. (default: false)
--license-keystringThe license key you want to use for this server. License keys are used to unlock features. Learn more here https://github.com/open-wa/wa-automate-nodejs#license-key
--ready-webhookstringWebhook that fires when the EASY API is completely ready
--on-callstringA default message to send to any number that is trying to call the host account
--auto-rejectbooleanAutomatically reject incoming phone and video calls to the host account.
--emit-unreadbooleanEmit all unread messages via onMessage webhooks on launch. (default: false)
--skip-url-checkbooleanDon't validate webhook URLs. Enables use of non-FQDNs.
--tunnelbooleanExpose a tunnel to your EASY API session - this is for testing and it is unsecured. By default it will use a random cloudflare tunnel URL. Make sure you have cloudflared installed and running.
--cf-tunnel-host-domainstringIf you have a domain set up in a cloudflare account and have run cloudflared login on your machine, you can use this to expose the tunnel on your own domain. For example, if you set --cf-tunnel-host-domain mycool.site, the tunnel will be exposed on https://session_id_owa.mycool.site
--cf-tunnel-namespacestringYou can set a sub-subdomain namespace on which the tunnel will be exposed. Needs to be set in conjunction with --tunnel & --cf-tunnel-host-domain. For example, if you set --cf-tunnel-namespace owa, the tunnel will be exposed on https://session_id.owa.mycool.site
--pm2booleanOffload the EASY API to local instance of pm2. You can add pm2 specific arguments also if you want.
--privkeystringThe private key to use for the TLS connection. --cert is also required
--certstringThe certificate to use for the TLS connection. --privkey is also required
--helmetbooleanEnable helmet middleware for security.
--allow-ipsstringAllow only these IPs to connect to the EASY API. By default, all IPs are allowed.
--helpPrint this usage guide.

- + \ No newline at end of file diff --git a/docs/configuration/config-object.html b/docs/configuration/config-object.html index 6e6db199d3..faf5c6f698 100644 --- a/docs/configuration/config-object.html +++ b/docs/configuration/config-object.html @@ -14,13 +14,13 @@ - +

Configration

There are quite a few ways you can customize your session.

Find out about all possible options here: api.ConfigObject

Set the desired config options as parameter on [create].

In the following example:

  1. The process tries to find and run a chrome installation instead of using the default chromium (chrome is required to send videos & GIFS) [ConfigObject.useChrome]
  2. Automatically refreshes the QR code at regular intervals [ConfigObject.autoRefresh]
  3. Disables the cache (may be useful to optimize memory consumption) [ConfigObject.cacheEnabled]
  4. Sets the session Id to hr (this will result in a file called hr.data.json being saved to the process working directory) [ConfigObject.sessionId]
const { create, Client } = require('@open-wa/wa-automate');
// or
// import { create, Client } from '@open-wa/wa-automate';

const launchConfig = {
    useChrome: true,
    autoRefresh:true,
    cacheEnabled:false,
    sessionId: 'hr'
};


function start(client) {
  client.onMessage(async message => {
    if (message.body === 'Hi') {
      await client.sendText(message.from, '👋 Hello!');
    }
  });
}

create(launchConfig).then(start);

Timing out an unpaired session​

If you want to kill the process after a certain amount of seconds due to an unscanned code, you can now set the qrTimeout parameter in the configuration object. You can also use authTimeout if you want to wait only a certain period of time to wait for the session to connect to the phone.

create({
  qrTimeout: 30, //kills the session if the QR code is not scanned within 30 seconds.
  authTimeout: 30 //kills the session if the session hasn't authentication 30 seconds (e.g If the session has the right credentials but the phone is off).
})
.then(client => start(client));

Emitting a limited amount of qr codes​

Set [ConfigObject.maxQr] to limit the amount of QR codes to show before closing the process.

create({
    maxQr:10,
}).then(async client => await start(client));

Open with browser​

The actual browser window you use is called a head, by default the library runs a chrome session headless (i.e in the background - you don't see it). If you want the browser to open up to see what's going on you can set ConfigObject.headless to false.

create({
  headless: false
}).then(async client => await start(client));
- + \ No newline at end of file diff --git a/docs/configuration/launch-events.html b/docs/configuration/launch-events.html index 1fc7c47efb..637f7acd1d 100644 --- a/docs/configuration/launch-events.html +++ b/docs/configuration/launch-events.html @@ -14,13 +14,13 @@ - +

Launch Events

When you call [create] there is actually a lot happening in the background and in some use cases, it may be useful to listen to those events. In order to do this you have to use the built in event emitter ev:

import { ev } from '@open-wa/wa-automate';

ev.on('event', callback)

The event you want to listen to is in the format of [namespace].[sessionId]

The event can include wildcards.

For example, to listen to all qr code events, the event will be qr.**. e.g:

ev.on('qr.**',...

Listen to all sessionData events

ev.on('sessionData.**',...

Listen to all events from session1

ev.on('**.session1',...

Listen to all events

ev.on('**.**',...

ev always emits data, sessionId and the namespace which is helpful to know if there are multiple sessions or you're listening to events from all namespaces.

ev.on('**.**', (data, sessionId, namespace) => {

 console.log(`${namespace} event detected for session ${sessionId}`, data)

});
- + \ No newline at end of file diff --git a/docs/configuration/licensed-features.html b/docs/configuration/licensed-features.html index 2d03f99436..4279119057 100644 --- a/docs/configuration/licensed-features.html +++ b/docs/configuration/licensed-features.html @@ -14,13 +14,13 @@ - +

Licensed Features

Features​

Insiders Features​

open-wa is at the forefront of open source WA development. Some cutting edge features are available exclusively to license holders. Although there are multiple types of licenses, the most affordable is the Insiders license with the most amount of unlockable features. To identify which features are unlcoked with an Insiders license, look out for the "Insiders" tag in the Client documentation.

Sending messages to non-contact numbers​

The ability to send messages to non-contact numbers is restricted in this library to prevent spam.

There are 3 ways to start a chat with a new number:

  1. WA Links

    You can send a special link to the person you want to start a chat with. This will open a conversation with your number on their phone. This way you can insure that they have explicitly started a conversation with you.

  2. WA Buttons

    You can add this button to your website which, when clicked, will open a chat with you in the same way as above.

  3. With a Restricted License Key

    In order to unlock the functionality to send texts to unknown numbers through @open-wa/wa-automate itself, you will need a Restricted License key.

    One License Key is valid for one number. Each License Key for this is £10 per month. Instructions below.

Story Keys​

caution

Unfortunately, due to MD updates story features are currently broken.

After a lot of effort, ability to send text, image and video stories is available exclusively in this library. If you want access to the feature of posting Whatsapp Stories, please contact shah@openwa.dev

How to get a License Key​

  1. Go to Gumroad.

  2. Click on the type of license you require.

  3. In the checkout, enter the host account number you want to assign to the License Key (the one you will be using with open-wa, not your personal number) , along with the use case for this functionality and your github username. Please note, with this new system you'll only be able to change the number once.

  4. Complete the checkout process.

  5. You will instantly receive your License key on the screen and in your email.

  6. Use your license with the instructions below:

How to use your license​

This depends on how you're using the library. If you're using it with your own custom code then you can enter the licenseKey like so within the config of your create command:

> npx @open-wa/wa-automate --license-key FE764A87-BB9B48EE-BBBC035C-9736F87

Keys​

NamelinkDescription
InsidersLINKAll Insiders Features#insiders-features
RestrictedLINKSend messages to non-contacts

All keys include access to all insider's features. You do not need a Premium Key to send messages to non-contacts.

Troubleshooting​

If the license key is showing up as invalid, there may be an issue with your host account number you entered in the checkout form. In some countries, the host account number is different from the actual number (for example in Brazil, an extra 9 is added). If you're unsure about your host account number then use the following code:

const hostAccountNumber = await client.getHostNumber();
console.log('Host account', hostAccountNumber);

If it's different from what you've entered in the checkout form, please fill and send this email.

If you are having issues where your license key shows as valid in the console, but the features continually return false this may be due to a NodeJS issue relating to the time on your machine. To fix this, make sure your machine's time is correct.

Switching your host account​

If your development and production host accounts are different, then you can enter the development host account number in the form and when you're ready to your production host account, fill and send this email.

Notes​

  • One license key is valid for one host account number.
  • You can change the number assigned to a specific License Key once.
  • In order to cancel your License Key, simply stop your membership.
  • You can use multiple license keys for each host number.
  • Apart from adding your licenseKey to your config, you will need to change nothing else in your code.
  • An added benefit for members is priority on issues.
  • License Key requests may be rejected.
  • All code you will receive from the license server is closed-sourced and is under the same license as this project. You will not be able to read it. It is not transferrable to another number or another project.
  • All keys provide access to Insiders Features.
  • No Refunds unless you have chosen the incorrect license upon checkout. Refund requests need to take place after the correct license is purchased. Once the correct license is purchased please email me for a refund.
  • Volume licenses are available upon request.
  • Referral links are available upon request.
- + \ No newline at end of file diff --git a/docs/configuration/multiple-sessions.html b/docs/configuration/multiple-sessions.html index 38e7ebb322..0ef8e972ab 100644 --- a/docs/configuration/multiple-sessions.html +++ b/docs/configuration/multiple-sessions.html @@ -14,13 +14,13 @@ - +

Multiple Sessions

You can run multiple sessions of @open-wa/wa-automate in the same process. This allows you to do interesting things for example:

  1. Design and run automated tests for you WA bot.
  2. Connect two or more WA numbers to a single (or multiple) message handler(s)
  3. Use one client to make sure another one is alive by pinging it.

Please see demo/index.ts for a working example

NOTE: DO NOT CREATE TWO SESSIONS WITH THE SAME SESSIONID. DO NOT ALLOW SPACES AS SESSION ID.

import { create, Client, ev} from '@open-wa/wa-automate';

function start(client: Client) {
  ...
}

create({
  sessionId:'session'
}).then(client => start(client));

create({
  sessionId:'another_session'
}).then(client => start(client));

You can then capture the QR Code for each session using the following event listener code:

//events are fired with the ev namespace then the session Id. e.g "qr.another_session"
//You can however use the wildcard operator with the new event listener and capture the session Id as a parameter instead.
ev.on('qr.**', async (qrcode,sessionId) => {
  //base64 encoded qr code image
  const imageBuffer = Buffer.from(qrcode.replace('data:image/png;base64,',''), 'base64');
  fs.writeFileSync(`qr_code${sessionId?'_'+sessionId:''}.png`, imageBuffer);
});

Orchestrating multiple sessions​

Client sessions are living breathing objects. They CANNOT be stringified and parsed for later use. If you want to 'hold' multiple sessions in one process, make sure to keep them in memory in a session object registry or array.

For example, let's say you have a marketing and sales sessions.

...

const clientSessionRegistry = {};

async start(client){
  //save for later
  clientSessionRegistry[client.getSessionId()] = client;

  client.onMessage...
}

//maybe this is called from an API
sendText(sessionId, params){
  //grab the existing client from the 'registry'
  const client = clientSessionRegistry[sessionId];

  //use the client
  client.sendText(...params);
}

create().then(client => start);
- + \ No newline at end of file diff --git a/docs/configuration/the-client.html b/docs/configuration/the-client.html index bbc1f256d0..1f866bd634 100644 --- a/docs/configuration/the-client.html +++ b/docs/configuration/the-client.html @@ -14,13 +14,13 @@ - +

The Client

Who/what is the client? The Client is the orchestrator of a WA Web session. You can have multiple clients in one node (or ts-node) process. But it's generally best practice to keep a single client on a single process.

How to create a client​

After you've installed the library in your project, you can then use [create] to create a new session. This simple example starts a bot that replies with 👋 Hello! when it receives a Hi

const { create, Client } = require('@open-wa/wa-automate');

// or
// import { create, Client } from '@open-wa/wa-automate';


function start(client) {
  client.onMessage(async message => {
    if (message.body === 'Hi') {
      await client.sendText(message.from, '👋 Hello!');
    }
  });
}

create().then(start);

The method create is what creates, authenticates/reloads a session. When you call create, make sure to keep an eye on the console output. In the console it will log the loading state of the client and the QR code (if there is no valid session data).

You can call create() on it's own, however there are a bunch of powerful configuration variables you can set to acheive a more custom set up.

[[ConfigObject]]

Please note that you will be unable to scan the QR code if it is on a dark background.

What happens when the session starts​

In order to eliminate potential phishing attacks using this library, a message is sent to the host account from itself notifying the account user that the account is being managed/controlled using an automation software.

This host notification will result in a CORS error in the browser instance. You can ignore the error.

Learn more here: https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088

- + \ No newline at end of file diff --git a/docs/get-started/docker.html b/docs/get-started/docker.html index 3439ea18a7..5bf22c28f5 100644 --- a/docs/get-started/docker.html +++ b/docs/get-started/docker.html @@ -14,14 +14,14 @@ - +

Get started with wa-automate via Docker

open-wa has universal images on Docker Hub.

Prerequisites​

Make sure you have docker installed on your system and are not using a Apple silicon chip. Due to the lack of an ARM compatibile Google Chrome, the docker container does not run on ARM machines.

Run the container (EASY API)​

You can use the following docker command as a drop-in replacement for the normal CLI command (npx @open-wa/wa-automate). This means you can use CLI flags normally right after docker run openwa/wa-automate. The below example runs the library in socket mode.

> docker run openwa/wa-automate --socket

The docker image already has some defaults that do not need to be set via additional CLI flags.

Using the docker image with your own code​

You can extend the docker image and use it as a base for your own custom project. This is useful so you don't have to worry about dependencies. The image is optimised and slimmed out to prevent needless bloat.

First thing you need to do is to override the ENTRYPOINT of the base docker image by adding the line ENTRYPOINT []

FROM openwa/wa-automate
ENTRYPOINT []

# Now you can add your custom docker commands

After the above, add your custom docker commands to COPY your custom code into the image and then RUN it at the end.

Both methods are explained in the @open-wa/wa-automate-docker repository.

- + \ No newline at end of file diff --git a/docs/get-started/installation.html b/docs/get-started/installation.html index 2430c100a8..23932f109f 100644 --- a/docs/get-started/installation.html +++ b/docs/get-started/installation.html @@ -14,13 +14,13 @@ - +

Installation

Standard Installation​

Run the following command to ensure you have wa-automate installed:

> npm install @open-wa/wa-automate

or using yarn:

> yarn add @open-wa/wa-automate

You can then add the library to your project:

import { create, Client, decryptMedia, ev } from '@open-wa/wa-automate';

CentOS Installation​

Some people report CentOS causing problems when installing this library.

Try the following:

> npm install @open-wa/wa-automate --unsafe-perm

or if you come accros permission issues:

> sudo npm install @open-wa/wa-automate --unsafe-perm

Installation when primarily using Chrome​

If you use chrome, by setting useChrome or executablePath then you don't need to install the whole of puppeteer (puppeteer installs a version of Chromium - not Chrome - by default).

If there are issues with installing the packages then try this:

> npm install @open-wa/wa-automate --ignore-scripts

Doing this saves time and memory.

Chrome issues on Linux based systems​

Some people report issues with running the program using the built in puppeteer chromium package. Use this to install dependencies and install chrome. After doing the following command you can use Chrome by setting useChrome: true in the config or with the --use-chrome flag with the CLI.

> wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
> sudo apt install ./google-chrome-stable_current_amd64.deb
- + \ No newline at end of file diff --git a/docs/get-started/quick-run.html b/docs/get-started/quick-run.html index 95410fd065..495013b70b 100644 --- a/docs/get-started/quick-run.html +++ b/docs/get-started/quick-run.html @@ -14,13 +14,13 @@ - +

Zero Install EASY API

Ever wanted to create an API out of your WA number? You're in luck!

Open the terminal, and enter this:

> npx @open-wa/wa-automate

P.S you have to make sure you have node, npm, and npx installed on your system.

When you run the code, it will also give you a URL to an API explorer where you can play around with the various API endpoints with documentation.

You can see all the help text like so:

> npx @open-wa/wa-automate --help

You can set a custom port:

> npx @open-wa/wa-automate -p 8080

and an api key which will prevent unauthorized requests. This will result in a key being automatically generated for you:

> npx @open-wa/wa-automate -p 8080 -k

or you can set your own, I got the following secure key from https://randomkeygen.com/:

> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy'

You can easily force the program to maintain focus (--keep-alive or -a):

> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive

//or

> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --keep-alive

Restarting session​

As of version 2.0.0 of this library, you can now provide session data as a base64 string. This is the default method goin forward and your .data.json files should have this string if you've run the program in version 2.0.0+.

There are 3 param tags that can be used to set session data -s, --session or --session-data - all work but make sure you wrap the string with double quotes " and NOT sinle quotes '.

> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session-data "eyJXQUJyb...ifQ=="
//or
> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' --session "eyJXQUJyb...ifQ=="
//or
> npx @open-wa/wa-automate -p 8080 -k 'K6MEQJRV3trXMPZ5eQd1Jl8NaaaRZxqy' -s "eyJXQUJyb...ifQ=="

Running on a server​

If you're not running this on your localhost, you'll need to set the server hostname for the api-docs to work correctly.

> npx @open-wa/wa-automate -p 8080 --api-host 'https://my-wa-api.dev:8080'

Webhooks​

You can also set a webhook address to send all requests to. I like using webhook.site to check and test events.

> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a'

Now if you go to:

https://webhook.site/#!/7a00ac21-60f2-411e-a571-515b37b2025a

you'll be able to see all the events come through.

If you do use this link please make sure to clear all of your requests for your privacy.

API Docs​

By default, the CLI generates and serves a swagger api explorer at [host]/api-docs/

For example:

> npx @open-wa/wa-automate -w 'https://webhook.site/7a00ac21-60f2-411e-a571-515b37b2025a' -p 8008

will server the api docs at

http://localhost:8008/api-docs/

Postman collection​

The CLI will also automatically generate a postman collection for your specific set up (including api keys, hostname, ports, etc.) which you can then easily import into postman.

Coming soon​

Soon SDKs for most programming lanugages will be created using the CLI as a base 'server'. Check this issue for updates: #894

- + \ No newline at end of file diff --git a/docs/get-started/socketmode.html b/docs/get-started/socketmode.html index beb2ecb497..b62f6d70e2 100644 --- a/docs/get-started/socketmode.html +++ b/docs/get-started/socketmode.html @@ -14,13 +14,13 @@ - +

Socket mode

Now that you've checked out the EASY API and how to implement wa-automate with your own custom code I'm sure you're wondering if there was a best of both worlds? Yes there is! "Socket mode" allows you to seperate your session from your code and unlocks a number of benefits:

  • Your session and your code can be running on different servers
  • Rapid development - you no longer have to wait for a session to restart when restarting your custom code
  • 1-many - connect multiple socket clients to one session.

How to:

Step 1 - Start the EASY API in socket mode​

- + \ No newline at end of file diff --git a/docs/how-to/create-api.html b/docs/how-to/create-api.html index 493a843720..29b1221adf 100644 --- a/docs/how-to/create-api.html +++ b/docs/how-to/create-api.html @@ -14,13 +14,13 @@ - +

Creating an API

There are multiple convinient ways to create an API.

  1. Use the ready-made API via npx

Learn more here [[Easy API]]

  1. Build your own API on express and just use the built in middleware

- + \ No newline at end of file diff --git a/docs/how-to/decrypt-media.html b/docs/how-to/decrypt-media.html index 59667013e1..ba3ccd6451 100644 --- a/docs/how-to/decrypt-media.html +++ b/docs/how-to/decrypt-media.html @@ -14,13 +14,13 @@ - +

Decrypting Media

Here is a sample of how to decrypt media. This has been tested on images, videos, documents, audio and voice notes.

import { create, Client, decryptMedia } from '@open-wa/wa-automate';
const mime = require('mime-types');
const fs = require('fs');

function start(client: Client) {
  client.onMessage(async message => {
    if (message.mimetype) {
      const filename = `${message.t}.${mime.extension(message.mimetype)}`;
      const mediaData = await decryptMedia(message);
      const imageBase64 = `data:${message.mimetype};base64,${mediaData.toString(
        'base64'
      )}`;
      await client.sendImage(
        message.from,
        imageBase64,
        filename,
        `You just sent me this ${message.type}`
      );
      fs.writeFile(filename, mediaData, function(err) {
        if (err) {
          return console.log(err);
        }
        console.log('The file was saved!');
      });
    }
  });
}

create().then(client => start(client));

404'd​

You may sometimes get a 404 error when trying to decrypt media from an old message, this is because media is only available on the main servers for a limited period of time. In these circumstances, you will need to force the host account to reupload media. You can do this by using [[forceStaleMediaUpdate]] then using decryptMedia on the response.

      const mediaData = await decryptMedia(client.forceStaleMediaUpdate(message.id));

Decrypting Stickers​

Decrypting stickers with the method shown above will result in a blank .webp file. To decrypt the sticker, use [[getStickerDecryptable]].


      const mediaData = await decryptMedia(client.getStickerDecryptable(message.id));
      //or
      const mediaData = await client.decryptMedia(message.id);

It is always preferable to keep projects smaller than needed so you can now use a lightweight library called wa-decrypt for projects that do not need all of @open-wa/wa-automate.

You can install that using:

> npm i --save wa-decrypt

and import it like so:

import { decryptMedia } from 'wa-decrypt';

Learn more about wa-decrypt here

- + \ No newline at end of file diff --git a/docs/how-to/detect-logout.html b/docs/how-to/detect-logout.html index 040bc6f587..c4b0be7158 100644 --- a/docs/how-to/detect-logout.html +++ b/docs/how-to/detect-logout.html @@ -14,13 +14,13 @@ - +

Detecting Logouts

First use [[onStateChanged]] to detect changes in the session state. Then use [[forceRefocus]] to force the the app to continue working. If state equals UNPAIRED that means the host account user has manually de authenticated the session through the app.


  client.onStateChanged(state=>{
    console.log('statechanged', state)
    if(state==="CONFLICT" || state==="UNLAUNCHED") client.forceRefocus();

    if(state==='UNPAIRED') console.log('LOGGED OUT!!!!')
  });

For more information see: [[STATE]]

- + \ No newline at end of file diff --git a/docs/how-to/groups.html b/docs/how-to/groups.html index 89de4a183e..8599b3ada5 100644 --- a/docs/how-to/groups.html +++ b/docs/how-to/groups.html @@ -14,7 +14,7 @@ - + @@ -23,7 +23,7 @@ [[removeParticipant]] - remove a particpant [[promoteParticipant]] - Make a participant admin [[demoteParticipant]] - remove participant as admin

...
  client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
...

Listening to participant changes of a specific group​

You can react to when participants are added and removed. [[onParticipantsChanged]] emits a [[ParticipantChangedEventModel]].

client.onParticipantsChanged("XXXXXXXX-YYYYYYYY@g.us", (participantChangedEvent) => console.log("participant changed for group", participantChangedEvent));

//participantChangedEvent returns
{
  by: 'XXXXXXXXXXX@c.us', //who performed the action
  action: 'remove',
  who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.
}

This solution can result in some false positives and misfires however a lot of effort has been made to mitigate this to a reasonable level. Best practice is to maintian a seperate registry of participants and go from that.

Listen to participant changes globally​

[[onGlobalParticipantsChanged]] is a simple and memory efficient way to listen to all participant changes from all groups. This is an Insider's Feature.

client.onGlobalParticipantsChanged((participantChangedEvent) => console.log("participant changed for group", participantChangedEvent));

//participantChangedEvent returns
{
  by: 'XXXXXXXXXXX@c.us', //who performed the action
  action: 'remove',
  who: [ 'XXXXXXXXX@c.us' ] //all the numbers the action effects.
}
- + \ No newline at end of file diff --git a/docs/how-to/handle-errors.html b/docs/how-to/handle-errors.html index 88658b7b6a..dcc6d00f14 100644 --- a/docs/how-to/handle-errors.html +++ b/docs/how-to/handle-errors.html @@ -14,13 +14,13 @@ - +

Error Handling

Keep your promises!​

Treat all client methods as promises. Therefore make sure to await them and wrap them in try/catch blocks

    client.onMessage(async message => {
        try{
            //respond with 'Hi!'
            await client.sendText(message.from, 'Hi!');
        } catch(error){
            console.log(error);
        }
    })

Error handling on create​

The [[create]] method itself is a promise so you can handle errors using a try catch block here also from which you can choose to try again or exit the process.

async function start(client){
    ...
}

async function launch(){
    try{
        const client = await create();
        await start(client);
    } catch(error){
        console.log(errror)
    }
}

launch();

Alternatively, you can set the client "start" function (the function that consumes the client after it has been created) as a config variable [[restartOnCrash]], allowing the process itself to restart/retry if there are any issues. Be careful with this as it may lead to an endless loop.

You can also use [[logConsole]] (logs all browser console output) or just [[logConsoleErrors]] (only logs browser errors) to better debug issues.

Setting [[killProcessOnBrowserClose]] to true will kill the whole node process upon any critical browser issue (maybe the browser runs out of memory and crashes, this option will kill the process).

This is useful if you have a n orchestrator process that restarts processes. (e.g pm2 or a docker restart policy)

async function start(client){
    ...
}

async function launch(){
    try{
        const client = await create({
            //sets restartOnCrash to the above `start` function
            restartOnCrash: start,

            //log all browser console output
            logConsole: true,

            //or just browser errors
            logConsoleErrors: true,

            //kill the process if the browser crashes/is closed manually
            killProcessOnBrowserClose: true
        });
        await start(client);
    } catch(error){
        console.log(error)
    }
}

launch();

Manage page errors​

Since this project is built upon puppeteer, you can access the Puppeteer Page instance by referencing client.getPage(), and then therefore you can listen to any errors on the page like so:

client.getPage().on('error', _=>{
...
}

Kill the session​

As of v1.6.6^ you can now kill the session when required. Best practice is to manage trycatch-es yourself and kill the client on catch.

try{
...
await client.sendMessage(...
...
} catch(error){
client.kill();
//maybe restart the session then
}
- + \ No newline at end of file diff --git a/docs/how-to/incoming-calls.html b/docs/how-to/incoming-calls.html index e4046ca075..76804020b7 100644 --- a/docs/how-to/incoming-calls.html +++ b/docs/how-to/incoming-calls.html @@ -14,13 +14,13 @@ - +

Handle Incoming Call

[[onIncomingCall]] emits a [[Call]] object. You can use this to tell people not to call the number

    client.onIncomingCall(async call=>{
        await client.sendText(call.peerJid._serialized, 'Sorry I cannot accept calls');
    });
- + \ No newline at end of file diff --git a/docs/how-to/location.html b/docs/how-to/location.html index ae51a78745..6d0417047c 100644 --- a/docs/how-to/location.html +++ b/docs/how-to/location.html @@ -14,13 +14,13 @@ - +

Location

Sending Location​

[[sendLocation]]

    client.sendLocation(chatId, latitude, longitude, 'London!')

Receiving Location​

Check the [[Message]] reference to learn how to extract the coordinates from a location message

    client.onMessage(message=> {
        if(message.type==="location") {
            //Using destructuring
            const {
                // The text associated with the location
                loc,
                //Latitude
                lat,
                //Longitude
                lng
            } = message
        }
    })

Listening to Live Locations​

[[onLiveLocation]] fires a [[LiveLocationChangedEvent]] event. [[onLiveLocation]] requires a chat id to listen to so you need to detect exactly when a chat starts sharing a live location with your host account. This example detects when a live location is started and then registers a new callback to listen to updates in that live location session.

    const liveLocationCallback = currentLiveLocation => {
        console.log('Live location update', currentLiveLocation.id, currentLiveLocation.lat, currentLiveLocation.lng);
    }
    client.onMessage(message=> {
        //This is how to detect when someone has started a live location with you
        if(message.shareDuration){
            client.onLiveLocation(message.from, liveLocationCallback)
        }
    })

Forcing Live Locations to Update​

The updates of live locations are very passive. If you require updates at regular intervals then you can force it using [[forceUpdateLiveLocation]]. It is recomended to keep an array of chat ids that have live location sessions and map through them at regular intervals

    await client.forceUpdateLiveLocation(chatId);

    //or force update live locations of multiple chats
    await Promise.all([
        'chatId1',
        'chatId2'
    ].map(client.forceUpdateLiveLocation));
- + \ No newline at end of file diff --git a/docs/how-to/manage-participants.html b/docs/how-to/manage-participants.html index 38b1820ca4..d9523fe082 100644 --- a/docs/how-to/manage-participants.html +++ b/docs/how-to/manage-participants.html @@ -14,7 +14,7 @@ - + @@ -23,7 +23,7 @@ [[removeParticipant]] - remove a particpant [[promoteParticipant]] - Make a participant admin [[demoteParticipant]] - remove participant as admin

...
  client.addParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.removeParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.promoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
  client.demoteParticipant('XXXXXXX-YYYYYY@c.us','ZZZZZZZZZ@c.us')
...
- + \ No newline at end of file diff --git a/docs/how-to/misc.html b/docs/how-to/misc.html index 54dac5affc..d5ed8c29d1 100644 --- a/docs/how-to/misc.html +++ b/docs/how-to/misc.html @@ -14,13 +14,13 @@ - +

More examples

Simulate typing​

As of version 1.3.1 you can now simulate '...typing'

You need to pass the following params:

Note: You need to manually turn this off!!!

//start '...typing'
await client.simulateTyping('xxxxx@c.us',true)
//wait 3 seconds

//stop '...typing'
await client.simulateTyping('xxxxx@c.us',false)

Load profile pics from server​

Generally, after the 20th chat in your WA, getChat methods do not retreive the chat picture. You need to get these from the WA servers. This is how you do it in v1.6.6^:

client.getProfilePicFromServer('XXXXXXX-YYYYY@c.us')

Listen to Read Receipts​

As of version 1.5.3 you can now listen in on the read state (or technically acknowledgement state) of the messages. As of writing the limitation is presumed to be on sent messages.

The callback you set returns the whole raw message object.

Here's how you do it.

client.onAck((msg:any) => console.log(msg.id.toString(),msg.body,msg.ack))

ack represents the acknoledgement state, of which there are 3.

1 => Message Sent (1 tick)

2 => Message Received by Recipient (2 ticks)

3 => Message Read Receipt Confirmed (2 blue ticks)

Note: You won't get 3 if the recipient has read receipts off.

- + \ No newline at end of file diff --git a/docs/how-to/react-to-group-events.html b/docs/how-to/react-to-group-events.html index 5547d26434..1533cd70b2 100644 --- a/docs/how-to/react-to-group-events.html +++ b/docs/how-to/react-to-group-events.html @@ -14,13 +14,13 @@ - +

Reacting To Group Events

For a specific group you can use [[onParticipantsChanged]], this will fire all detectable group participant change events (see: [[ParticipantChangedEventModel]]).

import {
  create,
  Client,
  ParticipantChangedEventModel,
} from "@open-wa/wa-automate";

function start(client: Client) {
  const groupChatId = "00000000000-11111111111@g.us";
  client.onParticipantsChanged(
    groupChatId,
    async (changeEvent: ParticipantChangedEventModel) => {
      if (changeEvent.action == "add") {
        // It is possible that multiple accounts get added
        await Promise.all(
          changeEvent.who.map((number) =>
            client.sendTextWithMentions(
              groupChatId,
              `@${number} has been added!`
            )
          )
        );
      }
      if (changeEvent.action == "remove") {
        // It is possible that multiple accounts get removed
        //remember: all client methods are promises!
        await Promise.all(
          changeEvent.who.map((number) =>
            client.sendTextWithMentions(
              groupChatId,
              `@${number} has been removed!`
            )
          )
        );
      }
    }
  );
}

create().then((client) => start(client));

Listening to participant change events from all groups​

If you want to listen to participant change requests from all groups, you can get a list of all groups [[getAllChatIds]], filter for groups .filter(id=>id.includes('@g.us') then use the above method. However this results in multiple listeners in the browser and can have detrimental performance implications.

For better performance and stability you can use the Insiders Feature [[onGlobalParticipantsChanged]].

import {
  create,
  Client,
  ParticipantChangedEventModel,
} from "@open-wa/wa-automate";

function start(client: Client) {
  client.onGlobalParticipantsChanged(
    async (changeEvent: ParticipantChangedEventModel) => {
      if (changeEvent.action == "add") {
        // It is possible that multiple accounts get added
        await Promise.all(
          changeEvent.who.map((number) =>
            client.sendTextWithMentions(
              changeEvent.chat,
              `@${number} has been added!`
            )
          )
        );
      }
      if (changeEvent.action == "remove") {
        // It is possible that multiple accounts get removed
        //remember: all client methods are promises!
        await Promise.all(
          changeEvent.who.map((number) =>
            client.sendTextWithMentions(
              changeEvent.chat,
              `@${number} has been removed!`
            )
          )
        );
      }
    }
  );
}

create().then((client) => start(client));
- + \ No newline at end of file diff --git a/docs/how-to/read-state.html b/docs/how-to/read-state.html index b4d718a261..047e5e5820 100644 --- a/docs/how-to/read-state.html +++ b/docs/how-to/read-state.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/how-to/receive-files.html b/docs/how-to/receive-files.html index 8106bec25d..7c1be634de 100644 --- a/docs/how-to/receive-files.html +++ b/docs/how-to/receive-files.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/how-to/receive-messages.html b/docs/how-to/receive-messages.html index 352db0b761..203933b884 100644 --- a/docs/how-to/receive-messages.html +++ b/docs/how-to/receive-messages.html @@ -14,13 +14,13 @@ - +

Receiving Messages

Listen to only incoming messages​

[[onMessage]]

    client.onMessage(message=>{
        console.log(message.body);
    })

Listen to all messages in and out​

[[onAnyMessage]]

    client.onAnyMessage(message=>{
        console.log(message.body);
    })
- + \ No newline at end of file diff --git a/docs/how-to/send-files.html b/docs/how-to/send-files.html index 3d2c806a38..a97e0a070b 100644 --- a/docs/how-to/send-files.html +++ b/docs/how-to/send-files.html @@ -14,13 +14,13 @@ - +

Sending Files

Send Image​

[[sendImage]]

Make sure to use a [[DataURL]] for the second parameter.

    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')

    //send image as a reply to another message quotedMessageId
    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)

    //wait for the Id to be returned
    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)

Send Audio​

[[sendPtt]] sends an audio clip as a 'push to talk' type file. This allows recipients to play the clip as they would any other voice note.

    client.sendPtt(chatId, dataUrl)

    //Send the audio as reply to a message (quotedMessageId)
    client.sendPtt(chatId, dataUrl, quotedMessageId)

Send File​

[[sendFile]]

[[sendFileFromUrl]]


    client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf')

    //Send the file as reply to a message (quotedMessageId)
    client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', quotedMessageId)

    //Send a file and wait for the message id to be returned
    client.sendFile(chatId, dataUrl, 'file.pdf', 'check this pdf', null, true)

    //or from URL
    client.sendFileFromUrl(chatId, url);

Send Stickers​

[[sendImageAsSticker]]

[[sendStickerfromUrl]]

    client.sendImageAsSticker(chatId, dataUrl);

    //or from a URL
    client.sendStickerfromUrl(chatId, url);

Sending Gifs​

There are two ways to send GIFs - by Video or by giphy link.

WA doesn't actually support the .gif format - probably due to how inefficient it is as a filetype - they instead convert GIFs to video then process them.

In order to send gifs you need to do the same (convert the gif to an mp4 file) then use [[sendVideoAsGif]]

[[sendGiphy]] is a convenience method to make it easier to send gifs from the website GIPHY. You need to make sure you use a giphy media link as shown below.


import { create, Client} from '@open-wa/wa-automate';

function start(client: Client) {
await client.sendVideoAsGif('xyz@c.us','Video FILE DATA URL','some file.mp4', `Hello this is the caption`);

//or send via Giphy URL

await client.sendGiphy('xyz@c.us','https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif', `Hello this is the caption`);
}

///IMPORTANT! Please make sure to point to your chrome installation and make sure your host has ffmpeg support
create({
  // For Mac:
  executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
  // For Windows:
  // executablePath: 'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
}).then(client => start(client));

- + \ No newline at end of file diff --git a/docs/how-to/send-messages.html b/docs/how-to/send-messages.html index f52948933f..bf8d652ece 100644 --- a/docs/how-to/send-messages.html +++ b/docs/how-to/send-messages.html @@ -14,13 +14,13 @@ - +

Sending Messages

When sending a message, make sure to await the promise. It usually returns an id if the message was sent successfully.

Send a basic message​

[[sendText]]

    await client.sendText(chatId, "Hello");

Send a message with mentions​

[[sendTextWithMentions]]

    await client.sendTextWithMentions(chatId, "Hello");

Send a reply​

[[reply]]

    await client.reply(chatId, "Hello", idOfMessageToReplyTo);

    // set the fourth variable to true to set the chat to 'seen'
    await client.reply(chatId, "Hello", idOfMessageToReplyTo, true);

Send a reply with mentions​

[[sendReplyWithMentions]]

    await client.sendReplyWithMentions(chatId, "Hello", idOfMessageToReplyTo);

Forward Messages​

To forward messages use [[forwardMessages]] with the following params:

  • chat to forward messages to : xxxxx@c.us
  • messages: a single or array of message ids or message objects
  • skipMyMessages: true or false, if true it will filter out messages sent by you from the list of messages, default false.
//forward multiple messages using an array of messageIds
await client.forwardMessages('xxxxx@c.us',[Array of Message Ids],true)

//forward single message by id
await client.forwardMessages('xxxxx@c.us,"messageId",true)
- + \ No newline at end of file diff --git a/docs/how-to/send-videos.html b/docs/how-to/send-videos.html index b7f22b6b66..b6dfa89948 100644 --- a/docs/how-to/send-videos.html +++ b/docs/how-to/send-videos.html @@ -14,13 +14,13 @@ - +

Send Video

In order to send videos, the client must be started with an instance of chrome! Otherwise videos will be sent as files and not render properly in the app.

To use chrome set [[useChrome]] (finds the chrome installation automatically) to true or set the [[executablePath]] (set the chrome installation path manually).

[[useChrome]] takes a few seconds so to save time in consequtive processes set [[executablePath]] ([[useChrome]] will output the valid [[executablePath]] in the logs so keep an eye on them)

    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption')

    //send image as a reply to another message quotedMessageId
    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', quotedMessageId)

    //wait for the Id to be returned
    client.sendImage(chatId, dataUrl, 'filename.jpeg', 'cool caption', null, true)

Example of config for sending videos:

create({
  // For Mac:
  executablePath: '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome',
  // For Windows:
  // executablePath: 'C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe',
}).then(client => start(client));
- + \ No newline at end of file diff --git a/docs/how-to/sendfile.html b/docs/how-to/sendfile.html index 7c9824c619..3a344b188b 100644 --- a/docs/how-to/sendfile.html +++ b/docs/how-to/sendfile.html @@ -14,13 +14,13 @@ - +
- + \ No newline at end of file diff --git a/docs/how-to/use-a-proxy.html b/docs/how-to/use-a-proxy.html index 3ad707b4e1..6f48ce7904 100644 --- a/docs/how-to/use-a-proxy.html +++ b/docs/how-to/use-a-proxy.html @@ -14,13 +14,13 @@ - +

Proxying your session

It is extremely simple to use a proxy with @open-wa. Once you have your proxy protocol, address, port, username and password you just need to set the [[proxyServerCredentials]] and @open-wa will connect your session via the proxy. For example, if your proxy details are:

//this is dummy data

protocol: http
address: proxyaddress.abc
port: 1234
username: open-wa
password: antidote

then your config will look something like this:

create({
  proxyServerCredentials: {
    address: 'http://proxyaddress.abc:1234',
    username: 'open-wa',
    password: 'antidote'
  }
}).then(client => start(client));
- + \ No newline at end of file diff --git a/docs/intro.html b/docs/intro.html index 4abc691840..60c035a2da 100644 --- a/docs/intro.html +++ b/docs/intro.html @@ -14,13 +14,13 @@ - +

Introduction

open-wa is a collection of tools designed to enable you to easily automate your WhatsApp account.

There are multiple ways to run this library:

  • CLI (npx/docker)

    • npx
    • docker

  • Your own code

    • Locally
    • Socketed
- + \ No newline at end of file diff --git a/index.html b/index.html index 650eb85d67..c03a33896f 100644 --- a/index.html +++ b/index.html @@ -14,13 +14,13 @@ - +

@open-wa/wa-automate-nodejs

The most advanced NodeJS WhatsApp library for chatbots with advanced features.

npx @open-wa/wa-automate
Easy to Use

Easy to Use

Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

Focus on What Matters

Focus on What Matters

Docusaurus lets you focus on your docs, and we'll do the chores. Go ahead and move your docs into the docs directory.

Powered by React

Powered by React

Extend or customize your website layout by reusing React. Docusaurus can be extended while reusing the same header and footer.

- + \ No newline at end of file diff --git a/markdown-page.html b/markdown-page.html index 5e5c64c5be..49dbfd667f 100644 --- a/markdown-page.html +++ b/markdown-page.html @@ -14,13 +14,13 @@ - +

Markdown page example

You don't need React to write simple standalone pages.

- + \ No newline at end of file diff --git a/search.html b/search.html index 444f7a02f7..5fdd421ef1 100644 --- a/search.html +++ b/search.html @@ -14,13 +14,13 @@ - +

Search the documentation

- + \ No newline at end of file