purecloudplatformclientv2 49.0.0 → 49.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +8 -8
- data/docs/AlertingApi.md +33 -33
- data/docs/AnalyticsApi.md +81 -81
- data/docs/ArchitectApi.md +243 -243
- data/docs/AuthorizationApi.md +102 -102
- data/docs/BillingApi.md +6 -6
- data/docs/ContentManagementApi.md +114 -114
- data/docs/ConversationsApi.md +300 -300
- data/docs/DialerRulesetConfigChangeCondition.md +1 -0
- data/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +2 -0
- data/docs/ExternalContactsApi.md +90 -90
- data/docs/FaxApi.md +18 -18
- data/docs/FlowsApi.md +3 -3
- data/docs/GeneralDataProtectionRegulationApi.md +12 -12
- data/docs/GeolocationApi.md +12 -12
- data/docs/GreetingsApi.md +48 -48
- data/docs/GroupsApi.md +42 -42
- data/docs/IdentityProviderApi.md +84 -84
- data/docs/IntegrationsApi.md +123 -123
- data/docs/LanguagesApi.md +30 -30
- data/docs/LicenseApi.md +24 -24
- data/docs/LocationsApi.md +21 -21
- data/docs/MessagingApi.md +42 -42
- data/docs/MobileDevicesApi.md +15 -15
- data/docs/NotificationsApi.md +21 -21
- data/docs/OAuthApi.md +18 -18
- data/docs/ObjectsApi.md +24 -24
- data/docs/OrganizationApi.md +18 -18
- data/docs/OrganizationAuthorizationApi.md +69 -69
- data/docs/OutboundApi.md +288 -288
- data/docs/PresenceApi.md +27 -27
- data/docs/QualityApi.md +174 -174
- data/docs/QueueUserEventTopicQueueMember.md +4 -3
- data/docs/RecordingApi.md +111 -111
- data/docs/ResponseManagementApi.md +33 -33
- data/docs/RoutingApi.md +189 -189
- data/docs/ScriptsApi.md +33 -33
- data/docs/SearchApi.md +48 -48
- data/docs/StationsApi.md +15 -15
- data/docs/SuggestApi.md +12 -12
- data/docs/TelephonyProvidersEdgeApi.md +375 -375
- data/docs/TokensApi.md +6 -6
- data/docs/UserRecordingsApi.md +18 -18
- data/docs/UsersApi.md +183 -183
- data/docs/UtilitiesApi.md +12 -12
- data/docs/VoicemailApi.md +72 -72
- data/docs/WebChatApi.md +24 -24
- data/docs/WorkforceManagementApi.md +192 -192
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +50 -25
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +2 -2
data/docs/OutboundApi.md
CHANGED
@@ -108,7 +108,7 @@ Method | Description
|
|
108
108
|
|
109
109
|
<a name="delete_outbound_attemptlimit"></a>
|
110
110
|
|
111
|
-
##
|
111
|
+
## delete_outbound_attemptlimit(attempt_limits_id)
|
112
112
|
|
113
113
|
|
114
114
|
|
@@ -124,7 +124,7 @@ Requires ANY permissions:
|
|
124
124
|
|
125
125
|
|
126
126
|
### Example
|
127
|
-
|
127
|
+
```{"language":"ruby"}
|
128
128
|
# load the gem
|
129
129
|
require 'purecloudplatformclientv2'
|
130
130
|
# setup authorization
|
@@ -149,7 +149,7 @@ begin
|
|
149
149
|
rescue PureCloud::ApiError => e
|
150
150
|
puts "Exception when calling OutboundApi->delete_outbound_attemptlimit: #{e}"
|
151
151
|
end
|
152
|
-
|
152
|
+
```
|
153
153
|
|
154
154
|
### Parameters
|
155
155
|
|
@@ -172,7 +172,7 @@ nil (empty response body)
|
|
172
172
|
|
173
173
|
<a name="delete_outbound_callabletimeset"></a>
|
174
174
|
|
175
|
-
##
|
175
|
+
## delete_outbound_callabletimeset(callable_time_set_id)
|
176
176
|
|
177
177
|
|
178
178
|
|
@@ -188,7 +188,7 @@ Requires ANY permissions:
|
|
188
188
|
|
189
189
|
|
190
190
|
### Example
|
191
|
-
|
191
|
+
```{"language":"ruby"}
|
192
192
|
# load the gem
|
193
193
|
require 'purecloudplatformclientv2'
|
194
194
|
# setup authorization
|
@@ -213,7 +213,7 @@ begin
|
|
213
213
|
rescue PureCloud::ApiError => e
|
214
214
|
puts "Exception when calling OutboundApi->delete_outbound_callabletimeset: #{e}"
|
215
215
|
end
|
216
|
-
|
216
|
+
```
|
217
217
|
|
218
218
|
### Parameters
|
219
219
|
|
@@ -236,7 +236,7 @@ nil (empty response body)
|
|
236
236
|
|
237
237
|
<a name="delete_outbound_callanalysisresponseset"></a>
|
238
238
|
|
239
|
-
##
|
239
|
+
## delete_outbound_callanalysisresponseset(call_analysis_set_id)
|
240
240
|
|
241
241
|
|
242
242
|
|
@@ -252,7 +252,7 @@ Requires ANY permissions:
|
|
252
252
|
|
253
253
|
|
254
254
|
### Example
|
255
|
-
|
255
|
+
```{"language":"ruby"}
|
256
256
|
# load the gem
|
257
257
|
require 'purecloudplatformclientv2'
|
258
258
|
# setup authorization
|
@@ -277,7 +277,7 @@ begin
|
|
277
277
|
rescue PureCloud::ApiError => e
|
278
278
|
puts "Exception when calling OutboundApi->delete_outbound_callanalysisresponseset: #{e}"
|
279
279
|
end
|
280
|
-
|
280
|
+
```
|
281
281
|
|
282
282
|
### Parameters
|
283
283
|
|
@@ -300,7 +300,7 @@ nil (empty response body)
|
|
300
300
|
|
301
301
|
<a name="delete_outbound_campaign"></a>
|
302
302
|
|
303
|
-
##
|
303
|
+
## [**Campaign**](Campaign.html) delete_outbound_campaign(campaign_id)
|
304
304
|
|
305
305
|
|
306
306
|
|
@@ -316,7 +316,7 @@ Requires ANY permissions:
|
|
316
316
|
|
317
317
|
|
318
318
|
### Example
|
319
|
-
|
319
|
+
```{"language":"ruby"}
|
320
320
|
# load the gem
|
321
321
|
require 'purecloudplatformclientv2'
|
322
322
|
# setup authorization
|
@@ -342,7 +342,7 @@ begin
|
|
342
342
|
rescue PureCloud::ApiError => e
|
343
343
|
puts "Exception when calling OutboundApi->delete_outbound_campaign: #{e}"
|
344
344
|
end
|
345
|
-
|
345
|
+
```
|
346
346
|
|
347
347
|
### Parameters
|
348
348
|
|
@@ -365,7 +365,7 @@ Name | Type | Description | Notes
|
|
365
365
|
|
366
366
|
<a name="delete_outbound_campaign_progress"></a>
|
367
367
|
|
368
|
-
##
|
368
|
+
## delete_outbound_campaign_progress(campaign_id)
|
369
369
|
|
370
370
|
|
371
371
|
|
@@ -381,7 +381,7 @@ Requires ANY permissions:
|
|
381
381
|
|
382
382
|
|
383
383
|
### Example
|
384
|
-
|
384
|
+
```{"language":"ruby"}
|
385
385
|
# load the gem
|
386
386
|
require 'purecloudplatformclientv2'
|
387
387
|
# setup authorization
|
@@ -406,7 +406,7 @@ begin
|
|
406
406
|
rescue PureCloud::ApiError => e
|
407
407
|
puts "Exception when calling OutboundApi->delete_outbound_campaign_progress: #{e}"
|
408
408
|
end
|
409
|
-
|
409
|
+
```
|
410
410
|
|
411
411
|
### Parameters
|
412
412
|
|
@@ -429,7 +429,7 @@ nil (empty response body)
|
|
429
429
|
|
430
430
|
<a name="delete_outbound_campaignrule"></a>
|
431
431
|
|
432
|
-
##
|
432
|
+
## delete_outbound_campaignrule(campaign_rule_id)
|
433
433
|
|
434
434
|
|
435
435
|
|
@@ -445,7 +445,7 @@ Requires ANY permissions:
|
|
445
445
|
|
446
446
|
|
447
447
|
### Example
|
448
|
-
|
448
|
+
```{"language":"ruby"}
|
449
449
|
# load the gem
|
450
450
|
require 'purecloudplatformclientv2'
|
451
451
|
# setup authorization
|
@@ -470,7 +470,7 @@ begin
|
|
470
470
|
rescue PureCloud::ApiError => e
|
471
471
|
puts "Exception when calling OutboundApi->delete_outbound_campaignrule: #{e}"
|
472
472
|
end
|
473
|
-
|
473
|
+
```
|
474
474
|
|
475
475
|
### Parameters
|
476
476
|
|
@@ -493,7 +493,7 @@ nil (empty response body)
|
|
493
493
|
|
494
494
|
<a name="delete_outbound_contactlist"></a>
|
495
495
|
|
496
|
-
##
|
496
|
+
## delete_outbound_contactlist(contact_list_id)
|
497
497
|
|
498
498
|
|
499
499
|
|
@@ -509,7 +509,7 @@ Requires ANY permissions:
|
|
509
509
|
|
510
510
|
|
511
511
|
### Example
|
512
|
-
|
512
|
+
```{"language":"ruby"}
|
513
513
|
# load the gem
|
514
514
|
require 'purecloudplatformclientv2'
|
515
515
|
# setup authorization
|
@@ -534,7 +534,7 @@ begin
|
|
534
534
|
rescue PureCloud::ApiError => e
|
535
535
|
puts "Exception when calling OutboundApi->delete_outbound_contactlist: #{e}"
|
536
536
|
end
|
537
|
-
|
537
|
+
```
|
538
538
|
|
539
539
|
### Parameters
|
540
540
|
|
@@ -557,7 +557,7 @@ nil (empty response body)
|
|
557
557
|
|
558
558
|
<a name="delete_outbound_contactlist_contact"></a>
|
559
559
|
|
560
|
-
##
|
560
|
+
## delete_outbound_contactlist_contact(contact_list_id, contact_id)
|
561
561
|
|
562
562
|
|
563
563
|
|
@@ -573,7 +573,7 @@ Requires ANY permissions:
|
|
573
573
|
|
574
574
|
|
575
575
|
### Example
|
576
|
-
|
576
|
+
```{"language":"ruby"}
|
577
577
|
# load the gem
|
578
578
|
require 'purecloudplatformclientv2'
|
579
579
|
# setup authorization
|
@@ -600,7 +600,7 @@ begin
|
|
600
600
|
rescue PureCloud::ApiError => e
|
601
601
|
puts "Exception when calling OutboundApi->delete_outbound_contactlist_contact: #{e}"
|
602
602
|
end
|
603
|
-
|
603
|
+
```
|
604
604
|
|
605
605
|
### Parameters
|
606
606
|
|
@@ -624,7 +624,7 @@ nil (empty response body)
|
|
624
624
|
|
625
625
|
<a name="delete_outbound_contactlist_contacts"></a>
|
626
626
|
|
627
|
-
##
|
627
|
+
## delete_outbound_contactlist_contacts(contact_list_id, contact_ids)
|
628
628
|
|
629
629
|
|
630
630
|
|
@@ -640,7 +640,7 @@ Requires ANY permissions:
|
|
640
640
|
|
641
641
|
|
642
642
|
### Example
|
643
|
-
|
643
|
+
```{"language":"ruby"}
|
644
644
|
# load the gem
|
645
645
|
require 'purecloudplatformclientv2'
|
646
646
|
# setup authorization
|
@@ -667,7 +667,7 @@ begin
|
|
667
667
|
rescue PureCloud::ApiError => e
|
668
668
|
puts "Exception when calling OutboundApi->delete_outbound_contactlist_contacts: #{e}"
|
669
669
|
end
|
670
|
-
|
670
|
+
```
|
671
671
|
|
672
672
|
### Parameters
|
673
673
|
|
@@ -691,7 +691,7 @@ nil (empty response body)
|
|
691
691
|
|
692
692
|
<a name="delete_outbound_contactlistfilter"></a>
|
693
693
|
|
694
|
-
##
|
694
|
+
## delete_outbound_contactlistfilter(contact_list_filter_id)
|
695
695
|
|
696
696
|
|
697
697
|
|
@@ -707,7 +707,7 @@ Requires ANY permissions:
|
|
707
707
|
|
708
708
|
|
709
709
|
### Example
|
710
|
-
|
710
|
+
```{"language":"ruby"}
|
711
711
|
# load the gem
|
712
712
|
require 'purecloudplatformclientv2'
|
713
713
|
# setup authorization
|
@@ -732,7 +732,7 @@ begin
|
|
732
732
|
rescue PureCloud::ApiError => e
|
733
733
|
puts "Exception when calling OutboundApi->delete_outbound_contactlistfilter: #{e}"
|
734
734
|
end
|
735
|
-
|
735
|
+
```
|
736
736
|
|
737
737
|
### Parameters
|
738
738
|
|
@@ -755,7 +755,7 @@ nil (empty response body)
|
|
755
755
|
|
756
756
|
<a name="delete_outbound_contactlists"></a>
|
757
757
|
|
758
|
-
##
|
758
|
+
## delete_outbound_contactlists(id)
|
759
759
|
|
760
760
|
|
761
761
|
|
@@ -771,7 +771,7 @@ Requires ANY permissions:
|
|
771
771
|
|
772
772
|
|
773
773
|
### Example
|
774
|
-
|
774
|
+
```{"language":"ruby"}
|
775
775
|
# load the gem
|
776
776
|
require 'purecloudplatformclientv2'
|
777
777
|
# setup authorization
|
@@ -796,7 +796,7 @@ begin
|
|
796
796
|
rescue PureCloud::ApiError => e
|
797
797
|
puts "Exception when calling OutboundApi->delete_outbound_contactlists: #{e}"
|
798
798
|
end
|
799
|
-
|
799
|
+
```
|
800
800
|
|
801
801
|
### Parameters
|
802
802
|
|
@@ -819,7 +819,7 @@ nil (empty response body)
|
|
819
819
|
|
820
820
|
<a name="delete_outbound_dnclist"></a>
|
821
821
|
|
822
|
-
##
|
822
|
+
## delete_outbound_dnclist(dnc_list_id)
|
823
823
|
|
824
824
|
|
825
825
|
|
@@ -835,7 +835,7 @@ Requires ANY permissions:
|
|
835
835
|
|
836
836
|
|
837
837
|
### Example
|
838
|
-
|
838
|
+
```{"language":"ruby"}
|
839
839
|
# load the gem
|
840
840
|
require 'purecloudplatformclientv2'
|
841
841
|
# setup authorization
|
@@ -860,7 +860,7 @@ begin
|
|
860
860
|
rescue PureCloud::ApiError => e
|
861
861
|
puts "Exception when calling OutboundApi->delete_outbound_dnclist: #{e}"
|
862
862
|
end
|
863
|
-
|
863
|
+
```
|
864
864
|
|
865
865
|
### Parameters
|
866
866
|
|
@@ -883,7 +883,7 @@ nil (empty response body)
|
|
883
883
|
|
884
884
|
<a name="delete_outbound_ruleset"></a>
|
885
885
|
|
886
|
-
##
|
886
|
+
## delete_outbound_ruleset(rule_set_id)
|
887
887
|
|
888
888
|
|
889
889
|
|
@@ -899,7 +899,7 @@ Requires ANY permissions:
|
|
899
899
|
|
900
900
|
|
901
901
|
### Example
|
902
|
-
|
902
|
+
```{"language":"ruby"}
|
903
903
|
# load the gem
|
904
904
|
require 'purecloudplatformclientv2'
|
905
905
|
# setup authorization
|
@@ -924,7 +924,7 @@ begin
|
|
924
924
|
rescue PureCloud::ApiError => e
|
925
925
|
puts "Exception when calling OutboundApi->delete_outbound_ruleset: #{e}"
|
926
926
|
end
|
927
|
-
|
927
|
+
```
|
928
928
|
|
929
929
|
### Parameters
|
930
930
|
|
@@ -947,7 +947,7 @@ nil (empty response body)
|
|
947
947
|
|
948
948
|
<a name="delete_outbound_schedules_campaign"></a>
|
949
949
|
|
950
|
-
##
|
950
|
+
## delete_outbound_schedules_campaign(campaign_id)
|
951
951
|
|
952
952
|
|
953
953
|
|
@@ -963,7 +963,7 @@ Requires ANY permissions:
|
|
963
963
|
|
964
964
|
|
965
965
|
### Example
|
966
|
-
|
966
|
+
```{"language":"ruby"}
|
967
967
|
# load the gem
|
968
968
|
require 'purecloudplatformclientv2'
|
969
969
|
# setup authorization
|
@@ -988,7 +988,7 @@ begin
|
|
988
988
|
rescue PureCloud::ApiError => e
|
989
989
|
puts "Exception when calling OutboundApi->delete_outbound_schedules_campaign: #{e}"
|
990
990
|
end
|
991
|
-
|
991
|
+
```
|
992
992
|
|
993
993
|
### Parameters
|
994
994
|
|
@@ -1011,7 +1011,7 @@ nil (empty response body)
|
|
1011
1011
|
|
1012
1012
|
<a name="delete_outbound_schedules_sequence"></a>
|
1013
1013
|
|
1014
|
-
##
|
1014
|
+
## delete_outbound_schedules_sequence(sequence_id)
|
1015
1015
|
|
1016
1016
|
|
1017
1017
|
|
@@ -1027,7 +1027,7 @@ Requires ANY permissions:
|
|
1027
1027
|
|
1028
1028
|
|
1029
1029
|
### Example
|
1030
|
-
|
1030
|
+
```{"language":"ruby"}
|
1031
1031
|
# load the gem
|
1032
1032
|
require 'purecloudplatformclientv2'
|
1033
1033
|
# setup authorization
|
@@ -1052,7 +1052,7 @@ begin
|
|
1052
1052
|
rescue PureCloud::ApiError => e
|
1053
1053
|
puts "Exception when calling OutboundApi->delete_outbound_schedules_sequence: #{e}"
|
1054
1054
|
end
|
1055
|
-
|
1055
|
+
```
|
1056
1056
|
|
1057
1057
|
### Parameters
|
1058
1058
|
|
@@ -1075,7 +1075,7 @@ nil (empty response body)
|
|
1075
1075
|
|
1076
1076
|
<a name="delete_outbound_sequence"></a>
|
1077
1077
|
|
1078
|
-
##
|
1078
|
+
## delete_outbound_sequence(sequence_id)
|
1079
1079
|
|
1080
1080
|
|
1081
1081
|
|
@@ -1091,7 +1091,7 @@ Requires ANY permissions:
|
|
1091
1091
|
|
1092
1092
|
|
1093
1093
|
### Example
|
1094
|
-
|
1094
|
+
```{"language":"ruby"}
|
1095
1095
|
# load the gem
|
1096
1096
|
require 'purecloudplatformclientv2'
|
1097
1097
|
# setup authorization
|
@@ -1116,7 +1116,7 @@ begin
|
|
1116
1116
|
rescue PureCloud::ApiError => e
|
1117
1117
|
puts "Exception when calling OutboundApi->delete_outbound_sequence: #{e}"
|
1118
1118
|
end
|
1119
|
-
|
1119
|
+
```
|
1120
1120
|
|
1121
1121
|
### Parameters
|
1122
1122
|
|
@@ -1139,7 +1139,7 @@ nil (empty response body)
|
|
1139
1139
|
|
1140
1140
|
<a name="get_outbound_attemptlimit"></a>
|
1141
1141
|
|
1142
|
-
##
|
1142
|
+
## [**AttemptLimits**](AttemptLimits.html) get_outbound_attemptlimit(attempt_limits_id)
|
1143
1143
|
|
1144
1144
|
|
1145
1145
|
|
@@ -1155,7 +1155,7 @@ Requires ANY permissions:
|
|
1155
1155
|
|
1156
1156
|
|
1157
1157
|
### Example
|
1158
|
-
|
1158
|
+
```{"language":"ruby"}
|
1159
1159
|
# load the gem
|
1160
1160
|
require 'purecloudplatformclientv2'
|
1161
1161
|
# setup authorization
|
@@ -1181,7 +1181,7 @@ begin
|
|
1181
1181
|
rescue PureCloud::ApiError => e
|
1182
1182
|
puts "Exception when calling OutboundApi->get_outbound_attemptlimit: #{e}"
|
1183
1183
|
end
|
1184
|
-
|
1184
|
+
```
|
1185
1185
|
|
1186
1186
|
### Parameters
|
1187
1187
|
|
@@ -1204,7 +1204,7 @@ Name | Type | Description | Notes
|
|
1204
1204
|
|
1205
1205
|
<a name="get_outbound_attemptlimits"></a>
|
1206
1206
|
|
1207
|
-
##
|
1207
|
+
## [**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_outbound_attemptlimits(opts)
|
1208
1208
|
|
1209
1209
|
|
1210
1210
|
|
@@ -1220,7 +1220,7 @@ Requires ANY permissions:
|
|
1220
1220
|
|
1221
1221
|
|
1222
1222
|
### Example
|
1223
|
-
|
1223
|
+
```{"language":"ruby"}
|
1224
1224
|
# load the gem
|
1225
1225
|
require 'purecloudplatformclientv2'
|
1226
1226
|
# setup authorization
|
@@ -1252,7 +1252,7 @@ begin
|
|
1252
1252
|
rescue PureCloud::ApiError => e
|
1253
1253
|
puts "Exception when calling OutboundApi->get_outbound_attemptlimits: #{e}"
|
1254
1254
|
end
|
1255
|
-
|
1255
|
+
```
|
1256
1256
|
|
1257
1257
|
### Parameters
|
1258
1258
|
|
@@ -1280,7 +1280,7 @@ Name | Type | Description | Notes
|
|
1280
1280
|
|
1281
1281
|
<a name="get_outbound_callabletimeset"></a>
|
1282
1282
|
|
1283
|
-
##
|
1283
|
+
## [**CallableTimeSet**](CallableTimeSet.html) get_outbound_callabletimeset(callable_time_set_id)
|
1284
1284
|
|
1285
1285
|
|
1286
1286
|
|
@@ -1296,7 +1296,7 @@ Requires ANY permissions:
|
|
1296
1296
|
|
1297
1297
|
|
1298
1298
|
### Example
|
1299
|
-
|
1299
|
+
```{"language":"ruby"}
|
1300
1300
|
# load the gem
|
1301
1301
|
require 'purecloudplatformclientv2'
|
1302
1302
|
# setup authorization
|
@@ -1322,7 +1322,7 @@ begin
|
|
1322
1322
|
rescue PureCloud::ApiError => e
|
1323
1323
|
puts "Exception when calling OutboundApi->get_outbound_callabletimeset: #{e}"
|
1324
1324
|
end
|
1325
|
-
|
1325
|
+
```
|
1326
1326
|
|
1327
1327
|
### Parameters
|
1328
1328
|
|
@@ -1345,7 +1345,7 @@ Name | Type | Description | Notes
|
|
1345
1345
|
|
1346
1346
|
<a name="get_outbound_callabletimesets"></a>
|
1347
1347
|
|
1348
|
-
##
|
1348
|
+
## [**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_outbound_callabletimesets(opts)
|
1349
1349
|
|
1350
1350
|
|
1351
1351
|
|
@@ -1361,7 +1361,7 @@ Requires ANY permissions:
|
|
1361
1361
|
|
1362
1362
|
|
1363
1363
|
### Example
|
1364
|
-
|
1364
|
+
```{"language":"ruby"}
|
1365
1365
|
# load the gem
|
1366
1366
|
require 'purecloudplatformclientv2'
|
1367
1367
|
# setup authorization
|
@@ -1393,7 +1393,7 @@ begin
|
|
1393
1393
|
rescue PureCloud::ApiError => e
|
1394
1394
|
puts "Exception when calling OutboundApi->get_outbound_callabletimesets: #{e}"
|
1395
1395
|
end
|
1396
|
-
|
1396
|
+
```
|
1397
1397
|
|
1398
1398
|
### Parameters
|
1399
1399
|
|
@@ -1421,7 +1421,7 @@ Name | Type | Description | Notes
|
|
1421
1421
|
|
1422
1422
|
<a name="get_outbound_callanalysisresponseset"></a>
|
1423
1423
|
|
1424
|
-
##
|
1424
|
+
## [**ResponseSet**](ResponseSet.html) get_outbound_callanalysisresponseset(call_analysis_set_id)
|
1425
1425
|
|
1426
1426
|
|
1427
1427
|
|
@@ -1437,7 +1437,7 @@ Requires ANY permissions:
|
|
1437
1437
|
|
1438
1438
|
|
1439
1439
|
### Example
|
1440
|
-
|
1440
|
+
```{"language":"ruby"}
|
1441
1441
|
# load the gem
|
1442
1442
|
require 'purecloudplatformclientv2'
|
1443
1443
|
# setup authorization
|
@@ -1463,7 +1463,7 @@ begin
|
|
1463
1463
|
rescue PureCloud::ApiError => e
|
1464
1464
|
puts "Exception when calling OutboundApi->get_outbound_callanalysisresponseset: #{e}"
|
1465
1465
|
end
|
1466
|
-
|
1466
|
+
```
|
1467
1467
|
|
1468
1468
|
### Parameters
|
1469
1469
|
|
@@ -1486,7 +1486,7 @@ Name | Type | Description | Notes
|
|
1486
1486
|
|
1487
1487
|
<a name="get_outbound_callanalysisresponsesets"></a>
|
1488
1488
|
|
1489
|
-
##
|
1489
|
+
## [**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_outbound_callanalysisresponsesets(opts)
|
1490
1490
|
|
1491
1491
|
|
1492
1492
|
|
@@ -1502,7 +1502,7 @@ Requires ANY permissions:
|
|
1502
1502
|
|
1503
1503
|
|
1504
1504
|
### Example
|
1505
|
-
|
1505
|
+
```{"language":"ruby"}
|
1506
1506
|
# load the gem
|
1507
1507
|
require 'purecloudplatformclientv2'
|
1508
1508
|
# setup authorization
|
@@ -1534,7 +1534,7 @@ begin
|
|
1534
1534
|
rescue PureCloud::ApiError => e
|
1535
1535
|
puts "Exception when calling OutboundApi->get_outbound_callanalysisresponsesets: #{e}"
|
1536
1536
|
end
|
1537
|
-
|
1537
|
+
```
|
1538
1538
|
|
1539
1539
|
### Parameters
|
1540
1540
|
|
@@ -1562,7 +1562,7 @@ Name | Type | Description | Notes
|
|
1562
1562
|
|
1563
1563
|
<a name="get_outbound_campaign"></a>
|
1564
1564
|
|
1565
|
-
##
|
1565
|
+
## [**Campaign**](Campaign.html) get_outbound_campaign(campaign_id)
|
1566
1566
|
|
1567
1567
|
|
1568
1568
|
|
@@ -1578,7 +1578,7 @@ Requires ANY permissions:
|
|
1578
1578
|
|
1579
1579
|
|
1580
1580
|
### Example
|
1581
|
-
|
1581
|
+
```{"language":"ruby"}
|
1582
1582
|
# load the gem
|
1583
1583
|
require 'purecloudplatformclientv2'
|
1584
1584
|
# setup authorization
|
@@ -1604,7 +1604,7 @@ begin
|
|
1604
1604
|
rescue PureCloud::ApiError => e
|
1605
1605
|
puts "Exception when calling OutboundApi->get_outbound_campaign: #{e}"
|
1606
1606
|
end
|
1607
|
-
|
1607
|
+
```
|
1608
1608
|
|
1609
1609
|
### Parameters
|
1610
1610
|
|
@@ -1627,7 +1627,7 @@ Name | Type | Description | Notes
|
|
1627
1627
|
|
1628
1628
|
<a name="get_outbound_campaign_diagnostics"></a>
|
1629
1629
|
|
1630
|
-
##
|
1630
|
+
## [**CampaignDiagnostics**](CampaignDiagnostics.html) get_outbound_campaign_diagnostics(campaign_id)
|
1631
1631
|
|
1632
1632
|
|
1633
1633
|
|
@@ -1643,7 +1643,7 @@ Requires ANY permissions:
|
|
1643
1643
|
|
1644
1644
|
|
1645
1645
|
### Example
|
1646
|
-
|
1646
|
+
```{"language":"ruby"}
|
1647
1647
|
# load the gem
|
1648
1648
|
require 'purecloudplatformclientv2'
|
1649
1649
|
# setup authorization
|
@@ -1669,7 +1669,7 @@ begin
|
|
1669
1669
|
rescue PureCloud::ApiError => e
|
1670
1670
|
puts "Exception when calling OutboundApi->get_outbound_campaign_diagnostics: #{e}"
|
1671
1671
|
end
|
1672
|
-
|
1672
|
+
```
|
1673
1673
|
|
1674
1674
|
### Parameters
|
1675
1675
|
|
@@ -1692,7 +1692,7 @@ Name | Type | Description | Notes
|
|
1692
1692
|
|
1693
1693
|
<a name="get_outbound_campaign_interactions"></a>
|
1694
1694
|
|
1695
|
-
##
|
1695
|
+
## [**CampaignInteractions**](CampaignInteractions.html) get_outbound_campaign_interactions(campaign_id)
|
1696
1696
|
|
1697
1697
|
|
1698
1698
|
|
@@ -1708,7 +1708,7 @@ Requires ANY permissions:
|
|
1708
1708
|
|
1709
1709
|
|
1710
1710
|
### Example
|
1711
|
-
|
1711
|
+
```{"language":"ruby"}
|
1712
1712
|
# load the gem
|
1713
1713
|
require 'purecloudplatformclientv2'
|
1714
1714
|
# setup authorization
|
@@ -1734,7 +1734,7 @@ begin
|
|
1734
1734
|
rescue PureCloud::ApiError => e
|
1735
1735
|
puts "Exception when calling OutboundApi->get_outbound_campaign_interactions: #{e}"
|
1736
1736
|
end
|
1737
|
-
|
1737
|
+
```
|
1738
1738
|
|
1739
1739
|
### Parameters
|
1740
1740
|
|
@@ -1757,7 +1757,7 @@ Name | Type | Description | Notes
|
|
1757
1757
|
|
1758
1758
|
<a name="get_outbound_campaign_progress"></a>
|
1759
1759
|
|
1760
|
-
##
|
1760
|
+
## [**CampaignProgress**](CampaignProgress.html) get_outbound_campaign_progress(campaign_id)
|
1761
1761
|
|
1762
1762
|
|
1763
1763
|
|
@@ -1773,7 +1773,7 @@ Requires ANY permissions:
|
|
1773
1773
|
|
1774
1774
|
|
1775
1775
|
### Example
|
1776
|
-
|
1776
|
+
```{"language":"ruby"}
|
1777
1777
|
# load the gem
|
1778
1778
|
require 'purecloudplatformclientv2'
|
1779
1779
|
# setup authorization
|
@@ -1799,7 +1799,7 @@ begin
|
|
1799
1799
|
rescue PureCloud::ApiError => e
|
1800
1800
|
puts "Exception when calling OutboundApi->get_outbound_campaign_progress: #{e}"
|
1801
1801
|
end
|
1802
|
-
|
1802
|
+
```
|
1803
1803
|
|
1804
1804
|
### Parameters
|
1805
1805
|
|
@@ -1822,7 +1822,7 @@ Name | Type | Description | Notes
|
|
1822
1822
|
|
1823
1823
|
<a name="get_outbound_campaign_stats"></a>
|
1824
1824
|
|
1825
|
-
##
|
1825
|
+
## [**CampaignStats**](CampaignStats.html) get_outbound_campaign_stats(campaign_id)
|
1826
1826
|
|
1827
1827
|
|
1828
1828
|
|
@@ -1838,7 +1838,7 @@ Requires ANY permissions:
|
|
1838
1838
|
|
1839
1839
|
|
1840
1840
|
### Example
|
1841
|
-
|
1841
|
+
```{"language":"ruby"}
|
1842
1842
|
# load the gem
|
1843
1843
|
require 'purecloudplatformclientv2'
|
1844
1844
|
# setup authorization
|
@@ -1864,7 +1864,7 @@ begin
|
|
1864
1864
|
rescue PureCloud::ApiError => e
|
1865
1865
|
puts "Exception when calling OutboundApi->get_outbound_campaign_stats: #{e}"
|
1866
1866
|
end
|
1867
|
-
|
1867
|
+
```
|
1868
1868
|
|
1869
1869
|
### Parameters
|
1870
1870
|
|
@@ -1887,7 +1887,7 @@ Name | Type | Description | Notes
|
|
1887
1887
|
|
1888
1888
|
<a name="get_outbound_campaignrule"></a>
|
1889
1889
|
|
1890
|
-
##
|
1890
|
+
## [**CampaignRule**](CampaignRule.html) get_outbound_campaignrule(campaign_rule_id)
|
1891
1891
|
|
1892
1892
|
|
1893
1893
|
|
@@ -1903,7 +1903,7 @@ Requires ANY permissions:
|
|
1903
1903
|
|
1904
1904
|
|
1905
1905
|
### Example
|
1906
|
-
|
1906
|
+
```{"language":"ruby"}
|
1907
1907
|
# load the gem
|
1908
1908
|
require 'purecloudplatformclientv2'
|
1909
1909
|
# setup authorization
|
@@ -1929,7 +1929,7 @@ begin
|
|
1929
1929
|
rescue PureCloud::ApiError => e
|
1930
1930
|
puts "Exception when calling OutboundApi->get_outbound_campaignrule: #{e}"
|
1931
1931
|
end
|
1932
|
-
|
1932
|
+
```
|
1933
1933
|
|
1934
1934
|
### Parameters
|
1935
1935
|
|
@@ -1952,7 +1952,7 @@ Name | Type | Description | Notes
|
|
1952
1952
|
|
1953
1953
|
<a name="get_outbound_campaignrules"></a>
|
1954
1954
|
|
1955
|
-
##
|
1955
|
+
## [**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_outbound_campaignrules(opts)
|
1956
1956
|
|
1957
1957
|
|
1958
1958
|
|
@@ -1968,7 +1968,7 @@ Requires ANY permissions:
|
|
1968
1968
|
|
1969
1969
|
|
1970
1970
|
### Example
|
1971
|
-
|
1971
|
+
```{"language":"ruby"}
|
1972
1972
|
# load the gem
|
1973
1973
|
require 'purecloudplatformclientv2'
|
1974
1974
|
# setup authorization
|
@@ -2000,7 +2000,7 @@ begin
|
|
2000
2000
|
rescue PureCloud::ApiError => e
|
2001
2001
|
puts "Exception when calling OutboundApi->get_outbound_campaignrules: #{e}"
|
2002
2002
|
end
|
2003
|
-
|
2003
|
+
```
|
2004
2004
|
|
2005
2005
|
### Parameters
|
2006
2006
|
|
@@ -2028,7 +2028,7 @@ Name | Type | Description | Notes
|
|
2028
2028
|
|
2029
2029
|
<a name="get_outbound_campaigns"></a>
|
2030
2030
|
|
2031
|
-
##
|
2031
|
+
## [**CampaignEntityListing**](CampaignEntityListing.html) get_outbound_campaigns(opts)
|
2032
2032
|
|
2033
2033
|
|
2034
2034
|
|
@@ -2044,7 +2044,7 @@ Requires ANY permissions:
|
|
2044
2044
|
|
2045
2045
|
|
2046
2046
|
### Example
|
2047
|
-
|
2047
|
+
```{"language":"ruby"}
|
2048
2048
|
# load the gem
|
2049
2049
|
require 'purecloudplatformclientv2'
|
2050
2050
|
# setup authorization
|
@@ -2083,7 +2083,7 @@ begin
|
|
2083
2083
|
rescue PureCloud::ApiError => e
|
2084
2084
|
puts "Exception when calling OutboundApi->get_outbound_campaigns: #{e}"
|
2085
2085
|
end
|
2086
|
-
|
2086
|
+
```
|
2087
2087
|
|
2088
2088
|
### Parameters
|
2089
2089
|
|
@@ -2118,7 +2118,7 @@ Name | Type | Description | Notes
|
|
2118
2118
|
|
2119
2119
|
<a name="get_outbound_campaigns_divisionviews"></a>
|
2120
2120
|
|
2121
|
-
##
|
2121
|
+
## [**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts)
|
2122
2122
|
|
2123
2123
|
|
2124
2124
|
|
@@ -2134,7 +2134,7 @@ Requires ANY permissions:
|
|
2134
2134
|
|
2135
2135
|
|
2136
2136
|
### Example
|
2137
|
-
|
2137
|
+
```{"language":"ruby"}
|
2138
2138
|
# load the gem
|
2139
2139
|
require 'purecloudplatformclientv2'
|
2140
2140
|
# setup authorization
|
@@ -2167,7 +2167,7 @@ begin
|
|
2167
2167
|
rescue PureCloud::ApiError => e
|
2168
2168
|
puts "Exception when calling OutboundApi->get_outbound_campaigns_divisionviews: #{e}"
|
2169
2169
|
end
|
2170
|
-
|
2170
|
+
```
|
2171
2171
|
|
2172
2172
|
### Parameters
|
2173
2173
|
|
@@ -2196,7 +2196,7 @@ Name | Type | Description | Notes
|
|
2196
2196
|
|
2197
2197
|
<a name="get_outbound_contactlist"></a>
|
2198
2198
|
|
2199
|
-
##
|
2199
|
+
## [**ContactList**](ContactList.html) get_outbound_contactlist(contact_list_id, opts)
|
2200
2200
|
|
2201
2201
|
|
2202
2202
|
|
@@ -2212,7 +2212,7 @@ Requires ANY permissions:
|
|
2212
2212
|
|
2213
2213
|
|
2214
2214
|
### Example
|
2215
|
-
|
2215
|
+
```{"language":"ruby"}
|
2216
2216
|
# load the gem
|
2217
2217
|
require 'purecloudplatformclientv2'
|
2218
2218
|
# setup authorization
|
@@ -2242,7 +2242,7 @@ begin
|
|
2242
2242
|
rescue PureCloud::ApiError => e
|
2243
2243
|
puts "Exception when calling OutboundApi->get_outbound_contactlist: #{e}"
|
2244
2244
|
end
|
2245
|
-
|
2245
|
+
```
|
2246
2246
|
|
2247
2247
|
### Parameters
|
2248
2248
|
|
@@ -2267,7 +2267,7 @@ Name | Type | Description | Notes
|
|
2267
2267
|
|
2268
2268
|
<a name="get_outbound_contactlist_contact"></a>
|
2269
2269
|
|
2270
|
-
##
|
2270
|
+
## [**DialerContact**](DialerContact.html) get_outbound_contactlist_contact(contact_list_id, contact_id)
|
2271
2271
|
|
2272
2272
|
|
2273
2273
|
|
@@ -2283,7 +2283,7 @@ Requires ANY permissions:
|
|
2283
2283
|
|
2284
2284
|
|
2285
2285
|
### Example
|
2286
|
-
|
2286
|
+
```{"language":"ruby"}
|
2287
2287
|
# load the gem
|
2288
2288
|
require 'purecloudplatformclientv2'
|
2289
2289
|
# setup authorization
|
@@ -2311,7 +2311,7 @@ begin
|
|
2311
2311
|
rescue PureCloud::ApiError => e
|
2312
2312
|
puts "Exception when calling OutboundApi->get_outbound_contactlist_contact: #{e}"
|
2313
2313
|
end
|
2314
|
-
|
2314
|
+
```
|
2315
2315
|
|
2316
2316
|
### Parameters
|
2317
2317
|
|
@@ -2335,7 +2335,7 @@ Name | Type | Description | Notes
|
|
2335
2335
|
|
2336
2336
|
<a name="get_outbound_contactlist_export"></a>
|
2337
2337
|
|
2338
|
-
##
|
2338
|
+
## [**ExportUri**](ExportUri.html) get_outbound_contactlist_export(contact_list_id, opts)
|
2339
2339
|
|
2340
2340
|
|
2341
2341
|
|
@@ -2352,7 +2352,7 @@ Requires ALL permissions:
|
|
2352
2352
|
|
2353
2353
|
|
2354
2354
|
### Example
|
2355
|
-
|
2355
|
+
```{"language":"ruby"}
|
2356
2356
|
# load the gem
|
2357
2357
|
require 'purecloudplatformclientv2'
|
2358
2358
|
# setup authorization
|
@@ -2381,7 +2381,7 @@ begin
|
|
2381
2381
|
rescue PureCloud::ApiError => e
|
2382
2382
|
puts "Exception when calling OutboundApi->get_outbound_contactlist_export: #{e}"
|
2383
2383
|
end
|
2384
|
-
|
2384
|
+
```
|
2385
2385
|
|
2386
2386
|
### Parameters
|
2387
2387
|
|
@@ -2405,7 +2405,7 @@ Name | Type | Description | Notes
|
|
2405
2405
|
|
2406
2406
|
<a name="get_outbound_contactlist_importstatus"></a>
|
2407
2407
|
|
2408
|
-
##
|
2408
|
+
## [**ImportStatus**](ImportStatus.html) get_outbound_contactlist_importstatus(contact_list_id)
|
2409
2409
|
|
2410
2410
|
|
2411
2411
|
|
@@ -2421,7 +2421,7 @@ Requires ANY permissions:
|
|
2421
2421
|
|
2422
2422
|
|
2423
2423
|
### Example
|
2424
|
-
|
2424
|
+
```{"language":"ruby"}
|
2425
2425
|
# load the gem
|
2426
2426
|
require 'purecloudplatformclientv2'
|
2427
2427
|
# setup authorization
|
@@ -2447,7 +2447,7 @@ begin
|
|
2447
2447
|
rescue PureCloud::ApiError => e
|
2448
2448
|
puts "Exception when calling OutboundApi->get_outbound_contactlist_importstatus: #{e}"
|
2449
2449
|
end
|
2450
|
-
|
2450
|
+
```
|
2451
2451
|
|
2452
2452
|
### Parameters
|
2453
2453
|
|
@@ -2470,7 +2470,7 @@ Name | Type | Description | Notes
|
|
2470
2470
|
|
2471
2471
|
<a name="get_outbound_contactlist_timezonemappingpreview"></a>
|
2472
2472
|
|
2473
|
-
##
|
2473
|
+
## [**TimeZoneMappingPreview**](TimeZoneMappingPreview.html) get_outbound_contactlist_timezonemappingpreview(contact_list_id)
|
2474
2474
|
|
2475
2475
|
|
2476
2476
|
|
@@ -2486,7 +2486,7 @@ Requires ANY permissions:
|
|
2486
2486
|
|
2487
2487
|
|
2488
2488
|
### Example
|
2489
|
-
|
2489
|
+
```{"language":"ruby"}
|
2490
2490
|
# load the gem
|
2491
2491
|
require 'purecloudplatformclientv2'
|
2492
2492
|
# setup authorization
|
@@ -2512,7 +2512,7 @@ begin
|
|
2512
2512
|
rescue PureCloud::ApiError => e
|
2513
2513
|
puts "Exception when calling OutboundApi->get_outbound_contactlist_timezonemappingpreview: #{e}"
|
2514
2514
|
end
|
2515
|
-
|
2515
|
+
```
|
2516
2516
|
|
2517
2517
|
### Parameters
|
2518
2518
|
|
@@ -2535,7 +2535,7 @@ Name | Type | Description | Notes
|
|
2535
2535
|
|
2536
2536
|
<a name="get_outbound_contactlistfilter"></a>
|
2537
2537
|
|
2538
|
-
##
|
2538
|
+
## [**ContactListFilter**](ContactListFilter.html) get_outbound_contactlistfilter(contact_list_filter_id)
|
2539
2539
|
|
2540
2540
|
|
2541
2541
|
|
@@ -2551,7 +2551,7 @@ Requires ANY permissions:
|
|
2551
2551
|
|
2552
2552
|
|
2553
2553
|
### Example
|
2554
|
-
|
2554
|
+
```{"language":"ruby"}
|
2555
2555
|
# load the gem
|
2556
2556
|
require 'purecloudplatformclientv2'
|
2557
2557
|
# setup authorization
|
@@ -2577,7 +2577,7 @@ begin
|
|
2577
2577
|
rescue PureCloud::ApiError => e
|
2578
2578
|
puts "Exception when calling OutboundApi->get_outbound_contactlistfilter: #{e}"
|
2579
2579
|
end
|
2580
|
-
|
2580
|
+
```
|
2581
2581
|
|
2582
2582
|
### Parameters
|
2583
2583
|
|
@@ -2600,7 +2600,7 @@ Name | Type | Description | Notes
|
|
2600
2600
|
|
2601
2601
|
<a name="get_outbound_contactlistfilters"></a>
|
2602
2602
|
|
2603
|
-
##
|
2603
|
+
## [**ContactListFilterEntityListing**](ContactListFilterEntityListing.html) get_outbound_contactlistfilters(opts)
|
2604
2604
|
|
2605
2605
|
|
2606
2606
|
|
@@ -2616,7 +2616,7 @@ Requires ANY permissions:
|
|
2616
2616
|
|
2617
2617
|
|
2618
2618
|
### Example
|
2619
|
-
|
2619
|
+
```{"language":"ruby"}
|
2620
2620
|
# load the gem
|
2621
2621
|
require 'purecloudplatformclientv2'
|
2622
2622
|
# setup authorization
|
@@ -2649,7 +2649,7 @@ begin
|
|
2649
2649
|
rescue PureCloud::ApiError => e
|
2650
2650
|
puts "Exception when calling OutboundApi->get_outbound_contactlistfilters: #{e}"
|
2651
2651
|
end
|
2652
|
-
|
2652
|
+
```
|
2653
2653
|
|
2654
2654
|
### Parameters
|
2655
2655
|
|
@@ -2678,7 +2678,7 @@ Name | Type | Description | Notes
|
|
2678
2678
|
|
2679
2679
|
<a name="get_outbound_contactlists"></a>
|
2680
2680
|
|
2681
|
-
##
|
2681
|
+
## [**ContactListEntityListing**](ContactListEntityListing.html) get_outbound_contactlists(opts)
|
2682
2682
|
|
2683
2683
|
|
2684
2684
|
|
@@ -2694,7 +2694,7 @@ Requires ANY permissions:
|
|
2694
2694
|
|
2695
2695
|
|
2696
2696
|
### Example
|
2697
|
-
|
2697
|
+
```{"language":"ruby"}
|
2698
2698
|
# load the gem
|
2699
2699
|
require 'purecloudplatformclientv2'
|
2700
2700
|
# setup authorization
|
@@ -2730,7 +2730,7 @@ begin
|
|
2730
2730
|
rescue PureCloud::ApiError => e
|
2731
2731
|
puts "Exception when calling OutboundApi->get_outbound_contactlists: #{e}"
|
2732
2732
|
end
|
2733
|
-
|
2733
|
+
```
|
2734
2734
|
|
2735
2735
|
### Parameters
|
2736
2736
|
|
@@ -2762,7 +2762,7 @@ Name | Type | Description | Notes
|
|
2762
2762
|
|
2763
2763
|
<a name="get_outbound_contactlists_divisionview"></a>
|
2764
2764
|
|
2765
|
-
##
|
2765
|
+
## [**ContactListDivisionView**](ContactListDivisionView.html) get_outbound_contactlists_divisionview(contact_list_id, opts)
|
2766
2766
|
|
2767
2767
|
|
2768
2768
|
|
@@ -2778,7 +2778,7 @@ Requires ANY permissions:
|
|
2778
2778
|
|
2779
2779
|
|
2780
2780
|
### Example
|
2781
|
-
|
2781
|
+
```{"language":"ruby"}
|
2782
2782
|
# load the gem
|
2783
2783
|
require 'purecloudplatformclientv2'
|
2784
2784
|
# setup authorization
|
@@ -2808,7 +2808,7 @@ begin
|
|
2808
2808
|
rescue PureCloud::ApiError => e
|
2809
2809
|
puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionview: #{e}"
|
2810
2810
|
end
|
2811
|
-
|
2811
|
+
```
|
2812
2812
|
|
2813
2813
|
### Parameters
|
2814
2814
|
|
@@ -2833,7 +2833,7 @@ Name | Type | Description | Notes
|
|
2833
2833
|
|
2834
2834
|
<a name="get_outbound_contactlists_divisionviews"></a>
|
2835
2835
|
|
2836
|
-
##
|
2836
|
+
## [**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts)
|
2837
2837
|
|
2838
2838
|
|
2839
2839
|
|
@@ -2849,7 +2849,7 @@ Requires ANY permissions:
|
|
2849
2849
|
|
2850
2850
|
|
2851
2851
|
### Example
|
2852
|
-
|
2852
|
+
```{"language":"ruby"}
|
2853
2853
|
# load the gem
|
2854
2854
|
require 'purecloudplatformclientv2'
|
2855
2855
|
# setup authorization
|
@@ -2884,7 +2884,7 @@ begin
|
|
2884
2884
|
rescue PureCloud::ApiError => e
|
2885
2885
|
puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: #{e}"
|
2886
2886
|
end
|
2887
|
-
|
2887
|
+
```
|
2888
2888
|
|
2889
2889
|
### Parameters
|
2890
2890
|
|
@@ -2915,7 +2915,7 @@ Name | Type | Description | Notes
|
|
2915
2915
|
|
2916
2916
|
<a name="get_outbound_dnclist"></a>
|
2917
2917
|
|
2918
|
-
##
|
2918
|
+
## [**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts)
|
2919
2919
|
|
2920
2920
|
|
2921
2921
|
|
@@ -2931,7 +2931,7 @@ Requires ANY permissions:
|
|
2931
2931
|
|
2932
2932
|
|
2933
2933
|
### Example
|
2934
|
-
|
2934
|
+
```{"language":"ruby"}
|
2935
2935
|
# load the gem
|
2936
2936
|
require 'purecloudplatformclientv2'
|
2937
2937
|
# setup authorization
|
@@ -2961,7 +2961,7 @@ begin
|
|
2961
2961
|
rescue PureCloud::ApiError => e
|
2962
2962
|
puts "Exception when calling OutboundApi->get_outbound_dnclist: #{e}"
|
2963
2963
|
end
|
2964
|
-
|
2964
|
+
```
|
2965
2965
|
|
2966
2966
|
### Parameters
|
2967
2967
|
|
@@ -2986,7 +2986,7 @@ Name | Type | Description | Notes
|
|
2986
2986
|
|
2987
2987
|
<a name="get_outbound_dnclist_export"></a>
|
2988
2988
|
|
2989
|
-
##
|
2989
|
+
## [**ExportUri**](ExportUri.html) get_outbound_dnclist_export(dnc_list_id, opts)
|
2990
2990
|
|
2991
2991
|
|
2992
2992
|
|
@@ -3003,7 +3003,7 @@ Requires ALL permissions:
|
|
3003
3003
|
|
3004
3004
|
|
3005
3005
|
### Example
|
3006
|
-
|
3006
|
+
```{"language":"ruby"}
|
3007
3007
|
# load the gem
|
3008
3008
|
require 'purecloudplatformclientv2'
|
3009
3009
|
# setup authorization
|
@@ -3032,7 +3032,7 @@ begin
|
|
3032
3032
|
rescue PureCloud::ApiError => e
|
3033
3033
|
puts "Exception when calling OutboundApi->get_outbound_dnclist_export: #{e}"
|
3034
3034
|
end
|
3035
|
-
|
3035
|
+
```
|
3036
3036
|
|
3037
3037
|
### Parameters
|
3038
3038
|
|
@@ -3056,7 +3056,7 @@ Name | Type | Description | Notes
|
|
3056
3056
|
|
3057
3057
|
<a name="get_outbound_dnclist_importstatus"></a>
|
3058
3058
|
|
3059
|
-
##
|
3059
|
+
## [**ImportStatus**](ImportStatus.html) get_outbound_dnclist_importstatus(dnc_list_id)
|
3060
3060
|
|
3061
3061
|
|
3062
3062
|
|
@@ -3072,7 +3072,7 @@ Requires ANY permissions:
|
|
3072
3072
|
|
3073
3073
|
|
3074
3074
|
### Example
|
3075
|
-
|
3075
|
+
```{"language":"ruby"}
|
3076
3076
|
# load the gem
|
3077
3077
|
require 'purecloudplatformclientv2'
|
3078
3078
|
# setup authorization
|
@@ -3098,7 +3098,7 @@ begin
|
|
3098
3098
|
rescue PureCloud::ApiError => e
|
3099
3099
|
puts "Exception when calling OutboundApi->get_outbound_dnclist_importstatus: #{e}"
|
3100
3100
|
end
|
3101
|
-
|
3101
|
+
```
|
3102
3102
|
|
3103
3103
|
### Parameters
|
3104
3104
|
|
@@ -3121,7 +3121,7 @@ Name | Type | Description | Notes
|
|
3121
3121
|
|
3122
3122
|
<a name="get_outbound_dnclists"></a>
|
3123
3123
|
|
3124
|
-
##
|
3124
|
+
## [**DncListEntityListing**](DncListEntityListing.html) get_outbound_dnclists(opts)
|
3125
3125
|
|
3126
3126
|
|
3127
3127
|
|
@@ -3137,7 +3137,7 @@ Requires ANY permissions:
|
|
3137
3137
|
|
3138
3138
|
|
3139
3139
|
### Example
|
3140
|
-
|
3140
|
+
```{"language":"ruby"}
|
3141
3141
|
# load the gem
|
3142
3142
|
require 'purecloudplatformclientv2'
|
3143
3143
|
# setup authorization
|
@@ -3173,7 +3173,7 @@ begin
|
|
3173
3173
|
rescue PureCloud::ApiError => e
|
3174
3174
|
puts "Exception when calling OutboundApi->get_outbound_dnclists: #{e}"
|
3175
3175
|
end
|
3176
|
-
|
3176
|
+
```
|
3177
3177
|
|
3178
3178
|
### Parameters
|
3179
3179
|
|
@@ -3205,7 +3205,7 @@ Name | Type | Description | Notes
|
|
3205
3205
|
|
3206
3206
|
<a name="get_outbound_dnclists_divisionview"></a>
|
3207
3207
|
|
3208
|
-
##
|
3208
|
+
## [**DncListDivisionView**](DncListDivisionView.html) get_outbound_dnclists_divisionview(dnc_list_id, opts)
|
3209
3209
|
|
3210
3210
|
|
3211
3211
|
|
@@ -3221,7 +3221,7 @@ Requires ANY permissions:
|
|
3221
3221
|
|
3222
3222
|
|
3223
3223
|
### Example
|
3224
|
-
|
3224
|
+
```{"language":"ruby"}
|
3225
3225
|
# load the gem
|
3226
3226
|
require 'purecloudplatformclientv2'
|
3227
3227
|
# setup authorization
|
@@ -3251,7 +3251,7 @@ begin
|
|
3251
3251
|
rescue PureCloud::ApiError => e
|
3252
3252
|
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionview: #{e}"
|
3253
3253
|
end
|
3254
|
-
|
3254
|
+
```
|
3255
3255
|
|
3256
3256
|
### Parameters
|
3257
3257
|
|
@@ -3276,7 +3276,7 @@ Name | Type | Description | Notes
|
|
3276
3276
|
|
3277
3277
|
<a name="get_outbound_dnclists_divisionviews"></a>
|
3278
3278
|
|
3279
|
-
##
|
3279
|
+
## [**DncListDivisionViewListing**](DncListDivisionViewListing.html) get_outbound_dnclists_divisionviews(opts)
|
3280
3280
|
|
3281
3281
|
|
3282
3282
|
|
@@ -3292,7 +3292,7 @@ Requires ANY permissions:
|
|
3292
3292
|
|
3293
3293
|
|
3294
3294
|
### Example
|
3295
|
-
|
3295
|
+
```{"language":"ruby"}
|
3296
3296
|
# load the gem
|
3297
3297
|
require 'purecloudplatformclientv2'
|
3298
3298
|
# setup authorization
|
@@ -3327,7 +3327,7 @@ begin
|
|
3327
3327
|
rescue PureCloud::ApiError => e
|
3328
3328
|
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: #{e}"
|
3329
3329
|
end
|
3330
|
-
|
3330
|
+
```
|
3331
3331
|
|
3332
3332
|
### Parameters
|
3333
3333
|
|
@@ -3358,7 +3358,7 @@ Name | Type | Description | Notes
|
|
3358
3358
|
|
3359
3359
|
<a name="get_outbound_event"></a>
|
3360
3360
|
|
3361
|
-
##
|
3361
|
+
## [**EventLog**](EventLog.html) get_outbound_event(event_id)
|
3362
3362
|
|
3363
3363
|
|
3364
3364
|
|
@@ -3374,7 +3374,7 @@ Requires ANY permissions:
|
|
3374
3374
|
|
3375
3375
|
|
3376
3376
|
### Example
|
3377
|
-
|
3377
|
+
```{"language":"ruby"}
|
3378
3378
|
# load the gem
|
3379
3379
|
require 'purecloudplatformclientv2'
|
3380
3380
|
# setup authorization
|
@@ -3400,7 +3400,7 @@ begin
|
|
3400
3400
|
rescue PureCloud::ApiError => e
|
3401
3401
|
puts "Exception when calling OutboundApi->get_outbound_event: #{e}"
|
3402
3402
|
end
|
3403
|
-
|
3403
|
+
```
|
3404
3404
|
|
3405
3405
|
### Parameters
|
3406
3406
|
|
@@ -3423,7 +3423,7 @@ Name | Type | Description | Notes
|
|
3423
3423
|
|
3424
3424
|
<a name="get_outbound_events"></a>
|
3425
3425
|
|
3426
|
-
##
|
3426
|
+
## [**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts)
|
3427
3427
|
|
3428
3428
|
|
3429
3429
|
|
@@ -3439,7 +3439,7 @@ Requires ANY permissions:
|
|
3439
3439
|
|
3440
3440
|
|
3441
3441
|
### Example
|
3442
|
-
|
3442
|
+
```{"language":"ruby"}
|
3443
3443
|
# load the gem
|
3444
3444
|
require 'purecloudplatformclientv2'
|
3445
3445
|
# setup authorization
|
@@ -3472,7 +3472,7 @@ begin
|
|
3472
3472
|
rescue PureCloud::ApiError => e
|
3473
3473
|
puts "Exception when calling OutboundApi->get_outbound_events: #{e}"
|
3474
3474
|
end
|
3475
|
-
|
3475
|
+
```
|
3476
3476
|
|
3477
3477
|
### Parameters
|
3478
3478
|
|
@@ -3501,7 +3501,7 @@ Name | Type | Description | Notes
|
|
3501
3501
|
|
3502
3502
|
<a name="get_outbound_ruleset"></a>
|
3503
3503
|
|
3504
|
-
##
|
3504
|
+
## [**RuleSet**](RuleSet.html) get_outbound_ruleset(rule_set_id)
|
3505
3505
|
|
3506
3506
|
|
3507
3507
|
|
@@ -3517,7 +3517,7 @@ Requires ANY permissions:
|
|
3517
3517
|
|
3518
3518
|
|
3519
3519
|
### Example
|
3520
|
-
|
3520
|
+
```{"language":"ruby"}
|
3521
3521
|
# load the gem
|
3522
3522
|
require 'purecloudplatformclientv2'
|
3523
3523
|
# setup authorization
|
@@ -3543,7 +3543,7 @@ begin
|
|
3543
3543
|
rescue PureCloud::ApiError => e
|
3544
3544
|
puts "Exception when calling OutboundApi->get_outbound_ruleset: #{e}"
|
3545
3545
|
end
|
3546
|
-
|
3546
|
+
```
|
3547
3547
|
|
3548
3548
|
### Parameters
|
3549
3549
|
|
@@ -3566,7 +3566,7 @@ Name | Type | Description | Notes
|
|
3566
3566
|
|
3567
3567
|
<a name="get_outbound_rulesets"></a>
|
3568
3568
|
|
3569
|
-
##
|
3569
|
+
## [**RuleSetEntityListing**](RuleSetEntityListing.html) get_outbound_rulesets(opts)
|
3570
3570
|
|
3571
3571
|
|
3572
3572
|
|
@@ -3582,7 +3582,7 @@ Requires ANY permissions:
|
|
3582
3582
|
|
3583
3583
|
|
3584
3584
|
### Example
|
3585
|
-
|
3585
|
+
```{"language":"ruby"}
|
3586
3586
|
# load the gem
|
3587
3587
|
require 'purecloudplatformclientv2'
|
3588
3588
|
# setup authorization
|
@@ -3614,7 +3614,7 @@ begin
|
|
3614
3614
|
rescue PureCloud::ApiError => e
|
3615
3615
|
puts "Exception when calling OutboundApi->get_outbound_rulesets: #{e}"
|
3616
3616
|
end
|
3617
|
-
|
3617
|
+
```
|
3618
3618
|
|
3619
3619
|
### Parameters
|
3620
3620
|
|
@@ -3642,7 +3642,7 @@ Name | Type | Description | Notes
|
|
3642
3642
|
|
3643
3643
|
<a name="get_outbound_schedules_campaign"></a>
|
3644
3644
|
|
3645
|
-
##
|
3645
|
+
## [**CampaignSchedule**](CampaignSchedule.html) get_outbound_schedules_campaign(campaign_id)
|
3646
3646
|
|
3647
3647
|
|
3648
3648
|
|
@@ -3658,7 +3658,7 @@ Requires ANY permissions:
|
|
3658
3658
|
|
3659
3659
|
|
3660
3660
|
### Example
|
3661
|
-
|
3661
|
+
```{"language":"ruby"}
|
3662
3662
|
# load the gem
|
3663
3663
|
require 'purecloudplatformclientv2'
|
3664
3664
|
# setup authorization
|
@@ -3684,7 +3684,7 @@ begin
|
|
3684
3684
|
rescue PureCloud::ApiError => e
|
3685
3685
|
puts "Exception when calling OutboundApi->get_outbound_schedules_campaign: #{e}"
|
3686
3686
|
end
|
3687
|
-
|
3687
|
+
```
|
3688
3688
|
|
3689
3689
|
### Parameters
|
3690
3690
|
|
@@ -3707,7 +3707,7 @@ Name | Type | Description | Notes
|
|
3707
3707
|
|
3708
3708
|
<a name="get_outbound_schedules_campaigns"></a>
|
3709
3709
|
|
3710
|
-
##
|
3710
|
+
## [**Array<CampaignSchedule>**](CampaignSchedule.html) get_outbound_schedules_campaigns
|
3711
3711
|
|
3712
3712
|
|
3713
3713
|
|
@@ -3723,7 +3723,7 @@ Requires ANY permissions:
|
|
3723
3723
|
|
3724
3724
|
|
3725
3725
|
### Example
|
3726
|
-
|
3726
|
+
```{"language":"ruby"}
|
3727
3727
|
# load the gem
|
3728
3728
|
require 'purecloudplatformclientv2'
|
3729
3729
|
# setup authorization
|
@@ -3746,7 +3746,7 @@ begin
|
|
3746
3746
|
rescue PureCloud::ApiError => e
|
3747
3747
|
puts "Exception when calling OutboundApi->get_outbound_schedules_campaigns: #{e}"
|
3748
3748
|
end
|
3749
|
-
|
3749
|
+
```
|
3750
3750
|
|
3751
3751
|
### Parameters
|
3752
3752
|
This endpoint does not need any parameter.
|
@@ -3766,7 +3766,7 @@ This endpoint does not need any parameter.
|
|
3766
3766
|
|
3767
3767
|
<a name="get_outbound_schedules_sequence"></a>
|
3768
3768
|
|
3769
|
-
##
|
3769
|
+
## [**SequenceSchedule**](SequenceSchedule.html) get_outbound_schedules_sequence(sequence_id)
|
3770
3770
|
|
3771
3771
|
|
3772
3772
|
|
@@ -3782,7 +3782,7 @@ Requires ANY permissions:
|
|
3782
3782
|
|
3783
3783
|
|
3784
3784
|
### Example
|
3785
|
-
|
3785
|
+
```{"language":"ruby"}
|
3786
3786
|
# load the gem
|
3787
3787
|
require 'purecloudplatformclientv2'
|
3788
3788
|
# setup authorization
|
@@ -3808,7 +3808,7 @@ begin
|
|
3808
3808
|
rescue PureCloud::ApiError => e
|
3809
3809
|
puts "Exception when calling OutboundApi->get_outbound_schedules_sequence: #{e}"
|
3810
3810
|
end
|
3811
|
-
|
3811
|
+
```
|
3812
3812
|
|
3813
3813
|
### Parameters
|
3814
3814
|
|
@@ -3831,7 +3831,7 @@ Name | Type | Description | Notes
|
|
3831
3831
|
|
3832
3832
|
<a name="get_outbound_schedules_sequences"></a>
|
3833
3833
|
|
3834
|
-
##
|
3834
|
+
## [**Array<SequenceSchedule>**](SequenceSchedule.html) get_outbound_schedules_sequences
|
3835
3835
|
|
3836
3836
|
|
3837
3837
|
|
@@ -3847,7 +3847,7 @@ Requires ANY permissions:
|
|
3847
3847
|
|
3848
3848
|
|
3849
3849
|
### Example
|
3850
|
-
|
3850
|
+
```{"language":"ruby"}
|
3851
3851
|
# load the gem
|
3852
3852
|
require 'purecloudplatformclientv2'
|
3853
3853
|
# setup authorization
|
@@ -3870,7 +3870,7 @@ begin
|
|
3870
3870
|
rescue PureCloud::ApiError => e
|
3871
3871
|
puts "Exception when calling OutboundApi->get_outbound_schedules_sequences: #{e}"
|
3872
3872
|
end
|
3873
|
-
|
3873
|
+
```
|
3874
3874
|
|
3875
3875
|
### Parameters
|
3876
3876
|
This endpoint does not need any parameter.
|
@@ -3890,7 +3890,7 @@ This endpoint does not need any parameter.
|
|
3890
3890
|
|
3891
3891
|
<a name="get_outbound_sequence"></a>
|
3892
3892
|
|
3893
|
-
##
|
3893
|
+
## [**CampaignSequence**](CampaignSequence.html) get_outbound_sequence(sequence_id)
|
3894
3894
|
|
3895
3895
|
|
3896
3896
|
|
@@ -3906,7 +3906,7 @@ Requires ANY permissions:
|
|
3906
3906
|
|
3907
3907
|
|
3908
3908
|
### Example
|
3909
|
-
|
3909
|
+
```{"language":"ruby"}
|
3910
3910
|
# load the gem
|
3911
3911
|
require 'purecloudplatformclientv2'
|
3912
3912
|
# setup authorization
|
@@ -3932,7 +3932,7 @@ begin
|
|
3932
3932
|
rescue PureCloud::ApiError => e
|
3933
3933
|
puts "Exception when calling OutboundApi->get_outbound_sequence: #{e}"
|
3934
3934
|
end
|
3935
|
-
|
3935
|
+
```
|
3936
3936
|
|
3937
3937
|
### Parameters
|
3938
3938
|
|
@@ -3955,7 +3955,7 @@ Name | Type | Description | Notes
|
|
3955
3955
|
|
3956
3956
|
<a name="get_outbound_sequences"></a>
|
3957
3957
|
|
3958
|
-
##
|
3958
|
+
## [**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_outbound_sequences(opts)
|
3959
3959
|
|
3960
3960
|
|
3961
3961
|
|
@@ -3971,7 +3971,7 @@ Requires ANY permissions:
|
|
3971
3971
|
|
3972
3972
|
|
3973
3973
|
### Example
|
3974
|
-
|
3974
|
+
```{"language":"ruby"}
|
3975
3975
|
# load the gem
|
3976
3976
|
require 'purecloudplatformclientv2'
|
3977
3977
|
# setup authorization
|
@@ -4003,7 +4003,7 @@ begin
|
|
4003
4003
|
rescue PureCloud::ApiError => e
|
4004
4004
|
puts "Exception when calling OutboundApi->get_outbound_sequences: #{e}"
|
4005
4005
|
end
|
4006
|
-
|
4006
|
+
```
|
4007
4007
|
|
4008
4008
|
### Parameters
|
4009
4009
|
|
@@ -4031,7 +4031,7 @@ Name | Type | Description | Notes
|
|
4031
4031
|
|
4032
4032
|
<a name="get_outbound_settings"></a>
|
4033
4033
|
|
4034
|
-
##
|
4034
|
+
## [**OutboundSettings**](OutboundSettings.html) get_outbound_settings
|
4035
4035
|
|
4036
4036
|
|
4037
4037
|
|
@@ -4047,7 +4047,7 @@ Requires ANY permissions:
|
|
4047
4047
|
|
4048
4048
|
|
4049
4049
|
### Example
|
4050
|
-
|
4050
|
+
```{"language":"ruby"}
|
4051
4051
|
# load the gem
|
4052
4052
|
require 'purecloudplatformclientv2'
|
4053
4053
|
# setup authorization
|
@@ -4070,7 +4070,7 @@ begin
|
|
4070
4070
|
rescue PureCloud::ApiError => e
|
4071
4071
|
puts "Exception when calling OutboundApi->get_outbound_settings: #{e}"
|
4072
4072
|
end
|
4073
|
-
|
4073
|
+
```
|
4074
4074
|
|
4075
4075
|
### Parameters
|
4076
4076
|
This endpoint does not need any parameter.
|
@@ -4090,7 +4090,7 @@ This endpoint does not need any parameter.
|
|
4090
4090
|
|
4091
4091
|
<a name="get_outbound_wrapupcodemappings"></a>
|
4092
4092
|
|
4093
|
-
##
|
4093
|
+
## [**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings
|
4094
4094
|
|
4095
4095
|
|
4096
4096
|
|
@@ -4106,7 +4106,7 @@ Requires ANY permissions:
|
|
4106
4106
|
|
4107
4107
|
|
4108
4108
|
### Example
|
4109
|
-
|
4109
|
+
```{"language":"ruby"}
|
4110
4110
|
# load the gem
|
4111
4111
|
require 'purecloudplatformclientv2'
|
4112
4112
|
# setup authorization
|
@@ -4129,7 +4129,7 @@ begin
|
|
4129
4129
|
rescue PureCloud::ApiError => e
|
4130
4130
|
puts "Exception when calling OutboundApi->get_outbound_wrapupcodemappings: #{e}"
|
4131
4131
|
end
|
4132
|
-
|
4132
|
+
```
|
4133
4133
|
|
4134
4134
|
### Parameters
|
4135
4135
|
This endpoint does not need any parameter.
|
@@ -4149,7 +4149,7 @@ This endpoint does not need any parameter.
|
|
4149
4149
|
|
4150
4150
|
<a name="patch_outbound_settings"></a>
|
4151
4151
|
|
4152
|
-
##
|
4152
|
+
## patch_outbound_settings(body)
|
4153
4153
|
|
4154
4154
|
|
4155
4155
|
|
@@ -4165,7 +4165,7 @@ Requires ANY permissions:
|
|
4165
4165
|
|
4166
4166
|
|
4167
4167
|
### Example
|
4168
|
-
|
4168
|
+
```{"language":"ruby"}
|
4169
4169
|
# load the gem
|
4170
4170
|
require 'purecloudplatformclientv2'
|
4171
4171
|
# setup authorization
|
@@ -4190,7 +4190,7 @@ begin
|
|
4190
4190
|
rescue PureCloud::ApiError => e
|
4191
4191
|
puts "Exception when calling OutboundApi->patch_outbound_settings: #{e}"
|
4192
4192
|
end
|
4193
|
-
|
4193
|
+
```
|
4194
4194
|
|
4195
4195
|
### Parameters
|
4196
4196
|
|
@@ -4213,7 +4213,7 @@ nil (empty response body)
|
|
4213
4213
|
|
4214
4214
|
<a name="post_outbound_attemptlimits"></a>
|
4215
4215
|
|
4216
|
-
##
|
4216
|
+
## [**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body)
|
4217
4217
|
|
4218
4218
|
|
4219
4219
|
|
@@ -4229,7 +4229,7 @@ Requires ANY permissions:
|
|
4229
4229
|
|
4230
4230
|
|
4231
4231
|
### Example
|
4232
|
-
|
4232
|
+
```{"language":"ruby"}
|
4233
4233
|
# load the gem
|
4234
4234
|
require 'purecloudplatformclientv2'
|
4235
4235
|
# setup authorization
|
@@ -4255,7 +4255,7 @@ begin
|
|
4255
4255
|
rescue PureCloud::ApiError => e
|
4256
4256
|
puts "Exception when calling OutboundApi->post_outbound_attemptlimits: #{e}"
|
4257
4257
|
end
|
4258
|
-
|
4258
|
+
```
|
4259
4259
|
|
4260
4260
|
### Parameters
|
4261
4261
|
|
@@ -4278,7 +4278,7 @@ Name | Type | Description | Notes
|
|
4278
4278
|
|
4279
4279
|
<a name="post_outbound_audits"></a>
|
4280
4280
|
|
4281
|
-
##
|
4281
|
+
## [**AuditSearchResult**](AuditSearchResult.html) post_outbound_audits(body, opts)
|
4282
4282
|
|
4283
4283
|
|
4284
4284
|
|
@@ -4294,7 +4294,7 @@ Requires ANY permissions:
|
|
4294
4294
|
|
4295
4295
|
|
4296
4296
|
### Example
|
4297
|
-
|
4297
|
+
```{"language":"ruby"}
|
4298
4298
|
# load the gem
|
4299
4299
|
require 'purecloudplatformclientv2'
|
4300
4300
|
# setup authorization
|
@@ -4327,7 +4327,7 @@ begin
|
|
4327
4327
|
rescue PureCloud::ApiError => e
|
4328
4328
|
puts "Exception when calling OutboundApi->post_outbound_audits: #{e}"
|
4329
4329
|
end
|
4330
|
-
|
4330
|
+
```
|
4331
4331
|
|
4332
4332
|
### Parameters
|
4333
4333
|
|
@@ -4355,7 +4355,7 @@ Name | Type | Description | Notes
|
|
4355
4355
|
|
4356
4356
|
<a name="post_outbound_callabletimesets"></a>
|
4357
4357
|
|
4358
|
-
##
|
4358
|
+
## [**CallableTimeSet**](CallableTimeSet.html) post_outbound_callabletimesets(body)
|
4359
4359
|
|
4360
4360
|
|
4361
4361
|
|
@@ -4371,7 +4371,7 @@ Requires ANY permissions:
|
|
4371
4371
|
|
4372
4372
|
|
4373
4373
|
### Example
|
4374
|
-
|
4374
|
+
```{"language":"ruby"}
|
4375
4375
|
# load the gem
|
4376
4376
|
require 'purecloudplatformclientv2'
|
4377
4377
|
# setup authorization
|
@@ -4397,7 +4397,7 @@ begin
|
|
4397
4397
|
rescue PureCloud::ApiError => e
|
4398
4398
|
puts "Exception when calling OutboundApi->post_outbound_callabletimesets: #{e}"
|
4399
4399
|
end
|
4400
|
-
|
4400
|
+
```
|
4401
4401
|
|
4402
4402
|
### Parameters
|
4403
4403
|
|
@@ -4420,7 +4420,7 @@ Name | Type | Description | Notes
|
|
4420
4420
|
|
4421
4421
|
<a name="post_outbound_callanalysisresponsesets"></a>
|
4422
4422
|
|
4423
|
-
##
|
4423
|
+
## [**ResponseSet**](ResponseSet.html) post_outbound_callanalysisresponsesets(body)
|
4424
4424
|
|
4425
4425
|
|
4426
4426
|
|
@@ -4436,7 +4436,7 @@ Requires ANY permissions:
|
|
4436
4436
|
|
4437
4437
|
|
4438
4438
|
### Example
|
4439
|
-
|
4439
|
+
```{"language":"ruby"}
|
4440
4440
|
# load the gem
|
4441
4441
|
require 'purecloudplatformclientv2'
|
4442
4442
|
# setup authorization
|
@@ -4462,7 +4462,7 @@ begin
|
|
4462
4462
|
rescue PureCloud::ApiError => e
|
4463
4463
|
puts "Exception when calling OutboundApi->post_outbound_callanalysisresponsesets: #{e}"
|
4464
4464
|
end
|
4465
|
-
|
4465
|
+
```
|
4466
4466
|
|
4467
4467
|
### Parameters
|
4468
4468
|
|
@@ -4485,7 +4485,7 @@ Name | Type | Description | Notes
|
|
4485
4485
|
|
4486
4486
|
<a name="post_outbound_campaign_callback_schedule"></a>
|
4487
4487
|
|
4488
|
-
##
|
4488
|
+
## [**ContactCallbackRequest**](ContactCallbackRequest.html) post_outbound_campaign_callback_schedule(campaign_id, body)
|
4489
4489
|
|
4490
4490
|
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
4491
4491
|
|
@@ -4500,7 +4500,7 @@ Requires NO permissions:
|
|
4500
4500
|
|
4501
4501
|
|
4502
4502
|
### Example
|
4503
|
-
|
4503
|
+
```{"language":"ruby"}
|
4504
4504
|
# load the gem
|
4505
4505
|
require 'purecloudplatformclientv2'
|
4506
4506
|
# setup authorization
|
@@ -4528,7 +4528,7 @@ begin
|
|
4528
4528
|
rescue PureCloud::ApiError => e
|
4529
4529
|
puts "Exception when calling OutboundApi->post_outbound_campaign_callback_schedule: #{e}"
|
4530
4530
|
end
|
4531
|
-
|
4531
|
+
```
|
4532
4532
|
|
4533
4533
|
### Parameters
|
4534
4534
|
|
@@ -4552,7 +4552,7 @@ Name | Type | Description | Notes
|
|
4552
4552
|
|
4553
4553
|
<a name="post_outbound_campaignrules"></a>
|
4554
4554
|
|
4555
|
-
##
|
4555
|
+
## [**CampaignRule**](CampaignRule.html) post_outbound_campaignrules(body)
|
4556
4556
|
|
4557
4557
|
|
4558
4558
|
|
@@ -4568,7 +4568,7 @@ Requires ANY permissions:
|
|
4568
4568
|
|
4569
4569
|
|
4570
4570
|
### Example
|
4571
|
-
|
4571
|
+
```{"language":"ruby"}
|
4572
4572
|
# load the gem
|
4573
4573
|
require 'purecloudplatformclientv2'
|
4574
4574
|
# setup authorization
|
@@ -4594,7 +4594,7 @@ begin
|
|
4594
4594
|
rescue PureCloud::ApiError => e
|
4595
4595
|
puts "Exception when calling OutboundApi->post_outbound_campaignrules: #{e}"
|
4596
4596
|
end
|
4597
|
-
|
4597
|
+
```
|
4598
4598
|
|
4599
4599
|
### Parameters
|
4600
4600
|
|
@@ -4617,7 +4617,7 @@ Name | Type | Description | Notes
|
|
4617
4617
|
|
4618
4618
|
<a name="post_outbound_campaigns"></a>
|
4619
4619
|
|
4620
|
-
##
|
4620
|
+
## [**Campaign**](Campaign.html) post_outbound_campaigns(body)
|
4621
4621
|
|
4622
4622
|
|
4623
4623
|
|
@@ -4633,7 +4633,7 @@ Requires ANY permissions:
|
|
4633
4633
|
|
4634
4634
|
|
4635
4635
|
### Example
|
4636
|
-
|
4636
|
+
```{"language":"ruby"}
|
4637
4637
|
# load the gem
|
4638
4638
|
require 'purecloudplatformclientv2'
|
4639
4639
|
# setup authorization
|
@@ -4659,7 +4659,7 @@ begin
|
|
4659
4659
|
rescue PureCloud::ApiError => e
|
4660
4660
|
puts "Exception when calling OutboundApi->post_outbound_campaigns: #{e}"
|
4661
4661
|
end
|
4662
|
-
|
4662
|
+
```
|
4663
4663
|
|
4664
4664
|
### Parameters
|
4665
4665
|
|
@@ -4682,7 +4682,7 @@ Name | Type | Description | Notes
|
|
4682
4682
|
|
4683
4683
|
<a name="post_outbound_campaigns_progress"></a>
|
4684
4684
|
|
4685
|
-
##
|
4685
|
+
## [**Array<CampaignProgress>**](CampaignProgress.html) post_outbound_campaigns_progress(body)
|
4686
4686
|
|
4687
4687
|
|
4688
4688
|
|
@@ -4698,7 +4698,7 @@ Requires ANY permissions:
|
|
4698
4698
|
|
4699
4699
|
|
4700
4700
|
### Example
|
4701
|
-
|
4701
|
+
```{"language":"ruby"}
|
4702
4702
|
# load the gem
|
4703
4703
|
require 'purecloudplatformclientv2'
|
4704
4704
|
# setup authorization
|
@@ -4724,7 +4724,7 @@ begin
|
|
4724
4724
|
rescue PureCloud::ApiError => e
|
4725
4725
|
puts "Exception when calling OutboundApi->post_outbound_campaigns_progress: #{e}"
|
4726
4726
|
end
|
4727
|
-
|
4727
|
+
```
|
4728
4728
|
|
4729
4729
|
### Parameters
|
4730
4730
|
|
@@ -4747,7 +4747,7 @@ Name | Type | Description | Notes
|
|
4747
4747
|
|
4748
4748
|
<a name="post_outbound_contactlist_clear"></a>
|
4749
4749
|
|
4750
|
-
##
|
4750
|
+
## post_outbound_contactlist_clear(contact_list_id)
|
4751
4751
|
|
4752
4752
|
|
4753
4753
|
|
@@ -4763,7 +4763,7 @@ Requires ANY permissions:
|
|
4763
4763
|
|
4764
4764
|
|
4765
4765
|
### Example
|
4766
|
-
|
4766
|
+
```{"language":"ruby"}
|
4767
4767
|
# load the gem
|
4768
4768
|
require 'purecloudplatformclientv2'
|
4769
4769
|
# setup authorization
|
@@ -4788,7 +4788,7 @@ begin
|
|
4788
4788
|
rescue PureCloud::ApiError => e
|
4789
4789
|
puts "Exception when calling OutboundApi->post_outbound_contactlist_clear: #{e}"
|
4790
4790
|
end
|
4791
|
-
|
4791
|
+
```
|
4792
4792
|
|
4793
4793
|
### Parameters
|
4794
4794
|
|
@@ -4811,7 +4811,7 @@ nil (empty response body)
|
|
4811
4811
|
|
4812
4812
|
<a name="post_outbound_contactlist_contacts"></a>
|
4813
4813
|
|
4814
|
-
##
|
4814
|
+
## [**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts)
|
4815
4815
|
|
4816
4816
|
|
4817
4817
|
|
@@ -4827,7 +4827,7 @@ Requires ANY permissions:
|
|
4827
4827
|
|
4828
4828
|
|
4829
4829
|
### Example
|
4830
|
-
|
4830
|
+
```{"language":"ruby"}
|
4831
4831
|
# load the gem
|
4832
4832
|
require 'purecloudplatformclientv2'
|
4833
4833
|
# setup authorization
|
@@ -4860,7 +4860,7 @@ begin
|
|
4860
4860
|
rescue PureCloud::ApiError => e
|
4861
4861
|
puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts: #{e}"
|
4862
4862
|
end
|
4863
|
-
|
4863
|
+
```
|
4864
4864
|
|
4865
4865
|
### Parameters
|
4866
4866
|
|
@@ -4887,7 +4887,7 @@ Name | Type | Description | Notes
|
|
4887
4887
|
|
4888
4888
|
<a name="post_outbound_contactlist_contacts_bulk"></a>
|
4889
4889
|
|
4890
|
-
##
|
4890
|
+
## [**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body)
|
4891
4891
|
|
4892
4892
|
|
4893
4893
|
|
@@ -4903,7 +4903,7 @@ Requires ANY permissions:
|
|
4903
4903
|
|
4904
4904
|
|
4905
4905
|
### Example
|
4906
|
-
|
4906
|
+
```{"language":"ruby"}
|
4907
4907
|
# load the gem
|
4908
4908
|
require 'purecloudplatformclientv2'
|
4909
4909
|
# setup authorization
|
@@ -4931,7 +4931,7 @@ begin
|
|
4931
4931
|
rescue PureCloud::ApiError => e
|
4932
4932
|
puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: #{e}"
|
4933
4933
|
end
|
4934
|
-
|
4934
|
+
```
|
4935
4935
|
|
4936
4936
|
### Parameters
|
4937
4937
|
|
@@ -4955,7 +4955,7 @@ Name | Type | Description | Notes
|
|
4955
4955
|
|
4956
4956
|
<a name="post_outbound_contactlist_export"></a>
|
4957
4957
|
|
4958
|
-
##
|
4958
|
+
## [**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id)
|
4959
4959
|
|
4960
4960
|
|
4961
4961
|
|
@@ -4972,7 +4972,7 @@ Requires ALL permissions:
|
|
4972
4972
|
|
4973
4973
|
|
4974
4974
|
### Example
|
4975
|
-
|
4975
|
+
```{"language":"ruby"}
|
4976
4976
|
# load the gem
|
4977
4977
|
require 'purecloudplatformclientv2'
|
4978
4978
|
# setup authorization
|
@@ -4998,7 +4998,7 @@ begin
|
|
4998
4998
|
rescue PureCloud::ApiError => e
|
4999
4999
|
puts "Exception when calling OutboundApi->post_outbound_contactlist_export: #{e}"
|
5000
5000
|
end
|
5001
|
-
|
5001
|
+
```
|
5002
5002
|
|
5003
5003
|
### Parameters
|
5004
5004
|
|
@@ -5021,7 +5021,7 @@ Name | Type | Description | Notes
|
|
5021
5021
|
|
5022
5022
|
<a name="post_outbound_contactlistfilters"></a>
|
5023
5023
|
|
5024
|
-
##
|
5024
|
+
## [**ContactListFilter**](ContactListFilter.html) post_outbound_contactlistfilters(body)
|
5025
5025
|
|
5026
5026
|
|
5027
5027
|
|
@@ -5037,7 +5037,7 @@ Requires ANY permissions:
|
|
5037
5037
|
|
5038
5038
|
|
5039
5039
|
### Example
|
5040
|
-
|
5040
|
+
```{"language":"ruby"}
|
5041
5041
|
# load the gem
|
5042
5042
|
require 'purecloudplatformclientv2'
|
5043
5043
|
# setup authorization
|
@@ -5063,7 +5063,7 @@ begin
|
|
5063
5063
|
rescue PureCloud::ApiError => e
|
5064
5064
|
puts "Exception when calling OutboundApi->post_outbound_contactlistfilters: #{e}"
|
5065
5065
|
end
|
5066
|
-
|
5066
|
+
```
|
5067
5067
|
|
5068
5068
|
### Parameters
|
5069
5069
|
|
@@ -5086,7 +5086,7 @@ Name | Type | Description | Notes
|
|
5086
5086
|
|
5087
5087
|
<a name="post_outbound_contactlistfilters_preview"></a>
|
5088
5088
|
|
5089
|
-
##
|
5089
|
+
## [**FilterPreviewResponse**](FilterPreviewResponse.html) post_outbound_contactlistfilters_preview(body)
|
5090
5090
|
|
5091
5091
|
|
5092
5092
|
|
@@ -5102,7 +5102,7 @@ Requires ANY permissions:
|
|
5102
5102
|
|
5103
5103
|
|
5104
5104
|
### Example
|
5105
|
-
|
5105
|
+
```{"language":"ruby"}
|
5106
5106
|
# load the gem
|
5107
5107
|
require 'purecloudplatformclientv2'
|
5108
5108
|
# setup authorization
|
@@ -5128,7 +5128,7 @@ begin
|
|
5128
5128
|
rescue PureCloud::ApiError => e
|
5129
5129
|
puts "Exception when calling OutboundApi->post_outbound_contactlistfilters_preview: #{e}"
|
5130
5130
|
end
|
5131
|
-
|
5131
|
+
```
|
5132
5132
|
|
5133
5133
|
### Parameters
|
5134
5134
|
|
@@ -5151,7 +5151,7 @@ Name | Type | Description | Notes
|
|
5151
5151
|
|
5152
5152
|
<a name="post_outbound_contactlists"></a>
|
5153
5153
|
|
5154
|
-
##
|
5154
|
+
## [**ContactList**](ContactList.html) post_outbound_contactlists(body)
|
5155
5155
|
|
5156
5156
|
|
5157
5157
|
|
@@ -5167,7 +5167,7 @@ Requires ANY permissions:
|
|
5167
5167
|
|
5168
5168
|
|
5169
5169
|
### Example
|
5170
|
-
|
5170
|
+
```{"language":"ruby"}
|
5171
5171
|
# load the gem
|
5172
5172
|
require 'purecloudplatformclientv2'
|
5173
5173
|
# setup authorization
|
@@ -5193,7 +5193,7 @@ begin
|
|
5193
5193
|
rescue PureCloud::ApiError => e
|
5194
5194
|
puts "Exception when calling OutboundApi->post_outbound_contactlists: #{e}"
|
5195
5195
|
end
|
5196
|
-
|
5196
|
+
```
|
5197
5197
|
|
5198
5198
|
### Parameters
|
5199
5199
|
|
@@ -5216,7 +5216,7 @@ Name | Type | Description | Notes
|
|
5216
5216
|
|
5217
5217
|
<a name="post_outbound_conversation_dnc"></a>
|
5218
5218
|
|
5219
|
-
##
|
5219
|
+
## post_outbound_conversation_dnc(conversation_id)
|
5220
5220
|
|
5221
5221
|
|
5222
5222
|
|
@@ -5232,7 +5232,7 @@ Requires ANY permissions:
|
|
5232
5232
|
|
5233
5233
|
|
5234
5234
|
### Example
|
5235
|
-
|
5235
|
+
```{"language":"ruby"}
|
5236
5236
|
# load the gem
|
5237
5237
|
require 'purecloudplatformclientv2'
|
5238
5238
|
# setup authorization
|
@@ -5257,7 +5257,7 @@ begin
|
|
5257
5257
|
rescue PureCloud::ApiError => e
|
5258
5258
|
puts "Exception when calling OutboundApi->post_outbound_conversation_dnc: #{e}"
|
5259
5259
|
end
|
5260
|
-
|
5260
|
+
```
|
5261
5261
|
|
5262
5262
|
### Parameters
|
5263
5263
|
|
@@ -5280,7 +5280,7 @@ nil (empty response body)
|
|
5280
5280
|
|
5281
5281
|
<a name="post_outbound_dnclist_export"></a>
|
5282
5282
|
|
5283
|
-
##
|
5283
|
+
## [**UriReference**](UriReference.html) post_outbound_dnclist_export(dnc_list_id)
|
5284
5284
|
|
5285
5285
|
|
5286
5286
|
|
@@ -5297,7 +5297,7 @@ Requires ALL permissions:
|
|
5297
5297
|
|
5298
5298
|
|
5299
5299
|
### Example
|
5300
|
-
|
5300
|
+
```{"language":"ruby"}
|
5301
5301
|
# load the gem
|
5302
5302
|
require 'purecloudplatformclientv2'
|
5303
5303
|
# setup authorization
|
@@ -5323,7 +5323,7 @@ begin
|
|
5323
5323
|
rescue PureCloud::ApiError => e
|
5324
5324
|
puts "Exception when calling OutboundApi->post_outbound_dnclist_export: #{e}"
|
5325
5325
|
end
|
5326
|
-
|
5326
|
+
```
|
5327
5327
|
|
5328
5328
|
### Parameters
|
5329
5329
|
|
@@ -5346,7 +5346,7 @@ Name | Type | Description | Notes
|
|
5346
5346
|
|
5347
5347
|
<a name="post_outbound_dnclist_phonenumbers"></a>
|
5348
5348
|
|
5349
|
-
##
|
5349
|
+
## post_outbound_dnclist_phonenumbers(dnc_list_id, body)
|
5350
5350
|
|
5351
5351
|
|
5352
5352
|
|
@@ -5362,7 +5362,7 @@ Requires ANY permissions:
|
|
5362
5362
|
|
5363
5363
|
|
5364
5364
|
### Example
|
5365
|
-
|
5365
|
+
```{"language":"ruby"}
|
5366
5366
|
# load the gem
|
5367
5367
|
require 'purecloudplatformclientv2'
|
5368
5368
|
# setup authorization
|
@@ -5389,7 +5389,7 @@ begin
|
|
5389
5389
|
rescue PureCloud::ApiError => e
|
5390
5390
|
puts "Exception when calling OutboundApi->post_outbound_dnclist_phonenumbers: #{e}"
|
5391
5391
|
end
|
5392
|
-
|
5392
|
+
```
|
5393
5393
|
|
5394
5394
|
### Parameters
|
5395
5395
|
|
@@ -5413,7 +5413,7 @@ nil (empty response body)
|
|
5413
5413
|
|
5414
5414
|
<a name="post_outbound_dnclists"></a>
|
5415
5415
|
|
5416
|
-
##
|
5416
|
+
## [**DncList**](DncList.html) post_outbound_dnclists(body)
|
5417
5417
|
|
5418
5418
|
|
5419
5419
|
|
@@ -5429,7 +5429,7 @@ Requires ANY permissions:
|
|
5429
5429
|
|
5430
5430
|
|
5431
5431
|
### Example
|
5432
|
-
|
5432
|
+
```{"language":"ruby"}
|
5433
5433
|
# load the gem
|
5434
5434
|
require 'purecloudplatformclientv2'
|
5435
5435
|
# setup authorization
|
@@ -5455,7 +5455,7 @@ begin
|
|
5455
5455
|
rescue PureCloud::ApiError => e
|
5456
5456
|
puts "Exception when calling OutboundApi->post_outbound_dnclists: #{e}"
|
5457
5457
|
end
|
5458
|
-
|
5458
|
+
```
|
5459
5459
|
|
5460
5460
|
### Parameters
|
5461
5461
|
|
@@ -5478,7 +5478,7 @@ Name | Type | Description | Notes
|
|
5478
5478
|
|
5479
5479
|
<a name="post_outbound_rulesets"></a>
|
5480
5480
|
|
5481
|
-
##
|
5481
|
+
## [**RuleSet**](RuleSet.html) post_outbound_rulesets(body)
|
5482
5482
|
|
5483
5483
|
|
5484
5484
|
|
@@ -5494,7 +5494,7 @@ Requires ANY permissions:
|
|
5494
5494
|
|
5495
5495
|
|
5496
5496
|
### Example
|
5497
|
-
|
5497
|
+
```{"language":"ruby"}
|
5498
5498
|
# load the gem
|
5499
5499
|
require 'purecloudplatformclientv2'
|
5500
5500
|
# setup authorization
|
@@ -5520,7 +5520,7 @@ begin
|
|
5520
5520
|
rescue PureCloud::ApiError => e
|
5521
5521
|
puts "Exception when calling OutboundApi->post_outbound_rulesets: #{e}"
|
5522
5522
|
end
|
5523
|
-
|
5523
|
+
```
|
5524
5524
|
|
5525
5525
|
### Parameters
|
5526
5526
|
|
@@ -5543,7 +5543,7 @@ Name | Type | Description | Notes
|
|
5543
5543
|
|
5544
5544
|
<a name="post_outbound_sequences"></a>
|
5545
5545
|
|
5546
|
-
##
|
5546
|
+
## [**CampaignSequence**](CampaignSequence.html) post_outbound_sequences(body)
|
5547
5547
|
|
5548
5548
|
|
5549
5549
|
|
@@ -5559,7 +5559,7 @@ Requires ANY permissions:
|
|
5559
5559
|
|
5560
5560
|
|
5561
5561
|
### Example
|
5562
|
-
|
5562
|
+
```{"language":"ruby"}
|
5563
5563
|
# load the gem
|
5564
5564
|
require 'purecloudplatformclientv2'
|
5565
5565
|
# setup authorization
|
@@ -5585,7 +5585,7 @@ begin
|
|
5585
5585
|
rescue PureCloud::ApiError => e
|
5586
5586
|
puts "Exception when calling OutboundApi->post_outbound_sequences: #{e}"
|
5587
5587
|
end
|
5588
|
-
|
5588
|
+
```
|
5589
5589
|
|
5590
5590
|
### Parameters
|
5591
5591
|
|
@@ -5608,7 +5608,7 @@ Name | Type | Description | Notes
|
|
5608
5608
|
|
5609
5609
|
<a name="put_outbound_attemptlimit"></a>
|
5610
5610
|
|
5611
|
-
##
|
5611
|
+
## [**AttemptLimits**](AttemptLimits.html) put_outbound_attemptlimit(attempt_limits_id, body)
|
5612
5612
|
|
5613
5613
|
|
5614
5614
|
|
@@ -5624,7 +5624,7 @@ Requires ANY permissions:
|
|
5624
5624
|
|
5625
5625
|
|
5626
5626
|
### Example
|
5627
|
-
|
5627
|
+
```{"language":"ruby"}
|
5628
5628
|
# load the gem
|
5629
5629
|
require 'purecloudplatformclientv2'
|
5630
5630
|
# setup authorization
|
@@ -5652,7 +5652,7 @@ begin
|
|
5652
5652
|
rescue PureCloud::ApiError => e
|
5653
5653
|
puts "Exception when calling OutboundApi->put_outbound_attemptlimit: #{e}"
|
5654
5654
|
end
|
5655
|
-
|
5655
|
+
```
|
5656
5656
|
|
5657
5657
|
### Parameters
|
5658
5658
|
|
@@ -5676,7 +5676,7 @@ Name | Type | Description | Notes
|
|
5676
5676
|
|
5677
5677
|
<a name="put_outbound_callabletimeset"></a>
|
5678
5678
|
|
5679
|
-
##
|
5679
|
+
## [**CallableTimeSet**](CallableTimeSet.html) put_outbound_callabletimeset(callable_time_set_id, body)
|
5680
5680
|
|
5681
5681
|
|
5682
5682
|
|
@@ -5692,7 +5692,7 @@ Requires ANY permissions:
|
|
5692
5692
|
|
5693
5693
|
|
5694
5694
|
### Example
|
5695
|
-
|
5695
|
+
```{"language":"ruby"}
|
5696
5696
|
# load the gem
|
5697
5697
|
require 'purecloudplatformclientv2'
|
5698
5698
|
# setup authorization
|
@@ -5720,7 +5720,7 @@ begin
|
|
5720
5720
|
rescue PureCloud::ApiError => e
|
5721
5721
|
puts "Exception when calling OutboundApi->put_outbound_callabletimeset: #{e}"
|
5722
5722
|
end
|
5723
|
-
|
5723
|
+
```
|
5724
5724
|
|
5725
5725
|
### Parameters
|
5726
5726
|
|
@@ -5744,7 +5744,7 @@ Name | Type | Description | Notes
|
|
5744
5744
|
|
5745
5745
|
<a name="put_outbound_callanalysisresponseset"></a>
|
5746
5746
|
|
5747
|
-
##
|
5747
|
+
## [**ResponseSet**](ResponseSet.html) put_outbound_callanalysisresponseset(call_analysis_set_id, body)
|
5748
5748
|
|
5749
5749
|
|
5750
5750
|
|
@@ -5760,7 +5760,7 @@ Requires ANY permissions:
|
|
5760
5760
|
|
5761
5761
|
|
5762
5762
|
### Example
|
5763
|
-
|
5763
|
+
```{"language":"ruby"}
|
5764
5764
|
# load the gem
|
5765
5765
|
require 'purecloudplatformclientv2'
|
5766
5766
|
# setup authorization
|
@@ -5788,7 +5788,7 @@ begin
|
|
5788
5788
|
rescue PureCloud::ApiError => e
|
5789
5789
|
puts "Exception when calling OutboundApi->put_outbound_callanalysisresponseset: #{e}"
|
5790
5790
|
end
|
5791
|
-
|
5791
|
+
```
|
5792
5792
|
|
5793
5793
|
### Parameters
|
5794
5794
|
|
@@ -5812,7 +5812,7 @@ Name | Type | Description | Notes
|
|
5812
5812
|
|
5813
5813
|
<a name="put_outbound_campaign"></a>
|
5814
5814
|
|
5815
|
-
##
|
5815
|
+
## [**Campaign**](Campaign.html) put_outbound_campaign(campaign_id, body)
|
5816
5816
|
|
5817
5817
|
|
5818
5818
|
|
@@ -5828,7 +5828,7 @@ Requires ANY permissions:
|
|
5828
5828
|
|
5829
5829
|
|
5830
5830
|
### Example
|
5831
|
-
|
5831
|
+
```{"language":"ruby"}
|
5832
5832
|
# load the gem
|
5833
5833
|
require 'purecloudplatformclientv2'
|
5834
5834
|
# setup authorization
|
@@ -5856,7 +5856,7 @@ begin
|
|
5856
5856
|
rescue PureCloud::ApiError => e
|
5857
5857
|
puts "Exception when calling OutboundApi->put_outbound_campaign: #{e}"
|
5858
5858
|
end
|
5859
|
-
|
5859
|
+
```
|
5860
5860
|
|
5861
5861
|
### Parameters
|
5862
5862
|
|
@@ -5880,7 +5880,7 @@ Name | Type | Description | Notes
|
|
5880
5880
|
|
5881
5881
|
<a name="put_outbound_campaign_agent"></a>
|
5882
5882
|
|
5883
|
-
##
|
5883
|
+
## String** put_outbound_campaign_agent(campaign_id, user_id, body)
|
5884
5884
|
|
5885
5885
|
|
5886
5886
|
|
@@ -5895,7 +5895,7 @@ Requires NO permissions:
|
|
5895
5895
|
|
5896
5896
|
|
5897
5897
|
### Example
|
5898
|
-
|
5898
|
+
```{"language":"ruby"}
|
5899
5899
|
# load the gem
|
5900
5900
|
require 'purecloudplatformclientv2'
|
5901
5901
|
# setup authorization
|
@@ -5925,7 +5925,7 @@ begin
|
|
5925
5925
|
rescue PureCloud::ApiError => e
|
5926
5926
|
puts "Exception when calling OutboundApi->put_outbound_campaign_agent: #{e}"
|
5927
5927
|
end
|
5928
|
-
|
5928
|
+
```
|
5929
5929
|
|
5930
5930
|
### Parameters
|
5931
5931
|
|
@@ -5950,7 +5950,7 @@ Name | Type | Description | Notes
|
|
5950
5950
|
|
5951
5951
|
<a name="put_outbound_campaignrule"></a>
|
5952
5952
|
|
5953
|
-
##
|
5953
|
+
## [**CampaignRule**](CampaignRule.html) put_outbound_campaignrule(campaign_rule_id, body)
|
5954
5954
|
|
5955
5955
|
|
5956
5956
|
|
@@ -5966,7 +5966,7 @@ Requires ANY permissions:
|
|
5966
5966
|
|
5967
5967
|
|
5968
5968
|
### Example
|
5969
|
-
|
5969
|
+
```{"language":"ruby"}
|
5970
5970
|
# load the gem
|
5971
5971
|
require 'purecloudplatformclientv2'
|
5972
5972
|
# setup authorization
|
@@ -5994,7 +5994,7 @@ begin
|
|
5994
5994
|
rescue PureCloud::ApiError => e
|
5995
5995
|
puts "Exception when calling OutboundApi->put_outbound_campaignrule: #{e}"
|
5996
5996
|
end
|
5997
|
-
|
5997
|
+
```
|
5998
5998
|
|
5999
5999
|
### Parameters
|
6000
6000
|
|
@@ -6018,7 +6018,7 @@ Name | Type | Description | Notes
|
|
6018
6018
|
|
6019
6019
|
<a name="put_outbound_contactlist"></a>
|
6020
6020
|
|
6021
|
-
##
|
6021
|
+
## [**ContactList**](ContactList.html) put_outbound_contactlist(contact_list_id, body)
|
6022
6022
|
|
6023
6023
|
|
6024
6024
|
|
@@ -6034,7 +6034,7 @@ Requires ANY permissions:
|
|
6034
6034
|
|
6035
6035
|
|
6036
6036
|
### Example
|
6037
|
-
|
6037
|
+
```{"language":"ruby"}
|
6038
6038
|
# load the gem
|
6039
6039
|
require 'purecloudplatformclientv2'
|
6040
6040
|
# setup authorization
|
@@ -6062,7 +6062,7 @@ begin
|
|
6062
6062
|
rescue PureCloud::ApiError => e
|
6063
6063
|
puts "Exception when calling OutboundApi->put_outbound_contactlist: #{e}"
|
6064
6064
|
end
|
6065
|
-
|
6065
|
+
```
|
6066
6066
|
|
6067
6067
|
### Parameters
|
6068
6068
|
|
@@ -6086,7 +6086,7 @@ Name | Type | Description | Notes
|
|
6086
6086
|
|
6087
6087
|
<a name="put_outbound_contactlist_contact"></a>
|
6088
6088
|
|
6089
|
-
##
|
6089
|
+
## [**DialerContact**](DialerContact.html) put_outbound_contactlist_contact(contact_list_id, contact_id, body)
|
6090
6090
|
|
6091
6091
|
|
6092
6092
|
|
@@ -6102,7 +6102,7 @@ Requires ANY permissions:
|
|
6102
6102
|
|
6103
6103
|
|
6104
6104
|
### Example
|
6105
|
-
|
6105
|
+
```{"language":"ruby"}
|
6106
6106
|
# load the gem
|
6107
6107
|
require 'purecloudplatformclientv2'
|
6108
6108
|
# setup authorization
|
@@ -6132,7 +6132,7 @@ begin
|
|
6132
6132
|
rescue PureCloud::ApiError => e
|
6133
6133
|
puts "Exception when calling OutboundApi->put_outbound_contactlist_contact: #{e}"
|
6134
6134
|
end
|
6135
|
-
|
6135
|
+
```
|
6136
6136
|
|
6137
6137
|
### Parameters
|
6138
6138
|
|
@@ -6157,7 +6157,7 @@ Name | Type | Description | Notes
|
|
6157
6157
|
|
6158
6158
|
<a name="put_outbound_contactlistfilter"></a>
|
6159
6159
|
|
6160
|
-
##
|
6160
|
+
## [**ContactListFilter**](ContactListFilter.html) put_outbound_contactlistfilter(contact_list_filter_id, body)
|
6161
6161
|
|
6162
6162
|
|
6163
6163
|
|
@@ -6173,7 +6173,7 @@ Requires ANY permissions:
|
|
6173
6173
|
|
6174
6174
|
|
6175
6175
|
### Example
|
6176
|
-
|
6176
|
+
```{"language":"ruby"}
|
6177
6177
|
# load the gem
|
6178
6178
|
require 'purecloudplatformclientv2'
|
6179
6179
|
# setup authorization
|
@@ -6201,7 +6201,7 @@ begin
|
|
6201
6201
|
rescue PureCloud::ApiError => e
|
6202
6202
|
puts "Exception when calling OutboundApi->put_outbound_contactlistfilter: #{e}"
|
6203
6203
|
end
|
6204
|
-
|
6204
|
+
```
|
6205
6205
|
|
6206
6206
|
### Parameters
|
6207
6207
|
|
@@ -6225,7 +6225,7 @@ Name | Type | Description | Notes
|
|
6225
6225
|
|
6226
6226
|
<a name="put_outbound_dnclist"></a>
|
6227
6227
|
|
6228
|
-
##
|
6228
|
+
## [**DncList**](DncList.html) put_outbound_dnclist(dnc_list_id, body)
|
6229
6229
|
|
6230
6230
|
|
6231
6231
|
|
@@ -6241,7 +6241,7 @@ Requires ANY permissions:
|
|
6241
6241
|
|
6242
6242
|
|
6243
6243
|
### Example
|
6244
|
-
|
6244
|
+
```{"language":"ruby"}
|
6245
6245
|
# load the gem
|
6246
6246
|
require 'purecloudplatformclientv2'
|
6247
6247
|
# setup authorization
|
@@ -6269,7 +6269,7 @@ begin
|
|
6269
6269
|
rescue PureCloud::ApiError => e
|
6270
6270
|
puts "Exception when calling OutboundApi->put_outbound_dnclist: #{e}"
|
6271
6271
|
end
|
6272
|
-
|
6272
|
+
```
|
6273
6273
|
|
6274
6274
|
### Parameters
|
6275
6275
|
|
@@ -6293,7 +6293,7 @@ Name | Type | Description | Notes
|
|
6293
6293
|
|
6294
6294
|
<a name="put_outbound_ruleset"></a>
|
6295
6295
|
|
6296
|
-
##
|
6296
|
+
## [**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body)
|
6297
6297
|
|
6298
6298
|
|
6299
6299
|
|
@@ -6309,7 +6309,7 @@ Requires ANY permissions:
|
|
6309
6309
|
|
6310
6310
|
|
6311
6311
|
### Example
|
6312
|
-
|
6312
|
+
```{"language":"ruby"}
|
6313
6313
|
# load the gem
|
6314
6314
|
require 'purecloudplatformclientv2'
|
6315
6315
|
# setup authorization
|
@@ -6337,7 +6337,7 @@ begin
|
|
6337
6337
|
rescue PureCloud::ApiError => e
|
6338
6338
|
puts "Exception when calling OutboundApi->put_outbound_ruleset: #{e}"
|
6339
6339
|
end
|
6340
|
-
|
6340
|
+
```
|
6341
6341
|
|
6342
6342
|
### Parameters
|
6343
6343
|
|
@@ -6361,7 +6361,7 @@ Name | Type | Description | Notes
|
|
6361
6361
|
|
6362
6362
|
<a name="put_outbound_schedules_campaign"></a>
|
6363
6363
|
|
6364
|
-
##
|
6364
|
+
## [**CampaignSchedule**](CampaignSchedule.html) put_outbound_schedules_campaign(campaign_id, body)
|
6365
6365
|
|
6366
6366
|
|
6367
6367
|
|
@@ -6377,7 +6377,7 @@ Requires ANY permissions:
|
|
6377
6377
|
|
6378
6378
|
|
6379
6379
|
### Example
|
6380
|
-
|
6380
|
+
```{"language":"ruby"}
|
6381
6381
|
# load the gem
|
6382
6382
|
require 'purecloudplatformclientv2'
|
6383
6383
|
# setup authorization
|
@@ -6405,7 +6405,7 @@ begin
|
|
6405
6405
|
rescue PureCloud::ApiError => e
|
6406
6406
|
puts "Exception when calling OutboundApi->put_outbound_schedules_campaign: #{e}"
|
6407
6407
|
end
|
6408
|
-
|
6408
|
+
```
|
6409
6409
|
|
6410
6410
|
### Parameters
|
6411
6411
|
|
@@ -6429,7 +6429,7 @@ Name | Type | Description | Notes
|
|
6429
6429
|
|
6430
6430
|
<a name="put_outbound_schedules_sequence"></a>
|
6431
6431
|
|
6432
|
-
##
|
6432
|
+
## [**SequenceSchedule**](SequenceSchedule.html) put_outbound_schedules_sequence(sequence_id, body)
|
6433
6433
|
|
6434
6434
|
|
6435
6435
|
|
@@ -6445,7 +6445,7 @@ Requires ANY permissions:
|
|
6445
6445
|
|
6446
6446
|
|
6447
6447
|
### Example
|
6448
|
-
|
6448
|
+
```{"language":"ruby"}
|
6449
6449
|
# load the gem
|
6450
6450
|
require 'purecloudplatformclientv2'
|
6451
6451
|
# setup authorization
|
@@ -6473,7 +6473,7 @@ begin
|
|
6473
6473
|
rescue PureCloud::ApiError => e
|
6474
6474
|
puts "Exception when calling OutboundApi->put_outbound_schedules_sequence: #{e}"
|
6475
6475
|
end
|
6476
|
-
|
6476
|
+
```
|
6477
6477
|
|
6478
6478
|
### Parameters
|
6479
6479
|
|
@@ -6497,7 +6497,7 @@ Name | Type | Description | Notes
|
|
6497
6497
|
|
6498
6498
|
<a name="put_outbound_sequence"></a>
|
6499
6499
|
|
6500
|
-
##
|
6500
|
+
## [**CampaignSequence**](CampaignSequence.html) put_outbound_sequence(sequence_id, body)
|
6501
6501
|
|
6502
6502
|
|
6503
6503
|
|
@@ -6513,7 +6513,7 @@ Requires ANY permissions:
|
|
6513
6513
|
|
6514
6514
|
|
6515
6515
|
### Example
|
6516
|
-
|
6516
|
+
```{"language":"ruby"}
|
6517
6517
|
# load the gem
|
6518
6518
|
require 'purecloudplatformclientv2'
|
6519
6519
|
# setup authorization
|
@@ -6541,7 +6541,7 @@ begin
|
|
6541
6541
|
rescue PureCloud::ApiError => e
|
6542
6542
|
puts "Exception when calling OutboundApi->put_outbound_sequence: #{e}"
|
6543
6543
|
end
|
6544
|
-
|
6544
|
+
```
|
6545
6545
|
|
6546
6546
|
### Parameters
|
6547
6547
|
|
@@ -6565,7 +6565,7 @@ Name | Type | Description | Notes
|
|
6565
6565
|
|
6566
6566
|
<a name="put_outbound_wrapupcodemappings"></a>
|
6567
6567
|
|
6568
|
-
##
|
6568
|
+
## [**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_outbound_wrapupcodemappings(body)
|
6569
6569
|
|
6570
6570
|
|
6571
6571
|
|
@@ -6581,7 +6581,7 @@ Requires ANY permissions:
|
|
6581
6581
|
|
6582
6582
|
|
6583
6583
|
### Example
|
6584
|
-
|
6584
|
+
```{"language":"ruby"}
|
6585
6585
|
# load the gem
|
6586
6586
|
require 'purecloudplatformclientv2'
|
6587
6587
|
# setup authorization
|
@@ -6607,7 +6607,7 @@ begin
|
|
6607
6607
|
rescue PureCloud::ApiError => e
|
6608
6608
|
puts "Exception when calling OutboundApi->put_outbound_wrapupcodemappings: #{e}"
|
6609
6609
|
end
|
6610
|
-
|
6610
|
+
```
|
6611
6611
|
|
6612
6612
|
### Parameters
|
6613
6613
|
|