Skip to main content

Wechaty Puppet Services

Wechaty Puppet Service WXWork Wechaty Puppet Service PadLocal Wechaty Puppet Service Paimon Wechaty Puppet Service Donut Wechaty Puppet Service DIY

For different instant messaging (IM) systems (such as WeChat, Whatsapp, and TikTok), the Wechaty community builds separate RPA modules for each, and we call those modules Wechaty Puppet.

Wechaty Puppet Service is gRPC for Wechaty Puppet. To use a Wechaty Puppet Service, you need a TOKEN for that service, and pass it to Wechaty, then you will be able to use that Puppet Service.

export WECHATY_PUPPET=wechaty-puppet-service
export WECHATY_PUPPET_SERVICE_TOKEN="__TOKEN__"

You can switch between different Wechaty Puppet Services by changing your TOKEN. All your source code should work between different tokens without any changes.

What is Wechaty Puppet Service#

If you want to learn more about the concepts behind TOKEN, please read our blog post: Introducing Wechaty Puppet Service

Get A Token#

You can get a short-term free TOKEN for testing, get a long-term free TOKEN by joining our Wechaty Contributor Program, or buy a TOKEN from our Wechaty Puppet Service Providers.

If you have any questions about the Wechaty Puppet Service, please feel free to talk to us by joining our Gitter network if you aren’t already a member.

1. Free TOKEN (Short-term)#

Short-term TOKEN(7 days) is for those developers who want to test Wechaty Puppet Service to make sure the service can meet their needs.

TODO: list a easy to follow steps how to apply free token

  • Paimon: Register here
  • wxwork/donut: Using WeCom Account(Not WeChat) with administrator rights here
  • Padlocal: send email to oxddoxdd@gmail.com

2. Free TOKEN (Long-term)#

Long-term TOKEN is for those developers who has joined our Wechaty Contributor Program.

Anyone who has a merged PR to our GitHub repos will be welcome to join.

TODO: give a short intro for steps to join the WCP.

3. Paid TOKEN#

Paid TOKEN is the easiest one to getting started with the Wechaty Puppet Service.

Select a Wechaty Puppet Service from the list below and follow the steps in its page, then contact the Puppet Service Provider to buy one.

If you want to buy more than 10 at a time, or you need consulting servcies, please contact us in Gitter room at https://gitter.im/wechaty/wechaty.

Wechaty Puppet Servcies#

Now, we have the following Wechaty Puppet Services:

NamePlatformProtocolLife Cycle
WXWorkWeComWindowsBeta
PaimonWeChatPadBeta
PadLocalWeChatPadBeta
DonutWeChatWindowsDeprecated

If you are interested in using a Wechaty Puppet Provider directly in your program instead of a Puppet Service, please visit our Wechaty Puppet Directory

FAQ#

What is "Wechaty Puppet", "Wechaty Puppet Provider", "Wechaty Puppet Service"?#

We have a great blog post to explain those term in detail. Please read: Introducing Wechaty Puppet Service

What is "Wechaty Puppet Service Token" or TOKEN you are talking about?#

TOKEN is a unique string for authorizing Wechaty Puppet Service.

Here's some TOKEN examples:

  1. puppet_wxwork_7ce4cf8a1ab789166c39c6: WXWork TOKEN
  2. puppet_padlocal_7ce48a1ab789166c39c6: PadLocal TOKEN
  3. puppet_paimon_7ce4cf8a1ab789166c39c6: Paimon TOKEN
  4. puppet_donut_e7ce4cf8a1ab789166c39c6: Donut TOKEN
  5. 56945fa4-7ce8-4cf8-a1a9-b789166c39c6: UUIDv4 TOKEN

When you are using a Wechaty Puppet Service, you need to provide TOKEN to it so that it can serve you correctly.

The following shell commands demonstrated how to use it under Linux/macOS:

export WECHATY_PUPPET_SERVICE_TOKEN=__TOKEN__
ts-node bot.ts
// or: node bot.js
// or: make bot

__TOKEN__ is your TOKEN

How To Become a Wechaty Puppet Service Provider#

To be written.

Please feel free to list yourself to our list at Wechaty Puppet Provider Repo, and add your introduction in this README by submitting a Pull Request!

If you want to become a Wechaty Puppet Service Provider, please do not hesitate to file an issue to introduce yourself in this repository, then contact rui@chatie.io!

Learn more about the Wechaty Puppet Service Providers from:

  1. The relationship between Wechaty OSS Project and the Commercial Puppet Service Provider (CPSP) #11
  2. Wechaty Puppet Service Registration & Discovery (w.r.t. token) #39

Useful Links#

  1. Wechaty OSS Project and the Commercial Puppet Service Provider (CPSP)
  2. Wechaty Starter Project Template that works out-of-the-box
  3. How to create your own Wechaty Puppet Service Token with the Web Protocol
Last updated on by Leo_chen