Class: PureCloud::VoicemailApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/voicemail_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VoicemailApi

Returns a new instance of VoicemailApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_voicemail_message(message_id, opts = {}) ⇒ nil

Delete a voicemail message. A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 32

def delete_voicemail_message(message_id, opts = {})
  delete_voicemail_message_with_http_info(message_id, opts)
  return nil
end

#delete_voicemail_message_with_http_info(message_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a voicemail message. A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 42

def delete_voicemail_message_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_message ..."
  end
  
  
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.delete_voicemail_message" if message_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#delete_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_voicemail_messages(opts = {}) ⇒ nil

Delete all voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 95

def delete_voicemail_messages(opts = {})
  delete_voicemail_messages_with_http_info(opts)
  return nil
end

#delete_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete all voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 104

def delete_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.delete_voicemail_messages ..."
  end
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#delete_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_mailbox(group_id, opts = {}) ⇒ VoicemailMailboxInfo

Get the group’s mailbox information

Parameters:

  • group_id —

    groupId

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



150
151
152
153
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 150

def get_voicemail_group_mailbox(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_mailbox_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_mailbox_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the group&#39;s mailbox information

Parameters:

  • group_id —

    groupId

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailMailboxInfo, Fixnum, Hash)>) —

    VoicemailMailboxInfo data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 160

def get_voicemail_group_mailbox_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_mailbox ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_mailbox" if group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/mailbox".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_messages(group_id, opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

  • group_id —

    Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



217
218
219
220
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 217

def get_voicemail_group_messages(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_messages_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_messages_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

  • group_id —

    Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 229

def get_voicemail_group_messages_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_messages ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_messages" if group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/messages".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_group_policy(group_id, opts = {}) ⇒ VoicemailGroupPolicy

Get a group’s voicemail policy

Parameters:

  • group_id —

    Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



298
299
300
301
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 298

def get_voicemail_group_policy(group_id, opts = {})
  data, _status_code, _headers = get_voicemail_group_policy_with_http_info(group_id, opts)
  return data
end

#get_voicemail_group_policy_with_http_info(group_id, opts = {}) ⇒ Array<(VoicemailGroupPolicy, Fixnum, Hash)>

Get a group&#39;s voicemail policy

Parameters:

  • group_id —

    Group ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailGroupPolicy, Fixnum, Hash)>) —

    VoicemailGroupPolicy data, response status code and response headers



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 308

def get_voicemail_group_policy_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_group_policy ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.get_voicemail_group_policy" if group_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailGroupPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_group_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_mailbox(opts = {}) ⇒ VoicemailMailboxInfo

Get the current user’s mailbox information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 362

def get_voicemail_mailbox(opts = {})
  data, _status_code, _headers = get_voicemail_mailbox_with_http_info(opts)
  return data
end

#get_voicemail_mailbox_with_http_info(opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the current user&#39;s mailbox information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailMailboxInfo, Fixnum, Hash)>) —

    VoicemailMailboxInfo data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 371

def get_voicemail_mailbox_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_mailbox ..."
  end
  
  # resource path
  local_var_path = "/api/v2/voicemail/mailbox".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_mailbox(opts = {}) ⇒ VoicemailMailboxInfo

Get the current user’s mailbox information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



417
418
419
420
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 417

def get_voicemail_me_mailbox(opts = {})
  data, _status_code, _headers = get_voicemail_me_mailbox_with_http_info(opts)
  return data
end

#get_voicemail_me_mailbox_with_http_info(opts = {}) ⇒ Array<(VoicemailMailboxInfo, Fixnum, Hash)>

Get the current user&#39;s mailbox information

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailMailboxInfo, Fixnum, Hash)>) —

    VoicemailMailboxInfo data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 426

def get_voicemail_me_mailbox_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_mailbox ..."
  end
  
  # resource path
  local_var_path = "/api/v2/voicemail/me/mailbox".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMailboxInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_messages(opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



474
475
476
477
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 474

def get_voicemail_me_messages(opts = {})
  data, _status_code, _headers = get_voicemail_me_messages_with_http_info(opts)
  return data
end

#get_voicemail_me_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 485

def get_voicemail_me_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_messages ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/me/messages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_me_policy(opts = {}) ⇒ VoicemailUserPolicy

Get the current user’s voicemail policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



545
546
547
548
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 545

def get_voicemail_me_policy(opts = {})
  data, _status_code, _headers = get_voicemail_me_policy_with_http_info(opts)
  return data
end

#get_voicemail_me_policy_with_http_info(opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Get the current user&#39;s voicemail policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailUserPolicy, Fixnum, Hash)>) —

    VoicemailUserPolicy data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 554

def get_voicemail_me_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_me_policy ..."
  end
  
  # resource path
  local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_message(message_id, opts = {}) ⇒ VoicemailMessage

Get a voicemail message

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



602
603
604
605
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 602

def get_voicemail_message(message_id, opts = {})
  data, _status_code, _headers = get_voicemail_message_with_http_info(message_id, opts)
  return data
end

#get_voicemail_message_media(message_id, opts = {}) ⇒ VoicemailMediaInfo

Get media playback URI for this voicemail message

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format. (default to WEBM)

Returns:



676
677
678
679
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 676

def get_voicemail_message_media(message_id, opts = {})
  data, _status_code, _headers = get_voicemail_message_media_with_http_info(message_id, opts)
  return data
end

#get_voicemail_message_media_with_http_info(message_id, opts = {}) ⇒ Array<(VoicemailMediaInfo, Fixnum, Hash)>

Get media playback URI for this voicemail message

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format_id (String) —

    The desired media format.

Returns:

  • (Array<(VoicemailMediaInfo, Fixnum, Hash)>) —

    VoicemailMediaInfo data, response status code and response headers



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 687

def get_voicemail_message_media_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message_media ..."
  end
  
  
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message_media" if message_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'format_id'] && !['WAV', 'WEBM', 'WAV_ULAW', 'OGG_VORBIS', 'OGG_OPUS', 'MP3', 'NONE'].include?(opts[:'format_id'])
    fail ArgumentError, 'invalid value for "format_id", must be one of WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}/media".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMediaInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_message_media\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_message_with_http_info(message_id, opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Get a voicemail message

Parameters:

  • message_id —

    Message ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:

  • (Array<(VoicemailMessage, Fixnum, Hash)>) —

    VoicemailMessage data, response status code and response headers



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 613

def get_voicemail_message_with_http_info(message_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_message ..."
  end
  
  
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.get_voicemail_message" if message_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_messages(opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    An optional comma separated list of VoicemailMessage ids

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



754
755
756
757
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 754

def get_voicemail_messages(opts = {})
  data, _status_code, _headers = get_voicemail_messages_with_http_info(opts)
  return data
end

#get_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ids (String) —

    An optional comma separated list of VoicemailMessage ids

  • :expand (Array<String>) —

    If the caller is a known user, which fields, if any, to expand

Returns:



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 765

def get_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_messages ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'ids'] = opts[:'ids'] if opts[:'ids']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_policy(opts = {}) ⇒ VoicemailOrganizationPolicy

Get a policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



825
826
827
828
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 825

def get_voicemail_policy(opts = {})
  data, _status_code, _headers = get_voicemail_policy_with_http_info(opts)
  return data
end

#get_voicemail_policy_with_http_info(opts = {}) ⇒ Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>

Get a policy

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 834

def get_voicemail_policy_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_policy ..."
  end
  
  # resource path
  local_var_path = "/api/v2/voicemail/policy".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailOrganizationPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_queue_messages(queue_id, opts = {}) ⇒ VoicemailMessageEntityListing

List voicemail messages

Parameters:

  • queue_id —

    Queue ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



883
884
885
886
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 883

def get_voicemail_queue_messages(queue_id, opts = {})
  data, _status_code, _headers = get_voicemail_queue_messages_with_http_info(queue_id, opts)
  return data
end

#get_voicemail_queue_messages_with_http_info(queue_id, opts = {}) ⇒ Array<(VoicemailMessageEntityListing, Fixnum, Hash)>

List voicemail messages

Parameters:

  • queue_id —

    Queue ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 895

def get_voicemail_queue_messages_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_queue_messages ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling VoicemailApi.get_voicemail_queue_messages" if queue_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/queues/{queueId}/messages".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_queue_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_search(q64, opts = {}) ⇒ VoicemailsSearchResponse

Search voicemails using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:



965
966
967
968
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 965

def get_voicemail_search(q64, opts = {})
  data, _status_code, _headers = get_voicemail_search_with_http_info(q64, opts)
  return data
end

#get_voicemail_search_with_http_info(q64, opts = {}) ⇒ Array<(VoicemailsSearchResponse, Fixnum, Hash)>

Search voicemails using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:

  • (Array<(VoicemailsSearchResponse, Fixnum, Hash)>) —

    VoicemailsSearchResponse data, response status code and response headers



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 976

def get_voicemail_search_with_http_info(q64, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_search ..."
  end
  
  
  # verify the required parameter 'q64' is set
  fail ArgumentError, "Missing the required parameter 'q64' when calling VoicemailApi.get_voicemail_search" if q64.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = q64
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_voicemail_userpolicy(user_id, opts = {}) ⇒ VoicemailUserPolicy

Get a user’s voicemail policy

Parameters:

  • user_id —

    User ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1039
1040
1041
1042
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1039

def get_voicemail_userpolicy(user_id, opts = {})
  data, _status_code, _headers = get_voicemail_userpolicy_with_http_info(user_id, opts)
  return data
end

#get_voicemail_userpolicy_with_http_info(user_id, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Get a user&#39;s voicemail policy

Parameters:

  • user_id —

    User ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailUserPolicy, Fixnum, Hash)>) —

    VoicemailUserPolicy data, response status code and response headers



1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1049

def get_voicemail_userpolicy_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.get_voicemail_userpolicy ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.get_voicemail_userpolicy" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#get_voicemail_userpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_group_policy(group_id, body, opts = {}) ⇒ VoicemailGroupPolicy

Update a group’s voicemail policy

Parameters:

  • group_id —

    Group ID

  • body —

    The group&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1105
1106
1107
1108
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1105

def patch_voicemail_group_policy(group_id, body, opts = {})
  data, _status_code, _headers = patch_voicemail_group_policy_with_http_info(group_id, body, opts)
  return data
end

#patch_voicemail_group_policy_with_http_info(group_id, body, opts = {}) ⇒ Array<(VoicemailGroupPolicy, Fixnum, Hash)>

Update a group&#39;s voicemail policy

Parameters:

  • group_id —

    Group ID

  • body —

    The group&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailGroupPolicy, Fixnum, Hash)>) —

    VoicemailGroupPolicy data, response status code and response headers



1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1116

def patch_voicemail_group_policy_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_group_policy ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling VoicemailApi.patch_voicemail_group_policy" if group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_group_policy" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/groups/{groupId}/policy".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailGroupPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_group_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_me_policy(body, opts = {}) ⇒ VoicemailUserPolicy

Update the current user’s voicemail policy

Parameters:

  • body —

    The user&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1179
1180
1181
1182
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1179

def patch_voicemail_me_policy(body, opts = {})
  data, _status_code, _headers = patch_voicemail_me_policy_with_http_info(body, opts)
  return data
end

#patch_voicemail_me_policy_with_http_info(body, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Update the current user&#39;s voicemail policy

Parameters:

  • body —

    The user&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailUserPolicy, Fixnum, Hash)>) —

    VoicemailUserPolicy data, response status code and response headers



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1189

def patch_voicemail_me_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_me_policy ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_me_policy" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/me/policy".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_me_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_message(message_id, body, opts = {}) ⇒ VoicemailMessage

Update a voicemail message A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1245
1246
1247
1248
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1245

def patch_voicemail_message(message_id, body, opts = {})
  data, _status_code, _headers = patch_voicemail_message_with_http_info(message_id, body, opts)
  return data
end

#patch_voicemail_message_with_http_info(message_id, body, opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Update a voicemail message A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailMessage, Fixnum, Hash)>) —

    VoicemailMessage data, response status code and response headers



1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1256

def patch_voicemail_message_with_http_info(message_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_message ..."
  end
  
  
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.patch_voicemail_message" if message_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_message" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_voicemail_userpolicy(user_id, body, opts = {}) ⇒ VoicemailUserPolicy

Update a user’s voicemail policy

Parameters:

  • user_id —

    User ID

  • body —

    The user&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1320
1321
1322
1323
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1320

def patch_voicemail_userpolicy(user_id, body, opts = {})
  data, _status_code, _headers = patch_voicemail_userpolicy_with_http_info(user_id, body, opts)
  return data
end

#patch_voicemail_userpolicy_with_http_info(user_id, body, opts = {}) ⇒ Array<(VoicemailUserPolicy, Fixnum, Hash)>

Update a user&#39;s voicemail policy

Parameters:

  • user_id —

    User ID

  • body —

    The user&#39;s voicemail policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailUserPolicy, Fixnum, Hash)>) —

    VoicemailUserPolicy data, response status code and response headers



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1331

def patch_voicemail_userpolicy_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_userpolicy ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling VoicemailApi.patch_voicemail_userpolicy" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_userpolicy" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/userpolicies/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailUserPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_userpolicy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_voicemail_messages(opts = {}) ⇒ VoicemailMessage

Copy a voicemail message to a user or group

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



1394
1395
1396
1397
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1394

def post_voicemail_messages(opts = {})
  data, _status_code, _headers = post_voicemail_messages_with_http_info(opts)
  return data
end

#post_voicemail_messages_with_http_info(opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Copy a voicemail message to a user or group

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(VoicemailMessage, Fixnum, Hash)>) —

    VoicemailMessage data, response status code and response headers



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1404

def post_voicemail_messages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_messages ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#post_voicemail_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_voicemail_search(body, opts = {}) ⇒ VoicemailsSearchResponse

Search voicemails

Parameters:

  • body —

    Search request options

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1457
1458
1459
1460
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1457

def post_voicemail_search(body, opts = {})
  data, _status_code, _headers = post_voicemail_search_with_http_info(body, opts)
  return data
end

#post_voicemail_search_with_http_info(body, opts = {}) ⇒ Array<(VoicemailsSearchResponse, Fixnum, Hash)>

Search voicemails

Parameters:

  • body —

    Search request options

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailsSearchResponse, Fixnum, Hash)>) —

    VoicemailsSearchResponse data, response status code and response headers



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1467

def post_voicemail_search_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.post_voicemail_search ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.post_voicemail_search" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/search".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailsSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#post_voicemail_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_voicemail_message(message_id, body, opts = {}) ⇒ VoicemailMessage

Update a voicemail message A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1523
1524
1525
1526
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1523

def put_voicemail_message(message_id, body, opts = {})
  data, _status_code, _headers = put_voicemail_message_with_http_info(message_id, body, opts)
  return data
end

#put_voicemail_message_with_http_info(message_id, body, opts = {}) ⇒ Array<(VoicemailMessage, Fixnum, Hash)>

Update a voicemail message A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.

Parameters:

  • message_id —

    Message ID

  • body —

    VoicemailMessage

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoicemailMessage, Fixnum, Hash)>) —

    VoicemailMessage data, response status code and response headers



1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1534

def put_voicemail_message_with_http_info(message_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_message ..."
  end
  
  
  # verify the required parameter 'message_id' is set
  fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.put_voicemail_message" if message_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_message" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#put_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_voicemail_policy(body, opts = {}) ⇒ VoicemailOrganizationPolicy

Update a policy

Parameters:

  • body —

    Policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1597
1598
1599
1600
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1597

def put_voicemail_policy(body, opts = {})
  data, _status_code, _headers = put_voicemail_policy_with_http_info(body, opts)
  return data
end

#put_voicemail_policy_with_http_info(body, opts = {}) ⇒ Array<(VoicemailOrganizationPolicy, Fixnum, Hash)>

Update a policy

Parameters:

  • body —

    Policy

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
 
# File 'lib/purecloudclient_v2a/api/voicemail_api.rb', line 1607

def put_voicemail_policy_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VoicemailApi.put_voicemail_policy ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.put_voicemail_policy" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/voicemail/policy".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoicemailOrganizationPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VoicemailApi#put_voicemail_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end