🦄 Qontalk: A Go SDK for Qontak

Qontalk is a Go SDK that provides provides a unified Go SDK for seamless interaction with both the Qontak and FSM APIs, allowing you to interact with the Qontak platform. This SDK includes functionalities to authenticate, send message interactions, send interactive messages, send WhatsApp messages, send Direct WhatsApp Broadcasts, and retrieve WhatsApp Templates.

For more detailed information on using the Qontak Go SDK, check out the GODOC.md file.

Overview 💡

The qontalk package combines the functionality of the Qontak and FSM packages to provide a single, comprehensive SDK for both Qontak messaging and Finite State Machine (FSM) operations. This package allows you to effortlessly work with Qontak for messaging while simultaneously building, managing, and executing FSMs within your applications.

Qontak Integration 🌵

The Qontak integration within qontalk enables you to:

• Authenticate with Qontak's services using various authentication methods.
• Send messages to customers and agents, including text, images, and interactive messages.
• Manage WhatsApp templates and send WhatsApp messages.
• Perform Direct WhatsApp Broadcasts with customization options.

You can utilize these features to enhance your messaging capabilities and communication with customers and agents through Qontak's platform.

Finite State Machine (FSM) Integration 🚀

The FSM integration allows you to create, manage, and execute Finite State Machines within your application. You can define custom states, events, transitions, and callbacks to control the flow of your application based on specific conditions.

Key features of the FSM integration include:

• Creating FSM instances with custom initial states and transitions.
• Sending events to trigger state transitions.
• Managing FSM lifecycle, including starting and stopping FSM execution.
• Defining global callbacks to handle state transitions and events.

This FSM integration empowers you to build complex, stateful applications with ease.

Installation

To install the Qontalk SDK, you can use go get:

go get github.com/maskentir/qontalk

Documentation

You can find the full documentation for the Qontalk SDK here.

Usage

Here is a simple example of how to use the Qontalk SDK:

package main

import (
	"fmt"
	"regexp"

	"github.com/maskentir/qontalk"
	"github.com/maskentir/qontalk/fsm"
)

func main() {
	// Create a QontalkSDK instance
	sdk := qontalk.NewQontalkSDKBuilder().
		WithClientCredentials("your-username", "your-password", "your-grant-type", "your-client-id", "your-client-secret").
		Build()

	// Authenticate with Qontak
	if err := sdk.Authenticate(); err != nil {
		fmt.Println("Authentication failed:", err)
		return
	}

	// Use Qontak features, send messages, etc.

	// Create a new chatbot instance
	bot := fsm.NewBot("MyChatbot")

	// Define states and transitions
	transitions := []fsm.Transition{
		{Event: "start", Target: "initial"},
		{Event: "continue", Target: "ongoing"},
	}

	bot.AddState("initial", "Welcome to the chatbot!", transitions)

	// Define rules and actions
	rulePattern := "hello"
	regexPattern := fmt.Sprintf("(?i)%s", regexp.QuoteMeta(rulePattern))
	rule := fsm.Rule{
		Name:    "HelloRule",
		Pattern: regexp.MustCompile(regexPattern),
		Respond: "Hello! How can I assist you?",
	}

	bot.AddRuleToState("initial", rule.Name, regexPattern, rule.Respond, nil, nil)

	// Process user messages
	response, err := bot.ProcessMessage("user123", "hello")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println("Bot Response:", response)
}

Contributing

Please read our Contribution Guidelines before submitting a pull request.

Code of Conduct

Please follow our Code of Conduct when participating in this project.

Issue and Pull Request Templates

Before creating an issue or pull request, review our Issue Template and Pull Request Template.

License

This library is released under the MIT License.

Contact

If you have any questions or feedback, please contact our support team at harunwols@gmail.com.