threecx

README

go-3cx

package to wrap the api of 3cx®

• first steps: https://www.3cx.com/docs/configuration-rest-api/
• openapi documentation: https://downloads-global.3cx.com/downloads/misc/restapi/3cxconfigurationapi.yaml

used packages

• Resty

getting started

go get github.com/Lukas-Nielsen/go-3cx

import threecx "github.com/Lukas-Nielsen/go-3cx"

usage

conf

you need the FQDN of the instanz, username and password (with permissions for the action)

client, err := new threecx.NewClient(threecx.Host{FQDN string, Port int, Debug bool});

client.SetUser(threecx.User{Username string, Password string, MFA string});
// or
client.SetRest(Rest{ClientID string, ClientSecret string});
// or
client.SetToken(Token{TokenType string, Expires int, AccessToken string, RefreshToken string});

functions

get

err := c.Get(<uri>, <result struct>, <query params as map[string]string>)

delete

err := c.Delete(<uri>, <query params as map[string]string>)

post, put, patch

err := c.<Post|Put|Patch>(<uri>, <payload>, <query params as map[string]string>)

Documentation

Index

• type Client
  • func NewClient(host Host) (*Client, error)
  • func (c *Client) Delete(uri string, query map[string]string) error
  • func (c *Client) Get(uri string, result *any, query map[string]string) error
  • func (c *Client) GetToken() Token
  • func (c *Client) Patch(uri string, payload any, query map[string]string) error
  • func (c *Client) Post(uri string, payload any, query map[string]string) error
  • func (c *Client) Put(uri string, payload any, query map[string]string) error
  • func (c *Client) SetHost(host Host) (*Client, error)
  • func (c *Client) SetRest(rest Rest) (*Client, error)
  • func (c *Client) SetToken(token Token) (*Client, error)
  • func (c *Client) SetUser(user User) (*Client, error)
• type Host
• type Rest
• type Token
• type User

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(host Host) (*Client, error)

func (*Client) Delete

func (c *Client) Delete(uri string, query map[string]string) error

func (*Client) Get

func (c *Client) Get(uri string, result *any, query map[string]string) error

func (*Client) GetToken

func (c *Client) GetToken() Token

func (*Client) Patch

func (c *Client) Patch(uri string, payload any, query map[string]string) error

func (*Client) Post

func (c *Client) Post(uri string, payload any, query map[string]string) error

func (*Client) Put

func (c *Client) Put(uri string, payload any, query map[string]string) error

func (*Client) SetHost

func (c *Client) SetHost(host Host) (*Client, error)

func (*Client) SetRest

func (c *Client) SetRest(rest Rest) (*Client, error)

func (*Client) SetToken

func (c *Client) SetToken(token Token) (*Client, error)

func (*Client) SetUser

func (c *Client) SetUser(user User) (*Client, error)

type Host

type Host struct {
	// 3cx FQDN
	FQDN string
	// 3cx port
	Port int
	// debug the requests (see https://github.com/go-resty/resty)
	Debug bool
}

type Rest

type Rest struct {
	// clietn id
	ClientID string
	// client secret
	ClientSecret string
}

type Token

type Token struct {
	// normaly Bearer
	TokenType string `json:"token_type"`
	// unix timestamp when token expires
	Expires      int64  `json:"expires_in"`
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token"`
}

type User

type User struct {
	// username
	Username string
	// password
	Password string
	// mfa secret
	MFA string
}