什么是 wxbot?
wxbot 是一款用于微信 Web 版的机器人开发框架,它提供了丰富的 API 以及易于使用的接口,方便开发者快速的开发出自己的微信机器人。
安装 wxbot
你可以通过 npm 安装 wxbot,只要使用下面的命令即可:
npm install wxbot --save
使用 wxbot
为了使用 wxbot,你需要先引入 wxbot 模块:
const {WxWeb, WxContact} = require('wxbot');
然后,你需要登录微信:
-- -------------------- ---- ------- ----- -- - --- -------- ------------- ---- -- - ------------------------ --------------------------------------------- --- -------------- -- -- - ------------------------------------------- --- ---------------- ----- -------- -- - -------------------------------------- --- ----- -----------
以上代码将会在控制台输出登录二维码,你需要扫描该二维码并在手机上确认登录。
登录成功后,你将会收到一条欢迎消息。
wxbot API
wxbot 提供了很多易于使用的 API,这些 API 包括如下内容:
WxWeb API
WxWeb.prototype.start(): void
启动微信机器人并登录。
WxWeb.prototype.stop(): void
停止微信机器人。
WxWeb.prototype.logout(): void
登出微信。
WxWeb.prototype.getContact(name: string | RegExp): WxContact | null
获取联系人信息。
WxWeb.prototype.getContacts(name?: string | RegExp): WxContact[]
获取联系人列表。
WxWeb.prototype.sendTextMsg(to: WxContact | string, content: string): void
向指定联系人发送文本消息。
WxWeb.prototype.sendEmoticonMsg(to: WxContact | string, imgPath: string): void
向指定联系人发送表情消息。
WxContact API
WxContact.prototype.getUserByUserName(userName: string): object | null
获取联系人信息。
WxContact.prototype.getHeadImgUrl(): string
获取联系人头像 URL。
WxContact.prototype.sendMessage(content: string): void
向当前联系人发送消息。
示例代码
一个简单的 wxbot 应用程序:
-- -------------------- ---- ------- ----- ------- ---------- - ----------------- ----- -------- ------ - ----- -- - --- -------- ------------- ---- -- - ------------------------ --------------------------------------------- --- -------------- -- -- - ------------------------------------------- ----- ------- - ---------------------------- -- --------- - ------------------------------------ - --- ---------------- ----- -------- -- - -------------------------------------- -- ----------------- --- ----------------- - ----------------------------------------------- - --- ----- ----------- - -------
该程序会向文件传输助手发送一条测试消息,并且在收到其他联系人的消息时回复一条消息。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671178dd3466f61ffe6d2