Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sarthakjdev/wapi.go
a golang module to build cloud api based whatsapp chat bots
https://github.com/sarthakjdev/wapi.go
Last synced: about 1 month ago
JSON representation
a golang module to build cloud api based whatsapp chat bots
- Host: GitHub
- URL: https://github.com/sarthakjdev/wapi.go
- Owner: sarthakjdev
- License: apache-2.0
- Created: 2024-05-15T07:18:28.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-05-22T11:40:12.000Z (7 months ago)
- Last Synced: 2024-05-22T12:28:39.431Z (7 months ago)
- Language: Go
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Visit the documentation of the SDK [here](https://golang.wapikit.com)
## Status
Beta Version - This SDK is not stable right now. It is currently in beta version. Report issues [here](https://github.com/sarthakjdev/wapi.go/issues).
This SDK is part of a technical suite built to support the WhatsApp Business Application Development ecosystem. This SDK also has a Node.js version, you can check it out [here](https://sarthakjdev/wapi.js/js).
## About
Wapi.go is a Golang SDK, that supports WhatsApp API products i.e., Business Management API and Cloud API
to build WhatsApp applications easily.
This SDK supports managing WhatsApp business accounts, and managing phone numbers for a WhatsApp business account which includes creating, verifying, and registering a phone number to use for messaging via cloud API and deregistering a phone number. This SDK also supports the management of message templates which includes creating new templates or updating/deleting the existing ones.
You can listen to the incoming webhook events via the inbuilt standalone HTTP server built using echo and also you can integrate the SDK within your existing backend applications using the getters for the route handlers of the webhook server.
## Features
- Supports multiple phone number messaging clients.
- Supports WhatsApp
- Send Messages with the least configuration
- Event Listener for Notifications (support both User and System Notifications) and all the events provided by the WhatsApp Business Platform.
- Manage Phone numbers and messaging templates right from the SDK programmatically.
- Upload Media to WhatsApp servers
- Reply and React to incoming messages.
## Installation
This assumes you already have a working Go environment, if not please see
[this page](https://golang.org/doc/install) first.
`go get` _will always pull the latest tagged release from the master branch._
```sh
go get github.com/sarthakjdev/wapi.go
```
> Note: This SDK is not affiliated with the official WhatsApp Cloud API or does not act as any official solution provided the the Meta Inclusive Private Limited, this is just a open source SDK built for developers to support them in building whatsapp cloud api based chat bots easily.
## Usage
You can check out the example WhatsApp bot here. [Example Chatbot](./example-chat-bot/)
# Example Usage
Import the package into your project.
This repository has three packages exported:
- github.com/sarthakjdev/wapi.go/components
- github.com/sarthakjdev/wapi.go/wapi/wapi
- github.com/sarthakjdev/wapi.go/wapi/business
- github.com/sarthakjdev/wapi.go/wapi/events
```go
import "github.com/sarthakjdev/wapi.go/wapi/wapi"
```
Construct a new Wapi Client to access the managers in order to send messages and listen to incoming notifications.
```go
whatsappClient, err := wapi.New(wapi.ClientConfig{
PhoneNumberId: "",
ApiAccessToken: "",
BusinessAccountId: "",
WebhookPath: "/webhook",
WebhookSecret: "",
WebhookServerPort: 8080,
})
```
## References
- **Message Structures**: Refer to the WhatsApp Docs [here](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages).
- **Notification Payloads**: Details can be found [here](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components).
## Contribution Guidelines
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
For detailed guidelines, check [Contributing.md](./CONTRIBUTING.md).
# TODOs'
- Handle errors gracefully
- Handle template and interactive messages gracefully
- Add support for more interactive message types like address input.
## License
Distributed under the AGPL 3.0 License. View [LICENSE](./LICENSE).
## Contact
- [Sarthak Jain](https://sarthakjdev.com)
- Email: [email protected]
- [Twitter](https://twitter.com/sarthakjdev) | [LinkedIn](https://www.linkedin.com/in/sarthakjdev)
Note: This SDK is part of an open-source product-building initiative by [Softlancer](https://github.com/softlancerhq), and this repository will soon be moved under the same organization.