Skip to content

Commit

Permalink
chore: update read me and workflow enable on push to master
Browse files Browse the repository at this point in the history
Signed-off-by: sarthakjdev <[email protected]>
  • Loading branch information
sarthakjdev committed Jun 24, 2024
1 parent 2e93c4d commit 3f1e246
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
commitHash:
description: "Commit Hash"
default: "HEAD"
push:
branches:
- master

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,29 @@
<br />
</div>

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

- Single Client Model
- Supports multiple phone number messaging clients.
- Supports WhatsApp
- Send Messages with the least configuration
- Event Listener for Notifications (support both User and System Notifications)
- 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.

Expand Down Expand Up @@ -88,7 +97,7 @@ For detailed guidelines, check [Contributing.md](./CONTRIBUTING.md).
- Handle errors gracefully
- Handle template and interactive messages gracefully
- Add support for more interactive messaged types like address input.
-
-

## 📜 License

Expand Down
9 changes: 5 additions & 4 deletions examples/chat-bot/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,21 @@ import (

func main() {
// creating a client

businessAccountId := "103043282674158"
phoneNumber := "113269274970227"
businessAccountId := ""
phoneNumber := ""

client := wapi.New(&wapi.ClientConfig{
ApiAccessToken: "EABhCftGVaeIBOZCZANWI9Tkuy3etYh4lWP1nk1bqcuSyboHi5B1DDj1H3Q4dGYxK9iJ5f6U9Pb1BvoeTTR3aDCVtJIud10aUAtdl7YNbEqH2qeOLBZCEIZAFyt0mSDzog5dVcQHWDDPz1JQmNuebpFIJaBqqcxDdKNdCgx7AQGptJYhPclGc8E9T68Em5dThClm2ZAOST4kVIcvH2dA8zx9kZCqlAevUZBTxaB5hLuS18sZD",
ApiAccessToken: "",
BusinessAccountId: businessAccountId,
WebhookPath: "/webhook",
WebhookSecret: "1234567890",
WebhookServerPort: 8080,
})

// messaging client is specific to a phone number, if in case you are looking to change the mobile the number you need to create a new messaging client
// messagingClient := client.NewMessagingClient("113269274970227")

// uncomment to try this business api endpoint to get the conversation analytics
// client.Business.ConversationAnalytics(business.ConversationAnalyticsOptions{
// Start: time.Now().Add(-time.Hour * 24 * 7 * 30),
// End: time.Now(),
Expand Down

0 comments on commit 3f1e246

Please sign in to comment.