messagemedia_messages_sdk 2.0.3 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +292 -294
- data/lib/message_media_messages/exceptions/send_messages400_response_exception.rb +29 -29
- data/lib/message_media_messages/http/auth/auth_manager.rb +90 -90
- data/lib/message_media_messages/http/faraday_client.rb +1 -1
- data/lib/message_media_messages/models/confirm_delivery_reports_as_received_request1.rb +35 -35
- data/lib/message_media_messages/models/confirm_replies_as_received_request1.rb +35 -35
- data/lib/message_media_messages/models/delivery_report.rb +135 -135
- data/lib/message_media_messages/models/format1_enum.rb +20 -20
- data/lib/message_media_messages/models/format_enum.rb +20 -20
- data/lib/message_media_messages/models/get_message_status_response.rb +145 -145
- data/lib/message_media_messages/models/message.rb +166 -166
- data/lib/message_media_messages/models/reply.rb +112 -112
- data/lib/message_media_messages/models/source_number_type_enum.rb +21 -21
- data/lib/message_media_messages/models/status2_enum.rb +32 -32
- data/lib/message_media_messages/models/status_enum.rb +44 -44
- data/lib/message_media_messages/models/vendor_account_id.rb +44 -44
- metadata +12 -12
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e6e8b817954f1d1d78c4f6ca192c9505988b6442a764a27213f55170a033cf5b
|
|
4
|
+
data.tar.gz: fc4d1d4ba28b720c2e5aec0b797ed8d2cae06dba823a8417d17cae4184c6c76d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9c4fdc179c468f371d525dad185f84b5cd263e3779f13fd26135c38a5c78c78959163d23891cf25a808814a4e5659d085848635785eae906083b83868c5def57
|
|
7
|
+
data.tar.gz: f0dc2523c98c69b2ee6cec1b56606d08156cef4a00e8722ba923537bd7b80772d92b264145dd18f5c98bb422a9c28da68527820b480103067cf852bfb701fe31
|
data/README.md
CHANGED
|
@@ -1,294 +1,292 @@
|
|
|
1
|
-
|
|
2
|
-
# MessageMedia Messages Ruby SDK
|
|
3
|
-
[![Build Status](https://
|
|
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
|
-
body.messages =
|
|
94
|
-
|
|
95
|
-
body.messages[0] =
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
rescue
|
|
103
|
-
puts "Caught
|
|
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
|
-
body.messages =
|
|
131
|
-
|
|
132
|
-
body.messages[0] =
|
|
133
|
-
body.messages[0].
|
|
134
|
-
body.messages[0].
|
|
135
|
-
body.messages[0].
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
rescue
|
|
143
|
-
puts "Caught
|
|
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
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
## :page_with_curl: License
|
|
294
|
-
Apache License. See the [LICENSE](LICENSE) file.
|
|
1
|
+
|
|
2
|
+
# MessageMedia Messages Ruby SDK
|
|
3
|
+
[](https://github.com/messagemedia/messages-ruby-sdk/actions/workflows/ci.yml)
|
|
4
|
+
[](https://rubygems.org/gems/messagemedia_messages_sdk)
|
|
5
|
+
|
|
6
|
+
The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## Table of Contents
|
|
11
|
+
* [Authentication](#closed_lock_with_key-authentication)
|
|
12
|
+
* [Errors](#interrobang-errors)
|
|
13
|
+
* [Information](#newspaper-information)
|
|
14
|
+
* [Slack and Mailing List](#slack-and-mailing-list)
|
|
15
|
+
* [Bug Reports](#bug-reports)
|
|
16
|
+
* [Contributing](#contributing)
|
|
17
|
+
* [Installation](#star-installation)
|
|
18
|
+
* [Get Started](#clapper-get-started)
|
|
19
|
+
* [API Documentation](#closed_book-api-documentation)
|
|
20
|
+
* [Need help?](#confused-need-help)
|
|
21
|
+
* [License](#page_with_curl-license)
|
|
22
|
+
|
|
23
|
+
## :closed_lock_with_key: Authentication
|
|
24
|
+
|
|
25
|
+
Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
|
|
26
|
+
|
|
27
|
+
Requests are authenticated using HTTP Basic Auth or HMAC. For Basic Auth, your API key will be basicAuthUserName and API secret will be basicAuthPassword. For HMAC, your API key will be hmacAuthUserName and API secret will be hmacAuthPassword. This is demonstrated in the [Send an SMS example](https://github.com/messagemedia/messages-ruby-sdk/blob/master/README.md#send-an-sms) below.
|
|
28
|
+
|
|
29
|
+
## :interrobang: Errors
|
|
30
|
+
|
|
31
|
+
Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The most common status codes are listed below.
|
|
32
|
+
|
|
33
|
+
#### HTTP Status Codes
|
|
34
|
+
|
|
35
|
+
| Code | Title | Description |
|
|
36
|
+
|-----------|-------------|-------------|
|
|
37
|
+
| 400 | Invalid Request | The request was invalid |
|
|
38
|
+
| 401 | Unauthorized | Your API credentials are invalid |
|
|
39
|
+
| 403 | Disabled feature | Feature not enabled |
|
|
40
|
+
| 404 | Not Found | The resource does not exist |
|
|
41
|
+
| 50X | Internal Server Error | An error occurred with our API |
|
|
42
|
+
|
|
43
|
+
## :newspaper: Information
|
|
44
|
+
|
|
45
|
+
#### Slack and Mailing List
|
|
46
|
+
|
|
47
|
+
If you have any questions, comments, or concerns, please join our Slack channel:
|
|
48
|
+
https://developers.messagemedia.com/collaborate/slack/
|
|
49
|
+
|
|
50
|
+
Alternatively you can email us at:
|
|
51
|
+
developers@messagemedia.com
|
|
52
|
+
|
|
53
|
+
#### Bug reports
|
|
54
|
+
|
|
55
|
+
If you discover a problem with the SDK, we would like to know about it. You can raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues) or send an email to: developers@messagemedia.com
|
|
56
|
+
|
|
57
|
+
#### Contributing
|
|
58
|
+
|
|
59
|
+
We welcome your thoughts on how we could best provide you with SDKs that would simplify how you consume our services in your application. You can fork and create pull requests for any features you would like to see or raise an [issue](https://github.com/messagemedia/messages-nodejs-sdk/issues). Please be aware that a large share of the files are auto-generated by our backend tool.
|
|
60
|
+
|
|
61
|
+
## :star: Installation
|
|
62
|
+
* Run the following command to install the SDK via RubyGems:
|
|
63
|
+
```
|
|
64
|
+
gem install messages-ruby-sdk --version "3.0.0" --source "https://rubygems.pkg.github.com/messagemedia"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## :clapper: Get Started
|
|
68
|
+
It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.
|
|
69
|
+
|
|
70
|
+
### Send an SMS
|
|
71
|
+
Destination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156` NOT `0491570156`. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over [here](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.
|
|
72
|
+
|
|
73
|
+
```ruby
|
|
74
|
+
require 'message_media_messages'
|
|
75
|
+
require 'pp'
|
|
76
|
+
|
|
77
|
+
include MessageMediaMessages
|
|
78
|
+
|
|
79
|
+
auth_user_name = 'API_KEY'
|
|
80
|
+
auth_password = 'API_SECRET'
|
|
81
|
+
use_hmac = false
|
|
82
|
+
|
|
83
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
84
|
+
auth_user_name: auth_user_name,
|
|
85
|
+
auth_password: auth_password,
|
|
86
|
+
use_hmac_authentication: use_hmac
|
|
87
|
+
)
|
|
88
|
+
|
|
89
|
+
messages_controller = client.messages
|
|
90
|
+
body = SendMessagesRequest.new
|
|
91
|
+
body.messages = []
|
|
92
|
+
|
|
93
|
+
body.messages[0] = Message.new
|
|
94
|
+
body.messages[0].content = 'My first message'
|
|
95
|
+
body.messages[0].destination_number = '+61491570156'
|
|
96
|
+
|
|
97
|
+
begin
|
|
98
|
+
result = messages_controller.send_messages(body)
|
|
99
|
+
pp result
|
|
100
|
+
rescue SendMessages400ResponseException => ex
|
|
101
|
+
puts "Caught SendMessages400ResponseException: #{ex.message}"
|
|
102
|
+
rescue APIException => ex
|
|
103
|
+
puts "Caught APIException: #{ex.message}"
|
|
104
|
+
end
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Send an MMS
|
|
108
|
+
Destination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156` NOT `0491570156`. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over [here](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
require 'message_media_messages'
|
|
112
|
+
require 'pp'
|
|
113
|
+
|
|
114
|
+
include MessageMediaMessages
|
|
115
|
+
|
|
116
|
+
auth_user_name = 'API_KEY'
|
|
117
|
+
auth_password = 'API_SECRET'
|
|
118
|
+
use_hmac = false
|
|
119
|
+
|
|
120
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
121
|
+
auth_user_name: auth_user_name,
|
|
122
|
+
auth_password: auth_password,
|
|
123
|
+
use_hmac_authentication: use_hmac
|
|
124
|
+
)
|
|
125
|
+
|
|
126
|
+
messages_controller = client.messages
|
|
127
|
+
body = SendMessagesRequest.new
|
|
128
|
+
body.messages = []
|
|
129
|
+
|
|
130
|
+
body.messages[0] = Message.new
|
|
131
|
+
body.messages[0].content = 'My second message'
|
|
132
|
+
body.messages[0].destination_number = '+61491570158'
|
|
133
|
+
body.messages[0].format = FormatEnum::MMS
|
|
134
|
+
body.messages[0].media = ['https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg']
|
|
135
|
+
body.messages[0].subject = 'This is an MMS message'
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
result = messages_controller.send_messages(body)
|
|
139
|
+
pp result
|
|
140
|
+
rescue SendMessages400ResponseException => ex
|
|
141
|
+
puts "Caught SendMessages400ResponseException: #{ex.message}"
|
|
142
|
+
rescue APIException => ex
|
|
143
|
+
puts "Caught APIException: #{ex.message}"
|
|
144
|
+
end
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Get Status of a Message
|
|
148
|
+
You can get a messsage ID from a sent message by looking at the `message_id` from the response of the above example.
|
|
149
|
+
```ruby
|
|
150
|
+
require 'message_media_messages'
|
|
151
|
+
require 'pp'
|
|
152
|
+
|
|
153
|
+
include MessageMediaMessages
|
|
154
|
+
|
|
155
|
+
auth_user_name = 'API_KEY'
|
|
156
|
+
auth_password = 'API_SECRET'
|
|
157
|
+
use_hmac = false
|
|
158
|
+
|
|
159
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
160
|
+
auth_user_name: auth_user_name,
|
|
161
|
+
auth_password: auth_password,
|
|
162
|
+
use_hmac_authentication: use_hmac
|
|
163
|
+
)
|
|
164
|
+
|
|
165
|
+
messages_controller = client.messages
|
|
166
|
+
message_id = '877c19ef-fa2e-4cec-827a-e1df9b5509f7'
|
|
167
|
+
|
|
168
|
+
begin
|
|
169
|
+
result = messages_controller.get_message_status(message_id)
|
|
170
|
+
pp result
|
|
171
|
+
rescue APIException => ex
|
|
172
|
+
puts "Caught APIException: #{ex.message}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Get replies to a message
|
|
177
|
+
You can check for replies that are sent to your messages
|
|
178
|
+
```ruby
|
|
179
|
+
require 'message_media_messages'
|
|
180
|
+
require 'pp'
|
|
181
|
+
|
|
182
|
+
include MessageMediaMessages
|
|
183
|
+
|
|
184
|
+
auth_user_name = 'API_KEY'
|
|
185
|
+
auth_password = 'API_SECRET'
|
|
186
|
+
use_hmac = false
|
|
187
|
+
|
|
188
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
189
|
+
auth_user_name: auth_user_name,
|
|
190
|
+
auth_password: auth_password,
|
|
191
|
+
use_hmac_authentication: use_hmac
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
replies_controller = client.replies
|
|
195
|
+
begin
|
|
196
|
+
result = replies_controller.check_replies()
|
|
197
|
+
pp replies
|
|
198
|
+
rescue APIException => ex
|
|
199
|
+
puts "Caught APIException: #{ex.message}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Check Delivery Reports
|
|
204
|
+
This endpoint allows you to check for delivery reports to inbound and outbound messages.
|
|
205
|
+
```ruby
|
|
206
|
+
require 'message_media_messages'
|
|
207
|
+
require 'pp'
|
|
208
|
+
|
|
209
|
+
auth_user_name = 'API_KEY'
|
|
210
|
+
auth_password = 'API_SECRET'
|
|
211
|
+
use_hmac = false
|
|
212
|
+
|
|
213
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
214
|
+
auth_user_name: auth_user_name,
|
|
215
|
+
auth_password: auth_password,
|
|
216
|
+
use_hmac_authentication: use_hmac
|
|
217
|
+
)
|
|
218
|
+
|
|
219
|
+
delivery_reports_controller = client.delivery_reports
|
|
220
|
+
begin
|
|
221
|
+
result = delivery_reports_controller.check_delivery_reports()
|
|
222
|
+
pp result
|
|
223
|
+
rescue APIException => ex
|
|
224
|
+
puts "Caught APIException: #{ex.message}"
|
|
225
|
+
end
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Confirm Delivery Reports
|
|
229
|
+
This endpoint allows you to mark delivery reports as confirmed so they're no longer returned by the Check Delivery Reports function.
|
|
230
|
+
```ruby
|
|
231
|
+
require 'message_media_messages'
|
|
232
|
+
require 'pp'
|
|
233
|
+
|
|
234
|
+
include MessageMediaMessages
|
|
235
|
+
|
|
236
|
+
auth_user_name = 'API_KEY'
|
|
237
|
+
auth_password = 'API_SECRET'
|
|
238
|
+
use_hmac = false
|
|
239
|
+
|
|
240
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
241
|
+
auth_user_name: auth_user_name,
|
|
242
|
+
auth_password: auth_password,
|
|
243
|
+
use_hmac_authentication: use_hmac
|
|
244
|
+
)
|
|
245
|
+
|
|
246
|
+
delivery_reports_controller = client.delivery_reports
|
|
247
|
+
body = ConfirmDeliveryReportsAsReceivedRequest.new
|
|
248
|
+
body.delivery_report_ids = ['011dcead-6988-4ad6-a1c7-6b6c68ea628d', '3487b3fa-6586-4979-a233-2d1b095c7718', 'ba28e94b-c83d-4759-98e7-ff9c7edb87a1']
|
|
249
|
+
|
|
250
|
+
begin
|
|
251
|
+
result = delivery_reports_controller.confirm_delivery_reports_as_received(body)
|
|
252
|
+
pp result
|
|
253
|
+
rescue APIException => ex
|
|
254
|
+
puts "Caught APIException: #{ex.message}"
|
|
255
|
+
end
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
### Check credits remaining (Prepaid accounts only)
|
|
259
|
+
This endpoint allows you to check for credits remaining on your prepaid account.
|
|
260
|
+
```ruby
|
|
261
|
+
require 'message_media_messages'
|
|
262
|
+
require 'pp'
|
|
263
|
+
|
|
264
|
+
include MessageMediaMessages
|
|
265
|
+
|
|
266
|
+
auth_user_name = 'API_KEY'
|
|
267
|
+
auth_password = 'API_SECRET'
|
|
268
|
+
use_hmac = false
|
|
269
|
+
|
|
270
|
+
client = MessageMediaMessages::MessageMediaMessagesClient.new(
|
|
271
|
+
auth_user_name: auth_user_name,
|
|
272
|
+
auth_password: auth_password,
|
|
273
|
+
use_hmac_authentication: use_hmac
|
|
274
|
+
)
|
|
275
|
+
|
|
276
|
+
messages_controller = client.messages
|
|
277
|
+
begin
|
|
278
|
+
result = messages_controller.check_credits_remaining()
|
|
279
|
+
pp result
|
|
280
|
+
rescue APIException => ex
|
|
281
|
+
puts "Caught APIException: #{ex.message}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## :closed_book: API Reference Documentation
|
|
286
|
+
Check out the [full API documentation](https://developers.messagemedia.com/code/messages-api-documentation/) for more detailed information.
|
|
287
|
+
|
|
288
|
+
## :confused: Need help?
|
|
289
|
+
Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
|
|
290
|
+
|
|
291
|
+
## :page_with_curl: License
|
|
292
|
+
Apache License. See the [LICENSE](LICENSE) file.
|