sms

Documentation

Index

• Variables
• type BinaryContent
• type Client
  • func (client *Client) GetSentSMSDeliveryReports(query GetSentSMSDeliveryReportsQuery) (*SMSReportResponse, error)
  • func (client *Client) SendMultipleTextualSMSAdvanced(request SMSAdvancedTextualRequest) (*SMSResponse, error)
• type DeliveryDay
  • func (val DeliveryDay) MarshalJSON() ([]byte, error)
  • func (val DeliveryDay) String() string
  • func (val *DeliveryDay) UnmarshalJSON(data []byte) error
• type DeliveryTime
• type DeliveryTimeWindow
• type Destination
• type Error
• type GetSentSMSDeliveryReportsQuery
  • func (query GetSentSMSDeliveryReportsQuery) Query() url.Values
• type IndiaDLTOptions
• type Language
• type Message
• type Price
• type RegionalOptions
• type SMSAdvancedTextualRequest
• type SMSReport
• type SMSReportResponse
• type SMSResponse
• type SMSResponseDetails
• type Status
• type Tracking

Variables

var DeliveryDayValues = []DeliveryDay{
	DD_MONDAY, DD_TUESDAY, DD_WEDNESDAY, DD_THURSDAY, DD_FRIDAY, DD_SATURDAY, DD_SUNDAY,
}

Types

type BinaryContent

type BinaryContent struct {
	Hex        string `json:"hex,omitempty"`
	DataCoding int32  `json:"dataCoding,omitempty"`
	EsmClass   int32  `json:"esmClass,omitempty"`
}

type Client

type Client api.Client

func (*Client) GetSentSMSDeliveryReports

func (client *Client) GetSentSMSDeliveryReports(query GetSentSMSDeliveryReportsQuery) (*SMSReportResponse, error)

func (*Client) SendMultipleTextualSMSAdvanced

func (client *Client) SendMultipleTextualSMSAdvanced(request SMSAdvancedTextualRequest) (*SMSResponse, error)

type DeliveryDay

type DeliveryDay int

const (
	DD_MONDAY DeliveryDay = iota
	DD_TUESDAY
	DD_WEDNESDAY
	DD_THURSDAY
	DD_FRIDAY
	DD_SATURDAY
	DD_SUNDAY
)

func (DeliveryDay) MarshalJSON

func (val DeliveryDay) MarshalJSON() ([]byte, error)

func (DeliveryDay) String

func (val DeliveryDay) String() string

func (*DeliveryDay) UnmarshalJSON

func (val *DeliveryDay) UnmarshalJSON(data []byte) error

type DeliveryTime

type DeliveryTime struct {
	Hour   int32 `json:"hour,omitempty"`
	Minute int32 `json:"minute,omitempty"`
}

type DeliveryTimeWindow

type DeliveryTimeWindow struct {
	From *DeliveryTime `json:"from,omitempty"`
	To   *DeliveryTime `json:"to,omitempty"`
	Days []DeliveryDay `json:"days,omitempty"`
}

type Destination

type Destination struct {
	To        string `json:"to,omitempty"`
	MessageID string `json:"messageId,omitempty"`
}

type Error

type Error struct {
	GroupID     int32  `json:"groupId,omitempty"`
	GroupName   string `json:"groupName,omitempty"`
	ID          int32  `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Permanent   bool   `json:"permanent,omitempty"`
}

type GetSentSMSDeliveryReportsQuery

type GetSentSMSDeliveryReportsQuery struct {
	BulkID    string
	MessageID string
	Limit     int32
}

func (GetSentSMSDeliveryReportsQuery) Query

func (query GetSentSMSDeliveryReportsQuery) Query() url.Values

type IndiaDLTOptions

type IndiaDLTOptions struct {
	ContentTemplateID string `json:"contentTemplateId,omitempty"`
	PrincipalEntityID string `json:"principalEntityId,omitempty"`
}

type Language

type Language struct {
	SingleShift  bool   `json:"singleShift,omitempty"`
	LockingShift bool   `json:"lockingShift,omitempty"`
	LanguageCode string `json:"languageCode,omitempty"`
}

type Message

type Message struct {
	From               string              `json:"from,omitempty"`
	To                 []string            `json:"to,omitempty"`
	Destinations       []Destination       `json:"destinations,omitempty"`
	Text               string              `json:"text,omitempty"`
	Binary             *BinaryContent      `json:"binary,omitempty"`
	Flash              bool                `json:"flash,omitempty"`
	Language           *Language           `json:"language,omitempty"`
	Transliteration    string              `json:"transliteration,omitempty"`
	Notify             bool                `json:"notify,omitempty"`
	IntermediateReport bool                `json:"intermediateReport,omitempty"`
	NotifyURL          string              `json:"notifyUrl,omitempty"`
	NotifyContentType  string              `json:"notifyContentType,omitempty"`
	CallbackData       string              `json:"callbackData,omitempty"`
	ValidityPeriod     int64               `json:"validityPeriod,omitempty"`
	SendAt             *infobip.Time       `json:"sendAt,omitempty"`
	DeliveryTimeWindow *DeliveryTimeWindow `json:"deliveryTimeWindow,omitempty"`
	CampaignID         string              `json:"campaignId,omitempty"`
	OperatorClientID   string              `json:"operatorClientId,omitempty"`
	Regional           *RegionalOptions    `json:"regional,omitempty"`
}

type Price

type Price struct {
	PricePerMessage float64 `json:"pricePerMessage,omitempty"`
	PricePerLookup  float64 `json:"pricePerLookup,omitempty"`
	Currency        string  `json:"currency,omitempty"`
}

type RegionalOptions

type RegionalOptions struct {
	IndiaDLT *IndiaDLTOptions `json:"indiaDlt,omitempty"`
}

type SMSAdvancedTextualRequest

type SMSAdvancedTextualRequest struct {
	Tracking *Tracking `json:"tracking,omitempty"`
	Messages []Message `json:"messages,omitempty"`
	BulkID   string    `json:"bulkId,omitempty"`
}

type SMSReport

type SMSReport struct {
	BulkID       string        `json:"bulkId,omitempty"`
	MessageID    string        `json:"messageId,omitempty"`
	To           string        `json:"to,omitempty"`
	From         string        `json:"from,omitempty"`
	Text         string        `json:"text,omitempty"`
	SentAt       *infobip.Time `json:"sentAt,omitempty"`
	DoneAt       *infobip.Time `json:"doneAt,omitempty"`
	SMSCount     int32         `json:"smsCount,omitempty"`
	MccMnc       string        `json:"mccMnc,omitempty"`
	Price        *Price        `json:"price,omitempty"`
	Status       *Status       `json:"status,omitempty"`
	Error        *Error        `json:"error,omitempty"`
	CallbackData string        `json:"callbackData,omitempty"`
}

type SMSReportResponse

type SMSReportResponse struct {
	Results []SMSReport `json:"results,omitempty"`
}

type SMSResponse

type SMSResponse struct {
	BulkID             string               `json:"bulkId,omitempty"`
	TrackingProcessKey string               `json:"trackingProcessKey,omitempty"`
	Messages           []SMSResponseDetails `json:"messages,omitempty"`
}

type SMSResponseDetails

type SMSResponseDetails struct {
	To        string  `json:"to,omitempty"`
	Status    *Status `json:"status,omitempty"`
	SMSCount  int32   `json:"smsCount,omitempty"`
	MessageID string  `json:"messageId,omitempty"`
}

type Status

type Status struct {
	GroupID     int32  `json:"groupId,omitempty"`
	GroupName   string `json:"groupName,omitempty"`
	ID          int32  `json:"id,omitempty"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Action      string `json:"action,omitempty"`
}

type Tracking

type Tracking struct {
	Track      string `json:"track,omitempty"`
	ProcessKey string `json:"processKey,omitempty"`
	Type       string `json:"type,omitempty"`
	BaseURL    string `json:"baseUrl,omitempty"`
}