verify

Documentation

Index

• func Delete(c *messagebird.Client, id string) error
• type Params
• type Verify
  • func Create(c *messagebird.Client, recipient string, params *Params) (*Verify, error)
  • func Read(c *messagebird.Client, id string) (*Verify, error)
  • func VerifyToken(c *messagebird.Client, id, token string) (*Verify, error)
  • func (v *Verify) UnmarshalJSON(b []byte) error
• type VerifyMessage
  • func ReadVerifyEmailMessage(c *messagebird.Client, id string) (*VerifyMessage, error)

Functions

func Delete

func Delete(c *messagebird.Client, id string) error

Delete deletes an existing Verify object by its ID.

Types

type Params

type Params struct {
	Originator  string
	Reference   string
	Type        string
	Template    string
	DataCoding  string
	ReportURL   string
	Voice       string
	Language    string
	Timeout     int
	TokenLength int
	Subject     string
}

Params handles optional verification parameters.

type Verify

type Verify struct {
	ID                 string
	HRef               string
	Reference          string
	Status             string
	Messages           map[string]string
	CreatedDatetime    *time.Time
	ValidUntilDatetime *time.Time
	Recipient          string
}

Verify object represents MessageBird server response.

func Create

func Create(c *messagebird.Client, recipient string, params *Params) (*Verify, error)

Create generates a new One-Time-Password for one recipient.

func Read

func Read(c *messagebird.Client, id string) (*Verify, error)

Read retrieves an existing Verify object by its ID.

func VerifyToken

func VerifyToken(c *messagebird.Client, id, token string) (*Verify, error)

VerifyToken performs token value check against MessageBird API.

func (*Verify) UnmarshalJSON

func (v *Verify) UnmarshalJSON(b []byte) error

* The type of the Verify.Recipient object changed from int to string but the api still returns a recipent numeric value whne sms type is used. This was the best way to ensure backward compatibility with the previous versions

type VerifyMessage

type VerifyMessage struct {
	ID     string `json:"id"`
	Status string `json:"status"`
}

func ReadVerifyEmailMessage

func ReadVerifyEmailMessage(c *messagebird.Client, id string) (*VerifyMessage, error)