Class: Bandwidth::Messaging::APIController

Inherits:
BaseController show all
Defined in:
lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

Overview

APIController

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #validate_parameters, #validate_response

Constructor Details

#initialize(config, http_call_back: nil) ⇒ APIController

Returns a new instance of APIController.



10
11
12
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 10

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#create_message(account_id, body) ⇒ BandwidthMessage

Endpoint for sending text messages and picture messages using V2 messaging.

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • body (MessageRequest) —

    Required parameter: Example:

Returns:



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 422

def create_message(,
                   body)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/messages'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: BandwidthMessage.from_hash(decoded)
  )
end

#delete_media(account_id, media_id) ⇒ void

This method returns an undefined value.

Deletes a media file from Bandwidth API server. Make sure you don’t have any application scripts still using the media before you delete. If you accidentally delete a media file, you can immediately upload a new file with the same name.

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • media_id (String) —

    Required parameter: The media ID to delete



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
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 248

def delete_media(,
                 media_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'mediaId' => { 'value' => media_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end

#get_media(account_id, media_id) ⇒ Binary

Downloads a media file you previously uploaded.

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • media_id (String) —

    Required parameter: Media ID to retrieve

Returns:

  • (Binary) —

    response from the API call



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
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 91

def get_media(,
              media_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'mediaId' => { 'value' => media_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request, binary: true)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(
    _response, data: _response.raw_body
  )
end

#get_messages(account_id, message_id: nil, source_tn: nil, destination_tn: nil, message_status: nil, error_code: nil, from_date_time: nil, to_date_time: nil, page_token: nil, limit: nil) ⇒ BandwidthMessagesList

Gets a list of messages based on query parameters. search for. Special characters need to be encoded using URL encoding the message received the message message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED, ACCEPTED, UNDELIVERED message range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days. for pagination of results in search result. Default 100. The sum of limit and after cannot be more than 10000

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • message_id (String) (defaults to: nil) —

    Optional parameter: The ID of the message to

  • source_tn (String) (defaults to: nil) —

    Optional parameter: The phone number that sent

  • destination_tn (String) (defaults to: nil) —

    Optional parameter: The phone number that

  • message_status (String) (defaults to: nil) —

    Optional parameter: The status of the

  • error_code (Integer) (defaults to: nil) —

    Optional parameter: The error code of the

  • from_date_time (String) (defaults to: nil) —

    Optional parameter: The start of the date

  • to_date_time (String) (defaults to: nil) —

    Optional parameter: The end of the date range

  • page_token (String) (defaults to: nil) —

    Optional parameter: A base64 encoded value used

  • limit (Integer) (defaults to: nil) —

    Optional parameter: The maximum records requested

Returns:



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 331

def get_messages(,
                 message_id: nil,
                 source_tn: nil,
                 destination_tn: nil,
                 message_status: nil,
                 error_code: nil,
                 from_date_time: nil,
                 to_date_time: nil,
                 page_token: nil,
                 limit: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/messages'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    'messageId' => message_id,
    'sourceTn' => source_tn,
    'destinationTn' => destination_tn,
    'messageStatus' => message_status,
    'errorCode' => error_code,
    'fromDateTime' => from_date_time,
    'toDateTime' => to_date_time,
    'pageToken' => page_token,
    'limit' => limit
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: BandwidthMessagesList.from_hash(decoded)
  )
end

#list_media(account_id, continuation_token: nil) ⇒ List of Media

Gets a list of your media files. No query parameters are supported. used to retrieve subsequent media.

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • continuation_token (String) (defaults to: nil) —

    Optional parameter: Continuation token

Returns:

  • (List of Media) —

    response from the API call



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
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 19

def list_media(,
               continuation_token: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/media'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'Continuation-Token' => continuation_token
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response,
    data: decoded.map { |element| Media.from_hash(element) }
  )
end

#upload_media(account_id, media_id, body, content_type: 'application/octet-stream', cache_control: nil) ⇒ void

This method returns an undefined value.

Uploads a file the normal HTTP way. You may add headers to the request in order to provide some control to your media-file. media ID entity-body used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.

Parameters:

  • account_id (String) —

    Required parameter: User’s account ID

  • media_id (String) —

    Required parameter: The user supplied custom

  • body (File | UploadIO) —

    Required parameter: Example:

  • content_type (String) (defaults to: 'application/octet-stream') —

    Optional parameter: The media type of the

  • cache_control (String) (defaults to: nil) —

    Optional parameter: General-header field is



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
 
# File 'lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb', line 163

def upload_media(,
                 media_id,
                 body,
                 content_type: 'application/octet-stream',
                 cache_control: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
  _query_builder << '/users/{accountId}/media/{mediaId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false },
    'mediaId' => { 'value' => media_id, 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  if body.is_a? FileWrapper
    body_wrapper = body.file
    body_content_type = body.content_type
  else
    body_wrapper = body
    body_content_type = content_type
  end

  # Prepare headers.
  _headers = {
    'content-type' => body_content_type,
    'content-length' => body_wrapper.size.to_s,
    'Cache-Control' => cache_control
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.put(
    _query_url,
    headers: _headers,
    parameters: body_wrapper
  )
  MessagingBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  case _response.status_code
  when 400
    raise MessagingException.new(
      '400 Request is malformed or invalid',
      _response
    )
  when 401
    raise MessagingException.new(
      '401 The specified user does not have access to the account',
      _response
    )
  when 403
    raise MessagingException.new(
      '403 The user does not have access to this API',
      _response
    )
  when 404
    raise MessagingException.new(
      '404 Path not found',
      _response
    )
  when 415
    raise MessagingException.new(
      '415 The content-type of the request is incorrect',
      _response
    )
  when 429
    raise MessagingException.new(
      '429 The rate limit has been reached',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  ApiResponse.new(_response)
end