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/ConversationsApi.md
CHANGED
@@ -112,7 +112,7 @@ Method | Description
|
|
112
112
|
|
113
113
|
<a name="delete_conversation_participant_code"></a>
|
114
114
|
|
115
|
-
##
|
115
|
+
## delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
116
116
|
|
117
117
|
|
118
118
|
|
@@ -127,7 +127,7 @@ Requires NO permissions:
|
|
127
127
|
|
128
128
|
|
129
129
|
### Example
|
130
|
-
|
130
|
+
```{"language":"ruby"}
|
131
131
|
# load the gem
|
132
132
|
require 'purecloudplatformclientv2'
|
133
133
|
# setup authorization
|
@@ -156,7 +156,7 @@ begin
|
|
156
156
|
rescue PureCloud::ApiError => e
|
157
157
|
puts "Exception when calling ConversationsApi->delete_conversation_participant_code: #{e}"
|
158
158
|
end
|
159
|
-
|
159
|
+
```
|
160
160
|
|
161
161
|
### Parameters
|
162
162
|
|
@@ -181,7 +181,7 @@ nil (empty response body)
|
|
181
181
|
|
182
182
|
<a name="delete_conversations_call_participant_consult"></a>
|
183
183
|
|
184
|
-
##
|
184
|
+
## delete_conversations_call_participant_consult(conversation_id, participant_id)
|
185
185
|
|
186
186
|
|
187
187
|
|
@@ -196,7 +196,7 @@ Requires NO permissions:
|
|
196
196
|
|
197
197
|
|
198
198
|
### Example
|
199
|
-
|
199
|
+
```{"language":"ruby"}
|
200
200
|
# load the gem
|
201
201
|
require 'purecloudplatformclientv2'
|
202
202
|
# setup authorization
|
@@ -223,7 +223,7 @@ begin
|
|
223
223
|
rescue PureCloud::ApiError => e
|
224
224
|
puts "Exception when calling ConversationsApi->delete_conversations_call_participant_consult: #{e}"
|
225
225
|
end
|
226
|
-
|
226
|
+
```
|
227
227
|
|
228
228
|
### Parameters
|
229
229
|
|
@@ -247,7 +247,7 @@ nil (empty response body)
|
|
247
247
|
|
248
248
|
<a name="delete_conversations_email_messages_draft_attachment"></a>
|
249
249
|
|
250
|
-
##
|
250
|
+
## delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id)
|
251
251
|
|
252
252
|
|
253
253
|
|
@@ -262,7 +262,7 @@ Requires NO permissions:
|
|
262
262
|
|
263
263
|
|
264
264
|
### Example
|
265
|
-
|
265
|
+
```{"language":"ruby"}
|
266
266
|
# load the gem
|
267
267
|
require 'purecloudplatformclientv2'
|
268
268
|
# setup authorization
|
@@ -289,7 +289,7 @@ begin
|
|
289
289
|
rescue PureCloud::ApiError => e
|
290
290
|
puts "Exception when calling ConversationsApi->delete_conversations_email_messages_draft_attachment: #{e}"
|
291
291
|
end
|
292
|
-
|
292
|
+
```
|
293
293
|
|
294
294
|
### Parameters
|
295
295
|
|
@@ -313,7 +313,7 @@ nil (empty response body)
|
|
313
313
|
|
314
314
|
<a name="get_analytics_conversation_details"></a>
|
315
315
|
|
316
|
-
##
|
316
|
+
## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
317
317
|
|
318
318
|
|
319
319
|
|
@@ -329,7 +329,7 @@ Requires ANY permissions:
|
|
329
329
|
|
330
330
|
|
331
331
|
### Example
|
332
|
-
|
332
|
+
```{"language":"ruby"}
|
333
333
|
# load the gem
|
334
334
|
require 'purecloudplatformclientv2'
|
335
335
|
# setup authorization
|
@@ -355,7 +355,7 @@ begin
|
|
355
355
|
rescue PureCloud::ApiError => e
|
356
356
|
puts "Exception when calling ConversationsApi->get_analytics_conversation_details: #{e}"
|
357
357
|
end
|
358
|
-
|
358
|
+
```
|
359
359
|
|
360
360
|
### Parameters
|
361
361
|
|
@@ -378,7 +378,7 @@ Name | Type | Description | Notes
|
|
378
378
|
|
379
379
|
<a name="get_analytics_conversations_details"></a>
|
380
380
|
|
381
|
-
##
|
381
|
+
## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversations_details(opts)
|
382
382
|
|
383
383
|
|
384
384
|
|
@@ -394,7 +394,7 @@ Requires ANY permissions:
|
|
394
394
|
|
395
395
|
|
396
396
|
### Example
|
397
|
-
|
397
|
+
```{"language":"ruby"}
|
398
398
|
# load the gem
|
399
399
|
require 'purecloudplatformclientv2'
|
400
400
|
# setup authorization
|
@@ -421,7 +421,7 @@ begin
|
|
421
421
|
rescue PureCloud::ApiError => e
|
422
422
|
puts "Exception when calling ConversationsApi->get_analytics_conversations_details: #{e}"
|
423
423
|
end
|
424
|
-
|
424
|
+
```
|
425
425
|
|
426
426
|
### Parameters
|
427
427
|
|
@@ -444,7 +444,7 @@ Name | Type | Description | Notes
|
|
444
444
|
|
445
445
|
<a name="get_conversation"></a>
|
446
446
|
|
447
|
-
##
|
447
|
+
## [**Conversation**](Conversation.html) get_conversation(conversation_id)
|
448
448
|
|
449
449
|
|
450
450
|
|
@@ -460,7 +460,7 @@ Requires ANY permissions:
|
|
460
460
|
|
461
461
|
|
462
462
|
### Example
|
463
|
-
|
463
|
+
```{"language":"ruby"}
|
464
464
|
# load the gem
|
465
465
|
require 'purecloudplatformclientv2'
|
466
466
|
# setup authorization
|
@@ -486,7 +486,7 @@ begin
|
|
486
486
|
rescue PureCloud::ApiError => e
|
487
487
|
puts "Exception when calling ConversationsApi->get_conversation: #{e}"
|
488
488
|
end
|
489
|
-
|
489
|
+
```
|
490
490
|
|
491
491
|
### Parameters
|
492
492
|
|
@@ -509,7 +509,7 @@ Name | Type | Description | Notes
|
|
509
509
|
|
510
510
|
<a name="get_conversation_participant_secureivrsession"></a>
|
511
511
|
|
512
|
-
##
|
512
|
+
## [**SecureSession**](SecureSession.html) get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
513
513
|
|
514
514
|
|
515
515
|
|
@@ -524,7 +524,7 @@ Requires NO permissions:
|
|
524
524
|
|
525
525
|
|
526
526
|
### Example
|
527
|
-
|
527
|
+
```{"language":"ruby"}
|
528
528
|
# load the gem
|
529
529
|
require 'purecloudplatformclientv2'
|
530
530
|
# setup authorization
|
@@ -554,7 +554,7 @@ begin
|
|
554
554
|
rescue PureCloud::ApiError => e
|
555
555
|
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsession: #{e}"
|
556
556
|
end
|
557
|
-
|
557
|
+
```
|
558
558
|
|
559
559
|
### Parameters
|
560
560
|
|
@@ -579,7 +579,7 @@ Name | Type | Description | Notes
|
|
579
579
|
|
580
580
|
<a name="get_conversation_participant_secureivrsessions"></a>
|
581
581
|
|
582
|
-
##
|
582
|
+
## [**SecureSessionEntityListing**](SecureSessionEntityListing.html) get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
583
583
|
|
584
584
|
|
585
585
|
|
@@ -594,7 +594,7 @@ Requires NO permissions:
|
|
594
594
|
|
595
595
|
|
596
596
|
### Example
|
597
|
-
|
597
|
+
```{"language":"ruby"}
|
598
598
|
# load the gem
|
599
599
|
require 'purecloudplatformclientv2'
|
600
600
|
# setup authorization
|
@@ -622,7 +622,7 @@ begin
|
|
622
622
|
rescue PureCloud::ApiError => e
|
623
623
|
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsessions: #{e}"
|
624
624
|
end
|
625
|
-
|
625
|
+
```
|
626
626
|
|
627
627
|
### Parameters
|
628
628
|
|
@@ -646,7 +646,7 @@ Name | Type | Description | Notes
|
|
646
646
|
|
647
647
|
<a name="get_conversation_participant_wrapup"></a>
|
648
648
|
|
649
|
-
##
|
649
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
650
650
|
|
651
651
|
|
652
652
|
|
@@ -661,7 +661,7 @@ Requires NO permissions:
|
|
661
661
|
|
662
662
|
|
663
663
|
### Example
|
664
|
-
|
664
|
+
```{"language":"ruby"}
|
665
665
|
# load the gem
|
666
666
|
require 'purecloudplatformclientv2'
|
667
667
|
# setup authorization
|
@@ -692,7 +692,7 @@ begin
|
|
692
692
|
rescue PureCloud::ApiError => e
|
693
693
|
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapup: #{e}"
|
694
694
|
end
|
695
|
-
|
695
|
+
```
|
696
696
|
|
697
697
|
### Parameters
|
698
698
|
|
@@ -717,7 +717,7 @@ Name | Type | Description | Notes
|
|
717
717
|
|
718
718
|
<a name="get_conversation_participant_wrapupcodes"></a>
|
719
719
|
|
720
|
-
##
|
720
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
721
721
|
|
722
722
|
|
723
723
|
|
@@ -732,7 +732,7 @@ Requires NO permissions:
|
|
732
732
|
|
733
733
|
|
734
734
|
### Example
|
735
|
-
|
735
|
+
```{"language":"ruby"}
|
736
736
|
# load the gem
|
737
737
|
require 'purecloudplatformclientv2'
|
738
738
|
# setup authorization
|
@@ -760,7 +760,7 @@ begin
|
|
760
760
|
rescue PureCloud::ApiError => e
|
761
761
|
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapupcodes: #{e}"
|
762
762
|
end
|
763
|
-
|
763
|
+
```
|
764
764
|
|
765
765
|
### Parameters
|
766
766
|
|
@@ -784,7 +784,7 @@ Name | Type | Description | Notes
|
|
784
784
|
|
785
785
|
<a name="get_conversations"></a>
|
786
786
|
|
787
|
-
##
|
787
|
+
## [**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
788
788
|
|
789
789
|
|
790
790
|
|
@@ -799,7 +799,7 @@ Requires NO permissions:
|
|
799
799
|
|
800
800
|
|
801
801
|
### Example
|
802
|
-
|
802
|
+
```{"language":"ruby"}
|
803
803
|
# load the gem
|
804
804
|
require 'purecloudplatformclientv2'
|
805
805
|
# setup authorization
|
@@ -826,7 +826,7 @@ begin
|
|
826
826
|
rescue PureCloud::ApiError => e
|
827
827
|
puts "Exception when calling ConversationsApi->get_conversations: #{e}"
|
828
828
|
end
|
829
|
-
|
829
|
+
```
|
830
830
|
|
831
831
|
### Parameters
|
832
832
|
|
@@ -849,7 +849,7 @@ Name | Type | Description | Notes
|
|
849
849
|
|
850
850
|
<a name="get_conversations_call"></a>
|
851
851
|
|
852
|
-
##
|
852
|
+
## [**CallConversation**](CallConversation.html) get_conversations_call(conversation_id)
|
853
853
|
|
854
854
|
|
855
855
|
|
@@ -864,7 +864,7 @@ Requires NO permissions:
|
|
864
864
|
|
865
865
|
|
866
866
|
### Example
|
867
|
-
|
867
|
+
```{"language":"ruby"}
|
868
868
|
# load the gem
|
869
869
|
require 'purecloudplatformclientv2'
|
870
870
|
# setup authorization
|
@@ -890,7 +890,7 @@ begin
|
|
890
890
|
rescue PureCloud::ApiError => e
|
891
891
|
puts "Exception when calling ConversationsApi->get_conversations_call: #{e}"
|
892
892
|
end
|
893
|
-
|
893
|
+
```
|
894
894
|
|
895
895
|
### Parameters
|
896
896
|
|
@@ -913,7 +913,7 @@ Name | Type | Description | Notes
|
|
913
913
|
|
914
914
|
<a name="get_conversations_call_participant_wrapup"></a>
|
915
915
|
|
916
|
-
##
|
916
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
917
917
|
|
918
918
|
|
919
919
|
|
@@ -928,7 +928,7 @@ Requires NO permissions:
|
|
928
928
|
|
929
929
|
|
930
930
|
### Example
|
931
|
-
|
931
|
+
```{"language":"ruby"}
|
932
932
|
# load the gem
|
933
933
|
require 'purecloudplatformclientv2'
|
934
934
|
# setup authorization
|
@@ -959,7 +959,7 @@ begin
|
|
959
959
|
rescue PureCloud::ApiError => e
|
960
960
|
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapup: #{e}"
|
961
961
|
end
|
962
|
-
|
962
|
+
```
|
963
963
|
|
964
964
|
### Parameters
|
965
965
|
|
@@ -984,7 +984,7 @@ Name | Type | Description | Notes
|
|
984
984
|
|
985
985
|
<a name="get_conversations_call_participant_wrapupcodes"></a>
|
986
986
|
|
987
|
-
##
|
987
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
988
988
|
|
989
989
|
|
990
990
|
|
@@ -999,7 +999,7 @@ Requires NO permissions:
|
|
999
999
|
|
1000
1000
|
|
1001
1001
|
### Example
|
1002
|
-
|
1002
|
+
```{"language":"ruby"}
|
1003
1003
|
# load the gem
|
1004
1004
|
require 'purecloudplatformclientv2'
|
1005
1005
|
# setup authorization
|
@@ -1027,7 +1027,7 @@ begin
|
|
1027
1027
|
rescue PureCloud::ApiError => e
|
1028
1028
|
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapupcodes: #{e}"
|
1029
1029
|
end
|
1030
|
-
|
1030
|
+
```
|
1031
1031
|
|
1032
1032
|
### Parameters
|
1033
1033
|
|
@@ -1051,7 +1051,7 @@ Name | Type | Description | Notes
|
|
1051
1051
|
|
1052
1052
|
<a name="get_conversations_callback"></a>
|
1053
1053
|
|
1054
|
-
##
|
1054
|
+
## [**CallbackConversation**](CallbackConversation.html) get_conversations_callback(conversation_id)
|
1055
1055
|
|
1056
1056
|
|
1057
1057
|
|
@@ -1066,7 +1066,7 @@ Requires NO permissions:
|
|
1066
1066
|
|
1067
1067
|
|
1068
1068
|
### Example
|
1069
|
-
|
1069
|
+
```{"language":"ruby"}
|
1070
1070
|
# load the gem
|
1071
1071
|
require 'purecloudplatformclientv2'
|
1072
1072
|
# setup authorization
|
@@ -1092,7 +1092,7 @@ begin
|
|
1092
1092
|
rescue PureCloud::ApiError => e
|
1093
1093
|
puts "Exception when calling ConversationsApi->get_conversations_callback: #{e}"
|
1094
1094
|
end
|
1095
|
-
|
1095
|
+
```
|
1096
1096
|
|
1097
1097
|
### Parameters
|
1098
1098
|
|
@@ -1115,7 +1115,7 @@ Name | Type | Description | Notes
|
|
1115
1115
|
|
1116
1116
|
<a name="get_conversations_callback_participant_wrapup"></a>
|
1117
1117
|
|
1118
|
-
##
|
1118
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
1119
1119
|
|
1120
1120
|
|
1121
1121
|
|
@@ -1130,7 +1130,7 @@ Requires NO permissions:
|
|
1130
1130
|
|
1131
1131
|
|
1132
1132
|
### Example
|
1133
|
-
|
1133
|
+
```{"language":"ruby"}
|
1134
1134
|
# load the gem
|
1135
1135
|
require 'purecloudplatformclientv2'
|
1136
1136
|
# setup authorization
|
@@ -1161,7 +1161,7 @@ begin
|
|
1161
1161
|
rescue PureCloud::ApiError => e
|
1162
1162
|
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: #{e}"
|
1163
1163
|
end
|
1164
|
-
|
1164
|
+
```
|
1165
1165
|
|
1166
1166
|
### Parameters
|
1167
1167
|
|
@@ -1186,7 +1186,7 @@ Name | Type | Description | Notes
|
|
1186
1186
|
|
1187
1187
|
<a name="get_conversations_callback_participant_wrapupcodes"></a>
|
1188
1188
|
|
1189
|
-
##
|
1189
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
1190
1190
|
|
1191
1191
|
|
1192
1192
|
|
@@ -1201,7 +1201,7 @@ Requires NO permissions:
|
|
1201
1201
|
|
1202
1202
|
|
1203
1203
|
### Example
|
1204
|
-
|
1204
|
+
```{"language":"ruby"}
|
1205
1205
|
# load the gem
|
1206
1206
|
require 'purecloudplatformclientv2'
|
1207
1207
|
# setup authorization
|
@@ -1229,7 +1229,7 @@ begin
|
|
1229
1229
|
rescue PureCloud::ApiError => e
|
1230
1230
|
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: #{e}"
|
1231
1231
|
end
|
1232
|
-
|
1232
|
+
```
|
1233
1233
|
|
1234
1234
|
### Parameters
|
1235
1235
|
|
@@ -1253,7 +1253,7 @@ Name | Type | Description | Notes
|
|
1253
1253
|
|
1254
1254
|
<a name="get_conversations_callbacks"></a>
|
1255
1255
|
|
1256
|
-
##
|
1256
|
+
## [**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_conversations_callbacks
|
1257
1257
|
|
1258
1258
|
|
1259
1259
|
|
@@ -1268,7 +1268,7 @@ Requires NO permissions:
|
|
1268
1268
|
|
1269
1269
|
|
1270
1270
|
### Example
|
1271
|
-
|
1271
|
+
```{"language":"ruby"}
|
1272
1272
|
# load the gem
|
1273
1273
|
require 'purecloudplatformclientv2'
|
1274
1274
|
# setup authorization
|
@@ -1291,7 +1291,7 @@ begin
|
|
1291
1291
|
rescue PureCloud::ApiError => e
|
1292
1292
|
puts "Exception when calling ConversationsApi->get_conversations_callbacks: #{e}"
|
1293
1293
|
end
|
1294
|
-
|
1294
|
+
```
|
1295
1295
|
|
1296
1296
|
### Parameters
|
1297
1297
|
This endpoint does not need any parameter.
|
@@ -1311,7 +1311,7 @@ This endpoint does not need any parameter.
|
|
1311
1311
|
|
1312
1312
|
<a name="get_conversations_calls"></a>
|
1313
1313
|
|
1314
|
-
##
|
1314
|
+
## [**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls
|
1315
1315
|
|
1316
1316
|
|
1317
1317
|
|
@@ -1326,7 +1326,7 @@ Requires NO permissions:
|
|
1326
1326
|
|
1327
1327
|
|
1328
1328
|
### Example
|
1329
|
-
|
1329
|
+
```{"language":"ruby"}
|
1330
1330
|
# load the gem
|
1331
1331
|
require 'purecloudplatformclientv2'
|
1332
1332
|
# setup authorization
|
@@ -1349,7 +1349,7 @@ begin
|
|
1349
1349
|
rescue PureCloud::ApiError => e
|
1350
1350
|
puts "Exception when calling ConversationsApi->get_conversations_calls: #{e}"
|
1351
1351
|
end
|
1352
|
-
|
1352
|
+
```
|
1353
1353
|
|
1354
1354
|
### Parameters
|
1355
1355
|
This endpoint does not need any parameter.
|
@@ -1369,7 +1369,7 @@ This endpoint does not need any parameter.
|
|
1369
1369
|
|
1370
1370
|
<a name="get_conversations_calls_history"></a>
|
1371
1371
|
|
1372
|
-
##
|
1372
|
+
## [**CallHistoryConversationEntityListing**](CallHistoryConversationEntityListing.html) get_conversations_calls_history(opts)
|
1373
1373
|
|
1374
1374
|
|
1375
1375
|
|
@@ -1384,7 +1384,7 @@ Requires NO permissions:
|
|
1384
1384
|
|
1385
1385
|
|
1386
1386
|
### Example
|
1387
|
-
|
1387
|
+
```{"language":"ruby"}
|
1388
1388
|
# load the gem
|
1389
1389
|
require 'purecloudplatformclientv2'
|
1390
1390
|
# setup authorization
|
@@ -1414,7 +1414,7 @@ begin
|
|
1414
1414
|
rescue PureCloud::ApiError => e
|
1415
1415
|
puts "Exception when calling ConversationsApi->get_conversations_calls_history: #{e}"
|
1416
1416
|
end
|
1417
|
-
|
1417
|
+
```
|
1418
1418
|
|
1419
1419
|
### Parameters
|
1420
1420
|
|
@@ -1440,7 +1440,7 @@ Name | Type | Description | Notes
|
|
1440
1440
|
|
1441
1441
|
<a name="get_conversations_calls_maximumconferenceparties"></a>
|
1442
1442
|
|
1443
|
-
##
|
1443
|
+
## [**MaxParticipants**](MaxParticipants.html) get_conversations_calls_maximumconferenceparties
|
1444
1444
|
|
1445
1445
|
|
1446
1446
|
|
@@ -1455,7 +1455,7 @@ Requires NO permissions:
|
|
1455
1455
|
|
1456
1456
|
|
1457
1457
|
### Example
|
1458
|
-
|
1458
|
+
```{"language":"ruby"}
|
1459
1459
|
# load the gem
|
1460
1460
|
require 'purecloudplatformclientv2'
|
1461
1461
|
# setup authorization
|
@@ -1478,7 +1478,7 @@ begin
|
|
1478
1478
|
rescue PureCloud::ApiError => e
|
1479
1479
|
puts "Exception when calling ConversationsApi->get_conversations_calls_maximumconferenceparties: #{e}"
|
1480
1480
|
end
|
1481
|
-
|
1481
|
+
```
|
1482
1482
|
|
1483
1483
|
### Parameters
|
1484
1484
|
This endpoint does not need any parameter.
|
@@ -1498,7 +1498,7 @@ This endpoint does not need any parameter.
|
|
1498
1498
|
|
1499
1499
|
<a name="get_conversations_chat"></a>
|
1500
1500
|
|
1501
|
-
##
|
1501
|
+
## [**ChatConversation**](ChatConversation.html) get_conversations_chat(conversation_id)
|
1502
1502
|
|
1503
1503
|
|
1504
1504
|
|
@@ -1513,7 +1513,7 @@ Requires NO permissions:
|
|
1513
1513
|
|
1514
1514
|
|
1515
1515
|
### Example
|
1516
|
-
|
1516
|
+
```{"language":"ruby"}
|
1517
1517
|
# load the gem
|
1518
1518
|
require 'purecloudplatformclientv2'
|
1519
1519
|
# setup authorization
|
@@ -1539,7 +1539,7 @@ begin
|
|
1539
1539
|
rescue PureCloud::ApiError => e
|
1540
1540
|
puts "Exception when calling ConversationsApi->get_conversations_chat: #{e}"
|
1541
1541
|
end
|
1542
|
-
|
1542
|
+
```
|
1543
1543
|
|
1544
1544
|
### Parameters
|
1545
1545
|
|
@@ -1562,7 +1562,7 @@ Name | Type | Description | Notes
|
|
1562
1562
|
|
1563
1563
|
<a name="get_conversations_chat_participant_wrapup"></a>
|
1564
1564
|
|
1565
|
-
##
|
1565
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
1566
1566
|
|
1567
1567
|
|
1568
1568
|
|
@@ -1577,7 +1577,7 @@ Requires NO permissions:
|
|
1577
1577
|
|
1578
1578
|
|
1579
1579
|
### Example
|
1580
|
-
|
1580
|
+
```{"language":"ruby"}
|
1581
1581
|
# load the gem
|
1582
1582
|
require 'purecloudplatformclientv2'
|
1583
1583
|
# setup authorization
|
@@ -1608,7 +1608,7 @@ begin
|
|
1608
1608
|
rescue PureCloud::ApiError => e
|
1609
1609
|
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapup: #{e}"
|
1610
1610
|
end
|
1611
|
-
|
1611
|
+
```
|
1612
1612
|
|
1613
1613
|
### Parameters
|
1614
1614
|
|
@@ -1633,7 +1633,7 @@ Name | Type | Description | Notes
|
|
1633
1633
|
|
1634
1634
|
<a name="get_conversations_chat_participant_wrapupcodes"></a>
|
1635
1635
|
|
1636
|
-
##
|
1636
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
1637
1637
|
|
1638
1638
|
|
1639
1639
|
|
@@ -1648,7 +1648,7 @@ Requires NO permissions:
|
|
1648
1648
|
|
1649
1649
|
|
1650
1650
|
### Example
|
1651
|
-
|
1651
|
+
```{"language":"ruby"}
|
1652
1652
|
# load the gem
|
1653
1653
|
require 'purecloudplatformclientv2'
|
1654
1654
|
# setup authorization
|
@@ -1676,7 +1676,7 @@ begin
|
|
1676
1676
|
rescue PureCloud::ApiError => e
|
1677
1677
|
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapupcodes: #{e}"
|
1678
1678
|
end
|
1679
|
-
|
1679
|
+
```
|
1680
1680
|
|
1681
1681
|
### Parameters
|
1682
1682
|
|
@@ -1700,7 +1700,7 @@ Name | Type | Description | Notes
|
|
1700
1700
|
|
1701
1701
|
<a name="get_conversations_chats"></a>
|
1702
1702
|
|
1703
|
-
##
|
1703
|
+
## [**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_conversations_chats
|
1704
1704
|
|
1705
1705
|
|
1706
1706
|
|
@@ -1715,7 +1715,7 @@ Requires NO permissions:
|
|
1715
1715
|
|
1716
1716
|
|
1717
1717
|
### Example
|
1718
|
-
|
1718
|
+
```{"language":"ruby"}
|
1719
1719
|
# load the gem
|
1720
1720
|
require 'purecloudplatformclientv2'
|
1721
1721
|
# setup authorization
|
@@ -1738,7 +1738,7 @@ begin
|
|
1738
1738
|
rescue PureCloud::ApiError => e
|
1739
1739
|
puts "Exception when calling ConversationsApi->get_conversations_chats: #{e}"
|
1740
1740
|
end
|
1741
|
-
|
1741
|
+
```
|
1742
1742
|
|
1743
1743
|
### Parameters
|
1744
1744
|
This endpoint does not need any parameter.
|
@@ -1758,7 +1758,7 @@ This endpoint does not need any parameter.
|
|
1758
1758
|
|
1759
1759
|
<a name="get_conversations_cobrowsesession"></a>
|
1760
1760
|
|
1761
|
-
##
|
1761
|
+
## [**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(conversation_id)
|
1762
1762
|
|
1763
1763
|
|
1764
1764
|
|
@@ -1773,7 +1773,7 @@ Requires NO 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 ConversationsApi->get_conversations_cobrowsesession: #{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_conversations_cobrowsesession_participant_wrapup"></a>
|
1824
1824
|
|
1825
|
-
##
|
1825
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
1826
1826
|
|
1827
1827
|
|
1828
1828
|
|
@@ -1837,7 +1837,7 @@ Requires NO permissions:
|
|
1837
1837
|
|
1838
1838
|
|
1839
1839
|
### Example
|
1840
|
-
|
1840
|
+
```{"language":"ruby"}
|
1841
1841
|
# load the gem
|
1842
1842
|
require 'purecloudplatformclientv2'
|
1843
1843
|
# setup authorization
|
@@ -1868,7 +1868,7 @@ begin
|
|
1868
1868
|
rescue PureCloud::ApiError => e
|
1869
1869
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapup: #{e}"
|
1870
1870
|
end
|
1871
|
-
|
1871
|
+
```
|
1872
1872
|
|
1873
1873
|
### Parameters
|
1874
1874
|
|
@@ -1893,7 +1893,7 @@ Name | Type | Description | Notes
|
|
1893
1893
|
|
1894
1894
|
<a name="get_conversations_cobrowsesession_participant_wrapupcodes"></a>
|
1895
1895
|
|
1896
|
-
##
|
1896
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
1897
1897
|
|
1898
1898
|
|
1899
1899
|
|
@@ -1908,7 +1908,7 @@ Requires NO permissions:
|
|
1908
1908
|
|
1909
1909
|
|
1910
1910
|
### Example
|
1911
|
-
|
1911
|
+
```{"language":"ruby"}
|
1912
1912
|
# load the gem
|
1913
1913
|
require 'purecloudplatformclientv2'
|
1914
1914
|
# setup authorization
|
@@ -1936,7 +1936,7 @@ begin
|
|
1936
1936
|
rescue PureCloud::ApiError => e
|
1937
1937
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapupcodes: #{e}"
|
1938
1938
|
end
|
1939
|
-
|
1939
|
+
```
|
1940
1940
|
|
1941
1941
|
### Parameters
|
1942
1942
|
|
@@ -1960,7 +1960,7 @@ Name | Type | Description | Notes
|
|
1960
1960
|
|
1961
1961
|
<a name="get_conversations_cobrowsesessions"></a>
|
1962
1962
|
|
1963
|
-
##
|
1963
|
+
## [**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_conversations_cobrowsesessions
|
1964
1964
|
|
1965
1965
|
|
1966
1966
|
|
@@ -1975,7 +1975,7 @@ Requires NO permissions:
|
|
1975
1975
|
|
1976
1976
|
|
1977
1977
|
### Example
|
1978
|
-
|
1978
|
+
```{"language":"ruby"}
|
1979
1979
|
# load the gem
|
1980
1980
|
require 'purecloudplatformclientv2'
|
1981
1981
|
# setup authorization
|
@@ -1998,7 +1998,7 @@ begin
|
|
1998
1998
|
rescue PureCloud::ApiError => e
|
1999
1999
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesessions: #{e}"
|
2000
2000
|
end
|
2001
|
-
|
2001
|
+
```
|
2002
2002
|
|
2003
2003
|
### Parameters
|
2004
2004
|
This endpoint does not need any parameter.
|
@@ -2018,7 +2018,7 @@ This endpoint does not need any parameter.
|
|
2018
2018
|
|
2019
2019
|
<a name="get_conversations_email"></a>
|
2020
2020
|
|
2021
|
-
##
|
2021
|
+
## [**EmailConversation**](EmailConversation.html) get_conversations_email(conversation_id)
|
2022
2022
|
|
2023
2023
|
|
2024
2024
|
|
@@ -2033,7 +2033,7 @@ Requires NO permissions:
|
|
2033
2033
|
|
2034
2034
|
|
2035
2035
|
### Example
|
2036
|
-
|
2036
|
+
```{"language":"ruby"}
|
2037
2037
|
# load the gem
|
2038
2038
|
require 'purecloudplatformclientv2'
|
2039
2039
|
# setup authorization
|
@@ -2059,7 +2059,7 @@ begin
|
|
2059
2059
|
rescue PureCloud::ApiError => e
|
2060
2060
|
puts "Exception when calling ConversationsApi->get_conversations_email: #{e}"
|
2061
2061
|
end
|
2062
|
-
|
2062
|
+
```
|
2063
2063
|
|
2064
2064
|
### Parameters
|
2065
2065
|
|
@@ -2082,7 +2082,7 @@ Name | Type | Description | Notes
|
|
2082
2082
|
|
2083
2083
|
<a name="get_conversations_email_message"></a>
|
2084
2084
|
|
2085
|
-
##
|
2085
|
+
## [**EmailMessage**](EmailMessage.html) get_conversations_email_message(conversation_id, message_id)
|
2086
2086
|
|
2087
2087
|
|
2088
2088
|
|
@@ -2097,7 +2097,7 @@ Requires NO permissions:
|
|
2097
2097
|
|
2098
2098
|
|
2099
2099
|
### Example
|
2100
|
-
|
2100
|
+
```{"language":"ruby"}
|
2101
2101
|
# load the gem
|
2102
2102
|
require 'purecloudplatformclientv2'
|
2103
2103
|
# setup authorization
|
@@ -2125,7 +2125,7 @@ begin
|
|
2125
2125
|
rescue PureCloud::ApiError => e
|
2126
2126
|
puts "Exception when calling ConversationsApi->get_conversations_email_message: #{e}"
|
2127
2127
|
end
|
2128
|
-
|
2128
|
+
```
|
2129
2129
|
|
2130
2130
|
### Parameters
|
2131
2131
|
|
@@ -2149,7 +2149,7 @@ Name | Type | Description | Notes
|
|
2149
2149
|
|
2150
2150
|
<a name="get_conversations_email_messages"></a>
|
2151
2151
|
|
2152
|
-
##
|
2152
|
+
## [**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(conversation_id)
|
2153
2153
|
|
2154
2154
|
|
2155
2155
|
|
@@ -2164,7 +2164,7 @@ Requires NO permissions:
|
|
2164
2164
|
|
2165
2165
|
|
2166
2166
|
### Example
|
2167
|
-
|
2167
|
+
```{"language":"ruby"}
|
2168
2168
|
# load the gem
|
2169
2169
|
require 'purecloudplatformclientv2'
|
2170
2170
|
# setup authorization
|
@@ -2190,7 +2190,7 @@ begin
|
|
2190
2190
|
rescue PureCloud::ApiError => e
|
2191
2191
|
puts "Exception when calling ConversationsApi->get_conversations_email_messages: #{e}"
|
2192
2192
|
end
|
2193
|
-
|
2193
|
+
```
|
2194
2194
|
|
2195
2195
|
### Parameters
|
2196
2196
|
|
@@ -2213,7 +2213,7 @@ Name | Type | Description | Notes
|
|
2213
2213
|
|
2214
2214
|
<a name="get_conversations_email_messages_draft"></a>
|
2215
2215
|
|
2216
|
-
##
|
2216
|
+
## [**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(conversation_id)
|
2217
2217
|
|
2218
2218
|
|
2219
2219
|
|
@@ -2228,7 +2228,7 @@ Requires NO permissions:
|
|
2228
2228
|
|
2229
2229
|
|
2230
2230
|
### Example
|
2231
|
-
|
2231
|
+
```{"language":"ruby"}
|
2232
2232
|
# load the gem
|
2233
2233
|
require 'purecloudplatformclientv2'
|
2234
2234
|
# setup authorization
|
@@ -2254,7 +2254,7 @@ begin
|
|
2254
2254
|
rescue PureCloud::ApiError => e
|
2255
2255
|
puts "Exception when calling ConversationsApi->get_conversations_email_messages_draft: #{e}"
|
2256
2256
|
end
|
2257
|
-
|
2257
|
+
```
|
2258
2258
|
|
2259
2259
|
### Parameters
|
2260
2260
|
|
@@ -2277,7 +2277,7 @@ Name | Type | Description | Notes
|
|
2277
2277
|
|
2278
2278
|
<a name="get_conversations_email_participant_wrapup"></a>
|
2279
2279
|
|
2280
|
-
##
|
2280
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
2281
2281
|
|
2282
2282
|
|
2283
2283
|
|
@@ -2292,7 +2292,7 @@ Requires NO permissions:
|
|
2292
2292
|
|
2293
2293
|
|
2294
2294
|
### Example
|
2295
|
-
|
2295
|
+
```{"language":"ruby"}
|
2296
2296
|
# load the gem
|
2297
2297
|
require 'purecloudplatformclientv2'
|
2298
2298
|
# setup authorization
|
@@ -2323,7 +2323,7 @@ begin
|
|
2323
2323
|
rescue PureCloud::ApiError => e
|
2324
2324
|
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapup: #{e}"
|
2325
2325
|
end
|
2326
|
-
|
2326
|
+
```
|
2327
2327
|
|
2328
2328
|
### Parameters
|
2329
2329
|
|
@@ -2348,7 +2348,7 @@ Name | Type | Description | Notes
|
|
2348
2348
|
|
2349
2349
|
<a name="get_conversations_email_participant_wrapupcodes"></a>
|
2350
2350
|
|
2351
|
-
##
|
2351
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
2352
2352
|
|
2353
2353
|
|
2354
2354
|
|
@@ -2363,7 +2363,7 @@ Requires NO permissions:
|
|
2363
2363
|
|
2364
2364
|
|
2365
2365
|
### Example
|
2366
|
-
|
2366
|
+
```{"language":"ruby"}
|
2367
2367
|
# load the gem
|
2368
2368
|
require 'purecloudplatformclientv2'
|
2369
2369
|
# setup authorization
|
@@ -2391,7 +2391,7 @@ begin
|
|
2391
2391
|
rescue PureCloud::ApiError => e
|
2392
2392
|
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapupcodes: #{e}"
|
2393
2393
|
end
|
2394
|
-
|
2394
|
+
```
|
2395
2395
|
|
2396
2396
|
### Parameters
|
2397
2397
|
|
@@ -2415,7 +2415,7 @@ Name | Type | Description | Notes
|
|
2415
2415
|
|
2416
2416
|
<a name="get_conversations_emails"></a>
|
2417
2417
|
|
2418
|
-
##
|
2418
|
+
## [**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_conversations_emails
|
2419
2419
|
|
2420
2420
|
|
2421
2421
|
|
@@ -2430,7 +2430,7 @@ Requires NO permissions:
|
|
2430
2430
|
|
2431
2431
|
|
2432
2432
|
### Example
|
2433
|
-
|
2433
|
+
```{"language":"ruby"}
|
2434
2434
|
# load the gem
|
2435
2435
|
require 'purecloudplatformclientv2'
|
2436
2436
|
# setup authorization
|
@@ -2453,7 +2453,7 @@ begin
|
|
2453
2453
|
rescue PureCloud::ApiError => e
|
2454
2454
|
puts "Exception when calling ConversationsApi->get_conversations_emails: #{e}"
|
2455
2455
|
end
|
2456
|
-
|
2456
|
+
```
|
2457
2457
|
|
2458
2458
|
### Parameters
|
2459
2459
|
This endpoint does not need any parameter.
|
@@ -2473,7 +2473,7 @@ This endpoint does not need any parameter.
|
|
2473
2473
|
|
2474
2474
|
<a name="get_conversations_message"></a>
|
2475
2475
|
|
2476
|
-
##
|
2476
|
+
## [**MessageConversation**](MessageConversation.html) get_conversations_message(conversation_id)
|
2477
2477
|
|
2478
2478
|
|
2479
2479
|
|
@@ -2488,7 +2488,7 @@ Requires NO permissions:
|
|
2488
2488
|
|
2489
2489
|
|
2490
2490
|
### Example
|
2491
|
-
|
2491
|
+
```{"language":"ruby"}
|
2492
2492
|
# load the gem
|
2493
2493
|
require 'purecloudplatformclientv2'
|
2494
2494
|
# setup authorization
|
@@ -2514,7 +2514,7 @@ begin
|
|
2514
2514
|
rescue PureCloud::ApiError => e
|
2515
2515
|
puts "Exception when calling ConversationsApi->get_conversations_message: #{e}"
|
2516
2516
|
end
|
2517
|
-
|
2517
|
+
```
|
2518
2518
|
|
2519
2519
|
### Parameters
|
2520
2520
|
|
@@ -2537,7 +2537,7 @@ Name | Type | Description | Notes
|
|
2537
2537
|
|
2538
2538
|
<a name="get_conversations_message_communication_messages_media_media_id"></a>
|
2539
2539
|
|
2540
|
-
##
|
2540
|
+
## [**MessageMediaData**](MessageMediaData.html) get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id)
|
2541
2541
|
|
2542
2542
|
|
2543
2543
|
|
@@ -2553,7 +2553,7 @@ Requires ANY permissions:
|
|
2553
2553
|
|
2554
2554
|
|
2555
2555
|
### Example
|
2556
|
-
|
2556
|
+
```{"language":"ruby"}
|
2557
2557
|
# load the gem
|
2558
2558
|
require 'purecloudplatformclientv2'
|
2559
2559
|
# setup authorization
|
@@ -2583,7 +2583,7 @@ begin
|
|
2583
2583
|
rescue PureCloud::ApiError => e
|
2584
2584
|
puts "Exception when calling ConversationsApi->get_conversations_message_communication_messages_media_media_id: #{e}"
|
2585
2585
|
end
|
2586
|
-
|
2586
|
+
```
|
2587
2587
|
|
2588
2588
|
### Parameters
|
2589
2589
|
|
@@ -2608,7 +2608,7 @@ Name | Type | Description | Notes
|
|
2608
2608
|
|
2609
2609
|
<a name="get_conversations_message_message"></a>
|
2610
2610
|
|
2611
|
-
##
|
2611
|
+
## [**MessageData**](MessageData.html) get_conversations_message_message(conversation_id, message_id)
|
2612
2612
|
|
2613
2613
|
|
2614
2614
|
|
@@ -2624,7 +2624,7 @@ Requires ANY permissions:
|
|
2624
2624
|
|
2625
2625
|
|
2626
2626
|
### Example
|
2627
|
-
|
2627
|
+
```{"language":"ruby"}
|
2628
2628
|
# load the gem
|
2629
2629
|
require 'purecloudplatformclientv2'
|
2630
2630
|
# setup authorization
|
@@ -2652,7 +2652,7 @@ begin
|
|
2652
2652
|
rescue PureCloud::ApiError => e
|
2653
2653
|
puts "Exception when calling ConversationsApi->get_conversations_message_message: #{e}"
|
2654
2654
|
end
|
2655
|
-
|
2655
|
+
```
|
2656
2656
|
|
2657
2657
|
### Parameters
|
2658
2658
|
|
@@ -2676,7 +2676,7 @@ Name | Type | Description | Notes
|
|
2676
2676
|
|
2677
2677
|
<a name="get_conversations_message_participant_wrapup"></a>
|
2678
2678
|
|
2679
|
-
##
|
2679
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
2680
2680
|
|
2681
2681
|
|
2682
2682
|
|
@@ -2691,7 +2691,7 @@ Requires NO permissions:
|
|
2691
2691
|
|
2692
2692
|
|
2693
2693
|
### Example
|
2694
|
-
|
2694
|
+
```{"language":"ruby"}
|
2695
2695
|
# load the gem
|
2696
2696
|
require 'purecloudplatformclientv2'
|
2697
2697
|
# setup authorization
|
@@ -2722,7 +2722,7 @@ begin
|
|
2722
2722
|
rescue PureCloud::ApiError => e
|
2723
2723
|
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapup: #{e}"
|
2724
2724
|
end
|
2725
|
-
|
2725
|
+
```
|
2726
2726
|
|
2727
2727
|
### Parameters
|
2728
2728
|
|
@@ -2747,7 +2747,7 @@ Name | Type | Description | Notes
|
|
2747
2747
|
|
2748
2748
|
<a name="get_conversations_message_participant_wrapupcodes"></a>
|
2749
2749
|
|
2750
|
-
##
|
2750
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
2751
2751
|
|
2752
2752
|
|
2753
2753
|
|
@@ -2762,7 +2762,7 @@ Requires NO permissions:
|
|
2762
2762
|
|
2763
2763
|
|
2764
2764
|
### Example
|
2765
|
-
|
2765
|
+
```{"language":"ruby"}
|
2766
2766
|
# load the gem
|
2767
2767
|
require 'purecloudplatformclientv2'
|
2768
2768
|
# setup authorization
|
@@ -2790,7 +2790,7 @@ begin
|
|
2790
2790
|
rescue PureCloud::ApiError => e
|
2791
2791
|
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapupcodes: #{e}"
|
2792
2792
|
end
|
2793
|
-
|
2793
|
+
```
|
2794
2794
|
|
2795
2795
|
### Parameters
|
2796
2796
|
|
@@ -2814,7 +2814,7 @@ Name | Type | Description | Notes
|
|
2814
2814
|
|
2815
2815
|
<a name="get_conversations_messages"></a>
|
2816
2816
|
|
2817
|
-
##
|
2817
|
+
## [**MessageConversationEntityListing**](MessageConversationEntityListing.html) get_conversations_messages
|
2818
2818
|
|
2819
2819
|
|
2820
2820
|
|
@@ -2829,7 +2829,7 @@ Requires NO permissions:
|
|
2829
2829
|
|
2830
2830
|
|
2831
2831
|
### Example
|
2832
|
-
|
2832
|
+
```{"language":"ruby"}
|
2833
2833
|
# load the gem
|
2834
2834
|
require 'purecloudplatformclientv2'
|
2835
2835
|
# setup authorization
|
@@ -2852,7 +2852,7 @@ begin
|
|
2852
2852
|
rescue PureCloud::ApiError => e
|
2853
2853
|
puts "Exception when calling ConversationsApi->get_conversations_messages: #{e}"
|
2854
2854
|
end
|
2855
|
-
|
2855
|
+
```
|
2856
2856
|
|
2857
2857
|
### Parameters
|
2858
2858
|
This endpoint does not need any parameter.
|
@@ -2872,7 +2872,7 @@ This endpoint does not need any parameter.
|
|
2872
2872
|
|
2873
2873
|
<a name="patch_conversation_participant"></a>
|
2874
2874
|
|
2875
|
-
##
|
2875
|
+
## patch_conversation_participant(conversation_id, participant_id, body)
|
2876
2876
|
|
2877
2877
|
|
2878
2878
|
|
@@ -2887,7 +2887,7 @@ Requires NO permissions:
|
|
2887
2887
|
|
2888
2888
|
|
2889
2889
|
### Example
|
2890
|
-
|
2890
|
+
```{"language":"ruby"}
|
2891
2891
|
# load the gem
|
2892
2892
|
require 'purecloudplatformclientv2'
|
2893
2893
|
# setup authorization
|
@@ -2916,7 +2916,7 @@ begin
|
|
2916
2916
|
rescue PureCloud::ApiError => e
|
2917
2917
|
puts "Exception when calling ConversationsApi->patch_conversation_participant: #{e}"
|
2918
2918
|
end
|
2919
|
-
|
2919
|
+
```
|
2920
2920
|
|
2921
2921
|
### Parameters
|
2922
2922
|
|
@@ -2941,7 +2941,7 @@ nil (empty response body)
|
|
2941
2941
|
|
2942
2942
|
<a name="patch_conversation_participant_attributes"></a>
|
2943
2943
|
|
2944
|
-
##
|
2944
|
+
## patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
2945
2945
|
|
2946
2946
|
|
2947
2947
|
|
@@ -2956,7 +2956,7 @@ Requires NO permissions:
|
|
2956
2956
|
|
2957
2957
|
|
2958
2958
|
### Example
|
2959
|
-
|
2959
|
+
```{"language":"ruby"}
|
2960
2960
|
# load the gem
|
2961
2961
|
require 'purecloudplatformclientv2'
|
2962
2962
|
# setup authorization
|
@@ -2985,7 +2985,7 @@ begin
|
|
2985
2985
|
rescue PureCloud::ApiError => e
|
2986
2986
|
puts "Exception when calling ConversationsApi->patch_conversation_participant_attributes: #{e}"
|
2987
2987
|
end
|
2988
|
-
|
2988
|
+
```
|
2989
2989
|
|
2990
2990
|
### Parameters
|
2991
2991
|
|
@@ -3010,7 +3010,7 @@ nil (empty response body)
|
|
3010
3010
|
|
3011
3011
|
<a name="patch_conversations_call"></a>
|
3012
3012
|
|
3013
|
-
##
|
3013
|
+
## [**Conversation**](Conversation.html) patch_conversations_call(conversation_id, body)
|
3014
3014
|
|
3015
3015
|
|
3016
3016
|
|
@@ -3026,7 +3026,7 @@ Requires ANY permissions:
|
|
3026
3026
|
|
3027
3027
|
|
3028
3028
|
### Example
|
3029
|
-
|
3029
|
+
```{"language":"ruby"}
|
3030
3030
|
# load the gem
|
3031
3031
|
require 'purecloudplatformclientv2'
|
3032
3032
|
# setup authorization
|
@@ -3054,7 +3054,7 @@ begin
|
|
3054
3054
|
rescue PureCloud::ApiError => e
|
3055
3055
|
puts "Exception when calling ConversationsApi->patch_conversations_call: #{e}"
|
3056
3056
|
end
|
3057
|
-
|
3057
|
+
```
|
3058
3058
|
|
3059
3059
|
### Parameters
|
3060
3060
|
|
@@ -3078,7 +3078,7 @@ Name | Type | Description | Notes
|
|
3078
3078
|
|
3079
3079
|
<a name="patch_conversations_call_participant"></a>
|
3080
3080
|
|
3081
|
-
##
|
3081
|
+
## patch_conversations_call_participant(conversation_id, participant_id, body)
|
3082
3082
|
|
3083
3083
|
|
3084
3084
|
|
@@ -3093,7 +3093,7 @@ Requires NO permissions:
|
|
3093
3093
|
|
3094
3094
|
|
3095
3095
|
### Example
|
3096
|
-
|
3096
|
+
```{"language":"ruby"}
|
3097
3097
|
# load the gem
|
3098
3098
|
require 'purecloudplatformclientv2'
|
3099
3099
|
# setup authorization
|
@@ -3122,7 +3122,7 @@ begin
|
|
3122
3122
|
rescue PureCloud::ApiError => e
|
3123
3123
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant: #{e}"
|
3124
3124
|
end
|
3125
|
-
|
3125
|
+
```
|
3126
3126
|
|
3127
3127
|
### Parameters
|
3128
3128
|
|
@@ -3147,7 +3147,7 @@ nil (empty response body)
|
|
3147
3147
|
|
3148
3148
|
<a name="patch_conversations_call_participant_attributes"></a>
|
3149
3149
|
|
3150
|
-
##
|
3150
|
+
## patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
3151
3151
|
|
3152
3152
|
|
3153
3153
|
|
@@ -3162,7 +3162,7 @@ Requires NO permissions:
|
|
3162
3162
|
|
3163
3163
|
|
3164
3164
|
### Example
|
3165
|
-
|
3165
|
+
```{"language":"ruby"}
|
3166
3166
|
# load the gem
|
3167
3167
|
require 'purecloudplatformclientv2'
|
3168
3168
|
# setup authorization
|
@@ -3191,7 +3191,7 @@ begin
|
|
3191
3191
|
rescue PureCloud::ApiError => e
|
3192
3192
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: #{e}"
|
3193
3193
|
end
|
3194
|
-
|
3194
|
+
```
|
3195
3195
|
|
3196
3196
|
### Parameters
|
3197
3197
|
|
@@ -3216,7 +3216,7 @@ nil (empty response body)
|
|
3216
3216
|
|
3217
3217
|
<a name="patch_conversations_call_participant_communication"></a>
|
3218
3218
|
|
3219
|
-
##
|
3219
|
+
## [**Empty**](Empty.html) patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
3220
3220
|
|
3221
3221
|
|
3222
3222
|
|
@@ -3231,7 +3231,7 @@ Requires NO permissions:
|
|
3231
3231
|
|
3232
3232
|
|
3233
3233
|
### Example
|
3234
|
-
|
3234
|
+
```{"language":"ruby"}
|
3235
3235
|
# load the gem
|
3236
3236
|
require 'purecloudplatformclientv2'
|
3237
3237
|
# setup authorization
|
@@ -3263,7 +3263,7 @@ begin
|
|
3263
3263
|
rescue PureCloud::ApiError => e
|
3264
3264
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_communication: #{e}"
|
3265
3265
|
end
|
3266
|
-
|
3266
|
+
```
|
3267
3267
|
|
3268
3268
|
### Parameters
|
3269
3269
|
|
@@ -3289,7 +3289,7 @@ Name | Type | Description | Notes
|
|
3289
3289
|
|
3290
3290
|
<a name="patch_conversations_call_participant_consult"></a>
|
3291
3291
|
|
3292
|
-
##
|
3292
|
+
## [**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
3293
3293
|
|
3294
3294
|
|
3295
3295
|
|
@@ -3304,7 +3304,7 @@ Requires NO permissions:
|
|
3304
3304
|
|
3305
3305
|
|
3306
3306
|
### Example
|
3307
|
-
|
3307
|
+
```{"language":"ruby"}
|
3308
3308
|
# load the gem
|
3309
3309
|
require 'purecloudplatformclientv2'
|
3310
3310
|
# setup authorization
|
@@ -3334,7 +3334,7 @@ begin
|
|
3334
3334
|
rescue PureCloud::ApiError => e
|
3335
3335
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_consult: #{e}"
|
3336
3336
|
end
|
3337
|
-
|
3337
|
+
```
|
3338
3338
|
|
3339
3339
|
### Parameters
|
3340
3340
|
|
@@ -3359,7 +3359,7 @@ Name | Type | Description | Notes
|
|
3359
3359
|
|
3360
3360
|
<a name="patch_conversations_callback"></a>
|
3361
3361
|
|
3362
|
-
##
|
3362
|
+
## [**Conversation**](Conversation.html) patch_conversations_callback(conversation_id, body)
|
3363
3363
|
|
3364
3364
|
|
3365
3365
|
|
@@ -3375,7 +3375,7 @@ Requires ANY permissions:
|
|
3375
3375
|
|
3376
3376
|
|
3377
3377
|
### Example
|
3378
|
-
|
3378
|
+
```{"language":"ruby"}
|
3379
3379
|
# load the gem
|
3380
3380
|
require 'purecloudplatformclientv2'
|
3381
3381
|
# setup authorization
|
@@ -3403,7 +3403,7 @@ begin
|
|
3403
3403
|
rescue PureCloud::ApiError => e
|
3404
3404
|
puts "Exception when calling ConversationsApi->patch_conversations_callback: #{e}"
|
3405
3405
|
end
|
3406
|
-
|
3406
|
+
```
|
3407
3407
|
|
3408
3408
|
### Parameters
|
3409
3409
|
|
@@ -3427,7 +3427,7 @@ Name | Type | Description | Notes
|
|
3427
3427
|
|
3428
3428
|
<a name="patch_conversations_callback_participant"></a>
|
3429
3429
|
|
3430
|
-
##
|
3430
|
+
## patch_conversations_callback_participant(conversation_id, participant_id, body)
|
3431
3431
|
|
3432
3432
|
|
3433
3433
|
|
@@ -3442,7 +3442,7 @@ Requires NO permissions:
|
|
3442
3442
|
|
3443
3443
|
|
3444
3444
|
### Example
|
3445
|
-
|
3445
|
+
```{"language":"ruby"}
|
3446
3446
|
# load the gem
|
3447
3447
|
require 'purecloudplatformclientv2'
|
3448
3448
|
# setup authorization
|
@@ -3471,7 +3471,7 @@ begin
|
|
3471
3471
|
rescue PureCloud::ApiError => e
|
3472
3472
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant: #{e}"
|
3473
3473
|
end
|
3474
|
-
|
3474
|
+
```
|
3475
3475
|
|
3476
3476
|
### Parameters
|
3477
3477
|
|
@@ -3496,7 +3496,7 @@ nil (empty response body)
|
|
3496
3496
|
|
3497
3497
|
<a name="patch_conversations_callback_participant_attributes"></a>
|
3498
3498
|
|
3499
|
-
##
|
3499
|
+
## patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
3500
3500
|
|
3501
3501
|
|
3502
3502
|
|
@@ -3511,7 +3511,7 @@ Requires NO permissions:
|
|
3511
3511
|
|
3512
3512
|
|
3513
3513
|
### Example
|
3514
|
-
|
3514
|
+
```{"language":"ruby"}
|
3515
3515
|
# load the gem
|
3516
3516
|
require 'purecloudplatformclientv2'
|
3517
3517
|
# setup authorization
|
@@ -3540,7 +3540,7 @@ begin
|
|
3540
3540
|
rescue PureCloud::ApiError => e
|
3541
3541
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: #{e}"
|
3542
3542
|
end
|
3543
|
-
|
3543
|
+
```
|
3544
3544
|
|
3545
3545
|
### Parameters
|
3546
3546
|
|
@@ -3565,7 +3565,7 @@ nil (empty response body)
|
|
3565
3565
|
|
3566
3566
|
<a name="patch_conversations_callback_participant_communication"></a>
|
3567
3567
|
|
3568
|
-
##
|
3568
|
+
## [**Empty**](Empty.html) patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
3569
3569
|
|
3570
3570
|
|
3571
3571
|
|
@@ -3580,7 +3580,7 @@ Requires NO permissions:
|
|
3580
3580
|
|
3581
3581
|
|
3582
3582
|
### Example
|
3583
|
-
|
3583
|
+
```{"language":"ruby"}
|
3584
3584
|
# load the gem
|
3585
3585
|
require 'purecloudplatformclientv2'
|
3586
3586
|
# setup authorization
|
@@ -3612,7 +3612,7 @@ begin
|
|
3612
3612
|
rescue PureCloud::ApiError => e
|
3613
3613
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: #{e}"
|
3614
3614
|
end
|
3615
|
-
|
3615
|
+
```
|
3616
3616
|
|
3617
3617
|
### Parameters
|
3618
3618
|
|
@@ -3638,7 +3638,7 @@ Name | Type | Description | Notes
|
|
3638
3638
|
|
3639
3639
|
<a name="patch_conversations_chat"></a>
|
3640
3640
|
|
3641
|
-
##
|
3641
|
+
## [**Conversation**](Conversation.html) patch_conversations_chat(conversation_id, body)
|
3642
3642
|
|
3643
3643
|
|
3644
3644
|
|
@@ -3654,7 +3654,7 @@ Requires ANY permissions:
|
|
3654
3654
|
|
3655
3655
|
|
3656
3656
|
### Example
|
3657
|
-
|
3657
|
+
```{"language":"ruby"}
|
3658
3658
|
# load the gem
|
3659
3659
|
require 'purecloudplatformclientv2'
|
3660
3660
|
# setup authorization
|
@@ -3682,7 +3682,7 @@ begin
|
|
3682
3682
|
rescue PureCloud::ApiError => e
|
3683
3683
|
puts "Exception when calling ConversationsApi->patch_conversations_chat: #{e}"
|
3684
3684
|
end
|
3685
|
-
|
3685
|
+
```
|
3686
3686
|
|
3687
3687
|
### Parameters
|
3688
3688
|
|
@@ -3706,7 +3706,7 @@ Name | Type | Description | Notes
|
|
3706
3706
|
|
3707
3707
|
<a name="patch_conversations_chat_participant"></a>
|
3708
3708
|
|
3709
|
-
##
|
3709
|
+
## patch_conversations_chat_participant(conversation_id, participant_id, body)
|
3710
3710
|
|
3711
3711
|
|
3712
3712
|
|
@@ -3721,7 +3721,7 @@ Requires NO permissions:
|
|
3721
3721
|
|
3722
3722
|
|
3723
3723
|
### Example
|
3724
|
-
|
3724
|
+
```{"language":"ruby"}
|
3725
3725
|
# load the gem
|
3726
3726
|
require 'purecloudplatformclientv2'
|
3727
3727
|
# setup authorization
|
@@ -3750,7 +3750,7 @@ begin
|
|
3750
3750
|
rescue PureCloud::ApiError => e
|
3751
3751
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant: #{e}"
|
3752
3752
|
end
|
3753
|
-
|
3753
|
+
```
|
3754
3754
|
|
3755
3755
|
### Parameters
|
3756
3756
|
|
@@ -3775,7 +3775,7 @@ nil (empty response body)
|
|
3775
3775
|
|
3776
3776
|
<a name="patch_conversations_chat_participant_attributes"></a>
|
3777
3777
|
|
3778
|
-
##
|
3778
|
+
## patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
3779
3779
|
|
3780
3780
|
|
3781
3781
|
|
@@ -3790,7 +3790,7 @@ Requires NO permissions:
|
|
3790
3790
|
|
3791
3791
|
|
3792
3792
|
### Example
|
3793
|
-
|
3793
|
+
```{"language":"ruby"}
|
3794
3794
|
# load the gem
|
3795
3795
|
require 'purecloudplatformclientv2'
|
3796
3796
|
# setup authorization
|
@@ -3819,7 +3819,7 @@ begin
|
|
3819
3819
|
rescue PureCloud::ApiError => e
|
3820
3820
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_attributes: #{e}"
|
3821
3821
|
end
|
3822
|
-
|
3822
|
+
```
|
3823
3823
|
|
3824
3824
|
### Parameters
|
3825
3825
|
|
@@ -3844,7 +3844,7 @@ nil (empty response body)
|
|
3844
3844
|
|
3845
3845
|
<a name="patch_conversations_chat_participant_communication"></a>
|
3846
3846
|
|
3847
|
-
##
|
3847
|
+
## [**Empty**](Empty.html) patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
3848
3848
|
|
3849
3849
|
|
3850
3850
|
|
@@ -3859,7 +3859,7 @@ Requires NO permissions:
|
|
3859
3859
|
|
3860
3860
|
|
3861
3861
|
### Example
|
3862
|
-
|
3862
|
+
```{"language":"ruby"}
|
3863
3863
|
# load the gem
|
3864
3864
|
require 'purecloudplatformclientv2'
|
3865
3865
|
# setup authorization
|
@@ -3891,7 +3891,7 @@ begin
|
|
3891
3891
|
rescue PureCloud::ApiError => e
|
3892
3892
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_communication: #{e}"
|
3893
3893
|
end
|
3894
|
-
|
3894
|
+
```
|
3895
3895
|
|
3896
3896
|
### Parameters
|
3897
3897
|
|
@@ -3917,7 +3917,7 @@ Name | Type | Description | Notes
|
|
3917
3917
|
|
3918
3918
|
<a name="patch_conversations_cobrowsesession"></a>
|
3919
3919
|
|
3920
|
-
##
|
3920
|
+
## [**Conversation**](Conversation.html) patch_conversations_cobrowsesession(conversation_id, body)
|
3921
3921
|
|
3922
3922
|
|
3923
3923
|
|
@@ -3933,7 +3933,7 @@ Requires ANY permissions:
|
|
3933
3933
|
|
3934
3934
|
|
3935
3935
|
### Example
|
3936
|
-
|
3936
|
+
```{"language":"ruby"}
|
3937
3937
|
# load the gem
|
3938
3938
|
require 'purecloudplatformclientv2'
|
3939
3939
|
# setup authorization
|
@@ -3961,7 +3961,7 @@ begin
|
|
3961
3961
|
rescue PureCloud::ApiError => e
|
3962
3962
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession: #{e}"
|
3963
3963
|
end
|
3964
|
-
|
3964
|
+
```
|
3965
3965
|
|
3966
3966
|
### Parameters
|
3967
3967
|
|
@@ -3985,7 +3985,7 @@ Name | Type | Description | Notes
|
|
3985
3985
|
|
3986
3986
|
<a name="patch_conversations_cobrowsesession_participant"></a>
|
3987
3987
|
|
3988
|
-
##
|
3988
|
+
## patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
3989
3989
|
|
3990
3990
|
|
3991
3991
|
|
@@ -4000,7 +4000,7 @@ Requires NO permissions:
|
|
4000
4000
|
|
4001
4001
|
|
4002
4002
|
### Example
|
4003
|
-
|
4003
|
+
```{"language":"ruby"}
|
4004
4004
|
# load the gem
|
4005
4005
|
require 'purecloudplatformclientv2'
|
4006
4006
|
# setup authorization
|
@@ -4030,7 +4030,7 @@ begin
|
|
4030
4030
|
rescue PureCloud::ApiError => e
|
4031
4031
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant: #{e}"
|
4032
4032
|
end
|
4033
|
-
|
4033
|
+
```
|
4034
4034
|
|
4035
4035
|
### Parameters
|
4036
4036
|
|
@@ -4055,7 +4055,7 @@ nil (empty response body)
|
|
4055
4055
|
|
4056
4056
|
<a name="patch_conversations_cobrowsesession_participant_attributes"></a>
|
4057
4057
|
|
4058
|
-
##
|
4058
|
+
## patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
4059
4059
|
|
4060
4060
|
|
4061
4061
|
|
@@ -4070,7 +4070,7 @@ Requires NO permissions:
|
|
4070
4070
|
|
4071
4071
|
|
4072
4072
|
### Example
|
4073
|
-
|
4073
|
+
```{"language":"ruby"}
|
4074
4074
|
# load the gem
|
4075
4075
|
require 'purecloudplatformclientv2'
|
4076
4076
|
# setup authorization
|
@@ -4100,7 +4100,7 @@ begin
|
|
4100
4100
|
rescue PureCloud::ApiError => e
|
4101
4101
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_attributes: #{e}"
|
4102
4102
|
end
|
4103
|
-
|
4103
|
+
```
|
4104
4104
|
|
4105
4105
|
### Parameters
|
4106
4106
|
|
@@ -4125,7 +4125,7 @@ nil (empty response body)
|
|
4125
4125
|
|
4126
4126
|
<a name="patch_conversations_cobrowsesession_participant_communication"></a>
|
4127
4127
|
|
4128
|
-
##
|
4128
|
+
## [**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
4129
4129
|
|
4130
4130
|
|
4131
4131
|
|
@@ -4140,7 +4140,7 @@ Requires NO permissions:
|
|
4140
4140
|
|
4141
4141
|
|
4142
4142
|
### Example
|
4143
|
-
|
4143
|
+
```{"language":"ruby"}
|
4144
4144
|
# load the gem
|
4145
4145
|
require 'purecloudplatformclientv2'
|
4146
4146
|
# setup authorization
|
@@ -4172,7 +4172,7 @@ begin
|
|
4172
4172
|
rescue PureCloud::ApiError => e
|
4173
4173
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_communication: #{e}"
|
4174
4174
|
end
|
4175
|
-
|
4175
|
+
```
|
4176
4176
|
|
4177
4177
|
### Parameters
|
4178
4178
|
|
@@ -4198,7 +4198,7 @@ Name | Type | Description | Notes
|
|
4198
4198
|
|
4199
4199
|
<a name="patch_conversations_email"></a>
|
4200
4200
|
|
4201
|
-
##
|
4201
|
+
## [**Conversation**](Conversation.html) patch_conversations_email(conversation_id, body)
|
4202
4202
|
|
4203
4203
|
|
4204
4204
|
|
@@ -4214,7 +4214,7 @@ Requires ANY permissions:
|
|
4214
4214
|
|
4215
4215
|
|
4216
4216
|
### Example
|
4217
|
-
|
4217
|
+
```{"language":"ruby"}
|
4218
4218
|
# load the gem
|
4219
4219
|
require 'purecloudplatformclientv2'
|
4220
4220
|
# setup authorization
|
@@ -4242,7 +4242,7 @@ begin
|
|
4242
4242
|
rescue PureCloud::ApiError => e
|
4243
4243
|
puts "Exception when calling ConversationsApi->patch_conversations_email: #{e}"
|
4244
4244
|
end
|
4245
|
-
|
4245
|
+
```
|
4246
4246
|
|
4247
4247
|
### Parameters
|
4248
4248
|
|
@@ -4266,7 +4266,7 @@ Name | Type | Description | Notes
|
|
4266
4266
|
|
4267
4267
|
<a name="patch_conversations_email_participant"></a>
|
4268
4268
|
|
4269
|
-
##
|
4269
|
+
## patch_conversations_email_participant(conversation_id, participant_id, body)
|
4270
4270
|
|
4271
4271
|
|
4272
4272
|
|
@@ -4281,7 +4281,7 @@ Requires NO permissions:
|
|
4281
4281
|
|
4282
4282
|
|
4283
4283
|
### Example
|
4284
|
-
|
4284
|
+
```{"language":"ruby"}
|
4285
4285
|
# load the gem
|
4286
4286
|
require 'purecloudplatformclientv2'
|
4287
4287
|
# setup authorization
|
@@ -4310,7 +4310,7 @@ begin
|
|
4310
4310
|
rescue PureCloud::ApiError => e
|
4311
4311
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant: #{e}"
|
4312
4312
|
end
|
4313
|
-
|
4313
|
+
```
|
4314
4314
|
|
4315
4315
|
### Parameters
|
4316
4316
|
|
@@ -4335,7 +4335,7 @@ nil (empty response body)
|
|
4335
4335
|
|
4336
4336
|
<a name="patch_conversations_email_participant_attributes"></a>
|
4337
4337
|
|
4338
|
-
##
|
4338
|
+
## patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
4339
4339
|
|
4340
4340
|
|
4341
4341
|
|
@@ -4350,7 +4350,7 @@ Requires NO permissions:
|
|
4350
4350
|
|
4351
4351
|
|
4352
4352
|
### Example
|
4353
|
-
|
4353
|
+
```{"language":"ruby"}
|
4354
4354
|
# load the gem
|
4355
4355
|
require 'purecloudplatformclientv2'
|
4356
4356
|
# setup authorization
|
@@ -4379,7 +4379,7 @@ begin
|
|
4379
4379
|
rescue PureCloud::ApiError => e
|
4380
4380
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_attributes: #{e}"
|
4381
4381
|
end
|
4382
|
-
|
4382
|
+
```
|
4383
4383
|
|
4384
4384
|
### Parameters
|
4385
4385
|
|
@@ -4404,7 +4404,7 @@ nil (empty response body)
|
|
4404
4404
|
|
4405
4405
|
<a name="patch_conversations_email_participant_communication"></a>
|
4406
4406
|
|
4407
|
-
##
|
4407
|
+
## [**Empty**](Empty.html) patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
4408
4408
|
|
4409
4409
|
|
4410
4410
|
|
@@ -4419,7 +4419,7 @@ Requires NO permissions:
|
|
4419
4419
|
|
4420
4420
|
|
4421
4421
|
### Example
|
4422
|
-
|
4422
|
+
```{"language":"ruby"}
|
4423
4423
|
# load the gem
|
4424
4424
|
require 'purecloudplatformclientv2'
|
4425
4425
|
# setup authorization
|
@@ -4451,7 +4451,7 @@ begin
|
|
4451
4451
|
rescue PureCloud::ApiError => e
|
4452
4452
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_communication: #{e}"
|
4453
4453
|
end
|
4454
|
-
|
4454
|
+
```
|
4455
4455
|
|
4456
4456
|
### Parameters
|
4457
4457
|
|
@@ -4477,7 +4477,7 @@ Name | Type | Description | Notes
|
|
4477
4477
|
|
4478
4478
|
<a name="patch_conversations_message"></a>
|
4479
4479
|
|
4480
|
-
##
|
4480
|
+
## [**Conversation**](Conversation.html) patch_conversations_message(conversation_id, body)
|
4481
4481
|
|
4482
4482
|
|
4483
4483
|
|
@@ -4493,7 +4493,7 @@ Requires ANY permissions:
|
|
4493
4493
|
|
4494
4494
|
|
4495
4495
|
### Example
|
4496
|
-
|
4496
|
+
```{"language":"ruby"}
|
4497
4497
|
# load the gem
|
4498
4498
|
require 'purecloudplatformclientv2'
|
4499
4499
|
# setup authorization
|
@@ -4521,7 +4521,7 @@ begin
|
|
4521
4521
|
rescue PureCloud::ApiError => e
|
4522
4522
|
puts "Exception when calling ConversationsApi->patch_conversations_message: #{e}"
|
4523
4523
|
end
|
4524
|
-
|
4524
|
+
```
|
4525
4525
|
|
4526
4526
|
### Parameters
|
4527
4527
|
|
@@ -4545,7 +4545,7 @@ Name | Type | Description | Notes
|
|
4545
4545
|
|
4546
4546
|
<a name="patch_conversations_message_participant"></a>
|
4547
4547
|
|
4548
|
-
##
|
4548
|
+
## patch_conversations_message_participant(conversation_id, participant_id, opts)
|
4549
4549
|
|
4550
4550
|
|
4551
4551
|
|
@@ -4560,7 +4560,7 @@ Requires NO permissions:
|
|
4560
4560
|
|
4561
4561
|
|
4562
4562
|
### Example
|
4563
|
-
|
4563
|
+
```{"language":"ruby"}
|
4564
4564
|
# load the gem
|
4565
4565
|
require 'purecloudplatformclientv2'
|
4566
4566
|
# setup authorization
|
@@ -4590,7 +4590,7 @@ begin
|
|
4590
4590
|
rescue PureCloud::ApiError => e
|
4591
4591
|
puts "Exception when calling ConversationsApi->patch_conversations_message_participant: #{e}"
|
4592
4592
|
end
|
4593
|
-
|
4593
|
+
```
|
4594
4594
|
|
4595
4595
|
### Parameters
|
4596
4596
|
|
@@ -4615,7 +4615,7 @@ nil (empty response body)
|
|
4615
4615
|
|
4616
4616
|
<a name="patch_conversations_message_participant_attributes"></a>
|
4617
4617
|
|
4618
|
-
##
|
4618
|
+
## patch_conversations_message_participant_attributes(conversation_id, participant_id, opts)
|
4619
4619
|
|
4620
4620
|
|
4621
4621
|
|
@@ -4630,7 +4630,7 @@ Requires NO permissions:
|
|
4630
4630
|
|
4631
4631
|
|
4632
4632
|
### Example
|
4633
|
-
|
4633
|
+
```{"language":"ruby"}
|
4634
4634
|
# load the gem
|
4635
4635
|
require 'purecloudplatformclientv2'
|
4636
4636
|
# setup authorization
|
@@ -4660,7 +4660,7 @@ begin
|
|
4660
4660
|
rescue PureCloud::ApiError => e
|
4661
4661
|
puts "Exception when calling ConversationsApi->patch_conversations_message_participant_attributes: #{e}"
|
4662
4662
|
end
|
4663
|
-
|
4663
|
+
```
|
4664
4664
|
|
4665
4665
|
### Parameters
|
4666
4666
|
|
@@ -4685,7 +4685,7 @@ nil (empty response body)
|
|
4685
4685
|
|
4686
4686
|
<a name="patch_conversations_message_participant_communication"></a>
|
4687
4687
|
|
4688
|
-
##
|
4688
|
+
## [**Empty**](Empty.html) patch_conversations_message_participant_communication(conversation_id, participant_id, communication_id, body)
|
4689
4689
|
|
4690
4690
|
|
4691
4691
|
|
@@ -4700,7 +4700,7 @@ Requires NO permissions:
|
|
4700
4700
|
|
4701
4701
|
|
4702
4702
|
### Example
|
4703
|
-
|
4703
|
+
```{"language":"ruby"}
|
4704
4704
|
# load the gem
|
4705
4705
|
require 'purecloudplatformclientv2'
|
4706
4706
|
# setup authorization
|
@@ -4732,7 +4732,7 @@ begin
|
|
4732
4732
|
rescue PureCloud::ApiError => e
|
4733
4733
|
puts "Exception when calling ConversationsApi->patch_conversations_message_participant_communication: #{e}"
|
4734
4734
|
end
|
4735
|
-
|
4735
|
+
```
|
4736
4736
|
|
4737
4737
|
### Parameters
|
4738
4738
|
|
@@ -4758,7 +4758,7 @@ Name | Type | Description | Notes
|
|
4758
4758
|
|
4759
4759
|
<a name="post_analytics_conversation_details_properties"></a>
|
4760
4760
|
|
4761
|
-
##
|
4761
|
+
## [**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
4762
4762
|
|
4763
4763
|
|
4764
4764
|
|
@@ -4774,7 +4774,7 @@ Requires ANY permissions:
|
|
4774
4774
|
|
4775
4775
|
|
4776
4776
|
### Example
|
4777
|
-
|
4777
|
+
```{"language":"ruby"}
|
4778
4778
|
# load the gem
|
4779
4779
|
require 'purecloudplatformclientv2'
|
4780
4780
|
# setup authorization
|
@@ -4802,7 +4802,7 @@ begin
|
|
4802
4802
|
rescue PureCloud::ApiError => e
|
4803
4803
|
puts "Exception when calling ConversationsApi->post_analytics_conversation_details_properties: #{e}"
|
4804
4804
|
end
|
4805
|
-
|
4805
|
+
```
|
4806
4806
|
|
4807
4807
|
### Parameters
|
4808
4808
|
|
@@ -4826,7 +4826,7 @@ Name | Type | Description | Notes
|
|
4826
4826
|
|
4827
4827
|
<a name="post_analytics_conversations_aggregates_query"></a>
|
4828
4828
|
|
4829
|
-
##
|
4829
|
+
## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
4830
4830
|
|
4831
4831
|
|
4832
4832
|
|
@@ -4842,7 +4842,7 @@ Requires ANY permissions:
|
|
4842
4842
|
|
4843
4843
|
|
4844
4844
|
### Example
|
4845
|
-
|
4845
|
+
```{"language":"ruby"}
|
4846
4846
|
# load the gem
|
4847
4847
|
require 'purecloudplatformclientv2'
|
4848
4848
|
# setup authorization
|
@@ -4868,7 +4868,7 @@ begin
|
|
4868
4868
|
rescue PureCloud::ApiError => e
|
4869
4869
|
puts "Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: #{e}"
|
4870
4870
|
end
|
4871
|
-
|
4871
|
+
```
|
4872
4872
|
|
4873
4873
|
### Parameters
|
4874
4874
|
|
@@ -4891,7 +4891,7 @@ Name | Type | Description | Notes
|
|
4891
4891
|
|
4892
4892
|
<a name="post_analytics_conversations_details_query"></a>
|
4893
4893
|
|
4894
|
-
##
|
4894
|
+
## [**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|
4895
4895
|
|
4896
4896
|
|
4897
4897
|
|
@@ -4907,7 +4907,7 @@ Requires ANY permissions:
|
|
4907
4907
|
|
4908
4908
|
|
4909
4909
|
### Example
|
4910
|
-
|
4910
|
+
```{"language":"ruby"}
|
4911
4911
|
# load the gem
|
4912
4912
|
require 'purecloudplatformclientv2'
|
4913
4913
|
# setup authorization
|
@@ -4933,7 +4933,7 @@ begin
|
|
4933
4933
|
rescue PureCloud::ApiError => e
|
4934
4934
|
puts "Exception when calling ConversationsApi->post_analytics_conversations_details_query: #{e}"
|
4935
4935
|
end
|
4936
|
-
|
4936
|
+
```
|
4937
4937
|
|
4938
4938
|
### Parameters
|
4939
4939
|
|
@@ -4956,7 +4956,7 @@ Name | Type | Description | Notes
|
|
4956
4956
|
|
4957
4957
|
<a name="post_conversation_disconnect"></a>
|
4958
4958
|
|
4959
|
-
##
|
4959
|
+
## String** post_conversation_disconnect(conversation_id)
|
4960
4960
|
|
4961
4961
|
|
4962
4962
|
|
@@ -4972,7 +4972,7 @@ Requires ANY 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 ConversationsApi->post_conversation_disconnect: #{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_conversation_participant_callbacks"></a>
|
5023
5023
|
|
5024
|
-
##
|
5024
|
+
## post_conversation_participant_callbacks(conversation_id, participant_id, opts)
|
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
|
@@ -5067,7 +5067,7 @@ begin
|
|
5067
5067
|
rescue PureCloud::ApiError => e
|
5068
5068
|
puts "Exception when calling ConversationsApi->post_conversation_participant_callbacks: #{e}"
|
5069
5069
|
end
|
5070
|
-
|
5070
|
+
```
|
5071
5071
|
|
5072
5072
|
### Parameters
|
5073
5073
|
|
@@ -5092,7 +5092,7 @@ nil (empty response body)
|
|
5092
5092
|
|
5093
5093
|
<a name="post_conversation_participant_digits"></a>
|
5094
5094
|
|
5095
|
-
##
|
5095
|
+
## post_conversation_participant_digits(conversation_id, participant_id, opts)
|
5096
5096
|
|
5097
5097
|
|
5098
5098
|
|
@@ -5107,7 +5107,7 @@ Requires NO permissions:
|
|
5107
5107
|
|
5108
5108
|
|
5109
5109
|
### Example
|
5110
|
-
|
5110
|
+
```{"language":"ruby"}
|
5111
5111
|
# load the gem
|
5112
5112
|
require 'purecloudplatformclientv2'
|
5113
5113
|
# setup authorization
|
@@ -5137,7 +5137,7 @@ begin
|
|
5137
5137
|
rescue PureCloud::ApiError => e
|
5138
5138
|
puts "Exception when calling ConversationsApi->post_conversation_participant_digits: #{e}"
|
5139
5139
|
end
|
5140
|
-
|
5140
|
+
```
|
5141
5141
|
|
5142
5142
|
### Parameters
|
5143
5143
|
|
@@ -5162,7 +5162,7 @@ nil (empty response body)
|
|
5162
5162
|
|
5163
5163
|
<a name="post_conversation_participant_replace"></a>
|
5164
5164
|
|
5165
|
-
##
|
5165
|
+
## post_conversation_participant_replace(conversation_id, participant_id, body)
|
5166
5166
|
|
5167
5167
|
|
5168
5168
|
|
@@ -5177,7 +5177,7 @@ Requires NO permissions:
|
|
5177
5177
|
|
5178
5178
|
|
5179
5179
|
### Example
|
5180
|
-
|
5180
|
+
```{"language":"ruby"}
|
5181
5181
|
# load the gem
|
5182
5182
|
require 'purecloudplatformclientv2'
|
5183
5183
|
# setup authorization
|
@@ -5206,7 +5206,7 @@ begin
|
|
5206
5206
|
rescue PureCloud::ApiError => e
|
5207
5207
|
puts "Exception when calling ConversationsApi->post_conversation_participant_replace: #{e}"
|
5208
5208
|
end
|
5209
|
-
|
5209
|
+
```
|
5210
5210
|
|
5211
5211
|
### Parameters
|
5212
5212
|
|
@@ -5231,7 +5231,7 @@ nil (empty response body)
|
|
5231
5231
|
|
5232
5232
|
<a name="post_conversation_participant_secureivrsessions"></a>
|
5233
5233
|
|
5234
|
-
##
|
5234
|
+
## [**SecureSession**](SecureSession.html) post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts)
|
5235
5235
|
|
5236
5236
|
|
5237
5237
|
|
@@ -5246,7 +5246,7 @@ Requires NO permissions:
|
|
5246
5246
|
|
5247
5247
|
|
5248
5248
|
### Example
|
5249
|
-
|
5249
|
+
```{"language":"ruby"}
|
5250
5250
|
# load the gem
|
5251
5251
|
require 'purecloudplatformclientv2'
|
5252
5252
|
# setup authorization
|
@@ -5277,7 +5277,7 @@ begin
|
|
5277
5277
|
rescue PureCloud::ApiError => e
|
5278
5278
|
puts "Exception when calling ConversationsApi->post_conversation_participant_secureivrsessions: #{e}"
|
5279
5279
|
end
|
5280
|
-
|
5280
|
+
```
|
5281
5281
|
|
5282
5282
|
### Parameters
|
5283
5283
|
|
@@ -5302,7 +5302,7 @@ Name | Type | Description | Notes
|
|
5302
5302
|
|
5303
5303
|
<a name="post_conversations_call"></a>
|
5304
5304
|
|
5305
|
-
##
|
5305
|
+
## [**Conversation**](Conversation.html) post_conversations_call(conversation_id, body)
|
5306
5306
|
|
5307
5307
|
|
5308
5308
|
|
@@ -5317,7 +5317,7 @@ Requires NO permissions:
|
|
5317
5317
|
|
5318
5318
|
|
5319
5319
|
### Example
|
5320
|
-
|
5320
|
+
```{"language":"ruby"}
|
5321
5321
|
# load the gem
|
5322
5322
|
require 'purecloudplatformclientv2'
|
5323
5323
|
# setup authorization
|
@@ -5345,7 +5345,7 @@ begin
|
|
5345
5345
|
rescue PureCloud::ApiError => e
|
5346
5346
|
puts "Exception when calling ConversationsApi->post_conversations_call: #{e}"
|
5347
5347
|
end
|
5348
|
-
|
5348
|
+
```
|
5349
5349
|
|
5350
5350
|
### Parameters
|
5351
5351
|
|
@@ -5369,7 +5369,7 @@ Name | Type | Description | Notes
|
|
5369
5369
|
|
5370
5370
|
<a name="post_conversations_call_participant_consult"></a>
|
5371
5371
|
|
5372
|
-
##
|
5372
|
+
## [**ConsultTransferResponse**](ConsultTransferResponse.html) post_conversations_call_participant_consult(conversation_id, participant_id, body)
|
5373
5373
|
|
5374
5374
|
|
5375
5375
|
|
@@ -5384,7 +5384,7 @@ Requires NO permissions:
|
|
5384
5384
|
|
5385
5385
|
|
5386
5386
|
### Example
|
5387
|
-
|
5387
|
+
```{"language":"ruby"}
|
5388
5388
|
# load the gem
|
5389
5389
|
require 'purecloudplatformclientv2'
|
5390
5390
|
# setup authorization
|
@@ -5414,7 +5414,7 @@ begin
|
|
5414
5414
|
rescue PureCloud::ApiError => e
|
5415
5415
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_consult: #{e}"
|
5416
5416
|
end
|
5417
|
-
|
5417
|
+
```
|
5418
5418
|
|
5419
5419
|
### Parameters
|
5420
5420
|
|
@@ -5439,7 +5439,7 @@ Name | Type | Description | Notes
|
|
5439
5439
|
|
5440
5440
|
<a name="post_conversations_call_participant_monitor"></a>
|
5441
5441
|
|
5442
|
-
##
|
5442
|
+
## post_conversations_call_participant_monitor(conversation_id, participant_id)
|
5443
5443
|
|
5444
5444
|
|
5445
5445
|
|
@@ -5455,7 +5455,7 @@ Requires ANY permissions:
|
|
5455
5455
|
|
5456
5456
|
|
5457
5457
|
### Example
|
5458
|
-
|
5458
|
+
```{"language":"ruby"}
|
5459
5459
|
# load the gem
|
5460
5460
|
require 'purecloudplatformclientv2'
|
5461
5461
|
# setup authorization
|
@@ -5482,7 +5482,7 @@ begin
|
|
5482
5482
|
rescue PureCloud::ApiError => e
|
5483
5483
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_monitor: #{e}"
|
5484
5484
|
end
|
5485
|
-
|
5485
|
+
```
|
5486
5486
|
|
5487
5487
|
### Parameters
|
5488
5488
|
|
@@ -5506,7 +5506,7 @@ nil (empty response body)
|
|
5506
5506
|
|
5507
5507
|
<a name="post_conversations_call_participant_replace"></a>
|
5508
5508
|
|
5509
|
-
##
|
5509
|
+
## post_conversations_call_participant_replace(conversation_id, participant_id, body)
|
5510
5510
|
|
5511
5511
|
|
5512
5512
|
|
@@ -5521,7 +5521,7 @@ Requires NO permissions:
|
|
5521
5521
|
|
5522
5522
|
|
5523
5523
|
### Example
|
5524
|
-
|
5524
|
+
```{"language":"ruby"}
|
5525
5525
|
# load the gem
|
5526
5526
|
require 'purecloudplatformclientv2'
|
5527
5527
|
# setup authorization
|
@@ -5550,7 +5550,7 @@ begin
|
|
5550
5550
|
rescue PureCloud::ApiError => e
|
5551
5551
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_replace: #{e}"
|
5552
5552
|
end
|
5553
|
-
|
5553
|
+
```
|
5554
5554
|
|
5555
5555
|
### Parameters
|
5556
5556
|
|
@@ -5575,7 +5575,7 @@ nil (empty response body)
|
|
5575
5575
|
|
5576
5576
|
<a name="post_conversations_call_participants"></a>
|
5577
5577
|
|
5578
|
-
##
|
5578
|
+
## [**Conversation**](Conversation.html) post_conversations_call_participants(conversation_id, body)
|
5579
5579
|
|
5580
5580
|
|
5581
5581
|
|
@@ -5590,7 +5590,7 @@ Requires NO permissions:
|
|
5590
5590
|
|
5591
5591
|
|
5592
5592
|
### Example
|
5593
|
-
|
5593
|
+
```{"language":"ruby"}
|
5594
5594
|
# load the gem
|
5595
5595
|
require 'purecloudplatformclientv2'
|
5596
5596
|
# setup authorization
|
@@ -5618,7 +5618,7 @@ begin
|
|
5618
5618
|
rescue PureCloud::ApiError => e
|
5619
5619
|
puts "Exception when calling ConversationsApi->post_conversations_call_participants: #{e}"
|
5620
5620
|
end
|
5621
|
-
|
5621
|
+
```
|
5622
5622
|
|
5623
5623
|
### Parameters
|
5624
5624
|
|
@@ -5642,7 +5642,7 @@ Name | Type | Description | Notes
|
|
5642
5642
|
|
5643
5643
|
<a name="post_conversations_callback_participant_replace"></a>
|
5644
5644
|
|
5645
|
-
##
|
5645
|
+
## post_conversations_callback_participant_replace(conversation_id, participant_id, body)
|
5646
5646
|
|
5647
5647
|
|
5648
5648
|
|
@@ -5657,7 +5657,7 @@ Requires NO permissions:
|
|
5657
5657
|
|
5658
5658
|
|
5659
5659
|
### Example
|
5660
|
-
|
5660
|
+
```{"language":"ruby"}
|
5661
5661
|
# load the gem
|
5662
5662
|
require 'purecloudplatformclientv2'
|
5663
5663
|
# setup authorization
|
@@ -5686,7 +5686,7 @@ begin
|
|
5686
5686
|
rescue PureCloud::ApiError => e
|
5687
5687
|
puts "Exception when calling ConversationsApi->post_conversations_callback_participant_replace: #{e}"
|
5688
5688
|
end
|
5689
|
-
|
5689
|
+
```
|
5690
5690
|
|
5691
5691
|
### Parameters
|
5692
5692
|
|
@@ -5711,7 +5711,7 @@ nil (empty response body)
|
|
5711
5711
|
|
5712
5712
|
<a name="post_conversations_callbacks"></a>
|
5713
5713
|
|
5714
|
-
##
|
5714
|
+
## [**CreateCallbackResponse**](CreateCallbackResponse.html) post_conversations_callbacks(body)
|
5715
5715
|
|
5716
5716
|
|
5717
5717
|
|
@@ -5727,7 +5727,7 @@ Requires ANY permissions:
|
|
5727
5727
|
|
5728
5728
|
|
5729
5729
|
### Example
|
5730
|
-
|
5730
|
+
```{"language":"ruby"}
|
5731
5731
|
# load the gem
|
5732
5732
|
require 'purecloudplatformclientv2'
|
5733
5733
|
# setup authorization
|
@@ -5753,7 +5753,7 @@ begin
|
|
5753
5753
|
rescue PureCloud::ApiError => e
|
5754
5754
|
puts "Exception when calling ConversationsApi->post_conversations_callbacks: #{e}"
|
5755
5755
|
end
|
5756
|
-
|
5756
|
+
```
|
5757
5757
|
|
5758
5758
|
### Parameters
|
5759
5759
|
|
@@ -5776,7 +5776,7 @@ Name | Type | Description | Notes
|
|
5776
5776
|
|
5777
5777
|
<a name="post_conversations_calls"></a>
|
5778
5778
|
|
5779
|
-
##
|
5779
|
+
## [**CreateCallResponse**](CreateCallResponse.html) post_conversations_calls(body)
|
5780
5780
|
|
5781
5781
|
|
5782
5782
|
|
@@ -5792,7 +5792,7 @@ Requires ANY permissions:
|
|
5792
5792
|
|
5793
5793
|
|
5794
5794
|
### Example
|
5795
|
-
|
5795
|
+
```{"language":"ruby"}
|
5796
5796
|
# load the gem
|
5797
5797
|
require 'purecloudplatformclientv2'
|
5798
5798
|
# setup authorization
|
@@ -5818,7 +5818,7 @@ begin
|
|
5818
5818
|
rescue PureCloud::ApiError => e
|
5819
5819
|
puts "Exception when calling ConversationsApi->post_conversations_calls: #{e}"
|
5820
5820
|
end
|
5821
|
-
|
5821
|
+
```
|
5822
5822
|
|
5823
5823
|
### Parameters
|
5824
5824
|
|
@@ -5841,7 +5841,7 @@ Name | Type | Description | Notes
|
|
5841
5841
|
|
5842
5842
|
<a name="post_conversations_chat_participant_replace"></a>
|
5843
5843
|
|
5844
|
-
##
|
5844
|
+
## post_conversations_chat_participant_replace(conversation_id, participant_id, body)
|
5845
5845
|
|
5846
5846
|
|
5847
5847
|
|
@@ -5856,7 +5856,7 @@ Requires NO permissions:
|
|
5856
5856
|
|
5857
5857
|
|
5858
5858
|
### Example
|
5859
|
-
|
5859
|
+
```{"language":"ruby"}
|
5860
5860
|
# load the gem
|
5861
5861
|
require 'purecloudplatformclientv2'
|
5862
5862
|
# setup authorization
|
@@ -5885,7 +5885,7 @@ begin
|
|
5885
5885
|
rescue PureCloud::ApiError => e
|
5886
5886
|
puts "Exception when calling ConversationsApi->post_conversations_chat_participant_replace: #{e}"
|
5887
5887
|
end
|
5888
|
-
|
5888
|
+
```
|
5889
5889
|
|
5890
5890
|
### Parameters
|
5891
5891
|
|
@@ -5910,7 +5910,7 @@ nil (empty response body)
|
|
5910
5910
|
|
5911
5911
|
<a name="post_conversations_chats"></a>
|
5912
5912
|
|
5913
|
-
##
|
5913
|
+
## [**ChatConversation**](ChatConversation.html) post_conversations_chats(body)
|
5914
5914
|
|
5915
5915
|
|
5916
5916
|
|
@@ -5926,7 +5926,7 @@ Requires ANY permissions:
|
|
5926
5926
|
|
5927
5927
|
|
5928
5928
|
### Example
|
5929
|
-
|
5929
|
+
```{"language":"ruby"}
|
5930
5930
|
# load the gem
|
5931
5931
|
require 'purecloudplatformclientv2'
|
5932
5932
|
# setup authorization
|
@@ -5952,7 +5952,7 @@ begin
|
|
5952
5952
|
rescue PureCloud::ApiError => e
|
5953
5953
|
puts "Exception when calling ConversationsApi->post_conversations_chats: #{e}"
|
5954
5954
|
end
|
5955
|
-
|
5955
|
+
```
|
5956
5956
|
|
5957
5957
|
### Parameters
|
5958
5958
|
|
@@ -5975,7 +5975,7 @@ Name | Type | Description | Notes
|
|
5975
5975
|
|
5976
5976
|
<a name="post_conversations_cobrowsesession_participant_replace"></a>
|
5977
5977
|
|
5978
|
-
##
|
5978
|
+
## post_conversations_cobrowsesession_participant_replace(conversation_id, participant_id, opts)
|
5979
5979
|
|
5980
5980
|
|
5981
5981
|
|
@@ -5990,7 +5990,7 @@ Requires NO permissions:
|
|
5990
5990
|
|
5991
5991
|
|
5992
5992
|
### Example
|
5993
|
-
|
5993
|
+
```{"language":"ruby"}
|
5994
5994
|
# load the gem
|
5995
5995
|
require 'purecloudplatformclientv2'
|
5996
5996
|
# setup authorization
|
@@ -6020,7 +6020,7 @@ begin
|
|
6020
6020
|
rescue PureCloud::ApiError => e
|
6021
6021
|
puts "Exception when calling ConversationsApi->post_conversations_cobrowsesession_participant_replace: #{e}"
|
6022
6022
|
end
|
6023
|
-
|
6023
|
+
```
|
6024
6024
|
|
6025
6025
|
### Parameters
|
6026
6026
|
|
@@ -6045,7 +6045,7 @@ nil (empty response body)
|
|
6045
6045
|
|
6046
6046
|
<a name="post_conversations_email_inboundmessages"></a>
|
6047
6047
|
|
6048
|
-
##
|
6048
|
+
## [**EmailConversation**](EmailConversation.html) post_conversations_email_inboundmessages(conversation_id, body)
|
6049
6049
|
|
6050
6050
|
|
6051
6051
|
|
@@ -6060,7 +6060,7 @@ Requires NO permissions:
|
|
6060
6060
|
|
6061
6061
|
|
6062
6062
|
### Example
|
6063
|
-
|
6063
|
+
```{"language":"ruby"}
|
6064
6064
|
# load the gem
|
6065
6065
|
require 'purecloudplatformclientv2'
|
6066
6066
|
# setup authorization
|
@@ -6088,7 +6088,7 @@ begin
|
|
6088
6088
|
rescue PureCloud::ApiError => e
|
6089
6089
|
puts "Exception when calling ConversationsApi->post_conversations_email_inboundmessages: #{e}"
|
6090
6090
|
end
|
6091
|
-
|
6091
|
+
```
|
6092
6092
|
|
6093
6093
|
### Parameters
|
6094
6094
|
|
@@ -6112,7 +6112,7 @@ Name | Type | Description | Notes
|
|
6112
6112
|
|
6113
6113
|
<a name="post_conversations_email_messages"></a>
|
6114
6114
|
|
6115
|
-
##
|
6115
|
+
## [**EmailMessage**](EmailMessage.html) post_conversations_email_messages(conversation_id, body)
|
6116
6116
|
|
6117
6117
|
|
6118
6118
|
|
@@ -6127,7 +6127,7 @@ Requires NO permissions:
|
|
6127
6127
|
|
6128
6128
|
|
6129
6129
|
### Example
|
6130
|
-
|
6130
|
+
```{"language":"ruby"}
|
6131
6131
|
# load the gem
|
6132
6132
|
require 'purecloudplatformclientv2'
|
6133
6133
|
# setup authorization
|
@@ -6155,7 +6155,7 @@ begin
|
|
6155
6155
|
rescue PureCloud::ApiError => e
|
6156
6156
|
puts "Exception when calling ConversationsApi->post_conversations_email_messages: #{e}"
|
6157
6157
|
end
|
6158
|
-
|
6158
|
+
```
|
6159
6159
|
|
6160
6160
|
### Parameters
|
6161
6161
|
|
@@ -6179,7 +6179,7 @@ Name | Type | Description | Notes
|
|
6179
6179
|
|
6180
6180
|
<a name="post_conversations_email_participant_replace"></a>
|
6181
6181
|
|
6182
|
-
##
|
6182
|
+
## post_conversations_email_participant_replace(conversation_id, participant_id, body)
|
6183
6183
|
|
6184
6184
|
|
6185
6185
|
|
@@ -6194,7 +6194,7 @@ Requires NO permissions:
|
|
6194
6194
|
|
6195
6195
|
|
6196
6196
|
### Example
|
6197
|
-
|
6197
|
+
```{"language":"ruby"}
|
6198
6198
|
# load the gem
|
6199
6199
|
require 'purecloudplatformclientv2'
|
6200
6200
|
# setup authorization
|
@@ -6223,7 +6223,7 @@ begin
|
|
6223
6223
|
rescue PureCloud::ApiError => e
|
6224
6224
|
puts "Exception when calling ConversationsApi->post_conversations_email_participant_replace: #{e}"
|
6225
6225
|
end
|
6226
|
-
|
6226
|
+
```
|
6227
6227
|
|
6228
6228
|
### Parameters
|
6229
6229
|
|
@@ -6248,7 +6248,7 @@ nil (empty response body)
|
|
6248
6248
|
|
6249
6249
|
<a name="post_conversations_emails"></a>
|
6250
6250
|
|
6251
|
-
##
|
6251
|
+
## [**EmailConversation**](EmailConversation.html) post_conversations_emails(body)
|
6252
6252
|
|
6253
6253
|
|
6254
6254
|
|
@@ -6264,7 +6264,7 @@ Requires ANY permissions:
|
|
6264
6264
|
|
6265
6265
|
|
6266
6266
|
### Example
|
6267
|
-
|
6267
|
+
```{"language":"ruby"}
|
6268
6268
|
# load the gem
|
6269
6269
|
require 'purecloudplatformclientv2'
|
6270
6270
|
# setup authorization
|
@@ -6290,7 +6290,7 @@ begin
|
|
6290
6290
|
rescue PureCloud::ApiError => e
|
6291
6291
|
puts "Exception when calling ConversationsApi->post_conversations_emails: #{e}"
|
6292
6292
|
end
|
6293
|
-
|
6293
|
+
```
|
6294
6294
|
|
6295
6295
|
### Parameters
|
6296
6296
|
|
@@ -6313,7 +6313,7 @@ Name | Type | Description | Notes
|
|
6313
6313
|
|
6314
6314
|
<a name="post_conversations_faxes"></a>
|
6315
6315
|
|
6316
|
-
##
|
6316
|
+
## [**FaxSendResponse**](FaxSendResponse.html) post_conversations_faxes(body)
|
6317
6317
|
|
6318
6318
|
|
6319
6319
|
|
@@ -6328,7 +6328,7 @@ Requires NO permissions:
|
|
6328
6328
|
|
6329
6329
|
|
6330
6330
|
### Example
|
6331
|
-
|
6331
|
+
```{"language":"ruby"}
|
6332
6332
|
# load the gem
|
6333
6333
|
require 'purecloudplatformclientv2'
|
6334
6334
|
# setup authorization
|
@@ -6354,7 +6354,7 @@ begin
|
|
6354
6354
|
rescue PureCloud::ApiError => e
|
6355
6355
|
puts "Exception when calling ConversationsApi->post_conversations_faxes: #{e}"
|
6356
6356
|
end
|
6357
|
-
|
6357
|
+
```
|
6358
6358
|
|
6359
6359
|
### Parameters
|
6360
6360
|
|
@@ -6377,7 +6377,7 @@ Name | Type | Description | Notes
|
|
6377
6377
|
|
6378
6378
|
<a name="post_conversations_message_communication_messages"></a>
|
6379
6379
|
|
6380
|
-
##
|
6380
|
+
## [**MessageData**](MessageData.html) post_conversations_message_communication_messages(conversation_id, communication_id, body)
|
6381
6381
|
|
6382
6382
|
|
6383
6383
|
|
@@ -6393,7 +6393,7 @@ Requires ANY permissions:
|
|
6393
6393
|
|
6394
6394
|
|
6395
6395
|
### Example
|
6396
|
-
|
6396
|
+
```{"language":"ruby"}
|
6397
6397
|
# load the gem
|
6398
6398
|
require 'purecloudplatformclientv2'
|
6399
6399
|
# setup authorization
|
@@ -6423,7 +6423,7 @@ begin
|
|
6423
6423
|
rescue PureCloud::ApiError => e
|
6424
6424
|
puts "Exception when calling ConversationsApi->post_conversations_message_communication_messages: #{e}"
|
6425
6425
|
end
|
6426
|
-
|
6426
|
+
```
|
6427
6427
|
|
6428
6428
|
### Parameters
|
6429
6429
|
|
@@ -6448,7 +6448,7 @@ Name | Type | Description | Notes
|
|
6448
6448
|
|
6449
6449
|
<a name="post_conversations_message_communication_messages_media"></a>
|
6450
6450
|
|
6451
|
-
##
|
6451
|
+
## [**MessageMediaData**](MessageMediaData.html) post_conversations_message_communication_messages_media(conversation_id, communication_id)
|
6452
6452
|
|
6453
6453
|
|
6454
6454
|
|
@@ -6464,7 +6464,7 @@ Requires ANY permissions:
|
|
6464
6464
|
|
6465
6465
|
|
6466
6466
|
### Example
|
6467
|
-
|
6467
|
+
```{"language":"ruby"}
|
6468
6468
|
# load the gem
|
6469
6469
|
require 'purecloudplatformclientv2'
|
6470
6470
|
# setup authorization
|
@@ -6492,7 +6492,7 @@ begin
|
|
6492
6492
|
rescue PureCloud::ApiError => e
|
6493
6493
|
puts "Exception when calling ConversationsApi->post_conversations_message_communication_messages_media: #{e}"
|
6494
6494
|
end
|
6495
|
-
|
6495
|
+
```
|
6496
6496
|
|
6497
6497
|
### Parameters
|
6498
6498
|
|
@@ -6516,7 +6516,7 @@ Name | Type | Description | Notes
|
|
6516
6516
|
|
6517
6517
|
<a name="post_conversations_message_messages_bulk"></a>
|
6518
6518
|
|
6519
|
-
##
|
6519
|
+
## [**TextMessageListing**](TextMessageListing.html) post_conversations_message_messages_bulk(conversation_id, opts)
|
6520
6520
|
|
6521
6521
|
|
6522
6522
|
|
@@ -6532,7 +6532,7 @@ Requires ANY permissions:
|
|
6532
6532
|
|
6533
6533
|
|
6534
6534
|
### Example
|
6535
|
-
|
6535
|
+
```{"language":"ruby"}
|
6536
6536
|
# load the gem
|
6537
6537
|
require 'purecloudplatformclientv2'
|
6538
6538
|
# setup authorization
|
@@ -6561,7 +6561,7 @@ begin
|
|
6561
6561
|
rescue PureCloud::ApiError => e
|
6562
6562
|
puts "Exception when calling ConversationsApi->post_conversations_message_messages_bulk: #{e}"
|
6563
6563
|
end
|
6564
|
-
|
6564
|
+
```
|
6565
6565
|
|
6566
6566
|
### Parameters
|
6567
6567
|
|
@@ -6585,7 +6585,7 @@ Name | Type | Description | Notes
|
|
6585
6585
|
|
6586
6586
|
<a name="post_conversations_message_participant_replace"></a>
|
6587
6587
|
|
6588
|
-
##
|
6588
|
+
## post_conversations_message_participant_replace(conversation_id, participant_id, body)
|
6589
6589
|
|
6590
6590
|
|
6591
6591
|
|
@@ -6600,7 +6600,7 @@ Requires NO permissions:
|
|
6600
6600
|
|
6601
6601
|
|
6602
6602
|
### Example
|
6603
|
-
|
6603
|
+
```{"language":"ruby"}
|
6604
6604
|
# load the gem
|
6605
6605
|
require 'purecloudplatformclientv2'
|
6606
6606
|
# setup authorization
|
@@ -6629,7 +6629,7 @@ begin
|
|
6629
6629
|
rescue PureCloud::ApiError => e
|
6630
6630
|
puts "Exception when calling ConversationsApi->post_conversations_message_participant_replace: #{e}"
|
6631
6631
|
end
|
6632
|
-
|
6632
|
+
```
|
6633
6633
|
|
6634
6634
|
### Parameters
|
6635
6635
|
|
@@ -6654,7 +6654,7 @@ nil (empty response body)
|
|
6654
6654
|
|
6655
6655
|
<a name="post_conversations_messages"></a>
|
6656
6656
|
|
6657
|
-
##
|
6657
|
+
## [**MessageConversation**](MessageConversation.html) post_conversations_messages(body)
|
6658
6658
|
|
6659
6659
|
|
6660
6660
|
|
@@ -6670,7 +6670,7 @@ Requires ANY permissions:
|
|
6670
6670
|
|
6671
6671
|
|
6672
6672
|
### Example
|
6673
|
-
|
6673
|
+
```{"language":"ruby"}
|
6674
6674
|
# load the gem
|
6675
6675
|
require 'purecloudplatformclientv2'
|
6676
6676
|
# setup authorization
|
@@ -6696,7 +6696,7 @@ begin
|
|
6696
6696
|
rescue PureCloud::ApiError => e
|
6697
6697
|
puts "Exception when calling ConversationsApi->post_conversations_messages: #{e}"
|
6698
6698
|
end
|
6699
|
-
|
6699
|
+
```
|
6700
6700
|
|
6701
6701
|
### Parameters
|
6702
6702
|
|
@@ -6719,7 +6719,7 @@ Name | Type | Description | Notes
|
|
6719
6719
|
|
6720
6720
|
<a name="put_conversations_call_participant_communication_uuidata"></a>
|
6721
6721
|
|
6722
|
-
##
|
6722
|
+
## [**Empty**](Empty.html) put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body)
|
6723
6723
|
|
6724
6724
|
|
6725
6725
|
|
@@ -6734,7 +6734,7 @@ Requires NO permissions:
|
|
6734
6734
|
|
6735
6735
|
|
6736
6736
|
### Example
|
6737
|
-
|
6737
|
+
```{"language":"ruby"}
|
6738
6738
|
# load the gem
|
6739
6739
|
require 'purecloudplatformclientv2'
|
6740
6740
|
# setup authorization
|
@@ -6766,7 +6766,7 @@ begin
|
|
6766
6766
|
rescue PureCloud::ApiError => e
|
6767
6767
|
puts "Exception when calling ConversationsApi->put_conversations_call_participant_communication_uuidata: #{e}"
|
6768
6768
|
end
|
6769
|
-
|
6769
|
+
```
|
6770
6770
|
|
6771
6771
|
### Parameters
|
6772
6772
|
|
@@ -6792,7 +6792,7 @@ Name | Type | Description | Notes
|
|
6792
6792
|
|
6793
6793
|
<a name="put_conversations_email_messages_draft"></a>
|
6794
6794
|
|
6795
|
-
##
|
6795
|
+
## [**EmailMessage**](EmailMessage.html) put_conversations_email_messages_draft(conversation_id, body)
|
6796
6796
|
|
6797
6797
|
|
6798
6798
|
|
@@ -6807,7 +6807,7 @@ Requires NO permissions:
|
|
6807
6807
|
|
6808
6808
|
|
6809
6809
|
### Example
|
6810
|
-
|
6810
|
+
```{"language":"ruby"}
|
6811
6811
|
# load the gem
|
6812
6812
|
require 'purecloudplatformclientv2'
|
6813
6813
|
# setup authorization
|
@@ -6835,7 +6835,7 @@ begin
|
|
6835
6835
|
rescue PureCloud::ApiError => e
|
6836
6836
|
puts "Exception when calling ConversationsApi->put_conversations_email_messages_draft: #{e}"
|
6837
6837
|
end
|
6838
|
-
|
6838
|
+
```
|
6839
6839
|
|
6840
6840
|
### Parameters
|
6841
6841
|
|