go_sms_sender

package module
v0.17.0 Latest Latest
Warning

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

 Go to latest Published: May 29, 2024 License: Apache-2.0 Imports: 39 Imported by: 0

README

go-sms-sender

Go Report Card Go Go Reference GitHub release (latest SemVer)

This is a powerful open-source library for sending SMS message, which will help you to easily integrate with the popular SMS providers. And it has been applied to Casdoor, if you still don’t know how to use it after reading README.md, you can refer to it.

We support the following SMS providers, welcome to contribute.

Installation

Use go get to install：

go get github.com/casdoor/go-sms-sender

How to use

Create Client

Different SMS providers need to provide different configuration, but we support a unit API as below to init and get the SMS client.

func NewSmsClient(provider string, accessId string, accessKey string, sign string, template string, other ...string) (SmsClient, error)
  • provider the name of SMS provider, such as Aliyun SMS
  • accessId
  • accessKey
  • sign the sign name
  • template the template code
  • other other configuration
Send Message

After initializing the SMS client, we can use the following API to send message.

SendMessage(param map[string]string, targetPhoneNumber ...string) error
  • param the parameters in the SMS template, such as 6 random numbers
  • targetPhoneNumber the receivers, such as +8612345678910

Example

Twilio

Please get necessary information from Twilio console

package main

import "github.com/casdoor/go-sms-sender"

func main() {
	client, err := go_sms_sender.NewSmsClient(go_sms_sender.Twilio, "ACCOUNT_SID", "AUTH_TOKEN", "", "TEMPLATE_CODE")
	if err != nil {
		panic(err)
	}

	params := map[string]string{}
	params["code"] = "123456"
	phoneNumer := "+8612345678910"
	err = client.SendMessage(params, phoneNumer)
	if err != nil {
		panic(err)
	}
}
Aliyun

Before you begin, you need to sign up for an Aliyun account and retrieve your Credentials.

package main

import "github.com/casdoor/go-sms-sender"

func main() {
	client, err := go_sms_sender.NewSmsClient(go_sms_sender.Aliyun, "ACCESS_KEY_ID", "ACCESS_KEY_SECRET", "SIGN_NAME", "TEMPLATE_CODE")
	if err != nil {
		panic(err)
	}

	params := map[string]string{}
	params["code"] = "473956"
	phoneNumer := "+8612345678910"
	err = client.SendMessage(params, phoneNumer)
	if err != nil {
		panic(err)
	}
}
Tencent Cloud
package main

import "github.com/casdoor/go-sms-sender"

func main() {
	client, err := go_sms_sender.NewSmsClient(go_sms_sender.TencentCloud, "secretId", "secretKey", "SIGN_NAME", "TEMPLATE_CODE", "APP_ID")
	if err != nil {
		panic(err)
	}

	params := map[string]string{}
	params["0"] = "473956"
	phoneNumer := "+8612345678910"
	err = client.SendMessage(params, phoneNumer)
	if err != nil {
		panic(err)
	}
}
Netgsm
  • yourAccessId: is KullaniciAdi
  • yourAccessKey: is Sifre
  • yourSign: is Baslik
package main

import "github.com/casdoor/go-sms-sender"

func main() {
	client, err := go_sms_sender.NewSmsClient(go_sms_sender.Netgsm, "yourAccessId", "yourAccessKey", "yourSign", "yourTemplate")
	if err != nil {
		panic(err)
	}

	params := map[string]string{}
	params["param1"] = "value1"
	params["param2"] = "value2"
	phoneNumer := "+8612345678910"
	err = client.SendMessage(params, phoneNumer)
	if err != nil {
		panic(err)
	}
}
Running Tests

To run tests for the go-sms-sender library, navigate to the root folder of the project in your terminal and execute the following command:

go test -v ./...

you can modify mock_test.go file to mock an other tests

License

This project is licensed under the Apache 2.0 license.

Documentation

Index

Constants

View Source 
const (
	Twilio       = "Twilio SMS"
	AmazonSNS    = "Amazon SNS"
	AzureACS     = "Azure ACS"
	Msg91        = "Msg91 SMS"
	GCCPAY       = "GCCPAY SMS"
	Infobip      = "Infobip SMS"
	SUBMAIL      = "SUBMAIL SMS"
	SmsBao       = "SmsBao SMS"
	Aliyun       = "Aliyun SMS"
	TencentCloud = "Tencent Cloud SMS"
	BaiduCloud   = "Baidu Cloud SMS"
	VolcEngine   = "Volc Engine SMS"
	HuaweiCloud  = "Huawei Cloud SMS"
	UCloud       = "UCloud SMS"
	Huyi         = "Huyi SMS"
	MockSms      = "Mock SMS"
	Netgsm       = "Netgsm SMS"
	SMSAero      = "SMSAero"
	Pachka       = "Pachka"
)
View Source 
const AUTH_HEADER_VALUE = "WSSE realm=\"SDP\",profile=\"UsernameToken\",type=\"Appkey\""
View Source 
const WSSE_HEADER_FORMAT = "UsernameToken Username=\"%s\",PasswordDigest=\"%s\",Nonce=\"%s\",Created=\"%s\""

Variables

This section is empty.

Functions

func GetMd5String 

func GetMd5String(s string) string

func Md5 

func Md5(str string) string

func RandStringBytesCrypto 

func RandStringBytesCrypto(n int) (string, error)

Types

type ACSClient 

type ACSClient struct {
	AccessToken string
	Endpoint    string
	Message     string
	Sender      string
}

func GetACSClient 

func GetACSClient(accessToken string, message string, other []string) (*ACSClient, error)

func (*ACSClient) SendMessage 

func (a *ACSClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type AliyunClient 

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

func GetAliyunClient 

func GetAliyunClient(accessId string, accessKey string, sign string, template string) (*AliyunClient, error)

func (*AliyunClient) SendMessage 

func (c *AliyunClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type AliyunResult 

type AliyunResult struct {
	RequestId string
	Message   string
}

type AmazonSNSClient 

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

func GetAmazonSNSClient 

func GetAmazonSNSClient(accessKeyID string, secretAccessKey string, template string, region []string) (*AmazonSNSClient, error)

func (*AmazonSNSClient) SendMessage 

func (a *AmazonSNSClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type BaiduClient 

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

func GetBceClient 

func GetBceClient(accessId, accessKey, sign, template string, endpoint []string) (*BaiduClient, error)

func (*BaiduClient) SendMessage 

func (c *BaiduClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type Destination 

type Destination struct {
	To string `json:"to"`
}

type GCCPAYClient 

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

func GetGCCPAYClient 

func GetGCCPAYClient(clientname string, secret string, template string) (*GCCPAYClient, error)

func (*GCCPAYClient) SendMessage 

func (c *GCCPAYClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type HuaweiClient 

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

func GetHuaweiClient 

func GetHuaweiClient(accessId string, accessKey string, sign string, template string, other []string) (*HuaweiClient, error)

func (*HuaweiClient) SendMessage 

func (c *HuaweiClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

SendMessage https://support.huaweicloud.com/intl/en-us/devg-msgsms/sms_04_0012.html

type HuyiClient 

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

func GetHuyiClient 

func GetHuyiClient(appId string, appKey string, template string) (*HuyiClient, error)

func (*HuyiClient) SendMessage 

func (hc *HuyiClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type InfobipClient 

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

func GetInfobipClient 

func GetInfobipClient(sender string, apiKey string, baseUrl []string) (*InfobipClient, error)

func (*InfobipClient) SendMessage 

func (c *InfobipClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type InfobipConfigService 

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

type Message 

type Message struct {
	From         string        `json:"from"`
	Destinations []Destination `json:"destinations"`
	Text         string        `json:"text"`
}

type MessageData 

type MessageData struct {
	Messages []Message `json:"messages"`
}

type Mocker 

type Mocker struct{}

func NewMocker 

func NewMocker(accessId, accessKey, sign, templateId string, smsAccount []string) (*Mocker, error)

func (*Mocker) SendMessage 

func (m *Mocker) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type Msg91Client 

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

func GetMsg91Client 

func GetMsg91Client(senderId string, authKey string, templateId string) (*Msg91Client, error)

func (*Msg91Client) SendMessage 

func (m *Msg91Client) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type NetgsmClient 

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

func GetNetgsmClient 

func GetNetgsmClient(accessId, accessKey, sign, template string) (*NetgsmClient, error)

func (*NetgsmClient) SendMessage 

func (c *NetgsmClient) SendMessage(param map[string]string, targetPhoneNumbers ...string) error

type NetgsmResponse 

type NetgsmResponse struct {
	Code  string `xml:"main>code"`
	JobID string `xml:"main>jobID"`
	Error string `xml:"main>error"`
}

type PachkaClient added in v0.16.0 

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

func GetPachkaClient added in v0.16.0 

func GetPachkaClient(entityId string, apikey string, template string) (*PachkaClient, error)

func (*PachkaClient) SendMessage added in v0.16.0 

func (c *PachkaClient) SendMessage(param map[string]string, numbers ...string) error

type RequestBody added in v0.16.0 

type RequestBody struct {
	Message struct {
		EntityType string `json:"entity_type"`
		EntityID   int    `json:"entity_id"`
		Content    string `json:"content"`
	} `json:"message"`
}

type SmsBaoClient 

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

func GetSmsbaoClient 

func GetSmsbaoClient(username string, apikey string, sign string, template string, other []string) (*SmsBaoClient, error)

func (*SmsBaoClient) SendMessage 

func (c *SmsBaoClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type SmsClient 

type SmsClient interface {
	SendMessage(param map[string]string, targetPhoneNumber ...string) error
}

func NewSmsClient 

func NewSmsClient(provider string, accessId string, accessKey string, sign string, template string, other ...string) (SmsClient, error)

type SmsService 

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

type SmsaeroClient 

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

func GetSmsaeroClient 

func GetSmsaeroClient(email string, apikey string, signature string, template string) (*SmsaeroClient, error)

func (*SmsaeroClient) SendMessage 

func (c *SmsaeroClient) SendMessage(param map[string]string, numbers ...string) error

type SmsaeroMessage 

type SmsaeroMessage struct {
	Numbers []string `json:"numbers"`
	Sign    string   `json:"sign"`
	Text    string   `json:"text"`
	Channel string   `json:"channel"`
}

type SmsaeroResult 

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

type SubmailClient 

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

func GetSubmailClient 

func GetSubmailClient(appid string, signature string, project string) (*SubmailClient, error)

func (*SubmailClient) SendMessage 

func (c *SubmailClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type SubmailResult 

type SubmailResult struct {
	Status string `json:"status"`
	Code   int    `json:"code"`
	Msg    string `json:"msg"`
}

type TencentClient 

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

func GetTencentClient 

func GetTencentClient(accessId string, accessKey string, sign string, templateId string, appId []string) (*TencentClient, error)

func (*TencentClient) SendMessage 

func (c *TencentClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type TwilioClient 

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

func GetTwilioClient 

func GetTwilioClient(accessId string, accessKey string, template string) (*TwilioClient, error)

func (*TwilioClient) SendMessage 

func (c *TwilioClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

SendMessage targetPhoneNumber[0] is the sender's number, so targetPhoneNumber should have at least two parameters

type UcloudClient 

type UcloudClient struct {
	ProjectId  string
	PrivateKey string
	PublicKey  string
	Sign       string
	Template   string
	// contains filtered or unexported fields
}

func GetUcloudClient 

func GetUcloudClient(publicKey string, privateKey string, sign string, template string, projectId []string) (*UcloudClient, error)

func (*UcloudClient) SendMessage 

func (c *UcloudClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

type VolcClient 

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

func GetVolcClient 

func GetVolcClient(accessId, accessKey, sign, templateId string, smsAccount []string) (*VolcClient, error)

func (*VolcClient) SendMessage 

func (c *VolcClient) SendMessage(param map[string]string, targetPhoneNumber ...string) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.