movidersms

README

Movider API Client

How to Use It

package main

import (
	"context"
	"log"

	"github.com/royge/movidersms"
)

func main() {
	creds := movidersms.Credentials{"api-key", "api-secret"}
	sender := movidersms.NewSender(creds, []string{})

	res, err := sender.SendMessage(
		context.Background(),
		[]string{"6392612345678"},
		"Test Message",
	)
	if err != nil {
		panic(err)
	}

	log.Printf("Result: %+v\n", res)
}

Documentation

Index

• Constants
• Variables
• type Config
• type Credentials
• type Error
  • func (err *Error) Error() string
• type SendMessageRequest
  • func (smr *SendMessageRequest) Encode() []byte
  • func (smr *SendMessageRequest) Validate() error
• type SendMessageResponse
• type Sender
  • func NewSender(creds Credentials, allowedRecipients []string) *Sender
  • func (s *Sender) SendMessage(ctx context.Context, recipient []string, message string) (interface{}, error)

Constants

const (
	MoviderAPIURL  = "https://api.movider.co/v1"
	MaxPhoneLength = 15
)

Variables

var (
	ErrNoDestination      = errors.New("no destination number")
	ErrInvalidDestination = errors.New("recipient number is more than 15 characters")
	ErrNoText             = errors.New("no text message")
)

Types

type Config

type Config struct {
	APIURL            string
	Creds             Credentials
	AllowedRecipients []string
}

type Credentials

type Credentials struct {
	APIKey    string `json:"api_key"`
	APISecret string `json:"api_secret"`
}

type Error

type Error struct {
	Code        int    `json:"code"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

func (*Error) Error

func (err *Error) Error() string

type SendMessageRequest

type SendMessageRequest struct {
	Credentials

	To   []string `json:"to"`
	Text string   `json:"text"`
}

func (*SendMessageRequest) Encode

func (smr *SendMessageRequest) Encode() []byte

func (*SendMessageRequest) Validate

func (smr *SendMessageRequest) Validate() error

type SendMessageResponse

type SendMessageResponse struct {
	RemainingBalance float64 `json:"remaining_balance"`
	TotalSMS         int     `json:"total_sms"`
	Error            *Error  `json:"error"`
}

type Sender

type Sender struct {
	Config
}

func NewSender

func NewSender(creds Credentials, allowedRecipients []string) *Sender

func (*Sender) SendMessage

func (s *Sender) SendMessage(
	ctx context.Context, recipient []string, message string,
) (interface{}, error)