sms

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 14, 2019 License: BSD-3-Clause Imports: 8 Imported by: 0

README

AWS SNS-SMS

This activity allows you to send SMS messages using AWS SNS.

Installation

Flogo CLI
flogo install github.com/project-flogo/aws-contrib/activity/sms

Configuration

To configure AWS credentials see configuring-sdk

Settings:
Name Type Description
smsType string The type of SMS to send, defaults to Promotional
region string The AWS region, uses environment setting by default
senderID string The Sender ID for the SMS (note: not supported in all countries)
maxPrice float64 The maximum amount in USD that you are willing to spend to send a message
Input:
Name Type Description
to string The phone number to which to send the SMS (e.g. +15555550100)
message string The message to send
Output:
Name Type Description
messageId string The message id
Additional Information

You can find additional information at Amazon's Supported Regions and Countries page. There you can see what are the currently supported regions and also which countries support SenderID.

Examples

Coming soon...

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

Types

type Activity

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

Activity is an activity that is used to invoke a lambda function

func (*Activity) Eval

func (a *Activity) Eval(ctx activity.Context) (done bool, err error)

Eval implements activity.Activity.Eval

func (*Activity) Metadata

func (a *Activity) Metadata() *activity.Metadata

Metadata returns the activity's metadata

type Input

type Input struct {
	To      string `md:"subject"` // The phone number (in international format) to which to send the SMS
	Message string `md:"message"` // The message to send
}

func (*Input) FromMap

func (i *Input) FromMap(values map[string]interface{}) error

func (*Input) ToMap

func (i *Input) ToMap() map[string]interface{}

type Output

type Output struct {
	MessageId string `md:"messageId"` // The message id
}

func (*Output) FromMap

func (o *Output) FromMap(values map[string]interface{}) error

func (*Output) ToMap

func (o *Output) ToMap() map[string]interface{}

type Settings

type Settings struct {
	SmsType  string  `md:"smsType"`          // The type of SMS to send, defaults to Promotional
	SenderID string  `md:"senderID"`         // The Sender ID for the SMS (note: not supported in all countries)
	Region   string  `md:"region, required"` // The AWS region to use (note: SMS is not supported in all AWS regions)
	MaxPrice float64 `md:"maxPrice"`         // The maximum amount in USD that you are willing to spend to send a message
}

Jump to

Keyboard shortcuts

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