forked from messagebird/go-rest-api
/
message.go
209 lines (175 loc) · 5.2 KB
/
message.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
package sms
import (
"errors"
"net/http"
"net/url"
"strconv"
"time"
messagebird "github.com/Bijles-aan-Huis-B-V/messagebird-go-rest-api"
)
// TypeDetails is a hash with extra information.
// Is only used when a binary or premium message is sent.
type TypeDetails map[string]interface{}
// Message struct represents a message at messagebird.com.
type Message struct {
ID string
HRef string
Direction string
Type string
Originator string
Body string
Reference string
Validity *int
Gateway int
TypeDetails TypeDetails
DataCoding string
MClass int
ReportURL string
ScheduledDatetime *time.Time
CreatedDatetime *time.Time
Recipients messagebird.Recipients
}
// MessageList represents a list of Messages.
type MessageList struct {
Offset int
Limit int
Count int
TotalCount int
Links map[string]*string
Items []Message
}
// Params provide additional message send options and used in URL as params.
type Params struct {
GroupIds []string
Type string
Reference string
Validity int
Gateway int
TypeDetails TypeDetails
DataCoding string
ReportURL string
ScheduledDatetime time.Time
ShortenURLs bool
}
// ListParams provides additional message list options.
type ListParams struct {
Originator string
Direction string
Type string
Status string
Limit int
Offset int
}
func (lp *ListParams) QueryParams() string {
if lp == nil {
return ""
}
query := url.Values{}
if len(lp.Originator) > 0 {
query.Set("originator", lp.Originator)
}
if len(lp.Direction) > 0 {
query.Set("direction", lp.Direction)
}
if len(lp.Type) > 0 {
query.Set("type", lp.Type)
}
if len(lp.Status) > 0 {
query.Set("status", lp.Status)
}
if lp.Limit > 0 {
query.Set("limit", strconv.Itoa(lp.Limit))
}
if lp.Offset > 0 {
query.Set("offset", strconv.Itoa(lp.Offset))
}
return query.Encode()
}
type messageRequest struct {
Originator string `json:"originator"`
Body string `json:"body"`
Recipients []string `json:"recipients"`
GroupIds []string `json:"groupIds"`
Type string `json:"type,omitempty"`
Reference string `json:"reference,omitempty"`
Validity int `json:"validity,omitempty"`
Gateway int `json:"gateway,omitempty"`
TypeDetails TypeDetails `json:"typeDetails,omitempty"`
DataCoding string `json:"datacoding,omitempty"`
MClass int `json:"mclass,omitempty"`
ShortenURLs bool `json:"shortenUrls"`
ReportURL string `json:"reportUrl,omitempty"`
ScheduledDatetime string `json:"scheduledDatetime,omitempty"`
}
// path represents the path to the Message resource.
const path = "messages"
// Read retrieves the information of an existing Message.
func Read(c messagebird.Client, id string) (*Message, error) {
message := &Message{}
if err := c.Request(message, http.MethodGet, path+"/"+id, nil); err != nil {
return nil, err
}
return message, nil
}
// Delete Cancel sending Scheduled Sms.
// Return true if have been successfully deleted.
func Delete(c messagebird.Client, id string) error {
return c.Request(&Message{}, http.MethodDelete, path+"/"+id, nil)
}
// List retrieves all messages of the user represented as a MessageList object.
func List(c messagebird.Client, params *ListParams) (*MessageList, error) {
messageList := &MessageList{}
if err := c.Request(messageList, http.MethodGet, path+"?"+params.QueryParams(), nil); err != nil {
return nil, err
}
return messageList, nil
}
// Create creates a new message for one or more recipients.
func Create(c messagebird.Client, originator string, recipients []string, body string, msgParams *Params) (*Message, error) {
requestData, err := paramsToRequest(originator, recipients, body, msgParams)
if err != nil {
return nil, err
}
message := &Message{}
if err := c.Request(message, http.MethodPost, path, requestData); err != nil {
return nil, err
}
return message, nil
}
func paramsToRequest(originator string, recipients []string, body string, params *Params) (*messageRequest, error) {
if originator == "" {
return nil, errors.New("originator is required")
}
if len(recipients) == 0 {
return nil, errors.New("at least 1 recipient is required")
}
if body == "" {
return nil, errors.New("body is required")
}
request := &messageRequest{
Originator: originator,
Recipients: recipients,
Body: body,
}
if params == nil {
return request, nil
}
request.Type = params.Type
if request.Type == "flash" {
request.MClass = 0
} else {
request.MClass = 1
}
if !params.ScheduledDatetime.IsZero() {
request.ScheduledDatetime = params.ScheduledDatetime.Format(time.RFC3339)
}
request.GroupIds = params.GroupIds
request.Reference = params.Reference
request.Validity = params.Validity
request.Gateway = params.Gateway
request.TypeDetails = params.TypeDetails
request.DataCoding = params.DataCoding
request.ReportURL = params.ReportURL
request.ShortenURLs = params.ShortenURLs
return request, nil
}