ホーム>プログラミング関連>AI ソースコード
ダウンロード

Wechaty Puppet XP はじめに

導入

このプロジェクトは、オープンソース チャット ロボット コミュニティ Wechaty の puppet-xp プロジェクトに基づいており、WeChat チャット ロボットのクイック スタートとベスト プラクティスを開発しています。Windows WeChat クライアント バージョン 3.3.0.115、3.6.0.18、および 3.9.2.23 をサポートしています。

アドバンテージ：

  • ワンクリック操作、DLL インジェクションは不要
  • Wechatyコミュニティサポート

免責事項

このウェアハウスに公開されているコンテンツは学習と研究のみを目的としており、違法または商業目的で使用しないでください。その結果、法的な紛争が生じたとしても、作者は一切関与しません。

WeChat ロボットを実行すると、アカウントの禁止やその他の結果が生じる可能性があります。ご自身の責任でご使用ください。学習・研究のみを目的とし、違法な目的には使用しないでください。

機能サポート

これは、puppet-xp プロジェクトのサポート レベルに完全に依存します。現在サポートされている最新の WeChat バージョンは 3.9.2.23 で、最も安定したバージョンは 3.6.0.18 です。

バージョン3.3.0.115 3.6.0.18 3.9.2.23
<メッセージ>
テキストを受信する✅ ✅ ✅
写真を受け取る✅ ✅ ✅
ファイルを受信する✅ ✅ ✅
アニメーション画像を受信する✅ ✅ ✅
絵文字を受け取る✅ ✅ ✅
ミニプログラムカードを受け取る✅ ✅ ✅
連絡先カードを受け取る✅ ✅ ✅
ロケーションカードを受け取る✅ ✅ ✅
テキストを送信する✅ ✅ ✅
写真を送信する✅ ✅ ✅
ファイルを送信する✅ ✅ ✅
GIFを送信する✅ ✅ ✅
<グループ>
@グループメンバー✅ ✅ ✅
グループリスト✅ ✅ ✅
グループメンバーリスト✅ ✅ ✅
グループ詳細✅ ✅ ✅
グループに参加するためのヒント✅ ✅ ✅
<連絡先>
友達リスト✅ ✅ ✅
友達の詳細✅ ✅ ✅
<その他>
ログインイベント✅ ✅ ✅
QRコードをスキャンしてログインします✅

クイックスタート

wechaty-puppet-xp は Windows オペレーティング システムでの使用のみをサポートしており、WeChat のバージョンは npm パッケージのバージョンに対応している必要があります。クイック スタートは、デフォルトで WeChat バージョン 3.9.2.23 を使用します。

1.WeChatクライアントを確認してログインします。

コンピューター上の WeChat バージョンがサポートされているバージョンであるかどうかを確認し (指定されたバージョンをダウンロードする必要がない場合は、再インストールする必要はありません)、コンピューター上の現在の WeChat バージョンがサポートされている場合は、通常どおりWeChat にログインします。一致しない場合は、WeChatSetup-v3.9.2.23.exe をダウンロードする必要があります

2.現在のnodejs環境をインストールして確認する

16LTS バージョンの nodejs をダウンロードしてインストールし、ノードのバージョン >= v16.0.0 を確認します。 

 node -v

PS C:UsersAdministratorDocumentsGitHubwechaty-puppet-xp-demo> node -v
v16.15.0

3. デモコード puppet-xp-getting-started をダウンロードします。 

 git clone https://github.com/atorber/puppet-xp-getting-started

4. 依存関係をインストールする

 cd puppet-xp-getting-started
npm i wechaty-puppet-xp@next
npm install

インストールが失敗した場合は、puppet-xp を手動でインストールし、 npm i wechaty-puppet-xp@nextを実行できます。

5. プログラムを開始します

PC 上の WeChat がログインしていることを確認し、バージョンが v3.9.2.23 であることを確認します。 

 npm run start

次のような表示が表示され、起動が成功したことが示されます。 

 PS C:UsersAdministratorDocumentsGitHubwechaty-puppet-xp-demo> npm run start

> [email protected] start
> cross-env NODE_OPTIONS="--no-warnings --loader=ts-node/esm" node ./src/index.ts

01:42:54 INFO options... {"version":"3.9.2.23"}
01:42:57 INFO StarterBot Starter Bot Started.
01:43:12 INFO onLogin Contact<大师> login
01:43:13 INFO 当前登录账号信息： Contact<大师>
01:43:13 INFO 微信号查找联系人： Contact<文件传输助手>
01:43:13 INFO 昵称查找联系人： Contact<文件传输助手>
01:43:13 INFO 备注名称查找联系人： 没有找到联系人
01:43:13 INFO 群ID查找群： Room<大师是群主>
01:43:13 INFO 群名称查找群： Room<大师是群主>
01:43:13 INFO 联系人数量： 6271
01:43:13 INFO 群数量： 53
走る対応プログラム説明する
npm start src/indext.ts ts コードの例
npm run start:js src/ding-dong-bot.js jsコード例

コード例

 #!/usr/bin/env -S node --no-warnings --loader ts-node/esm
/**
 * wechaty-puppet-xp示例代码，可以作为模版编写自己的业务逻辑.
 *  
**/
import 'dotenv/config.js'

import {
    Contact,
    Message,
    ScanStatus,
    WechatyBuilder,
    log,
    types,
} from 'wechaty'

import qrcodeTerminal from 'qrcode-terminal'
import { FileBox } from 'file-box'

const onScan = (qrcode: string, status: ScanStatus) => {
    if (status === ScanStatus.Waiting || status === ScanStatus.Timeout) {
        const qrcodeImageUrl = [
            'https://wechaty.js.org/qrcode/',
            encodeURIComponent(qrcode),
        ].join('')
        log.info('onScan: %s(%s) - %s', ScanStatus[status], status, qrcodeImageUrl)

        qrcodeTerminal.generate(qrcode, { small: true })  // show qrcode on console

    } else {
        log.info('onScan: %s(%s)', ScanStatus[status], status)
    }
}

const onLogin = async (user: Contact) => {
    log.info('onLogin', '%s login', user)
    // 登录成功后调用bot
    main()
}

const onLogout = (user: Contact) => {
    log.info('onLogout', '%s logout', user)
}

const onMessage = async (msg: Message) => {
    log.info('onMessage', JSON.stringify(msg))
    // Message doc : https://wechaty.js.org/docs/api/message#messageage--number

    const talker = msg.talker() // 发消息人
    const listener = msg.listener() // 接收消息人
    const room = msg.room() // 是否是群消息
    const text = msg.text() // 消息内容
    const type = msg.type() // 消息类型
    const self = msg.self() // 是否自己发给自己的消息

    log.info('talker', JSON.stringify(talker))
    log.info('listener', listener||'undefined')
    log.info('room', room || 'undefined')
    log.info('text', text)
    log.info('type', type)
    log.info('self', self?'true':'false')

    try {
        switch (text) {
            case 'ding': // 接收到的消息是ding，回复dong
                await msg.say('dong')
                break
            case 'send text': // 接收到的消息是send text，发送文本消息
                await msg.say('this is a test text')
                break
            case 'send image': // 接收到的消息是send image，发送图片
                const image = FileBox.fromFile('file/ledongmao.jpg')
                await msg.say(image)
                break
            case 'send file': // 接收到的消息是send file，发送文件
                const fileBox = FileBox.fromUrl('https://wechaty.js.org/assets/logo.png')
                await msg.say(fileBox)
                break
            case 'send video': // 接收到的消息是send video，发送视频
                const video = FileBox.fromUrl('http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4')
                await msg.say(video)
                break
            case 'send audio': // 接收到的消息是send audio，发送音频
                const audio = FileBox.fromUrl('http://www.zhongguoyinhang.com/upload/2018-11/201811161154314128.mp3')
                await msg.say(audio)
                break
            case 'send emotion': // 接收到的消息是send emotion，发送表情
                const emotion = FileBox.fromUrl('https://res.wx.qq.com/mpres/htmledition/images/icon/emotion/0.gif')
                await msg.say(emotion)
                break
            default:
                break
        }
    } catch (e) {
        console.log('回复消息失败...', e)
    }

    try{
        switch (type) {
            case types.Message.Text: // 接收到的消息是文本
                log.info('接收到的消息是文本')
                log.info('消息内容：', text)
                break
            case types.Message.Image: // 接收到的消息是图片
                log.info('接收到的消息是图片')
                const image = await msg.toImage().thumbnail()  // Save the media message as a FileBox
                const filePath = 'file/' + image.name
                try {
                    image.toFile(filePath, true)
                    log.info(`Saved file: ${filePath}`)
                } catch (e) {
                    log.error('保存文件错误：', e)
                }
                break
            case types.Message.Attachment: // 接收到的消息是附件
                log.info('接收到的消息是附件')
                const attachment = await msg.toFileBox()  // Save the media message as a FileBox
                const attachmentPath = 'file/' + attachment.name
                try {
                    attachment.toFile(attachmentPath, true)
                    log.info(`Saved file: ${attachmentPath}`)
                } catch (e) {
                    log.error('保存文件错误：', e)
                }
                break
            case types.Message.Video: // 接收到的消息是视频
                log.info('接收到的消息是视频')
                const video = await msg.toFileBox()  // Save the media message as a FileBox
                const videoPath = 'file/' + video.name
                try {
                    video.toFile(videoPath, true)
                    log.info(`Saved file: ${videoPath}`)
                } catch (e) {
                    log.error('保存文件错误：', e)
                }
                break
            case types.Message.Audio: // 接收到的消息是音频
                log.info('接收到的消息是音频')
                break
            case types.Message.Emoticon: // 接收到的消息是表情
                log.info('接收到的消息是表情')
                const emoticon = await msg.toFileBox()  // Save the media message as a FileBox
                const emoticonPath = 'file/' + emoticon.name
                try {
                    emoticon.toFile(emoticonPath, true)
                    log.info(`Saved file: ${emoticonPath}`)
                } catch (e) {
                    log.error('保存文件错误：', e)
                }
                break
            case types.Message.Url: // 接收到的消息是链接
                log.info('接收到的消息是链接')
                try {
                    const urlLink = await msg.toUrlLink()
                    log.info('链接标题：', urlLink.title)
                    log.info('链接地址：', urlLink.url)
                } catch (e) {
                    log.error('获取链接错误：', e)
                }
                break
            case types.Message.MiniProgram: // 接收到的消息是小程序
                log.info('接收到的消息是小程序')
                try {
                    const miniProgram = await msg.toMiniProgram()
                    log.info('小程序标题：', miniProgram.title)
                    log.info('小程序描述：', miniProgram.description)
                    log.info('小程序页面地址：', miniProgram.pagePath)
                    log.info('小程序缩略图：', miniProgram.thumbUrl)
                } catch (e) {
                    log.error('获取小程序错误：', e)
                }
                break
            case types.Message.Transfer: // 接收到的消息是转账
                log.info('接收到的消息是转账')
                break
            case types.Message.RedEnvelope: // 接收到的消息是红包
                log.info('接收到的消息是红包')
                break
            case types.Message.Recalled: // 接收到的消息是撤回的消息
                log.info('接收到的消息是撤回的消息')
                break
            case types.Message.Location: // 接收到的消息是位置
                log.info('接收到的消息是位置')
                break
            case types.Message.GroupNote: // 接收到的消息是群公告
                log.info('接收到的消息是群公告')
                break
            case types.Message.Contact: // 接收到的消息是联系人名片
                log.info('接收到的消息是联系人名片')
                break
            case types.Message.ChatHistory: // 接收到的消息是聊天记录
                log.info('接收到的消息是聊天记录')
                break
            case types.Message.Post: // 接收到的消息是公众号文章
                log.info('接收到的消息是公众号文章')
                break
            case types.Message.Unknown: // 接收到的消息是未知类型
                log.info('接收到的消息是未知类型')
                break
            default:
                break
        }
    }catch(e){
        console.log('处理消息失败...', e)
    }
    // 关键词回复,同时也是发送消息的方法
}

const bot = WechatyBuilder.build({
    name: 'ding-dong-bot',
    puppet: 'wechaty-puppet-xp',
    puppetOptions: {
        version: '3.9.2.23',
    }
})

bot.on('scan', onScan)
bot.on('login', onLogin)
bot.on('logout', onLogout)
bot.on('message', onMessage)

bot.start()
    .then(async () => {
        log.info('StarterBot', 'Starter Bot Started.')
    })
    .catch(e => log.error('StarterBot', e))

const main = async () => {

    // 获取当前登录微信信息
    try {
        const self = bot.currentUser
        log.info('当前登录账号信息：', self)
    } catch (e) {
        log.error('get user failed', e)
    }

    // 通过微信号搜索联系人
    try {
        const contactById = await bot.Contact.find({
            id: 'filehelper'
        })
        log.info('微信号查找联系人：', contactById)
        // 向联系人发送消息
        contactById?.say('向指定好友微信号发送消息')
    } catch (e) {
        log.error('contactByWeixin', e)
    }

    // 通过昵称搜索联系人
    try {
        const contactByName = await bot.Contact.find({
            name: '文件传输助手'
        })
        log.info('昵称查找联系人：', contactByName)
        // 向联系人发送消息
        contactByName?.say('向指定好友昵称发送消息')
    } catch (e) {
        log.error('contactByName', e)
    }

    // 通过备注搜索联系人
    try {
        const contactByAlias = await bot.Contact.find({
            alias: '超哥'
        })
        log.info('备注名称查找联系人：', contactByAlias || '没有找到联系人')
        // 向联系人发送消息
        contactByAlias?.say('向指定好友备注好友发送消息')
    } catch (e) {
        log.error('contactByAlias', e)
    }

    try {
        // 通过群ID搜索群
        const roomById = await bot.Room.find({
            id: '21341182572@chatroom'
        })
        log.info('群ID查找群：', roomById)
        // 向群里发送消息
        roomById?.say('向指定群ID发送消息')
    } catch (e) {
        log.error('roomById', e)
    }

    try {
        // 通过群名称搜索群
        const roomByName = await bot.Room.find({
            topic: '大师是群主'
        })
        log.info('群名称查找群：', roomByName || '没有找到群')
        // 向群里发送消息
        roomByName?.say('向指定群名称发送消息')
    } catch (e) {
        console.log('roomByName', e)
    }

    try {
        // 获取所有联系人
        const contactList = await bot.Contact.findAll()
        // log.info('获取联系人列表：', contactList)
        log.info('联系人数量：', contactList.length)
    } catch (e) {
        log.error('contactList', e)
    }

    try {
        // 获取所有群
        const roomList = await bot.Room.findAll()
        // log.info('获取群列表：', roomList)
        log.info('群数量：', roomList.length)
    } catch (e) {
        log.error('roomList', e)
    }

}

バージョンのサポート

このプロジェクトは wechaty-puppet-xp で更新されており、複数の WeChat バージョンをサポートしています。WeChat バージョンと対応する npm バージョンを自分で切り替えることができます。

パペット-XP WeChatクライアントのダウンロードnpmパッケージのインストール
1.3.x WeChat-v3.9.2.23 npm i wechaty-puppet-xp@next
1.12.7 WeChat-v3.6.0.18 npm i [email protected]
1.11.14 WeChat-v3.3.0.115 npm i [email protected]

関連プロジェクト

  • wechaty-puppet-xp プロジェクトのソース コード

  • ChatFlow ChatFlow チャットロボット管理システム

参照

  • 良いニュース: Windows WeChat デスクトップ バージョン プロトコルを使用してログインすると、wechaty 無料バージョン プロトコルが間もなく利用可能になります、@atorber、2021 年 7 月 5 日

  • 新しい Windows パペット プロジェクト wechaty-puppet-xp が開始されました、@atorber、2021 年 7 月 13 日

  • コードは詩のようなもの、ボットは歌のようなもの、Wechaty によって引き起こされた初心者の冒険、@老张学技术、2021 年 7 月 5 日

  • Wechaty公式サイト

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて