Class: Bandwidth::Voice::APIController

Inherits:
BaseController show all
Defined in:
lib/bandwidth/voice_lib/voice/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/voice_lib/voice/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_call(account_id, body: nil) ⇒ ApiCallResponse

Creates a call request

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • body (ApiCreateCallRequest) (defaults to: nil) —

    Optional parameter: Example:

Returns:



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
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 18

def create_call(,
                body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => 
  )
  _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
  )
  VoiceBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#delete_recording(account_id, call_id, recording_id) ⇒ void

This method returns an undefined value.

Deletes the specified recording

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

  • recording_id (String) —

    Required parameter: Example:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
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
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 406

def delete_recording(,
                     call_id,
                     recording_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id,
    'recordingId' => recording_id
  )
  _query_url = APIHelper.clean_url _query_builder

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

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 404
    raise APIException.new(
      'The recording never existed, no longer exists, or is inaccessible' \
      ' to you',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#get_metadata_for_recording(account_id, call_id, recording_id) ⇒ RecordingMetadataResponse

Returns metadata for the specified recording

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

  • recording_id (String) —

    Required parameter: Example:

Returns:



324
325
326
327
328
329
330
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
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 324

def get_metadata_for_recording(,
                               call_id,
                               recording_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id,
    'recordingId' => recording_id
  )
  _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
  )
  VoiceBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 404
    raise APIException.new(
      'The recording never existed, no longer exists, or is inaccessible' \
      ' to you',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#get_query_metadata_for_account(account_id) ⇒ List of RecordingMetadataResponse

Returns a (potentially empty; capped at 1000) list of metadata for the recordings associated with the specified account

Parameters:

  • account_id (String) —

    Required parameter: Example:

Returns:



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 553

def ()
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/recordings'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => 
  )
  _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
  )
  VoiceBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#get_query_metadata_for_account_and_call(account_id, call_id) ⇒ List of RecordingMetadataResponse

Returns a (potentially empty) list of metadata for the recordings that took place during the specified call

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

Returns:



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
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 248

def (,
                                            call_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id
  )
  _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
  )
  VoiceBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#get_stream_recording_media(account_id, call_id, recording_id) ⇒ Binary

Downloads the specified recording

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

  • recording_id (String) —

    Required parameter: Example:

Returns:

  • (Binary) —

    response from the API call



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 480

def get_stream_recording_media(,
                               call_id,
                               recording_id)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recordings/{recordingId}/media'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id,
    'recordingId' => recording_id
  )
  _query_url = APIHelper.clean_url _query_builder

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

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise ErrorResponseException.new(
      'Something didn\'t look right about that request. Please fix it' \
      ' before trying again.',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 404
    raise APIException.new(
      'The recording never existed, no longer exists, or is inaccessible' \
      ' to you',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#modify_call(account_id, call_id, body: nil) ⇒ void

This method returns an undefined value.

Interrupts and replaces an active call’s BXML document

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

  • body (ApiModifyCallRequest) (defaults to: nil) —

    Optional parameter: Example:



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
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 92

def modify_call(,
                call_id,
                body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id
  )
  _query_url = APIHelper.clean_url _query_builder

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

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

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise APIException.new(
      'The call can\'t be modified in its current state',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 404
    raise APIException.new(
      'The call never existed, no longer exists, or is inaccessible to you',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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

#modify_call_recording_state(account_id, call_id, body: nil) ⇒ void

This method returns an undefined value.

Pauses or resumes a recording

Parameters:

  • account_id (String) —

    Required parameter: Example:

  • call_id (String) —

    Required parameter: Example:

  • body (ModifyCallRecordingState) (defaults to: nil) —

    Optional parameter: Example:



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
 
# File 'lib/bandwidth/voice_lib/voice/controllers/api_controller.rb', line 170

def modify_call_recording_state(,
                                call_id,
                                body: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::VOICEDEFAULT)
  _query_builder << '/api/v2/accounts/{accountId}/calls/{callId}/recording'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => ,
    'callId' => call_id
  )
  _query_url = APIHelper.clean_url _query_builder

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

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

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise APIException.new(
      'The call can\'t be modified in its current state',
      _response
    )
  elsif _response.status_code == 401
    raise APIException.new(
      'Please authenticate yourself',
      _response
    )
  elsif _response.status_code == 403
    raise ErrorResponseException.new(
      'Your credentials are invalid. Please use your API credentials for' \
      ' the Bandwidth Dashboard.',
      _response
    )
  elsif _response.status_code == 404
    raise APIException.new(
      'The call never existed, no longer exists, or is inaccessible to you',
      _response
    )
  elsif _response.status_code == 415
    raise ErrorResponseException.new(
      'We don\'t support that media type. Please send us' \
      ' `application/json`.',
      _response
    )
  elsif _response.status_code == 429
    raise ErrorResponseException.new(
      'You\'re sending requests to this endpoint too frequently. Please' \
      ' slow your request rate down and try again.',
      _response
    )
  elsif _response.status_code == 500
    raise ErrorResponseException.new(
      'Something unexpected happened. Please try again.',
      _response
    )
  end
  validate_response(_response)

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