sms

Documentation

Index

• Constants
• Variables
• type Gateway
  • func NewSMSGateway(login string, password string) *Gateway
  • func NewSMSGatewayFromEnv() (*Gateway, error)
  • func (g *Gateway) Balance() (float64, error)
  • func (g *Gateway) CheckMessages(ids ...string) ([]*Result, error)
  • func (g *Gateway) CheckQuery(name string, limit int) ([]*Result, error)
  • func (g *Gateway) Send(msg Message) (*Result, error)
  • func (g *Gateway) Senders() ([]string, error)
• type Message
  • func (m *Message) Encode() string
• type Result

Constants

const (
	// Статусы сообщений
	StatusAccepted      status = "accepted"       // Сообщение принято в обработку
	StatusQueued        status = "queued"         // Сообщение находится в очереди
	StatusDelivered     status = "delivered"      // Сообщение доставлено
	StatusDeliveryError status = "delivery error" // Ошибка доставки SMS
	StatusSMSCSubmit    status = "smsc submit"    // Сообщение доставлено в SMSC
	StatusSMSCReject    status = "smsc reject"    // Сообщение отвергнуто SMSC
	StatusIncorrectID   status = "incorrect id"   // Неверный идентификатор сообщения
)

Variables

var (
	ErrLoginMissing    = errors.New("sms gateway login missing")
	ErrPasswordMissing = errors.New("sms gateway password missing")
)

var (
	ErrWrongResponseParts = errors.New("wrong parts in response")
)

Types

type Gateway

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

func NewSMSGateway

func NewSMSGateway(login string, password string) *Gateway

Инициализация нового шлюза для отправки сообщений

func NewSMSGatewayFromEnv

func NewSMSGatewayFromEnv() (*Gateway, error)

Функция инициализирует шлюз из окружения операционной системы

func (*Gateway) Balance

func (g *Gateway) Balance() (float64, error)

Метод для проверки баланса на аккаунте

func (*Gateway) CheckMessages

func (g *Gateway) CheckMessages(ids ...string) ([]*Result, error)

Проверка состояния отправленного сообщения (до 200 id в запросе)

func (*Gateway) CheckQuery

func (g *Gateway) CheckQuery(name string, limit int) ([]*Result, error)

Проверка очереди статусов отправленных сообщений

func (*Gateway) Send

func (g *Gateway) Send(msg Message) (*Result, error)

Передача сообщения

func (*Gateway) Senders

func (g *Gateway) Senders() ([]string, error)

Метод для получения списка доступных подписей отправителя

type Message

type Message struct {
	Phone    string    // Телефон в формате +71234567890
	Text     string    // Текст сообщения
	WapURL   string    // Wap-push ссылка (прим: wap.yousite.ru)
	Sender   string    // Подпись отправителя
	Flash    bool      // Flash SMS – сообщение, которое сразу отображается на экране и не сохраняется в памяти телефона
	Schedule time.Time // Время для отложенной отправки
	Queue    string    // Название очереди статусов отправленных сообщений
}

Структура описывает сообщение, которое сервис может отправить

Обязательные поля: Phone, Text

func (*Message) Encode

func (m *Message) Encode() string

type Result

type Result struct {
	ID     string
	Status status
}

Структура для описания результата