telesign

package module

v0.0.1 Latest Latest Go to latest Published: Aug 26, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fox-one/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func SendMessage(ctx context.Context, key, secret string, msg Message) error
type Client
- func NewClient(key, secret string) *Client
- func (c *Client) SendMessage(ctx context.Context, msg Message) error
type Message

Constants ¶

View Source

const (
	MessageTypeARN = "ARN"
	MessageTypeOTP = "OTP" // one-time password
)

Variables ¶

This section is empty.

Functions ¶

func SendMessage ¶

func SendMessage(ctx context.Context, key, secret string, msg Message) error

Types ¶

type Client ¶

type Client struct {
	Key    string
	Secret string
}

func NewClient ¶

func NewClient(key, secret string) *Client

func (*Client) SendMessage ¶

func (c *Client) SendMessage(ctx context.Context, msg Message) error

type Message ¶

type Message struct {
	Phone   string `json:"phone,omitempty" valid:"required"`
	Content string `json:"content,omitempty" valid:"required"`
	Type    string `json:"type,omitempty" valid:"in(ARN|OTP)"` // default is OTP
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL