waeasyapi

README

WA Easy API Go Client

Golang bindings for interacting with the WA Easy API

This is primarily meant for merchants who wish to perform interactions with the WA Easy API programatically

Read up here for getting started and understanding the messages flow with WA Easy API: https://docs.waeasyapi.com/

Documentation

Documentation of WA Easy API's API and their usage is available at https://docs.waeasyapi.com

Usage

You need to setup your key and secret using the following: You can find your keys at https://app.waeasyapi.com/.

go get github.com/waeasyapi/waeasyapi-go

Or

import (waeasyapi "github.com/waeasyapi/waeasyapi-go")

client := waeasyapi.NewClient("<YOUR_ACC_ID>", "<YOUR_ACC_SECRET>")

Note: All methods return a map[string]interface{} and error

// number must start with the country's dialing code

// send a text message
number := "1982388224"
message := "Hello World"

body, err := client.Message.SendTextMessage(number, message, nil)

// send a template message
number := "1982388224"
template := "template-name"

params := map[string]interface{}{
  "key1": "value1",
  "key2": "value2",
}
body, err := client.Message.SendTemplateMessage(number, template, params, nil)


// send a url message
number := "1982388224"
url := "https://waeasyapi.com"

body, err := client.Message.SendURLMessage(number, url, nil)

// send an image message
number := "1982388224"
params := map[string]interface{}{
  "link": "your_image_url",
  "caption": "your image caption" // optional
}
body, err := client.Message.SendImageMessage(number, params, nil)

// send a video message
number := "1982388224"
params := map[string]interface{}{
  "link": "your_video_url",
  "caption": "your video caption" // optional
}
body, err := client.Message.SendVideoMessage(number, params, nil)

// send a audio message
number := "1982388224"
params := map[string]interface{}{
  "link": "your_audio_url",
}
body, err := client.Message.SendAudioMessage(number, params, nil)

// send a document message
number := "1982388224"
params := map[string]interface{}{
  "link": "your_document_url",
  "filename": "your filename" // optional
}
body, err := client.Message.SendDocumentMessage(number, params, nil)

License

The WA Easy API Go SDK is released under the MIT License. See LICENSE file for more details.

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(key string, secret string) *Client
  • func (client *Client) AddHeaders(headers map[string]string)
  • func (client *Client) SetTimeout(timeout int16)

Constants

const SDKName = "waeasyapi-go"

SDKName ...Name of this SDK

const SDKVersion = "1.5.0"

SDKVersion ...

Variables

var Request *requests.Request

Request ...

Types

type Client

type Client struct {
	Message *resources.Message
}

Client provides various helper methods to make HTTP requests to WAEasyAPI's APIs.

func NewClient

func NewClient(key string, secret string) *Client

NewClient creates and returns a new WAEasyAPI client. key and secret are used to authenticate the requests made to WAEasyAPI's APIs.

func (*Client) AddHeaders

func (client *Client) AddHeaders(headers map[string]string)

AddHeaders adds additional headers to WAEasyAPI's client. All requests made using the client will contain these additional headers in the HTTP request.

func (*Client) SetTimeout

func (client *Client) SetTimeout(timeout int16)

SetTimeout sets the timeout of WA Easy API's Client. The default timeout will be overridden for all HTTP requests made using this client.