getting started
1.0.0
Wechaty es un SDK (kit de desarrollo de software) de RPA (automatización robótica de procesos) conversacional para creadores de chatbot. Está bien diseñado con una API fácil de usar. Es compatible con todos los sistemas operativos, incluidos Linux, OSX, Win32, Docker y muchos IM (servicios de mensajería instantánea), incluidos WeChat, WeCom, Whatsapp, Lark, Gitter, etc.
Como desarrollador, puede utilizar Wechaty para crear fácilmente su bot, administrar eficazmente el envío y la recepción de mensajes, la creación de salas y el envío de invitaciones, contactar amigos y agregar inteligencia artificial entre los usuarios y su bot.
Si es un principiante total en Wechaty, este proyecto es el mejor punto de partida para usted. Puede ejecutarlo en un IDE de la nube en un par de pasos o en una configuración local en su máquina, como se describe en las secciones siguientes.
Si tiene dificultades o tiene alguna pregunta, puede solicitar ayuda en nuestra Comunidad de Discord en https://discord.gg/7q8NBZbQzt.
Aviso: la versión activa actual de Wechaty es la v1.x, que no es compatible con la mayoría de los módulos v0.x.
[email protected] : para utilizar Wechaty v0.x, visite la rama Wechaty Getting Started v0.x.dong cuando recibe un mensaje ding .
Arriba se muestra un breve resumen de la implementación del ding-dong-bot usando WeChat, WhatsApp y WeCom.
La forma más rápida de comenzar con Wechaty es utilizar un IDE basado en la nube para ejecutar el Proyecto de introducción de Wechaty. Puedes usar Gitpod o Google Cloud Shell.
Si eres un principiante total, te recomendamos Gitpod.
Gitpod es una plataforma en línea y de código abierto para entornos de desarrollo automatizados y listos para codificar. Puede hacer clic en el botón a continuación para acceder a una configuración completa del proyecto BOT ding-dong de introducción de Wechaty en gitpod. Si nunca antes ha usado gitpod, se le pedirá que inicie sesión con su cuenta de gitHub.
Puede obtener más información sobre Gitpod ❤️ Wechaty en nuestro blog: Cómo comenzar sin salir del navegador: Wechaty ❤️ Gitpod, @huan, 06 de febrero de 2021
Google Cloud Shell es un entorno de operaciones y desarrollo en línea al que se puede acceder desde cualquier lugar con su navegador. Puede ejecutar este proyecto en Google Cloud Shell haciendo clic en el botón a continuación.
Generado a través de open-in-cloud-shell
Después de abrir el editor de Google Cloud Shell, debería haber un tutorial abierto en el panel derecho que puede seguir para obtener más información sobre Wechaty.
Obtenga más información sobre cómo ejecutar este proyecto en Google Cloud Shell en nuestro blog: Tutoriales de Google Cloud Shell para Wechaty, @huan, 20 de febrero de 2021.
Para ejecutar este proyecto en su máquina local, necesita:
Tenga Node.js v16+ instalado en su máquina. Puede ejecutar el comando node -v en la terminal para verificar si tiene Node.js instalado. Si lo tiene, debería poder ver la versión impresa en el terminal como v16.13.0 . Su versión puede ser diferente a v16.13.0 . Si no está instalado o su versión es inferior a 16, deberá instalar la última versión siguiendo los enlaces a continuación:
Node.js para otras plataformas se puede encontrar en https://nodejs.org/en/download/package-manager/
Tenga el TOKEN de Wechaty Puppet Service si desea utilizar protocolos RPA distintos de Web
Debe clonar este repositorio en su máquina local y luego cambiar al directorio wechaty-getting-started ejecutando los siguientes comandos.
git clone https://github.com/wechaty/getting-started.git
cd getting-startedDebe instalar dependencias ejecutando el siguiente comando.
npm install Puede usar export para configurar variables de entorno en Linux y usar set en Windows. Si encuentra errores al ejecutar este comando, consulte los consejos de solución de problemas en el paso 4.
export WECHATY_LOG=verbose
export WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts set WECHATY_LOG=verbose
set WECHATY_PUPPET=wechaty-puppet-wechat
npm start
# the above is equals to the below command:
# npx ts-node examples/ding-dong-bot.ts¡Ya está todo listo!
Si tiene problemas al seguir los pasos anteriores, pruebe las opciones siguientes. También puedes hacer preguntas en nuestra sala de chat de Gitter.
Es posible que también necesites Windows-build-tool si estás usando Windows:
npm install windows-build-tools En nuestro ejemplo de introducción, el BOT ding-dong usa wechaty-puppet-wechat4u cuando WECHATY_PUPPET no está configurado, lo cual es solo para comodidad de los recién llegados.
De forma predeterminada, Wechaty utilizará el servicio Puppet para iniciar sesión en su bot. Puede utilizar otro proveedor de títeres como el protocolo web de Whatsapp (wechaty-puppet-whatsapp).
Si desea utilizar un proveedor de títeres Wechaty para un protocolo diferente, debe especificar un nombre de proveedor de servicios de títeres (el mismo que su nombre NPM) configurando la variable de entorno WECHATY_PUPPET .
Gracias a las grandes contribuciones de nuestra comunidad, hay muchos Wechaty Puppets que Wechaty puede utilizar. Nos han ayudado a utilizar protocolos como Web, Pad, Mac y Windows.
| Protocolo | MNP |
|---|---|
| Servicio de marionetas | wechaty-puppet-service |
| whatsappweb | wechaty-puppet-whatsapp |
| WebChat | wechaty-puppet-wechat |
| Plataforma WeChat | wechaty-puppet-padlocal |
Visite nuestro sitio web para obtener más información sobre los proveedores de servicios de marionetas de Wechaty
Por ejemplo, si desea utilizar el títere padlocal , debe configurar WECHATY_PUPPET=wechaty-puppet-padlocal antes de ejecutar npm start . También necesita un TOKEN para wechaty-puppet-padlocal que debe configurar en la variable de entorno WECHATY_PUPPET_PADLOCAL_TOKEN . Puede solicitar el PadLocal TOKEN desde aquí. Los fragmentos de código siguientes ilustran lo que se ha descrito anteriormente en Linux/MacOS y en Windows.
export WECHATY_PUPPET=wechaty-puppet-padlocal
export WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm start set WECHATY_PUPPET=wechaty-puppet-padlocal
set WECHATY_PUPPET_PADLOCAL_TOKEN= ' puppet_padlocal_your-token-here '
npm startObtenga más información sobre la instalación de Wechaty en Windows en esta publicación de blog.
Arriba hay un video tutorial de 10 minutos. Utiliza la versión 0.14 o versiones anteriores de Wechaty, por lo que también está desactualizado. Es una buena forma de empezar si eres nuevo en Wechaty.
Nota: antes de probar más ejemplos, asegúrese de haber probado el proyecto de introducción a wechaty en este repositorio.
https://github.com/wechaty/docker-wechaty-getting-started
https://github.com/wechaty/heroku-wechaty-getting-started
https://wechaty.github.io
Las cuentas de WeChat registradas después de 2017 no podrán iniciar sesión a través de la API web. Obtenga más información al respecto en wechaty/wechaty#872
Solución: puede utilizar protocolos de soporte de Wechaty distintos de Web API, como pad. Obtenga más información en wechaty/wechaty#1296
Puppet en Wechaty?El término Puppet en Wechaty es una clase abstracta para implementar complementos de protocolo. Los complementos son los componentes que ayudan a Wechaty a controlar Wechat y esa es la razón por la que los llamamos títeres.
Los complementos se denominan PuppetXXX , por ejemplo, PuppetWeChat usa el titiritero de Google para controlar la API web de WeChat a través de un navegador Chrome, PuppetPadchat usa el protocolo WebSocket para conectarse con un servidor de protocolo para controlar el programa Wechat del iPad. Para más detalles puedes ir a Puppet en wiki.
Obtenga más información sobre Wechaty Puppet en nuestra documentación en Wechaty Puppet
Agregue ejemplos de CQRS Wechaty.
Rama: v1.11: versión v1.11 de Wechaty.
¡Usando Google Cloud Shell para una configuración rápida!
¡Usando Gitpod para una configuración rápida!
Versión inicial
@wechaty/colaboradores
