Class: PureCloud::OutboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/outbound_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OutboundApi

Returns a new instance of OutboundApi.



23
24
25
 
# File 'lib/purecloud/api/outbound_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/purecloud/api/outbound_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_attemptlimits_attemptlimits_id(attempt_limits_id, opts = {}) ⇒ String

Delete attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

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

    the optional parameters

Returns:

  • (String) 


32
33
34
35
 
# File 'lib/purecloud/api/outbound_api.rb', line 32

def delete_attemptlimits_attemptlimits_id(attempt_limits_id, opts = {})
  data, status_code, headers = delete_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts)
  return data
end

#delete_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

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

    the optional parameters

Returns:

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

    String data, 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
 
# File 'lib/purecloud/api/outbound_api.rb', line 42

def delete_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_attemptlimits_attemptlimits_id ..."
  end
  
  # verify the required parameter 'attempt_limits_id' is set
  fail "Missing the required parameter 'attempt_limits_id' when calling delete_attemptlimits_attemptlimits_id" if attempt_limits_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_attemptlimits_attemptlimits_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_callabletimesets_callabletimeset_id(callable_time_set_id, opts = {}) ⇒ String

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:

  • (String) 


92
93
94
95
 
# File 'lib/purecloud/api/outbound_api.rb', line 92

def delete_callabletimesets_callabletimeset_id(callable_time_set_id, opts = {})
  data, status_code, headers = delete_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts)
  return data
end

#delete_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 102

def delete_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_callabletimesets_callabletimeset_id ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling delete_callabletimesets_callabletimeset_id" if callable_time_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_callabletimesets_callabletimeset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts = {}) ⇒ String

Delete a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Returns:

  • (String) 


152
153
154
155
 
# File 'lib/purecloud/api/outbound_api.rb', line 152

def delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts = {})
  data, status_code, headers = delete_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts)
  return data
end

#delete_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 162

def delete_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_callanalysisresponsesets_callanalysisset_id ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling delete_callanalysisresponsesets_callanalysisset_id" if call_analysis_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_callanalysisresponsesets_callanalysisset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaignrules_campaignrule_id(campaign_rule_id, opts = {}) ⇒ String

Delete Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

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

    the optional parameters

Returns:

  • (String) 


212
213
214
215
 
# File 'lib/purecloud/api/outbound_api.rb', line 212

def delete_campaignrules_campaignrule_id(campaign_rule_id, opts = {})
  data, status_code, headers = delete_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts)
  return data
end

#delete_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloud/api/outbound_api.rb', line 222

def delete_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_campaignrules_campaignrule_id ..."
  end
  
  # verify the required parameter 'campaign_rule_id' is set
  fail "Missing the required parameter 'campaign_rule_id' when calling delete_campaignrules_campaignrule_id" if campaign_rule_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_campaignrules_campaignrule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaigns_campaign_id(campaign_id, opts = {}) ⇒ Campaign

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/purecloud/api/outbound_api.rb', line 272

def delete_campaigns_campaign_id(campaign_id, opts = {})
  data, status_code, headers = delete_campaigns_campaign_id_with_http_info(campaign_id, opts)
  return data
end

#delete_campaigns_campaign_id_progress(campaign_id, opts = {}) ⇒ nil

Reset campaign progress and recycle the campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

  • (nil) 


332
333
334
335
 
# File 'lib/purecloud/api/outbound_api.rb', line 332

def delete_campaigns_campaign_id_progress(campaign_id, opts = {})
  delete_campaigns_campaign_id_progress_with_http_info(campaign_id, opts)
  return nil
end

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

Reset campaign progress and recycle the campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 342

def delete_campaigns_campaign_id_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_campaigns_campaign_id_progress ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling delete_campaigns_campaign_id_progress" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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: OutboundApi#delete_campaigns_campaign_id_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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
318
319
320
321
322
323
324
325
 
# File 'lib/purecloud/api/outbound_api.rb', line 282

def delete_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling delete_campaigns_campaign_id" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contactlists_contactlist_id(contact_list_id, opts = {}) ⇒ String

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

  • (String) 


391
392
393
394
 
# File 'lib/purecloud/api/outbound_api.rb', line 391

def delete_contactlists_contactlist_id(contact_list_id, opts = {})
  data, status_code, headers = delete_contactlists_contactlist_id_with_http_info(contact_list_id, opts)
  return data
end

#delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {}) ⇒ String

Delete a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

  • (String) 


452
453
454
455
 
# File 'lib/purecloud/api/outbound_api.rb', line 452

def delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {})
  data, status_code, headers = delete_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts)
  return data
end

#delete_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/purecloud/api/outbound_api.rb', line 463

def delete_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_contactlists_contactlist_id_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling delete_contactlists_contactlist_id_contacts_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling delete_contactlists_contactlist_id_contacts_contact_id" if contact_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_contactlists_contactlist_id_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contactlists_contactlist_id_with_http_info(contact_list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



401
402
403
404
405
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 401

def delete_contactlists_contactlist_id_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_contactlists_contactlist_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling delete_contactlists_contactlist_id" if contact_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_contactlists_contactlist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dnclists_dnclist_id(dnc_list_id, opts = {}) ⇒ String

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

  • (String) 


516
517
518
519
 
# File 'lib/purecloud/api/outbound_api.rb', line 516

def delete_dnclists_dnclist_id(dnc_list_id, opts = {})
  data, status_code, headers = delete_dnclists_dnclist_id_with_http_info(dnc_list_id, opts)
  return data
end

#delete_dnclists_dnclist_id_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/purecloud/api/outbound_api.rb', line 526

def delete_dnclists_dnclist_id_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_dnclists_dnclist_id ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling delete_dnclists_dnclist_id" if dnc_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_dnclists_dnclist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_rulesets_ruleset_id(rule_set_id, opts = {}) ⇒ String

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:

  • (String) 


576
577
578
579
 
# File 'lib/purecloud/api/outbound_api.rb', line 576

def delete_rulesets_ruleset_id(rule_set_id, opts = {})
  data, status_code, headers = delete_rulesets_ruleset_id_with_http_info(rule_set_id, opts)
  return data
end

#delete_rulesets_ruleset_id_with_http_info(rule_set_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
621
622
623
624
625
626
627
628
629
 
# File 'lib/purecloud/api/outbound_api.rb', line 586

def delete_rulesets_ruleset_id_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_rulesets_ruleset_id ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling delete_rulesets_ruleset_id" if rule_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_rulesets_ruleset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_schedules_campaigns_campaign_id(campaign_id, opts = {}) ⇒ String

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

  • (String) 


636
637
638
639
 
# File 'lib/purecloud/api/outbound_api.rb', line 636

def delete_schedules_campaigns_campaign_id(campaign_id, opts = {})
  data, status_code, headers = delete_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts)
  return data
end

#delete_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/purecloud/api/outbound_api.rb', line 646

def delete_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling delete_schedules_campaigns_campaign_id" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_schedules_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_schedules_sequences_sequence_id(sequence_id, opts = {}) ⇒ String

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:

  • (String) 


696
697
698
699
 
# File 'lib/purecloud/api/outbound_api.rb', line 696

def delete_schedules_sequences_sequence_id(sequence_id, opts = {})
  data, status_code, headers = delete_schedules_sequences_sequence_id_with_http_info(sequence_id, opts)
  return data
end

#delete_schedules_sequences_sequence_id_with_http_info(sequence_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
747
748
749
 
# File 'lib/purecloud/api/outbound_api.rb', line 706

def delete_schedules_sequences_sequence_id_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling delete_schedules_sequences_sequence_id" if sequence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_schedules_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sequences_sequence_id(sequence_id, opts = {}) ⇒ String

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:

  • (String) 


756
757
758
759
 
# File 'lib/purecloud/api/outbound_api.rb', line 756

def delete_sequences_sequence_id(sequence_id, opts = {})
  data, status_code, headers = delete_sequences_sequence_id_with_http_info(sequence_id, opts)
  return data
end

#delete_sequences_sequence_id_with_http_info(sequence_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 766

def delete_sequences_sequence_id_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling delete_sequences_sequence_id" if sequence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attemptlimits(opts = {}) ⇒ AttemptLimitsEntityListing

Query attempt limits list

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



821
822
823
824
 
# File 'lib/purecloud/api/outbound_api.rb', line 821

def get_attemptlimits(opts = {})
  data, status_code, headers = get_attemptlimits_with_http_info(opts)
  return data
end

#get_attemptlimits_attemptlimits_id(attempt_limits_id, opts = {}) ⇒ AttemptLimits

Get attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

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

    the optional parameters

Returns:



897
898
899
900
 
# File 'lib/purecloud/api/outbound_api.rb', line 897

def get_attemptlimits_attemptlimits_id(attempt_limits_id, opts = {})
  data, status_code, headers = get_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts)
  return data
end

#get_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Get attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

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

    the optional parameters

Returns:

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

    AttemptLimits data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 907

def get_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_attemptlimits_attemptlimits_id ..."
  end
  
  # verify the required parameter 'attempt_limits_id' is set
  fail "Missing the required parameter 'attempt_limits_id' when calling get_attemptlimits_attemptlimits_id" if attempt_limits_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_attemptlimits_attemptlimits_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attemptlimits_with_http_info(opts = {}) ⇒ Array<(AttemptLimitsEntityListing, Fixnum, Hash)>

Query attempt limits list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    AttemptLimitsEntityListing data, response status code and response headers



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
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/purecloud/api/outbound_api.rb', line 836

def get_attemptlimits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_attemptlimits ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AttemptLimitsEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callabletimesets(opts = {}) ⇒ CallableTimeSetEntityListing

Query callable time set list

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



962
963
964
965
 
# File 'lib/purecloud/api/outbound_api.rb', line 962

def get_callabletimesets(opts = {})
  data, status_code, headers = get_callabletimesets_with_http_info(opts)
  return data
end

#get_callabletimesets_callabletimeset_id(callable_time_set_id, opts = {}) ⇒ CallableTimeSet

Get callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:



1038
1039
1040
1041
 
# File 'lib/purecloud/api/outbound_api.rb', line 1038

def get_callabletimesets_callabletimeset_id(callable_time_set_id, opts = {})
  data, status_code, headers = get_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts)
  return data
end

#get_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Get callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:

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

    CallableTimeSet data, response status code and response headers



1048
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1048

def get_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimesets_callabletimeset_id ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling get_callabletimesets_callabletimeset_id" if callable_time_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_callabletimesets_callabletimeset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callabletimesets_with_http_info(opts = {}) ⇒ Array<(CallableTimeSetEntityListing, Fixnum, Hash)>

Query callable time set list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 977

def get_callabletimesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimesets ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CallableTimeSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callanalysisresponsesets(opts = {}) ⇒ ResponseSetEntityListing

Query a list of dialer call analysis response sets.

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1103
1104
1105
1106
 
# File 'lib/purecloud/api/outbound_api.rb', line 1103

def get_callanalysisresponsesets(opts = {})
  data, status_code, headers = get_callanalysisresponsesets_with_http_info(opts)
  return data
end

#get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts = {}) ⇒ ResponseSet

Get a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Returns:



1179
1180
1181
1182
 
# File 'lib/purecloud/api/outbound_api.rb', line 1179

def get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, opts = {})
  data, status_code, headers = get_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts)
  return data
end

#get_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Get a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Returns:

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

    ResponseSet 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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1189

def get_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets_callanalysisset_id ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling get_callanalysisresponsesets_callanalysisset_id" if call_analysis_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_callanalysisresponsesets_callanalysisset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callanalysisresponsesets_with_http_info(opts = {}) ⇒ Array<(ResponseSetEntityListing, Fixnum, Hash)>

Query a list of dialer call analysis response sets.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    ResponseSetEntityListing data, response status code and response headers



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/purecloud/api/outbound_api.rb', line 1118

def get_callanalysisresponsesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ResponseSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaignrules(opts = {}) ⇒ CampaignRuleEntityListing

Query Campaign Rule list

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1244
1245
1246
1247
 
# File 'lib/purecloud/api/outbound_api.rb', line 1244

def get_campaignrules(opts = {})
  data, status_code, headers = get_campaignrules_with_http_info(opts)
  return data
end

#get_campaignrules_campaignrule_id(campaign_rule_id, opts = {}) ⇒ CampaignRule

Get Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

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

    the optional parameters

Returns:



1320
1321
1322
1323
 
# File 'lib/purecloud/api/outbound_api.rb', line 1320

def get_campaignrules_campaignrule_id(campaign_rule_id, opts = {})
  data, status_code, headers = get_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts)
  return data
end

#get_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Get Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

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

    the optional parameters

Returns:

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

    CampaignRule data, response status code and response headers



1330
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1330

def get_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaignrules_campaignrule_id ..."
  end
  
  # verify the required parameter 'campaign_rule_id' is set
  fail "Missing the required parameter 'campaign_rule_id' when calling get_campaignrules_campaignrule_id" if campaign_rule_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaignrules_campaignrule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaignrules_with_http_info(opts = {}) ⇒ Array<(CampaignRuleEntityListing, Fixnum, Hash)>

Query Campaign Rule list

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    CampaignRuleEntityListing data, response status code and response headers



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
1313
 
# File 'lib/purecloud/api/outbound_api.rb', line 1259

def get_campaignrules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaignrules ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignRuleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns(opts = {}) ⇒ CampaignEntityListing

Query a list of dialer campaigns.

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_id (String) —

    DNC list ID

  • :distribution_queue_id (String) —

    Distribution queue ID

  • :edge_group_id (String) —

    Edge group ID

  • :call_analysis_response_set_id (String) —

    Call analysis response set ID

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1390
1391
1392
1393
 
# File 'lib/purecloud/api/outbound_api.rb', line 1390

def get_campaigns(opts = {})
  data, status_code, headers = get_campaigns_with_http_info(opts)
  return data
end

#get_campaigns_campaign_id(campaign_id, opts = {}) ⇒ Campaign

Get dialer campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1476
1477
1478
1479
 
# File 'lib/purecloud/api/outbound_api.rb', line 1476

def get_campaigns_campaign_id(campaign_id, opts = {})
  data, status_code, headers = get_campaigns_campaign_id_with_http_info(campaign_id, opts)
  return data
end

#get_campaigns_campaign_id_diagnostics(campaign_id, opts = {}) ⇒ CampaignDiagnostics

Get campaign diagnostics

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1536
1537
1538
1539
 
# File 'lib/purecloud/api/outbound_api.rb', line 1536

def get_campaigns_campaign_id_diagnostics(campaign_id, opts = {})
  data, status_code, headers = get_campaigns_campaign_id_diagnostics_with_http_info(campaign_id, opts)
  return data
end

#get_campaigns_campaign_id_diagnostics_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignDiagnostics, Fixnum, Hash)>

Get campaign diagnostics

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    CampaignDiagnostics data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1546

def get_campaigns_campaign_id_diagnostics_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns_campaign_id_diagnostics ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaigns_campaign_id_diagnostics" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/diagnostics".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignDiagnostics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns_campaign_id_diagnostics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_campaign_id_interactions(campaign_id, opts = {}) ⇒ CampaignInteractions

Get dialer campaign interactions.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1596
1597
1598
1599
 
# File 'lib/purecloud/api/outbound_api.rb', line 1596

def get_campaigns_campaign_id_interactions(campaign_id, opts = {})
  data, status_code, headers = get_campaigns_campaign_id_interactions_with_http_info(campaign_id, opts)
  return data
end

#get_campaigns_campaign_id_interactions_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignInteractions, Fixnum, Hash)>

Get dialer campaign interactions.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    CampaignInteractions data, response status code and response headers



1606
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1606

def get_campaigns_campaign_id_interactions_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns_campaign_id_interactions ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaigns_campaign_id_interactions" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/interactions".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignInteractions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns_campaign_id_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_campaign_id_progress(campaign_id, opts = {}) ⇒ CampaignProgress

Get campaign progress

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1656
1657
1658
1659
 
# File 'lib/purecloud/api/outbound_api.rb', line 1656

def get_campaigns_campaign_id_progress(campaign_id, opts = {})
  data, status_code, headers = get_campaigns_campaign_id_progress_with_http_info(campaign_id, opts)
  return data
end

#get_campaigns_campaign_id_progress_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignProgress, Fixnum, Hash)>

Get campaign progress

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    CampaignProgress data, response status code and response headers



1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
 
# File 'lib/purecloud/api/outbound_api.rb', line 1666

def get_campaigns_campaign_id_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns_campaign_id_progress ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaigns_campaign_id_progress" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignProgress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns_campaign_id_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_campaign_id_stats(campaign_id, opts = {}) ⇒ CampaignStats

Get statistics about a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1716
1717
1718
1719
 
# File 'lib/purecloud/api/outbound_api.rb', line 1716

def get_campaigns_campaign_id_stats(campaign_id, opts = {})
  data, status_code, headers = get_campaigns_campaign_id_stats_with_http_info(campaign_id, opts)
  return data
end

#get_campaigns_campaign_id_stats_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignStats, Fixnum, Hash)>

Get statistics about a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    CampaignStats data, response status code and response headers



1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/purecloud/api/outbound_api.rb', line 1726

def get_campaigns_campaign_id_stats_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns_campaign_id_stats ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaigns_campaign_id_stats" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/stats".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignStats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns_campaign_id_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Get dialer campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



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
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
 
# File 'lib/purecloud/api/outbound_api.rb', line 1486

def get_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaigns_campaign_id" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_campaigns_with_http_info(opts = {}) ⇒ Array<(CampaignEntityListing, Fixnum, Hash)>

Query a list of dialer campaigns.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_id (String) —

    DNC list ID

  • :distribution_queue_id (String) —

    Distribution queue ID

  • :edge_group_id (String) —

    Edge group ID

  • :call_analysis_response_set_id (String) —

    Call analysis response set ID

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    CampaignEntityListing data, response status code and response headers



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
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
 
# File 'lib/purecloud/api/outbound_api.rb', line 1410

def get_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'dncListId'] = opts[:'dnc_list_id'] if opts[:'dnc_list_id']
  query_params[:'distributionQueueId'] = opts[:'distribution_queue_id'] if opts[:'distribution_queue_id']
  query_params[:'edgeGroupId'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
  query_params[:'callAnalysisResponseSetId'] = opts[:'call_analysis_response_set_id'] if opts[:'call_analysis_response_set_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contactlists(opts = {}) ⇒ ContactListEntityListing

Query a list of contact lists.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1783
1784
1785
1786
 
# File 'lib/purecloud/api/outbound_api.rb', line 1783

def get_contactlists(opts = {})
  data, status_code, headers = get_contactlists_with_http_info(opts)
  return data
end

#get_contactlists_contactlist_id(contact_list_id, opts = {}) ⇒ ContactList

Get a dialer contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



1865
1866
1867
1868
 
# File 'lib/purecloud/api/outbound_api.rb', line 1865

def get_contactlists_contactlist_id(contact_list_id, opts = {})
  data, status_code, headers = get_contactlists_contactlist_id_with_http_info(contact_list_id, opts)
  return data
end

#get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {}) ⇒ DialerContact

Get a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:



1930
1931
1932
1933
 
# File 'lib/purecloud/api/outbound_api.rb', line 1930

def get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, opts = {})
  data, status_code, headers = get_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts)
  return data
end

#get_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {}) ⇒ Array<(DialerContact, Fixnum, Hash)>

Get a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

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

    DialerContact data, response status code and response headers



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'lib/purecloud/api/outbound_api.rb', line 1941

def get_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id_contacts_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling get_contactlists_contactlist_id_contacts_contact_id" if contact_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contactlists_contactlist_id_export(contact_list_id, opts = {}) ⇒ ExportUri

Get the URI of a contact list export.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri (default to false)

Returns:



1995
1996
1997
1998
 
# File 'lib/purecloud/api/outbound_api.rb', line 1995

def get_contactlists_contactlist_id_export(contact_list_id, opts = {})
  data, status_code, headers = get_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts)
  return data
end

#get_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ExportUri, Fixnum, Hash)>

Get the URI of a contact list export.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri

Returns:

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

    ExportUri data, response status code and response headers



2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
 
# File 'lib/purecloud/api/outbound_api.rb', line 2006

def get_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_export ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id_export" if contact_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contactlists_contactlist_id_importstatus(contact_list_id, opts = {}) ⇒ ImportStatus

Get dialer contactList import status.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:



2057
2058
2059
2060
 
# File 'lib/purecloud/api/outbound_api.rb', line 2057

def get_contactlists_contactlist_id_importstatus(contact_list_id, opts = {})
  data, status_code, headers = get_contactlists_contactlist_id_importstatus_with_http_info(contact_list_id, opts)
  return data
end

#get_contactlists_contactlist_id_importstatus_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ImportStatus, Fixnum, Hash)>

Get dialer contactList import status.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

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

    ImportStatus data, response status code and response headers



2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
 
# File 'lib/purecloud/api/outbound_api.rb', line 2067

def get_contactlists_contactlist_id_importstatus_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id_importstatus ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id_importstatus" if contact_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/importstatus".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contactlists_contactlist_id_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Get a dialer contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

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

    ContactList data, response status code and response headers



1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
 
# File 'lib/purecloud/api/outbound_api.rb', line 1877

def get_contactlists_contactlist_id_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists_contactlist_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contactlists_contactlist_id" if contact_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_contactlists_contactlist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_contactlists_with_http_info(opts = {}) ⇒ Array<(ContactListEntityListing, Fixnum, Hash)>

Query a list of contact lists.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    ContactListEntityListing data, response status code and response headers



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/purecloud/api/outbound_api.rb', line 1800

def get_contactlists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ContactListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnclists(opts = {}) ⇒ DncListEntityListing

Query dialer DNC lists

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



2124
2125
2126
2127
 
# File 'lib/purecloud/api/outbound_api.rb', line 2124

def get_dnclists(opts = {})
  data, status_code, headers = get_dnclists_with_http_info(opts)
  return data
end

#get_dnclists_dnclist_id(dnc_list_id, opts = {}) ⇒ DncList

Get dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



2206
2207
2208
2209
 
# File 'lib/purecloud/api/outbound_api.rb', line 2206

def get_dnclists_dnclist_id(dnc_list_id, opts = {})
  data, status_code, headers = get_dnclists_dnclist_id_with_http_info(dnc_list_id, opts)
  return data
end

#get_dnclists_dnclist_id_export(dnc_list_id, opts = {}) ⇒ ExportUri

Get the URI of a DNC list export.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri (default to false)

Returns:



2271
2272
2273
2274
 
# File 'lib/purecloud/api/outbound_api.rb', line 2271

def get_dnclists_dnclist_id_export(dnc_list_id, opts = {})
  data, status_code, headers = get_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts)
  return data
end

#get_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(ExportUri, Fixnum, Hash)>

Get the URI of a DNC list export.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri

Returns:

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

    ExportUri data, response status code and response headers



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
 
# File 'lib/purecloud/api/outbound_api.rb', line 2282

def get_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists_dnclist_id_export ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling get_dnclists_dnclist_id_export" if dnc_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_dnclists_dnclist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnclists_dnclist_id_importstatus(dnc_list_id, opts = {}) ⇒ ImportStatus

Get dialer dncList import status.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:



2333
2334
2335
2336
 
# File 'lib/purecloud/api/outbound_api.rb', line 2333

def get_dnclists_dnclist_id_importstatus(dnc_list_id, opts = {})
  data, status_code, headers = get_dnclists_dnclist_id_importstatus_with_http_info(dnc_list_id, opts)
  return data
end

#get_dnclists_dnclist_id_importstatus_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(ImportStatus, Fixnum, Hash)>

Get dialer dncList import status.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

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

    ImportStatus data, response status code and response headers



2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/purecloud/api/outbound_api.rb', line 2343

def get_dnclists_dnclist_id_importstatus_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists_dnclist_id_importstatus ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling get_dnclists_dnclist_id_importstatus" if dnc_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/importstatus".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_dnclists_dnclist_id_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnclists_dnclist_id_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Get dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

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

    DncList data, response status code and response headers



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
 
# File 'lib/purecloud/api/outbound_api.rb', line 2218

def get_dnclists_dnclist_id_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists_dnclist_id ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling get_dnclists_dnclist_id" if dnc_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_dnclists_dnclist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnclists_with_http_info(opts = {}) ⇒ Array<(DncListEntityListing, Fixnum, Hash)>

Query dialer DNC lists

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    DncListEntityListing data, response status code and response headers



2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/purecloud/api/outbound_api.rb', line 2141

def get_dnclists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DncListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_events(opts = {}) ⇒ DialerEventEntityListing

Query Event Logs

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2397
2398
2399
2400
 
# File 'lib/purecloud/api/outbound_api.rb', line 2397

def get_events(opts = {})
  data, status_code, headers = get_events_with_http_info(opts)
  return data
end

#get_events_event_id(event_id, opts = {}) ⇒ EventLog

Get Dialer Event

Parameters:

  • event_id —

    Event Log ID

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

    the optional parameters

Returns:



2471
2472
2473
2474
 
# File 'lib/purecloud/api/outbound_api.rb', line 2471

def get_events_event_id(event_id, opts = {})
  data, status_code, headers = get_events_event_id_with_http_info(event_id, opts)
  return data
end

#get_events_event_id_with_http_info(event_id, opts = {}) ⇒ Array<(EventLog, Fixnum, Hash)>

Get Dialer Event

Parameters:

  • event_id —

    Event Log ID

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

    the optional parameters

Returns:

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

    EventLog data, response status code and response headers



2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
 
# File 'lib/purecloud/api/outbound_api.rb', line 2481

def get_events_event_id_with_http_info(event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_events_event_id ..."
  end
  
  # verify the required parameter 'event_id' is set
  fail "Missing the required parameter 'event_id' when calling get_events_event_id" if event_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'EventLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_events_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_events_with_http_info(opts = {}) ⇒ Array<(DialerEventEntityListing, Fixnum, Hash)>

Query Event Logs

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    DialerEventEntityListing data, response status code and response headers



2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
 
# File 'lib/purecloud/api/outbound_api.rb', line 2411

def get_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_events ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/events".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DialerEventEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rulesets(opts = {}) ⇒ RuleSetEntityListing

Query a list of Rule Sets.

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2536
2537
2538
2539
 
# File 'lib/purecloud/api/outbound_api.rb', line 2536

def get_rulesets(opts = {})
  data, status_code, headers = get_rulesets_with_http_info(opts)
  return data
end

#get_rulesets_ruleset_id(rule_set_id, opts = {}) ⇒ RuleSet

Get a Rule Set by ID.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:



2612
2613
2614
2615
 
# File 'lib/purecloud/api/outbound_api.rb', line 2612

def get_rulesets_ruleset_id(rule_set_id, opts = {})
  data, status_code, headers = get_rulesets_ruleset_id_with_http_info(rule_set_id, opts)
  return data
end

#get_rulesets_ruleset_id_with_http_info(rule_set_id, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Get a Rule Set by ID.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:

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

    RuleSet data, response status code and response headers



2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
 
# File 'lib/purecloud/api/outbound_api.rb', line 2622

def get_rulesets_ruleset_id_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_rulesets_ruleset_id ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling get_rulesets_ruleset_id" if rule_set_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_rulesets_ruleset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rulesets_with_http_info(opts = {}) ⇒ Array<(RuleSetEntityListing, Fixnum, Hash)>

Query a list of Rule Sets.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    RuleSetEntityListing data, response status code and response headers



2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'lib/purecloud/api/outbound_api.rb', line 2551

def get_rulesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_rulesets ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'RuleSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_campaigns(opts = {}) ⇒ Array<CampaignSchedule>

Query for a list of dialer campaign schedules.

Parameters:

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

    the optional parameters

Returns:



2671
2672
2673
2674
 
# File 'lib/purecloud/api/outbound_api.rb', line 2671

def get_schedules_campaigns(opts = {})
  data, status_code, headers = get_schedules_campaigns_with_http_info(opts)
  return data
end

#get_schedules_campaigns_campaign_id(campaign_id, opts = {}) ⇒ CampaignSchedule

Get a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



2727
2728
2729
2730
 
# File 'lib/purecloud/api/outbound_api.rb', line 2727

def get_schedules_campaigns_campaign_id(campaign_id, opts = {})
  data, status_code, headers = get_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts)
  return data
end

#get_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignSchedule, Fixnum, Hash)>

Get a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    CampaignSchedule data, response status code and response headers



2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
 
# File 'lib/purecloud/api/outbound_api.rb', line 2737

def get_schedules_campaigns_campaign_id_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_schedules_campaigns_campaign_id" if campaign_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_schedules_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_campaigns_with_http_info(opts = {}) ⇒ Array<(Array<CampaignSchedule>, Fixnum, Hash)>

Query for a list of dialer campaign schedules.

Parameters:

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

    the optional parameters

Returns:

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

    Array<CampaignSchedule> data, response status code and response headers



2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'lib/purecloud/api/outbound_api.rb', line 2680

def get_schedules_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaigns ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Array<CampaignSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_schedules_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_sequences(opts = {}) ⇒ Array<SequenceSchedule>

Query for a list of dialer sequence schedules.

Parameters:

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

    the optional parameters

Returns:



2786
2787
2788
2789
 
# File 'lib/purecloud/api/outbound_api.rb', line 2786

def get_schedules_sequences(opts = {})
  data, status_code, headers = get_schedules_sequences_with_http_info(opts)
  return data
end

#get_schedules_sequences_sequence_id(sequence_id, opts = {}) ⇒ SequenceSchedule

Get a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:



2842
2843
2844
2845
 
# File 'lib/purecloud/api/outbound_api.rb', line 2842

def get_schedules_sequences_sequence_id(sequence_id, opts = {})
  data, status_code, headers = get_schedules_sequences_sequence_id_with_http_info(sequence_id, opts)
  return data
end

#get_schedules_sequences_sequence_id_with_http_info(sequence_id, opts = {}) ⇒ Array<(SequenceSchedule, Fixnum, Hash)>

Get a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:

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

    SequenceSchedule data, response status code and response headers



2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
 
# File 'lib/purecloud/api/outbound_api.rb', line 2852

def get_schedules_sequences_sequence_id_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling get_schedules_sequences_sequence_id" if sequence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_schedules_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_sequences_with_http_info(opts = {}) ⇒ Array<(Array<SequenceSchedule>, Fixnum, Hash)>

Query for a list of dialer sequence schedules.

Parameters:

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

    the optional parameters

Returns:

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

    Array<SequenceSchedule> data, response status code and response headers



2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
 
# File 'lib/purecloud/api/outbound_api.rb', line 2795

def get_schedules_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequences ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Array<SequenceSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_schedules_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sequences(opts = {}) ⇒ CampaignSequenceEntityListing

Query a list of dialer campaign sequences.

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)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2907
2908
2909
2910
 
# File 'lib/purecloud/api/outbound_api.rb', line 2907

def get_sequences(opts = {})
  data, status_code, headers = get_sequences_with_http_info(opts)
  return data
end

#get_sequences_sequence_id(sequence_id, opts = {}) ⇒ CampaignSequence

Get a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:



2983
2984
2985
2986
 
# File 'lib/purecloud/api/outbound_api.rb', line 2983

def get_sequences_sequence_id(sequence_id, opts = {})
  data, status_code, headers = get_sequences_sequence_id_with_http_info(sequence_id, opts)
  return data
end

#get_sequences_sequence_id_with_http_info(sequence_id, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Get a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:

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

    CampaignSequence data, response status code and response headers



2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
 
# File 'lib/purecloud/api/outbound_api.rb', line 2993

def get_sequences_sequence_id_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling get_sequences_sequence_id" if sequence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sequences_with_http_info(opts = {}) ⇒ Array<(CampaignSequenceEntityListing, Fixnum, Hash)>

Query a list of dialer campaign sequences.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
 
# File 'lib/purecloud/api/outbound_api.rb', line 2922

def get_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_sequences ..."
  end
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences".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']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSequenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_wrapupcodemappings(opts = {}) ⇒ WrapUpCodeMapping

Get the Dialer wrap up code mapping.

Parameters:

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

    the optional parameters

Returns:



3042
3043
3044
3045
 
# File 'lib/purecloud/api/outbound_api.rb', line 3042

def get_wrapupcodemappings(opts = {})
  data, status_code, headers = get_wrapupcodemappings_with_http_info(opts)
  return data
end

#get_wrapupcodemappings_with_http_info(opts = {}) ⇒ Array<(WrapUpCodeMapping, Fixnum, Hash)>

Get the Dialer wrap up code mapping.

Parameters:

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

    the optional parameters

Returns:

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

    WrapUpCodeMapping data, response status code and response headers



3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
 
# File 'lib/purecloud/api/outbound_api.rb', line 3051

def get_wrapupcodemappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_wrapupcodemappings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/wrapupcodemappings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_attemptlimits(body, opts = {}) ⇒ AttemptLimits

Create attempt limits

Parameters:

  • body —

    AttemptLimits

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

    the optional parameters

Returns:



3098
3099
3100
3101
 
# File 'lib/purecloud/api/outbound_api.rb', line 3098

def post_attemptlimits(body, opts = {})
  data, status_code, headers = post_attemptlimits_with_http_info(body, opts)
  return data
end

#post_attemptlimits_with_http_info(body, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Create attempt limits

Parameters:

  • body —

    AttemptLimits

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

    the optional parameters

Returns:

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

    AttemptLimits data, response status code and response headers



3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/purecloud/api/outbound_api.rb', line 3108

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_audits(body, opts = {}) ⇒ AuditSearchResult

Retrieves audits for dialer.

Parameters:

  • body —

    AuditSearch

  • 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)

  • :sort_by (String) —

    Sort by (default to entity.name)

  • :sort_order (String) —

    Sort order (default to ascending)

  • :facets_only (BOOLEAN) —

    Facets only (default to false)

Returns:



3163
3164
3165
3166
 
# File 'lib/purecloud/api/outbound_api.rb', line 3163

def post_audits(body, opts = {})
  data, status_code, headers = post_audits_with_http_info(body, opts)
  return data
end

#post_audits_with_http_info(body, opts = {}) ⇒ Array<(AuditSearchResult, Fixnum, Hash)>

Retrieves audits for dialer.

Parameters:

  • body —

    AuditSearch

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :facets_only (BOOLEAN) —

    Facets only

Returns:

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

    AuditSearchResult data, response status code and response headers



3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
 
# File 'lib/purecloud/api/outbound_api.rb', line 3178

def post_audits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_audits ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_audits" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/audits".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']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'facetsOnly'] = opts[:'facets_only'] if opts[:'facets_only']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AuditSearchResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_callabletimesets(body, opts = {}) ⇒ CallableTimeSet

Create callable time set

Parameters:

  • body —

    DialerCallableTimeSet

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

    the optional parameters

Returns:



3233
3234
3235
3236
 
# File 'lib/purecloud/api/outbound_api.rb', line 3233

def post_callabletimesets(body, opts = {})
  data, status_code, headers = post_callabletimesets_with_http_info(body, opts)
  return data
end

#post_callabletimesets_with_http_info(body, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Create callable time set

Parameters:

  • body —

    DialerCallableTimeSet

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

    the optional parameters

Returns:

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

    CallableTimeSet data, response status code and response headers



3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
 
# File 'lib/purecloud/api/outbound_api.rb', line 3243

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_callanalysisresponsesets(body, opts = {}) ⇒ ResponseSet

Create a dialer call analysis response set.

Parameters:

  • body —

    ResponseSet

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

    the optional parameters

Returns:



3293
3294
3295
3296
 
# File 'lib/purecloud/api/outbound_api.rb', line 3293

def post_callanalysisresponsesets(body, opts = {})
  data, status_code, headers = post_callanalysisresponsesets_with_http_info(body, opts)
  return data
end

#post_callanalysisresponsesets_with_http_info(body, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Create a dialer call analysis response set.

Parameters:

  • body —

    ResponseSet

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

    the optional parameters

Returns:

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

    ResponseSet data, response status code and response headers



3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
 
# File 'lib/purecloud/api/outbound_api.rb', line 3303

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaignrules(body, opts = {}) ⇒ CampaignRule

Create Campaign Rule

Parameters:

  • body —

    CampaignRule

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

    the optional parameters

Returns:



3353
3354
3355
3356
 
# File 'lib/purecloud/api/outbound_api.rb', line 3353

def post_campaignrules(body, opts = {})
  data, status_code, headers = post_campaignrules_with_http_info(body, opts)
  return data
end

#post_campaignrules_with_http_info(body, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Create Campaign Rule

Parameters:

  • body —

    CampaignRule

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

    the optional parameters

Returns:

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

    CampaignRule data, response status code and response headers



3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
 
# File 'lib/purecloud/api/outbound_api.rb', line 3363

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaigns(body, opts = {}) ⇒ Campaign

Create a campaign.

Parameters:

  • body —

    Campaign

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

    the optional parameters

Returns:



3413
3414
3415
3416
 
# File 'lib/purecloud/api/outbound_api.rb', line 3413

def post_campaigns(body, opts = {})
  data, status_code, headers = post_campaigns_with_http_info(body, opts)
  return data
end

#post_campaigns_campaign_id_callback_schedule(campaign_id, body, opts = {}) ⇒ ContactCallbackRequest

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use "/conversations/conversationId/participants/participantId/callbacks instead."

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    ContactCallbackRequest

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

    the optional parameters

Returns:



3474
3475
3476
3477
 
# File 'lib/purecloud/api/outbound_api.rb', line 3474

def post_campaigns_campaign_id_callback_schedule(campaign_id, body, opts = {})
  data, status_code, headers = post_campaigns_campaign_id_callback_schedule_with_http_info(campaign_id, body, opts)
  return data
end

#post_campaigns_campaign_id_callback_schedule_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(ContactCallbackRequest, Fixnum, Hash)>

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use &quot;/conversations/conversationId/participants/participantId/callbacks instead.&quot;

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    ContactCallbackRequest

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

    the optional parameters

Returns:

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

    ContactCallbackRequest data, response status code and response headers



3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
 
# File 'lib/purecloud/api/outbound_api.rb', line 3485

def post_campaigns_campaign_id_callback_schedule_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_campaigns_campaign_id_callback_schedule ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling post_campaigns_campaign_id_callback_schedule" if campaign_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_campaigns_campaign_id_callback_schedule" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/callback/schedule".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ContactCallbackRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_campaigns_campaign_id_callback_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaigns_progress(body, opts = {}) ⇒ Array<CampaignProgress>

Get progress for a list of campaigns

Parameters:

  • body —

    Campaign IDs

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

    the optional parameters

Returns:



3538
3539
3540
3541
 
# File 'lib/purecloud/api/outbound_api.rb', line 3538

def post_campaigns_progress(body, opts = {})
  data, status_code, headers = post_campaigns_progress_with_http_info(body, opts)
  return data
end

#post_campaigns_progress_with_http_info(body, opts = {}) ⇒ Array<(Array<CampaignProgress>, Fixnum, Hash)>

Get progress for a list of campaigns

Parameters:

  • body —

    Campaign IDs

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

    the optional parameters

Returns:

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

    Array<CampaignProgress> data, response status code and response headers



3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
 
# File 'lib/purecloud/api/outbound_api.rb', line 3548

def post_campaigns_progress_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_campaigns_progress ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_campaigns_progress" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/progress".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Array<CampaignProgress>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_campaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_campaigns_with_http_info(body, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Create a campaign.

Parameters:

  • body —

    Campaign

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
 
# File 'lib/purecloud/api/outbound_api.rb', line 3423

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_contactlists(body, opts = {}) ⇒ ContactList

Create a contact List.

Parameters:

  • body —

    ContactList

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

    the optional parameters

Returns:



3598
3599
3600
3601
 
# File 'lib/purecloud/api/outbound_api.rb', line 3598

def post_contactlists(body, opts = {})
  data, status_code, headers = post_contactlists_with_http_info(body, opts)
  return data
end

#post_contactlists_contactlist_id_contacts(contact_list_id, body, opts = {}) ⇒ Array<DialerContact>

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    Contact

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

    the optional parameters

Options Hash (opts):

  • :priority (BOOLEAN) —

    Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end.

  • :clear_system_data (BOOLEAN) —

    Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.

Returns:



3661
3662
3663
3664
 
# File 'lib/purecloud/api/outbound_api.rb', line 3661

def post_contactlists_contactlist_id_contacts(contact_list_id, body, opts = {})
  data, status_code, headers = post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, body, opts)
  return data
end

#post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, body, opts = {}) ⇒ Array<(Array<DialerContact>, Fixnum, Hash)>

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    Contact

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

    the optional parameters

Options Hash (opts):

  • :priority (BOOLEAN) —

    Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end.

  • :clear_system_data (BOOLEAN) —

    Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won&#39;t.

Returns:

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

    Array<DialerContact> data, response status code and response headers



3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
 
# File 'lib/purecloud/api/outbound_api.rb', line 3674

def post_contactlists_contactlist_id_contacts_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists_contactlist_id_contacts ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling post_contactlists_contactlist_id_contacts" if contact_list_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_contactlists_contactlist_id_contacts" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
  query_params[:'clearSystemData'] = opts[:'clear_system_data'] if opts[:'clear_system_data']

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Array<DialerContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_contactlists_contactlist_id_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_contactlists_contactlist_id_export(contact_list_id, opts = {}) ⇒ UriReference

Initiate the export of a contact list. Returns 200 if received OK.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:



3729
3730
3731
3732
 
# File 'lib/purecloud/api/outbound_api.rb', line 3729

def post_contactlists_contactlist_id_export(contact_list_id, opts = {})
  data, status_code, headers = post_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts)
  return data
end

#post_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts = {}) ⇒ Array<(UriReference, Fixnum, Hash)>

Initiate the export of a contact list. Returns 200 if received OK.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

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

    UriReference data, response status code and response headers



3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
 
# File 'lib/purecloud/api/outbound_api.rb', line 3739

def post_contactlists_contactlist_id_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_contactlists_contactlist_id_export ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling post_contactlists_contactlist_id_export" if contact_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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(: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 => 'UriReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_contactlists_contactlist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_contactlists_with_http_info(body, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Create a contact List.

Parameters:

  • body —

    ContactList

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

    the optional parameters

Returns:

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

    ContactList data, response status code and response headers



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
 
# File 'lib/purecloud/api/outbound_api.rb', line 3608

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_conversations_conversation_id_dnc(conversation_id, opts = {}) ⇒ nil

Add phone numbers to a Dialer DNC list.

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Returns:

  • (nil) 


3789
3790
3791
3792
 
# File 'lib/purecloud/api/outbound_api.rb', line 3789

def post_conversations_conversation_id_dnc(conversation_id, opts = {})
  post_conversations_conversation_id_dnc_with_http_info(conversation_id, opts)
  return nil
end

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

Add phone numbers to a Dialer DNC list.

Parameters:

  • conversation_id —

    Conversation ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
 
# File 'lib/purecloud/api/outbound_api.rb', line 3799

def post_conversations_conversation_id_dnc_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_conversations_conversation_id_dnc ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling post_conversations_conversation_id_dnc" if conversation_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/conversations/{conversationId}/dnc".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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(:POST, 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: OutboundApi#post_conversations_conversation_id_dnc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_dnclists(body, opts = {}) ⇒ DncList

Create dialer DNC list

Parameters:

  • body —

    DncList

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

    the optional parameters

Returns:



3848
3849
3850
3851
 
# File 'lib/purecloud/api/outbound_api.rb', line 3848

def post_dnclists(body, opts = {})
  data, status_code, headers = post_dnclists_with_http_info(body, opts)
  return data
end

#post_dnclists_dnclist_id_export(dnc_list_id, opts = {}) ⇒ UriReference

Initiate the export of a dnc list. Returns 200 if received OK.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:



3908
3909
3910
3911
 
# File 'lib/purecloud/api/outbound_api.rb', line 3908

def post_dnclists_dnclist_id_export(dnc_list_id, opts = {})
  data, status_code, headers = post_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts)
  return data
end

#post_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(UriReference, Fixnum, Hash)>

Initiate the export of a dnc list. Returns 200 if received OK.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

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

    UriReference data, response status code and response headers



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
 
# File 'lib/purecloud/api/outbound_api.rb', line 3918

def post_dnclists_dnclist_id_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_dnclists_dnclist_id_export ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling post_dnclists_dnclist_id_export" if dnc_list_id.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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(: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 => 'UriReference')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_dnclists_dnclist_id_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_dnclists_dnclist_id_phonenumbers(dnc_list_id, body, opts = {}) ⇒ nil

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DNC Phone Numbers

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

    the optional parameters

Returns:

  • (nil) 


3969
3970
3971
3972
 
# File 'lib/purecloud/api/outbound_api.rb', line 3969

def post_dnclists_dnclist_id_phonenumbers(dnc_list_id, body, opts = {})
  post_dnclists_dnclist_id_phonenumbers_with_http_info(dnc_list_id, body, opts)
  return nil
end

#post_dnclists_dnclist_id_phonenumbers_with_http_info(dnc_list_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DNC Phone Numbers

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
 
# File 'lib/purecloud/api/outbound_api.rb', line 3980

def post_dnclists_dnclist_id_phonenumbers_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#post_dnclists_dnclist_id_phonenumbers ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling post_dnclists_dnclist_id_phonenumbers" if dnc_list_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_dnclists_dnclist_id_phonenumbers" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/phonenumbers".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_dnclists_dnclist_id_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_dnclists_with_http_info(body, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Create dialer DNC list

Parameters:

  • body —

    DncList

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

    the optional parameters

Returns:

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

    DncList data, response status code and response headers



3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
 
# File 'lib/purecloud/api/outbound_api.rb', line 3858

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_rulesets(body, opts = {}) ⇒ RuleSet

Create a Dialer Call Analysis Response Set.

Parameters:

  • body —

    RuleSet

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

    the optional parameters

Returns:



4032
4033
4034
4035
 
# File 'lib/purecloud/api/outbound_api.rb', line 4032

def post_rulesets(body, opts = {})
  data, status_code, headers = post_rulesets_with_http_info(body, opts)
  return data
end

#post_rulesets_with_http_info(body, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Create a Dialer Call Analysis Response Set.

Parameters:

  • body —

    RuleSet

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

    the optional parameters

Returns:

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

    RuleSet data, response status code and response headers



4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
 
# File 'lib/purecloud/api/outbound_api.rb', line 4042

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_sequences(body, opts = {}) ⇒ CampaignSequence

Create a new campaign sequence.

Parameters:

  • body —

    Organization

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

    the optional parameters

Returns:



4092
4093
4094
4095
 
# File 'lib/purecloud/api/outbound_api.rb', line 4092

def post_sequences(body, opts = {})
  data, status_code, headers = post_sequences_with_http_info(body, opts)
  return data
end

#post_sequences_with_http_info(body, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Create a new campaign sequence.

Parameters:

  • body —

    Organization

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

    the optional parameters

Returns:

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

    CampaignSequence data, response status code and response headers



4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
 
# File 'lib/purecloud/api/outbound_api.rb', line 4102

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_attemptlimits_attemptlimits_id(attempt_limits_id, body, opts = {}) ⇒ AttemptLimits

Update attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • body —

    AttemptLimits

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

    the optional parameters

Returns:



4153
4154
4155
4156
 
# File 'lib/purecloud/api/outbound_api.rb', line 4153

def put_attemptlimits_attemptlimits_id(attempt_limits_id, body, opts = {})
  data, status_code, headers = put_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, body, opts)
  return data
end

#put_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, body, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Update attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • body —

    AttemptLimits

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

    the optional parameters

Returns:

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

    AttemptLimits data, response status code and response headers



4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
 
# File 'lib/purecloud/api/outbound_api.rb', line 4164

def put_attemptlimits_attemptlimits_id_with_http_info(attempt_limits_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_attemptlimits_attemptlimits_id ..."
  end
  
  # verify the required parameter 'attempt_limits_id' is set
  fail "Missing the required parameter 'attempt_limits_id' when calling put_attemptlimits_attemptlimits_id" if attempt_limits_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_attemptlimits_attemptlimits_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_attemptlimits_attemptlimits_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_callabletimesets_callabletimeset_id(callable_time_set_id, body, opts = {}) ⇒ CallableTimeSet

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • body —

    DialerCallableTimeSet

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

    the optional parameters

Returns:



4218
4219
4220
4221
 
# File 'lib/purecloud/api/outbound_api.rb', line 4218

def put_callabletimesets_callabletimeset_id(callable_time_set_id, body, opts = {})
  data, status_code, headers = put_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, body, opts)
  return data
end

#put_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, body, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • body —

    DialerCallableTimeSet

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

    the optional parameters

Returns:

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

    CallableTimeSet data, response status code and response headers



4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
 
# File 'lib/purecloud/api/outbound_api.rb', line 4229

def put_callabletimesets_callabletimeset_id_with_http_info(callable_time_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_callabletimesets_callabletimeset_id ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling put_callabletimesets_callabletimeset_id" if callable_time_set_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_callabletimesets_callabletimeset_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_callabletimesets_callabletimeset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, body, opts = {}) ⇒ ResponseSet

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • body —

    ResponseSet

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

    the optional parameters

Returns:



4283
4284
4285
4286
 
# File 'lib/purecloud/api/outbound_api.rb', line 4283

def put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, body, opts = {})
  data, status_code, headers = put_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, body, opts)
  return data
end

#put_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, body, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • body —

    ResponseSet

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

    the optional parameters

Returns:

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

    ResponseSet data, response status code and response headers



4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
 
# File 'lib/purecloud/api/outbound_api.rb', line 4294

def put_callanalysisresponsesets_callanalysisset_id_with_http_info(call_analysis_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_callanalysisresponsesets_callanalysisset_id ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling put_callanalysisresponsesets_callanalysisset_id" if call_analysis_set_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_callanalysisresponsesets_callanalysisset_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_callanalysisresponsesets_callanalysisset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_campaignrules_campaignrule_id(campaign_rule_id, body, opts = {}) ⇒ CampaignRule

Update Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • body —

    CampaignRule

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

    the optional parameters

Returns:



4348
4349
4350
4351
 
# File 'lib/purecloud/api/outbound_api.rb', line 4348

def put_campaignrules_campaignrule_id(campaign_rule_id, body, opts = {})
  data, status_code, headers = put_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, body, opts)
  return data
end

#put_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, body, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Update Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • body —

    CampaignRule

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

    the optional parameters

Returns:

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

    CampaignRule data, response status code and response headers



4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
 
# File 'lib/purecloud/api/outbound_api.rb', line 4359

def put_campaignrules_campaignrule_id_with_http_info(campaign_rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_campaignrules_campaignrule_id ..."
  end
  
  # verify the required parameter 'campaign_rule_id' is set
  fail "Missing the required parameter 'campaign_rule_id' when calling put_campaignrules_campaignrule_id" if campaign_rule_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_campaignrules_campaignrule_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_campaignrules_campaignrule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_campaigns_campaign_id(campaign_id, body, opts = {}) ⇒ Campaign

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    Campaign

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

    the optional parameters

Returns:



4413
4414
4415
4416
 
# File 'lib/purecloud/api/outbound_api.rb', line 4413

def put_campaigns_campaign_id(campaign_id, body, opts = {})
  data, status_code, headers = put_campaigns_campaign_id_with_http_info(campaign_id, body, opts)
  return data
end

#put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, body, opts = {}) ⇒ String

Send notification that an agent’s state changed New agent state.

Parameters:

  • campaign_id —

    Campaign ID

  • user_id —

    Agent&#39;s user ID

  • body —

    agent

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

    the optional parameters

Returns:

  • (String) 


4479
4480
4481
4482
 
# File 'lib/purecloud/api/outbound_api.rb', line 4479

def put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, body, opts = {})
  data, status_code, headers = put_campaigns_campaign_id_agents_user_id_with_http_info(campaign_id, user_id, body, opts)
  return data
end

#put_campaigns_campaign_id_agents_user_id_with_http_info(campaign_id, user_id, body, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send notification that an agent&#39;s state changed New agent state.

Parameters:

  • campaign_id —

    Campaign ID

  • user_id —

    Agent&#39;s user ID

  • body —

    agent

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
 
# File 'lib/purecloud/api/outbound_api.rb', line 4491

def put_campaigns_campaign_id_agents_user_id_with_http_info(campaign_id, user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_campaigns_campaign_id_agents_user_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling put_campaigns_campaign_id_agents_user_id" if campaign_id.nil?
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling put_campaigns_campaign_id_agents_user_id" if user_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_campaigns_campaign_id_agents_user_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/agents/{userId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_campaigns_campaign_id_agents_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_campaigns_campaign_id_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    Campaign

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

    the optional parameters

Returns:

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

    Campaign data, response status code and response headers



4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
 
# File 'lib/purecloud/api/outbound_api.rb', line 4424

def put_campaigns_campaign_id_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling put_campaigns_campaign_id" if campaign_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_campaigns_campaign_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_contactlists_contactlist_id(contact_list_id, body, opts = {}) ⇒ ContactList

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • body —

    ContactList

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

    the optional parameters

Returns:



4548
4549
4550
4551
 
# File 'lib/purecloud/api/outbound_api.rb', line 4548

def put_contactlists_contactlist_id(contact_list_id, body, opts = {})
  data, status_code, headers = put_contactlists_contactlist_id_with_http_info(contact_list_id, body, opts)
  return data
end

#put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, body, opts = {}) ⇒ DialerContact

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • body —

    Contact

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

    the optional parameters

Returns:



4614
4615
4616
4617
 
# File 'lib/purecloud/api/outbound_api.rb', line 4614

def put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, body, opts = {})
  data, status_code, headers = put_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, body, opts)
  return data
end

#put_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, body, opts = {}) ⇒ Array<(DialerContact, Fixnum, Hash)>

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • body —

    Contact

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

    the optional parameters

Returns:

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

    DialerContact data, response status code and response headers



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
 
# File 'lib/purecloud/api/outbound_api.rb', line 4626

def put_contactlists_contactlist_id_contacts_contact_id_with_http_info(contact_list_id, contact_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_contactlists_contactlist_id_contacts_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling put_contactlists_contactlist_id_contacts_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling put_contactlists_contactlist_id_contacts_contact_id" if contact_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_contactlists_contactlist_id_contacts_contact_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_contactlists_contactlist_id_contacts_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_contactlists_contactlist_id_with_http_info(contact_list_id, body, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • body —

    ContactList

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

    the optional parameters

Returns:

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

    ContactList data, response status code and response headers



4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
 
# File 'lib/purecloud/api/outbound_api.rb', line 4559

def put_contactlists_contactlist_id_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_contactlists_contactlist_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling put_contactlists_contactlist_id" if contact_list_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_contactlists_contactlist_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_contactlists_contactlist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_dnclists_dnclist_id(dnc_list_id, body, opts = {}) ⇒ DncList

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DncList

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

    the optional parameters

Returns:



4683
4684
4685
4686
 
# File 'lib/purecloud/api/outbound_api.rb', line 4683

def put_dnclists_dnclist_id(dnc_list_id, body, opts = {})
  data, status_code, headers = put_dnclists_dnclist_id_with_http_info(dnc_list_id, body, opts)
  return data
end

#put_dnclists_dnclist_id_with_http_info(dnc_list_id, body, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DncList

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

    the optional parameters

Returns:

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

    DncList data, response status code and response headers



4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
 
# File 'lib/purecloud/api/outbound_api.rb', line 4694

def put_dnclists_dnclist_id_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_dnclists_dnclist_id ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling put_dnclists_dnclist_id" if dnc_list_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_dnclists_dnclist_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_dnclists_dnclist_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_rulesets_ruleset_id(rule_set_id, body, opts = {}) ⇒ RuleSet

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

  • body —

    RuleSet

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

    the optional parameters

Returns:



4748
4749
4750
4751
 
# File 'lib/purecloud/api/outbound_api.rb', line 4748

def put_rulesets_ruleset_id(rule_set_id, body, opts = {})
  data, status_code, headers = put_rulesets_ruleset_id_with_http_info(rule_set_id, body, opts)
  return data
end

#put_rulesets_ruleset_id_with_http_info(rule_set_id, body, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

  • body —

    RuleSet

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

    the optional parameters

Returns:

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

    RuleSet data, response status code and response headers



4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
 
# File 'lib/purecloud/api/outbound_api.rb', line 4759

def put_rulesets_ruleset_id_with_http_info(rule_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_rulesets_ruleset_id ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling put_rulesets_ruleset_id" if rule_set_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_rulesets_ruleset_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_rulesets_ruleset_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_schedules_campaigns_campaign_id(campaign_id, body, opts = {}) ⇒ CampaignSchedule

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    CampaignSchedule

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

    the optional parameters

Returns:



4813
4814
4815
4816
 
# File 'lib/purecloud/api/outbound_api.rb', line 4813

def put_schedules_campaigns_campaign_id(campaign_id, body, opts = {})
  data, status_code, headers = put_schedules_campaigns_campaign_id_with_http_info(campaign_id, body, opts)
  return data
end

#put_schedules_campaigns_campaign_id_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(CampaignSchedule, Fixnum, Hash)>

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    CampaignSchedule

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

    the optional parameters

Returns:

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

    CampaignSchedule data, response status code and response headers



4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
 
# File 'lib/purecloud/api/outbound_api.rb', line 4824

def put_schedules_campaigns_campaign_id_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_schedules_campaigns_campaign_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling put_schedules_campaigns_campaign_id" if campaign_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_schedules_campaigns_campaign_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_schedules_campaigns_campaign_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_schedules_sequences_sequence_id(sequence_id, body, opts = {}) ⇒ SequenceSchedule

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • body —

    SequenceSchedule

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

    the optional parameters

Returns:



4878
4879
4880
4881
 
# File 'lib/purecloud/api/outbound_api.rb', line 4878

def put_schedules_sequences_sequence_id(sequence_id, body, opts = {})
  data, status_code, headers = put_schedules_sequences_sequence_id_with_http_info(sequence_id, body, opts)
  return data
end

#put_schedules_sequences_sequence_id_with_http_info(sequence_id, body, opts = {}) ⇒ Array<(SequenceSchedule, Fixnum, Hash)>

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • body —

    SequenceSchedule

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

    the optional parameters

Returns:

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

    SequenceSchedule data, response status code and response headers



4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
 
# File 'lib/purecloud/api/outbound_api.rb', line 4889

def put_schedules_sequences_sequence_id_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_schedules_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling put_schedules_sequences_sequence_id" if sequence_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_schedules_sequences_sequence_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_schedules_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_sequences_sequence_id(sequence_id, body, opts = {}) ⇒ CampaignSequence

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • body —

    Organization

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

    the optional parameters

Returns:



4943
4944
4945
4946
 
# File 'lib/purecloud/api/outbound_api.rb', line 4943

def put_sequences_sequence_id(sequence_id, body, opts = {})
  data, status_code, headers = put_sequences_sequence_id_with_http_info(sequence_id, body, opts)
  return data
end

#put_sequences_sequence_id_with_http_info(sequence_id, body, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • body —

    Organization

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

    the optional parameters

Returns:

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

    CampaignSequence data, response status code and response headers



4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
 
# File 'lib/purecloud/api/outbound_api.rb', line 4954

def put_sequences_sequence_id_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#put_sequences_sequence_id ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling put_sequences_sequence_id" if sequence_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_sequences_sequence_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_sequences_sequence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_wrapupcodemappings(body, opts = {}) ⇒ WrapUpCodeMapping

Update the Dialer wrap up code mapping.

Parameters:

  • body —

    wrapUpCodeMapping

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

    the optional parameters

Returns:



5007
5008
5009
5010
 
# File 'lib/purecloud/api/outbound_api.rb', line 5007

def put_wrapupcodemappings(body, opts = {})
  data, status_code, headers = put_wrapupcodemappings_with_http_info(body, opts)
  return data
end

#put_wrapupcodemappings_with_http_info(body, opts = {}) ⇒ Array<(WrapUpCodeMapping, Fixnum, Hash)>

Update the Dialer wrap up code mapping.

Parameters:

  • body —

    wrapUpCodeMapping

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

    the optional parameters

Returns:

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

    WrapUpCodeMapping data, response status code and response headers



5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
 
# File 'lib/purecloud/api/outbound_api.rb', line 5017

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end