purecloudplatformclientv2 35.0.0 → 36.0.0
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 +2 -2
- data/docs/AdditionalMessage.md +2 -0
- data/docs/AlertingApi.md +0 -2
- data/docs/AnalyticsApi.md +0 -13
- data/docs/ArchitectApi.md +210 -150
- data/docs/AttributesApi.md +0 -6
- data/docs/AuthorizationApi.md +15 -7
- data/docs/BillingApi.md +4 -1
- data/docs/CampaignDivisionView.md +1 -1
- data/docs/ContentManagementApi.md +0 -38
- data/docs/ConversationsApi.md +141 -75
- data/docs/CreateQueueRequest.md +1 -1
- data/docs/Division.md +15 -0
- data/docs/FaxApi.md +0 -6
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionView.md +1 -0
- data/docs/FreeSeatingConfiguration.md +1 -1
- data/docs/GeolocationApi.md +0 -3
- data/docs/GreetingsApi.md +0 -16
- data/docs/GroupsApi.md +2 -12
- data/docs/IdentityProviderApi.md +18 -9
- data/docs/IntegrationsApi.md +26 -31
- data/docs/LanguagesApi.md +0 -4
- data/docs/LicenseApi.md +21 -8
- data/docs/LocationsApi.md +0 -3
- data/docs/ManagementUnit.md +1 -0
- data/docs/MessageData.md +1 -0
- data/docs/MessageDetails.md +1 -0
- data/docs/MessageMedia.md +3 -0
- data/docs/MessageMediaData.md +20 -0
- data/docs/MessageSticker.md +14 -0
- data/docs/MobileDevicesApi.md +0 -5
- data/docs/NotificationsApi.md +0 -7
- data/docs/OrganizationApi.md +0 -2
- data/docs/OrganizationAuthorizationApi.md +16 -6
- data/docs/OutboundApi.md +8 -6
- data/docs/OutboundSettings.md +1 -0
- data/docs/PresenceApi.md +0 -5
- data/docs/QualityApi.md +0 -21
- data/docs/Queue.md +1 -1
- data/docs/RecordingApi.md +0 -17
- data/docs/ResponseManagementApi.md +0 -11
- data/docs/RoutingApi.md +93 -9
- data/docs/SearchApi.md +0 -14
- data/docs/StationsApi.md +0 -3
- data/docs/SuggestApi.md +0 -4
- data/docs/SurveyForm.md +3 -1
- data/docs/TelephonyProvidersEdgeApi.md +4 -16
- data/docs/TokensApi.md +0 -2
- data/docs/UserQueue.md +1 -1
- data/docs/UserRecordingsApi.md +0 -6
- data/docs/UsersApi.md +31 -42
- data/docs/UtilitiesApi.md +0 -3
- data/docs/VoicemailApi.md +8 -21
- data/docs/WorkforceManagementApi.md +25 -4
- data/lib/purecloudplatformclientv2.rb +3 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +136 -102
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +160 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +122 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +22 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/additional_message.rb +60 -4
- data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/division.rb +253 -0
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +27 -1
- data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +23 -9
- data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
- data/lib/purecloudplatformclientv2/models/message_data.rb +29 -1
- data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
- data/lib/purecloudplatformclientv2/models/message_media.rb +82 -4
- data/lib/purecloudplatformclientv2/models/message_media_data.rb +411 -0
- data/lib/purecloudplatformclientv2/models/message_sticker.rb +228 -0
- data/lib/purecloudplatformclientv2/models/outbound_settings.rb +27 -1
- data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_form.rb +53 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +8 -2
data/docs/AttributesApi.md
CHANGED
|
@@ -32,7 +32,6 @@ Requires NO permissions:
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
|
|
36
35
|
### Example
|
|
37
36
|
~~~ruby
|
|
38
37
|
# load the gem
|
|
@@ -96,7 +95,6 @@ Requires NO permissions:
|
|
|
96
95
|
|
|
97
96
|
|
|
98
97
|
|
|
99
|
-
|
|
100
98
|
### Example
|
|
101
99
|
~~~ruby
|
|
102
100
|
# load the gem
|
|
@@ -161,7 +159,6 @@ Requires NO permissions:
|
|
|
161
159
|
|
|
162
160
|
|
|
163
161
|
|
|
164
|
-
|
|
165
162
|
### Example
|
|
166
163
|
~~~ruby
|
|
167
164
|
# load the gem
|
|
@@ -229,7 +226,6 @@ Requires NO permissions:
|
|
|
229
226
|
|
|
230
227
|
|
|
231
228
|
|
|
232
|
-
|
|
233
229
|
### Example
|
|
234
230
|
~~~ruby
|
|
235
231
|
# load the gem
|
|
@@ -294,7 +290,6 @@ Requires NO permissions:
|
|
|
294
290
|
|
|
295
291
|
|
|
296
292
|
|
|
297
|
-
|
|
298
293
|
### Example
|
|
299
294
|
~~~ruby
|
|
300
295
|
# load the gem
|
|
@@ -359,7 +354,6 @@ Requires NO permissions:
|
|
|
359
354
|
|
|
360
355
|
|
|
361
356
|
|
|
362
|
-
|
|
363
357
|
### Example
|
|
364
358
|
~~~ruby
|
|
365
359
|
# load the gem
|
data/docs/AuthorizationApi.md
CHANGED
|
@@ -41,7 +41,9 @@ Wraps DELETE /api/v2/authorization/roles/{roleId}
|
|
|
41
41
|
|
|
42
42
|
Requires ANY permissions:
|
|
43
43
|
|
|
44
|
-
* admin
|
|
44
|
+
* admin
|
|
45
|
+
* role_manager
|
|
46
|
+
* authorization:role:delete
|
|
45
47
|
|
|
46
48
|
|
|
47
49
|
### Example
|
|
@@ -105,7 +107,9 @@ Wraps DELETE /api/v2/users/{userId}/roles
|
|
|
105
107
|
|
|
106
108
|
Requires ANY permissions:
|
|
107
109
|
|
|
108
|
-
* admin
|
|
110
|
+
* admin
|
|
111
|
+
* role_manager
|
|
112
|
+
* authorization:grant:delete
|
|
109
113
|
|
|
110
114
|
|
|
111
115
|
### Example
|
|
@@ -171,7 +175,6 @@ Requires NO permissions:
|
|
|
171
175
|
|
|
172
176
|
|
|
173
177
|
|
|
174
|
-
|
|
175
178
|
### Example
|
|
176
179
|
~~~ruby
|
|
177
180
|
# load the gem
|
|
@@ -239,7 +242,6 @@ Requires NO permissions:
|
|
|
239
242
|
|
|
240
243
|
|
|
241
244
|
|
|
242
|
-
|
|
243
245
|
### Example
|
|
244
246
|
~~~ruby
|
|
245
247
|
# load the gem
|
|
@@ -580,7 +582,9 @@ Wraps PATCH /api/v2/authorization/roles/{roleId}
|
|
|
580
582
|
|
|
581
583
|
Requires ANY permissions:
|
|
582
584
|
|
|
583
|
-
* admin
|
|
585
|
+
* admin
|
|
586
|
+
* role_manager
|
|
587
|
+
* authorization:role:edit
|
|
584
588
|
|
|
585
589
|
|
|
586
590
|
### Example
|
|
@@ -850,7 +854,9 @@ Wraps PUT /api/v2/authorization/roles/{roleId}
|
|
|
850
854
|
|
|
851
855
|
Requires ANY permissions:
|
|
852
856
|
|
|
853
|
-
* admin
|
|
857
|
+
* admin
|
|
858
|
+
* role_manager
|
|
859
|
+
* authorization:role:edit
|
|
854
860
|
|
|
855
861
|
|
|
856
862
|
### Example
|
|
@@ -1119,7 +1125,9 @@ Wraps PUT /api/v2/users/{userId}/roles
|
|
|
1119
1125
|
|
|
1120
1126
|
Requires ANY permissions:
|
|
1121
1127
|
|
|
1122
|
-
* admin
|
|
1128
|
+
* admin
|
|
1129
|
+
* role_manager
|
|
1130
|
+
* authorization:grant:add
|
|
1123
1131
|
|
|
1124
1132
|
|
|
1125
1133
|
### Example
|
data/docs/BillingApi.md
CHANGED
|
@@ -25,7 +25,10 @@ Wraps GET /api/v2/billing/reports/billableusage
|
|
|
25
25
|
|
|
26
26
|
Requires ANY permissions:
|
|
27
27
|
|
|
28
|
-
* billing:subscription:read
|
|
28
|
+
* billing:subscription:read
|
|
29
|
+
* billing:subscription:view
|
|
30
|
+
* billing:subscription:create
|
|
31
|
+
* billing:subscription:add
|
|
29
32
|
|
|
30
33
|
|
|
31
34
|
### Example
|
|
@@ -9,7 +9,7 @@ title: CampaignDivisionView
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
|
-
| **division** | [**
|
|
12
|
+
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
13
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
14
14
|
{: class="table table-striped"}
|
|
15
15
|
|
|
@@ -64,7 +64,6 @@ Requires NO permissions:
|
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
|
|
67
|
-
|
|
68
67
|
### Example
|
|
69
68
|
~~~ruby
|
|
70
69
|
# load the gem
|
|
@@ -132,7 +131,6 @@ Requires NO permissions:
|
|
|
132
131
|
|
|
133
132
|
|
|
134
133
|
|
|
135
|
-
|
|
136
134
|
### Example
|
|
137
135
|
~~~ruby
|
|
138
136
|
# load the gem
|
|
@@ -196,7 +194,6 @@ Requires NO permissions:
|
|
|
196
194
|
|
|
197
195
|
|
|
198
196
|
|
|
199
|
-
|
|
200
197
|
### Example
|
|
201
198
|
~~~ruby
|
|
202
199
|
# load the gem
|
|
@@ -260,7 +257,6 @@ Requires NO permissions:
|
|
|
260
257
|
|
|
261
258
|
|
|
262
259
|
|
|
263
|
-
|
|
264
260
|
### Example
|
|
265
261
|
~~~ruby
|
|
266
262
|
# load the gem
|
|
@@ -328,7 +324,6 @@ Requires NO permissions:
|
|
|
328
324
|
|
|
329
325
|
|
|
330
326
|
|
|
331
|
-
|
|
332
327
|
### Example
|
|
333
328
|
~~~ruby
|
|
334
329
|
# load the gem
|
|
@@ -395,7 +390,6 @@ Requires NO permissions:
|
|
|
395
390
|
|
|
396
391
|
|
|
397
392
|
|
|
398
|
-
|
|
399
393
|
### Example
|
|
400
394
|
~~~ruby
|
|
401
395
|
# load the gem
|
|
@@ -462,7 +456,6 @@ Requires NO permissions:
|
|
|
462
456
|
|
|
463
457
|
|
|
464
458
|
|
|
465
|
-
|
|
466
459
|
### Example
|
|
467
460
|
~~~ruby
|
|
468
461
|
# load the gem
|
|
@@ -531,7 +524,6 @@ Requires NO permissions:
|
|
|
531
524
|
|
|
532
525
|
|
|
533
526
|
|
|
534
|
-
|
|
535
527
|
### Example
|
|
536
528
|
~~~ruby
|
|
537
529
|
# load the gem
|
|
@@ -610,7 +602,6 @@ Requires NO permissions:
|
|
|
610
602
|
|
|
611
603
|
|
|
612
604
|
|
|
613
|
-
|
|
614
605
|
### Example
|
|
615
606
|
~~~ruby
|
|
616
607
|
# load the gem
|
|
@@ -681,7 +672,6 @@ Requires NO permissions:
|
|
|
681
672
|
|
|
682
673
|
|
|
683
674
|
|
|
684
|
-
|
|
685
675
|
### Example
|
|
686
676
|
~~~ruby
|
|
687
677
|
# load the gem
|
|
@@ -760,7 +750,6 @@ Requires NO permissions:
|
|
|
760
750
|
|
|
761
751
|
|
|
762
752
|
|
|
763
|
-
|
|
764
753
|
### Example
|
|
765
754
|
~~~ruby
|
|
766
755
|
# load the gem
|
|
@@ -837,7 +826,6 @@ Requires NO permissions:
|
|
|
837
826
|
|
|
838
827
|
|
|
839
828
|
|
|
840
|
-
|
|
841
829
|
### Example
|
|
842
830
|
~~~ruby
|
|
843
831
|
# load the gem
|
|
@@ -902,7 +890,6 @@ Requires NO permissions:
|
|
|
902
890
|
|
|
903
891
|
|
|
904
892
|
|
|
905
|
-
|
|
906
893
|
### Example
|
|
907
894
|
~~~ruby
|
|
908
895
|
# load the gem
|
|
@@ -961,7 +948,6 @@ Requires NO permissions:
|
|
|
961
948
|
|
|
962
949
|
|
|
963
950
|
|
|
964
|
-
|
|
965
951
|
### Example
|
|
966
952
|
~~~ruby
|
|
967
953
|
# load the gem
|
|
@@ -1030,7 +1016,6 @@ Requires NO permissions:
|
|
|
1030
1016
|
|
|
1031
1017
|
|
|
1032
1018
|
|
|
1033
|
-
|
|
1034
1019
|
### Example
|
|
1035
1020
|
~~~ruby
|
|
1036
1021
|
# load the gem
|
|
@@ -1105,7 +1090,6 @@ Requires NO permissions:
|
|
|
1105
1090
|
|
|
1106
1091
|
|
|
1107
1092
|
|
|
1108
|
-
|
|
1109
1093
|
### Example
|
|
1110
1094
|
~~~ruby
|
|
1111
1095
|
# load the gem
|
|
@@ -1177,7 +1161,6 @@ Requires NO permissions:
|
|
|
1177
1161
|
|
|
1178
1162
|
|
|
1179
1163
|
|
|
1180
|
-
|
|
1181
1164
|
### Example
|
|
1182
1165
|
~~~ruby
|
|
1183
1166
|
# load the gem
|
|
@@ -1245,7 +1228,6 @@ Requires NO permissions:
|
|
|
1245
1228
|
|
|
1246
1229
|
|
|
1247
1230
|
|
|
1248
|
-
|
|
1249
1231
|
### Example
|
|
1250
1232
|
~~~ruby
|
|
1251
1233
|
# load the gem
|
|
@@ -1310,7 +1292,6 @@ Requires NO permissions:
|
|
|
1310
1292
|
|
|
1311
1293
|
|
|
1312
1294
|
|
|
1313
|
-
|
|
1314
1295
|
### Example
|
|
1315
1296
|
~~~ruby
|
|
1316
1297
|
# load the gem
|
|
@@ -1369,7 +1350,6 @@ Requires NO permissions:
|
|
|
1369
1350
|
|
|
1370
1351
|
|
|
1371
1352
|
|
|
1372
|
-
|
|
1373
1353
|
### Example
|
|
1374
1354
|
~~~ruby
|
|
1375
1355
|
# load the gem
|
|
@@ -1438,7 +1418,6 @@ Requires NO permissions:
|
|
|
1438
1418
|
|
|
1439
1419
|
|
|
1440
1420
|
|
|
1441
|
-
|
|
1442
1421
|
### Example
|
|
1443
1422
|
~~~ruby
|
|
1444
1423
|
# load the gem
|
|
@@ -1515,7 +1494,6 @@ Requires NO permissions:
|
|
|
1515
1494
|
|
|
1516
1495
|
|
|
1517
1496
|
|
|
1518
|
-
|
|
1519
1497
|
### Example
|
|
1520
1498
|
~~~ruby
|
|
1521
1499
|
# load the gem
|
|
@@ -1587,7 +1565,6 @@ Requires NO permissions:
|
|
|
1587
1565
|
|
|
1588
1566
|
|
|
1589
1567
|
|
|
1590
|
-
|
|
1591
1568
|
### Example
|
|
1592
1569
|
~~~ruby
|
|
1593
1570
|
# load the gem
|
|
@@ -1660,7 +1637,6 @@ Requires NO permissions:
|
|
|
1660
1637
|
|
|
1661
1638
|
|
|
1662
1639
|
|
|
1663
|
-
|
|
1664
1640
|
### Example
|
|
1665
1641
|
~~~ruby
|
|
1666
1642
|
# load the gem
|
|
@@ -1732,7 +1708,6 @@ Requires NO permissions:
|
|
|
1732
1708
|
|
|
1733
1709
|
|
|
1734
1710
|
|
|
1735
|
-
|
|
1736
1711
|
### Example
|
|
1737
1712
|
~~~ruby
|
|
1738
1713
|
# load the gem
|
|
@@ -1807,7 +1782,6 @@ Requires NO permissions:
|
|
|
1807
1782
|
|
|
1808
1783
|
|
|
1809
1784
|
|
|
1810
|
-
|
|
1811
1785
|
### Example
|
|
1812
1786
|
~~~ruby
|
|
1813
1787
|
# load the gem
|
|
@@ -1879,7 +1853,6 @@ Requires NO permissions:
|
|
|
1879
1853
|
|
|
1880
1854
|
|
|
1881
1855
|
|
|
1882
|
-
|
|
1883
1856
|
### Example
|
|
1884
1857
|
~~~ruby
|
|
1885
1858
|
# load the gem
|
|
@@ -1944,7 +1917,6 @@ Requires NO permissions:
|
|
|
1944
1917
|
|
|
1945
1918
|
|
|
1946
1919
|
|
|
1947
|
-
|
|
1948
1920
|
### Example
|
|
1949
1921
|
~~~ruby
|
|
1950
1922
|
# load the gem
|
|
@@ -2018,7 +1990,6 @@ Requires NO permissions:
|
|
|
2018
1990
|
|
|
2019
1991
|
|
|
2020
1992
|
|
|
2021
|
-
|
|
2022
1993
|
### Example
|
|
2023
1994
|
~~~ruby
|
|
2024
1995
|
# load the gem
|
|
@@ -2090,7 +2061,6 @@ Requires NO permissions:
|
|
|
2090
2061
|
|
|
2091
2062
|
|
|
2092
2063
|
|
|
2093
|
-
|
|
2094
2064
|
### Example
|
|
2095
2065
|
~~~ruby
|
|
2096
2066
|
# load the gem
|
|
@@ -2163,7 +2133,6 @@ Requires NO permissions:
|
|
|
2163
2133
|
|
|
2164
2134
|
|
|
2165
2135
|
|
|
2166
|
-
|
|
2167
2136
|
### Example
|
|
2168
2137
|
~~~ruby
|
|
2169
2138
|
# load the gem
|
|
@@ -2232,7 +2201,6 @@ Requires NO permissions:
|
|
|
2232
2201
|
|
|
2233
2202
|
|
|
2234
2203
|
|
|
2235
|
-
|
|
2236
2204
|
### Example
|
|
2237
2205
|
~~~ruby
|
|
2238
2206
|
# load the gem
|
|
@@ -2297,7 +2265,6 @@ Requires NO permissions:
|
|
|
2297
2265
|
|
|
2298
2266
|
|
|
2299
2267
|
|
|
2300
|
-
|
|
2301
2268
|
### Example
|
|
2302
2269
|
~~~ruby
|
|
2303
2270
|
# load the gem
|
|
@@ -2365,7 +2332,6 @@ Requires NO permissions:
|
|
|
2365
2332
|
|
|
2366
2333
|
|
|
2367
2334
|
|
|
2368
|
-
|
|
2369
2335
|
### Example
|
|
2370
2336
|
~~~ruby
|
|
2371
2337
|
# load the gem
|
|
@@ -2437,7 +2403,6 @@ Requires NO permissions:
|
|
|
2437
2403
|
|
|
2438
2404
|
|
|
2439
2405
|
|
|
2440
|
-
|
|
2441
2406
|
### Example
|
|
2442
2407
|
~~~ruby
|
|
2443
2408
|
# load the gem
|
|
@@ -2502,7 +2467,6 @@ Requires NO permissions:
|
|
|
2502
2467
|
|
|
2503
2468
|
|
|
2504
2469
|
|
|
2505
|
-
|
|
2506
2470
|
### Example
|
|
2507
2471
|
~~~ruby
|
|
2508
2472
|
# load the gem
|
|
@@ -2570,7 +2534,6 @@ Requires NO permissions:
|
|
|
2570
2534
|
|
|
2571
2535
|
|
|
2572
2536
|
|
|
2573
|
-
|
|
2574
2537
|
### Example
|
|
2575
2538
|
~~~ruby
|
|
2576
2539
|
# load the gem
|
|
@@ -2641,7 +2604,6 @@ Requires NO permissions:
|
|
|
2641
2604
|
|
|
2642
2605
|
|
|
2643
2606
|
|
|
2644
|
-
|
|
2645
2607
|
### Example
|
|
2646
2608
|
~~~ruby
|
|
2647
2609
|
# load the gem
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -44,6 +44,7 @@ Method | Description
|
|
|
44
44
|
[**get_conversations_email_participant_wrapupcodes**](ConversationsApi.html#get_conversations_email_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
45
45
|
[**get_conversations_emails**](ConversationsApi.html#get_conversations_emails) | Get active email conversations for the logged in user
|
|
46
46
|
[**get_conversations_message**](ConversationsApi.html#get_conversations_message) | Get message conversation
|
|
47
|
+
[**get_conversations_message_communication_messages_media_media_id**](ConversationsApi.html#get_conversations_message_communication_messages_media_media_id) | Get media
|
|
47
48
|
[**get_conversations_message_message**](ConversationsApi.html#get_conversations_message_message) | Get message
|
|
48
49
|
[**get_conversations_message_participant_wrapup**](ConversationsApi.html#get_conversations_message_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
49
50
|
[**get_conversations_message_participant_wrapupcodes**](ConversationsApi.html#get_conversations_message_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
@@ -100,6 +101,7 @@ Method | Description
|
|
|
100
101
|
[**post_conversations_emails**](ConversationsApi.html#post_conversations_emails) | Create an email conversation
|
|
101
102
|
[**post_conversations_faxes**](ConversationsApi.html#post_conversations_faxes) | Create Fax Conversation
|
|
102
103
|
[**post_conversations_message_communication_messages**](ConversationsApi.html#post_conversations_message_communication_messages) | Send message
|
|
104
|
+
[**post_conversations_message_communication_messages_media**](ConversationsApi.html#post_conversations_message_communication_messages_media) | Create media
|
|
103
105
|
[**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
|
|
104
106
|
[**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
|
|
105
107
|
[**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
|
|
@@ -122,7 +124,6 @@ Requires NO permissions:
|
|
|
122
124
|
|
|
123
125
|
|
|
124
126
|
|
|
125
|
-
|
|
126
127
|
### Example
|
|
127
128
|
~~~ruby
|
|
128
129
|
# load the gem
|
|
@@ -192,7 +193,6 @@ Requires NO permissions:
|
|
|
192
193
|
|
|
193
194
|
|
|
194
195
|
|
|
195
|
-
|
|
196
196
|
### Example
|
|
197
197
|
~~~ruby
|
|
198
198
|
# load the gem
|
|
@@ -259,7 +259,6 @@ Requires NO permissions:
|
|
|
259
259
|
|
|
260
260
|
|
|
261
261
|
|
|
262
|
-
|
|
263
262
|
### Example
|
|
264
263
|
~~~ruby
|
|
265
264
|
# load the gem
|
|
@@ -456,7 +455,6 @@ Requires NO permissions:
|
|
|
456
455
|
|
|
457
456
|
|
|
458
457
|
|
|
459
|
-
|
|
460
458
|
### Example
|
|
461
459
|
~~~ruby
|
|
462
460
|
# load the gem
|
|
@@ -527,7 +525,6 @@ Requires NO permissions:
|
|
|
527
525
|
|
|
528
526
|
|
|
529
527
|
|
|
530
|
-
|
|
531
528
|
### Example
|
|
532
529
|
~~~ruby
|
|
533
530
|
# load the gem
|
|
@@ -595,7 +592,6 @@ Requires NO permissions:
|
|
|
595
592
|
|
|
596
593
|
|
|
597
594
|
|
|
598
|
-
|
|
599
595
|
### Example
|
|
600
596
|
~~~ruby
|
|
601
597
|
# load the gem
|
|
@@ -667,7 +663,6 @@ Requires NO permissions:
|
|
|
667
663
|
|
|
668
664
|
|
|
669
665
|
|
|
670
|
-
|
|
671
666
|
### Example
|
|
672
667
|
~~~ruby
|
|
673
668
|
# load the gem
|
|
@@ -735,7 +730,6 @@ Requires NO permissions:
|
|
|
735
730
|
|
|
736
731
|
|
|
737
732
|
|
|
738
|
-
|
|
739
733
|
### Example
|
|
740
734
|
~~~ruby
|
|
741
735
|
# load the gem
|
|
@@ -801,7 +795,6 @@ Requires NO permissions:
|
|
|
801
795
|
|
|
802
796
|
|
|
803
797
|
|
|
804
|
-
|
|
805
798
|
### Example
|
|
806
799
|
~~~ruby
|
|
807
800
|
# load the gem
|
|
@@ -866,7 +859,6 @@ Requires NO permissions:
|
|
|
866
859
|
|
|
867
860
|
|
|
868
861
|
|
|
869
|
-
|
|
870
862
|
### Example
|
|
871
863
|
~~~ruby
|
|
872
864
|
# load the gem
|
|
@@ -938,7 +930,6 @@ Requires NO permissions:
|
|
|
938
930
|
|
|
939
931
|
|
|
940
932
|
|
|
941
|
-
|
|
942
933
|
### Example
|
|
943
934
|
~~~ruby
|
|
944
935
|
# load the gem
|
|
@@ -1006,7 +997,6 @@ Requires NO permissions:
|
|
|
1006
997
|
|
|
1007
998
|
|
|
1008
999
|
|
|
1009
|
-
|
|
1010
1000
|
### Example
|
|
1011
1001
|
~~~ruby
|
|
1012
1002
|
# load the gem
|
|
@@ -1071,7 +1061,6 @@ Requires NO permissions:
|
|
|
1071
1061
|
|
|
1072
1062
|
|
|
1073
1063
|
|
|
1074
|
-
|
|
1075
1064
|
### Example
|
|
1076
1065
|
~~~ruby
|
|
1077
1066
|
# load the gem
|
|
@@ -1143,7 +1132,6 @@ Requires NO permissions:
|
|
|
1143
1132
|
|
|
1144
1133
|
|
|
1145
1134
|
|
|
1146
|
-
|
|
1147
1135
|
### Example
|
|
1148
1136
|
~~~ruby
|
|
1149
1137
|
# load the gem
|
|
@@ -1211,7 +1199,6 @@ Requires NO permissions:
|
|
|
1211
1199
|
|
|
1212
1200
|
|
|
1213
1201
|
|
|
1214
|
-
|
|
1215
1202
|
### Example
|
|
1216
1203
|
~~~ruby
|
|
1217
1204
|
# load the gem
|
|
@@ -1270,7 +1257,6 @@ Requires NO permissions:
|
|
|
1270
1257
|
|
|
1271
1258
|
|
|
1272
1259
|
|
|
1273
|
-
|
|
1274
1260
|
### Example
|
|
1275
1261
|
~~~ruby
|
|
1276
1262
|
# load the gem
|
|
@@ -1329,7 +1315,6 @@ Requires NO permissions:
|
|
|
1329
1315
|
|
|
1330
1316
|
|
|
1331
1317
|
|
|
1332
|
-
|
|
1333
1318
|
### Example
|
|
1334
1319
|
~~~ruby
|
|
1335
1320
|
# load the gem
|
|
@@ -1401,7 +1386,6 @@ Requires NO permissions:
|
|
|
1401
1386
|
|
|
1402
1387
|
|
|
1403
1388
|
|
|
1404
|
-
|
|
1405
1389
|
### Example
|
|
1406
1390
|
~~~ruby
|
|
1407
1391
|
# load the gem
|
|
@@ -1460,7 +1444,6 @@ Requires NO permissions:
|
|
|
1460
1444
|
|
|
1461
1445
|
|
|
1462
1446
|
|
|
1463
|
-
|
|
1464
1447
|
### Example
|
|
1465
1448
|
~~~ruby
|
|
1466
1449
|
# load the gem
|
|
@@ -1525,7 +1508,6 @@ Requires NO permissions:
|
|
|
1525
1508
|
|
|
1526
1509
|
|
|
1527
1510
|
|
|
1528
|
-
|
|
1529
1511
|
### Example
|
|
1530
1512
|
~~~ruby
|
|
1531
1513
|
# load the gem
|
|
@@ -1597,7 +1579,6 @@ Requires NO permissions:
|
|
|
1597
1579
|
|
|
1598
1580
|
|
|
1599
1581
|
|
|
1600
|
-
|
|
1601
1582
|
### Example
|
|
1602
1583
|
~~~ruby
|
|
1603
1584
|
# load the gem
|
|
@@ -1665,7 +1646,6 @@ Requires NO permissions:
|
|
|
1665
1646
|
|
|
1666
1647
|
|
|
1667
1648
|
|
|
1668
|
-
|
|
1669
1649
|
### Example
|
|
1670
1650
|
~~~ruby
|
|
1671
1651
|
# load the gem
|
|
@@ -1724,7 +1704,6 @@ Requires NO permissions:
|
|
|
1724
1704
|
|
|
1725
1705
|
|
|
1726
1706
|
|
|
1727
|
-
|
|
1728
1707
|
### Example
|
|
1729
1708
|
~~~ruby
|
|
1730
1709
|
# load the gem
|
|
@@ -1789,7 +1768,6 @@ Requires NO permissions:
|
|
|
1789
1768
|
|
|
1790
1769
|
|
|
1791
1770
|
|
|
1792
|
-
|
|
1793
1771
|
### Example
|
|
1794
1772
|
~~~ruby
|
|
1795
1773
|
# load the gem
|
|
@@ -1861,7 +1839,6 @@ Requires NO permissions:
|
|
|
1861
1839
|
|
|
1862
1840
|
|
|
1863
1841
|
|
|
1864
|
-
|
|
1865
1842
|
### Example
|
|
1866
1843
|
~~~ruby
|
|
1867
1844
|
# load the gem
|
|
@@ -1929,7 +1906,6 @@ Requires NO permissions:
|
|
|
1929
1906
|
|
|
1930
1907
|
|
|
1931
1908
|
|
|
1932
|
-
|
|
1933
1909
|
### Example
|
|
1934
1910
|
~~~ruby
|
|
1935
1911
|
# load the gem
|
|
@@ -1988,7 +1964,6 @@ Requires NO permissions:
|
|
|
1988
1964
|
|
|
1989
1965
|
|
|
1990
1966
|
|
|
1991
|
-
|
|
1992
1967
|
### Example
|
|
1993
1968
|
~~~ruby
|
|
1994
1969
|
# load the gem
|
|
@@ -2053,7 +2028,6 @@ Requires NO permissions:
|
|
|
2053
2028
|
|
|
2054
2029
|
|
|
2055
2030
|
|
|
2056
|
-
|
|
2057
2031
|
### Example
|
|
2058
2032
|
~~~ruby
|
|
2059
2033
|
# load the gem
|
|
@@ -2121,7 +2095,6 @@ Requires NO permissions:
|
|
|
2121
2095
|
|
|
2122
2096
|
|
|
2123
2097
|
|
|
2124
|
-
|
|
2125
2098
|
### Example
|
|
2126
2099
|
~~~ruby
|
|
2127
2100
|
# load the gem
|
|
@@ -2186,7 +2159,6 @@ Requires NO permissions:
|
|
|
2186
2159
|
|
|
2187
2160
|
|
|
2188
2161
|
|
|
2189
|
-
|
|
2190
2162
|
### Example
|
|
2191
2163
|
~~~ruby
|
|
2192
2164
|
# load the gem
|
|
@@ -2251,7 +2223,6 @@ Requires NO permissions:
|
|
|
2251
2223
|
|
|
2252
2224
|
|
|
2253
2225
|
|
|
2254
|
-
|
|
2255
2226
|
### Example
|
|
2256
2227
|
~~~ruby
|
|
2257
2228
|
# load the gem
|
|
@@ -2323,7 +2294,6 @@ Requires NO permissions:
|
|
|
2323
2294
|
|
|
2324
2295
|
|
|
2325
2296
|
|
|
2326
|
-
|
|
2327
2297
|
### Example
|
|
2328
2298
|
~~~ruby
|
|
2329
2299
|
# load the gem
|
|
@@ -2391,7 +2361,6 @@ Requires NO permissions:
|
|
|
2391
2361
|
|
|
2392
2362
|
|
|
2393
2363
|
|
|
2394
|
-
|
|
2395
2364
|
### Example
|
|
2396
2365
|
~~~ruby
|
|
2397
2366
|
# load the gem
|
|
@@ -2450,7 +2419,6 @@ Requires NO permissions:
|
|
|
2450
2419
|
|
|
2451
2420
|
|
|
2452
2421
|
|
|
2453
|
-
|
|
2454
2422
|
### Example
|
|
2455
2423
|
~~~ruby
|
|
2456
2424
|
# load the gem
|
|
@@ -2499,6 +2467,77 @@ Name | Type | Description | Notes
|
|
|
2499
2467
|
|
|
2500
2468
|
|
|
2501
2469
|
|
|
2470
|
+
<a name="get_conversations_message_communication_messages_media_media_id"></a>
|
|
2471
|
+
|
|
2472
|
+
## -[**MessageMediaData**](MessageMediaData.html) get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id)
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
Get media
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}
|
|
2481
|
+
|
|
2482
|
+
Requires ANY permissions:
|
|
2483
|
+
|
|
2484
|
+
* conversation:message:view
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
### Example
|
|
2488
|
+
~~~ruby
|
|
2489
|
+
# load the gem
|
|
2490
|
+
require 'purecloudplatformclientv2'
|
|
2491
|
+
# setup authorization
|
|
2492
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2493
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2494
|
+
environment = "mypurecloud.com"
|
|
2495
|
+
|
|
2496
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2497
|
+
|
|
2498
|
+
PureCloud.configure do |config|
|
|
2499
|
+
config.access_token = @authToken
|
|
2500
|
+
end
|
|
2501
|
+
|
|
2502
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2503
|
+
|
|
2504
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2505
|
+
|
|
2506
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2507
|
+
|
|
2508
|
+
media_id = "media_id_example" # String | mediaId
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
begin
|
|
2512
|
+
#Get media
|
|
2513
|
+
result = api_instance.get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id)
|
|
2514
|
+
p result
|
|
2515
|
+
rescue PureCloud::ApiError => e
|
|
2516
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_communication_messages_media_media_id: #{e}"
|
|
2517
|
+
end
|
|
2518
|
+
~~~
|
|
2519
|
+
|
|
2520
|
+
### Parameters
|
|
2521
|
+
|
|
2522
|
+
Name | Type | Description | Notes
|
|
2523
|
+
------------- | ------------- | ------------- | -------------
|
|
2524
|
+
**conversation_id** | **String**| conversationId | |
|
|
2525
|
+
**communication_id** | **String**| communicationId | |
|
|
2526
|
+
**media_id** | **String**| mediaId | |
|
|
2527
|
+
{: class="table table-striped"}
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
### Return type
|
|
2531
|
+
|
|
2532
|
+
[**MessageMediaData**](MessageMediaData.html)
|
|
2533
|
+
|
|
2534
|
+
### HTTP request headers
|
|
2535
|
+
|
|
2536
|
+
- **Content-Type**: application/json
|
|
2537
|
+
- **Accept**: application/json
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
|
|
2502
2541
|
<a name="get_conversations_message_message"></a>
|
|
2503
2542
|
|
|
2504
2543
|
## -[**MessageData**](MessageData.html) get_conversations_message_message(conversation_id, message_id)
|
|
@@ -2583,7 +2622,6 @@ Requires NO permissions:
|
|
|
2583
2622
|
|
|
2584
2623
|
|
|
2585
2624
|
|
|
2586
|
-
|
|
2587
2625
|
### Example
|
|
2588
2626
|
~~~ruby
|
|
2589
2627
|
# load the gem
|
|
@@ -2655,7 +2693,6 @@ Requires NO permissions:
|
|
|
2655
2693
|
|
|
2656
2694
|
|
|
2657
2695
|
|
|
2658
|
-
|
|
2659
2696
|
### Example
|
|
2660
2697
|
~~~ruby
|
|
2661
2698
|
# load the gem
|
|
@@ -2723,7 +2760,6 @@ Requires NO permissions:
|
|
|
2723
2760
|
|
|
2724
2761
|
|
|
2725
2762
|
|
|
2726
|
-
|
|
2727
2763
|
### Example
|
|
2728
2764
|
~~~ruby
|
|
2729
2765
|
# load the gem
|
|
@@ -2782,7 +2818,6 @@ Requires NO permissions:
|
|
|
2782
2818
|
|
|
2783
2819
|
|
|
2784
2820
|
|
|
2785
|
-
|
|
2786
2821
|
### Example
|
|
2787
2822
|
~~~ruby
|
|
2788
2823
|
# load the gem
|
|
@@ -2852,7 +2887,6 @@ Requires NO permissions:
|
|
|
2852
2887
|
|
|
2853
2888
|
|
|
2854
2889
|
|
|
2855
|
-
|
|
2856
2890
|
### Example
|
|
2857
2891
|
~~~ruby
|
|
2858
2892
|
# load the gem
|
|
@@ -2990,7 +3024,6 @@ Requires NO permissions:
|
|
|
2990
3024
|
|
|
2991
3025
|
|
|
2992
3026
|
|
|
2993
|
-
|
|
2994
3027
|
### Example
|
|
2995
3028
|
~~~ruby
|
|
2996
3029
|
# load the gem
|
|
@@ -3060,7 +3093,6 @@ Requires NO permissions:
|
|
|
3060
3093
|
|
|
3061
3094
|
|
|
3062
3095
|
|
|
3063
|
-
|
|
3064
3096
|
### Example
|
|
3065
3097
|
~~~ruby
|
|
3066
3098
|
# load the gem
|
|
@@ -3130,7 +3162,6 @@ Requires NO permissions:
|
|
|
3130
3162
|
|
|
3131
3163
|
|
|
3132
3164
|
|
|
3133
|
-
|
|
3134
3165
|
### Example
|
|
3135
3166
|
~~~ruby
|
|
3136
3167
|
# load the gem
|
|
@@ -3204,7 +3235,6 @@ Requires NO permissions:
|
|
|
3204
3235
|
|
|
3205
3236
|
|
|
3206
3237
|
|
|
3207
|
-
|
|
3208
3238
|
### Example
|
|
3209
3239
|
~~~ruby
|
|
3210
3240
|
# load the gem
|
|
@@ -3343,7 +3373,6 @@ Requires NO permissions:
|
|
|
3343
3373
|
|
|
3344
3374
|
|
|
3345
3375
|
|
|
3346
|
-
|
|
3347
3376
|
### Example
|
|
3348
3377
|
~~~ruby
|
|
3349
3378
|
# load the gem
|
|
@@ -3413,7 +3442,6 @@ Requires NO permissions:
|
|
|
3413
3442
|
|
|
3414
3443
|
|
|
3415
3444
|
|
|
3416
|
-
|
|
3417
3445
|
### Example
|
|
3418
3446
|
~~~ruby
|
|
3419
3447
|
# load the gem
|
|
@@ -3483,7 +3511,6 @@ Requires NO permissions:
|
|
|
3483
3511
|
|
|
3484
3512
|
|
|
3485
3513
|
|
|
3486
|
-
|
|
3487
3514
|
### Example
|
|
3488
3515
|
~~~ruby
|
|
3489
3516
|
# load the gem
|
|
@@ -3625,7 +3652,6 @@ Requires NO permissions:
|
|
|
3625
3652
|
|
|
3626
3653
|
|
|
3627
3654
|
|
|
3628
|
-
|
|
3629
3655
|
### Example
|
|
3630
3656
|
~~~ruby
|
|
3631
3657
|
# load the gem
|
|
@@ -3695,7 +3721,6 @@ Requires NO permissions:
|
|
|
3695
3721
|
|
|
3696
3722
|
|
|
3697
3723
|
|
|
3698
|
-
|
|
3699
3724
|
### Example
|
|
3700
3725
|
~~~ruby
|
|
3701
3726
|
# load the gem
|
|
@@ -3765,7 +3790,6 @@ Requires NO permissions:
|
|
|
3765
3790
|
|
|
3766
3791
|
|
|
3767
3792
|
|
|
3768
|
-
|
|
3769
3793
|
### Example
|
|
3770
3794
|
~~~ruby
|
|
3771
3795
|
# load the gem
|
|
@@ -3907,7 +3931,6 @@ Requires NO permissions:
|
|
|
3907
3931
|
|
|
3908
3932
|
|
|
3909
3933
|
|
|
3910
|
-
|
|
3911
3934
|
### Example
|
|
3912
3935
|
~~~ruby
|
|
3913
3936
|
# load the gem
|
|
@@ -3978,7 +4001,6 @@ Requires NO permissions:
|
|
|
3978
4001
|
|
|
3979
4002
|
|
|
3980
4003
|
|
|
3981
|
-
|
|
3982
4004
|
### Example
|
|
3983
4005
|
~~~ruby
|
|
3984
4006
|
# load the gem
|
|
@@ -4049,7 +4071,6 @@ Requires NO permissions:
|
|
|
4049
4071
|
|
|
4050
4072
|
|
|
4051
4073
|
|
|
4052
|
-
|
|
4053
4074
|
### Example
|
|
4054
4075
|
~~~ruby
|
|
4055
4076
|
# load the gem
|
|
@@ -4191,7 +4212,6 @@ Requires NO permissions:
|
|
|
4191
4212
|
|
|
4192
4213
|
|
|
4193
4214
|
|
|
4194
|
-
|
|
4195
4215
|
### Example
|
|
4196
4216
|
~~~ruby
|
|
4197
4217
|
# load the gem
|
|
@@ -4261,7 +4281,6 @@ Requires NO permissions:
|
|
|
4261
4281
|
|
|
4262
4282
|
|
|
4263
4283
|
|
|
4264
|
-
|
|
4265
4284
|
### Example
|
|
4266
4285
|
~~~ruby
|
|
4267
4286
|
# load the gem
|
|
@@ -4331,7 +4350,6 @@ Requires NO permissions:
|
|
|
4331
4350
|
|
|
4332
4351
|
|
|
4333
4352
|
|
|
4334
|
-
|
|
4335
4353
|
### Example
|
|
4336
4354
|
~~~ruby
|
|
4337
4355
|
# load the gem
|
|
@@ -4473,7 +4491,6 @@ Requires NO permissions:
|
|
|
4473
4491
|
|
|
4474
4492
|
|
|
4475
4493
|
|
|
4476
|
-
|
|
4477
4494
|
### Example
|
|
4478
4495
|
~~~ruby
|
|
4479
4496
|
# load the gem
|
|
@@ -4544,7 +4561,6 @@ Requires NO permissions:
|
|
|
4544
4561
|
|
|
4545
4562
|
|
|
4546
4563
|
|
|
4547
|
-
|
|
4548
4564
|
### Example
|
|
4549
4565
|
~~~ruby
|
|
4550
4566
|
# load the gem
|
|
@@ -4615,7 +4631,6 @@ Requires NO permissions:
|
|
|
4615
4631
|
|
|
4616
4632
|
|
|
4617
4633
|
|
|
4618
|
-
|
|
4619
4634
|
### Example
|
|
4620
4635
|
~~~ruby
|
|
4621
4636
|
# load the gem
|
|
@@ -5023,7 +5038,6 @@ Requires NO permissions:
|
|
|
5023
5038
|
|
|
5024
5039
|
|
|
5025
5040
|
|
|
5026
|
-
|
|
5027
5041
|
### Example
|
|
5028
5042
|
~~~ruby
|
|
5029
5043
|
# load the gem
|
|
@@ -5094,7 +5108,6 @@ Requires NO permissions:
|
|
|
5094
5108
|
|
|
5095
5109
|
|
|
5096
5110
|
|
|
5097
|
-
|
|
5098
5111
|
### Example
|
|
5099
5112
|
~~~ruby
|
|
5100
5113
|
# load the gem
|
|
@@ -5164,7 +5177,6 @@ Requires NO permissions:
|
|
|
5164
5177
|
|
|
5165
5178
|
|
|
5166
5179
|
|
|
5167
|
-
|
|
5168
5180
|
### Example
|
|
5169
5181
|
~~~ruby
|
|
5170
5182
|
# load the gem
|
|
@@ -5236,7 +5248,6 @@ Requires NO permissions:
|
|
|
5236
5248
|
|
|
5237
5249
|
|
|
5238
5250
|
|
|
5239
|
-
|
|
5240
5251
|
### Example
|
|
5241
5252
|
~~~ruby
|
|
5242
5253
|
# load the gem
|
|
@@ -5304,7 +5315,6 @@ Requires NO permissions:
|
|
|
5304
5315
|
|
|
5305
5316
|
|
|
5306
5317
|
|
|
5307
|
-
|
|
5308
5318
|
### Example
|
|
5309
5319
|
~~~ruby
|
|
5310
5320
|
# load the gem
|
|
@@ -5442,7 +5452,6 @@ Requires NO permissions:
|
|
|
5442
5452
|
|
|
5443
5453
|
|
|
5444
5454
|
|
|
5445
|
-
|
|
5446
5455
|
### Example
|
|
5447
5456
|
~~~ruby
|
|
5448
5457
|
# load the gem
|
|
@@ -5512,7 +5521,6 @@ Requires NO permissions:
|
|
|
5512
5521
|
|
|
5513
5522
|
|
|
5514
5523
|
|
|
5515
|
-
|
|
5516
5524
|
### Example
|
|
5517
5525
|
~~~ruby
|
|
5518
5526
|
# load the gem
|
|
@@ -5580,7 +5588,6 @@ Requires NO permissions:
|
|
|
5580
5588
|
|
|
5581
5589
|
|
|
5582
5590
|
|
|
5583
|
-
|
|
5584
5591
|
### Example
|
|
5585
5592
|
~~~ruby
|
|
5586
5593
|
# load the gem
|
|
@@ -5780,7 +5787,6 @@ Requires NO permissions:
|
|
|
5780
5787
|
|
|
5781
5788
|
|
|
5782
5789
|
|
|
5783
|
-
|
|
5784
5790
|
### Example
|
|
5785
5791
|
~~~ruby
|
|
5786
5792
|
# load the gem
|
|
@@ -5915,7 +5921,6 @@ Requires NO permissions:
|
|
|
5915
5921
|
|
|
5916
5922
|
|
|
5917
5923
|
|
|
5918
|
-
|
|
5919
5924
|
### Example
|
|
5920
5925
|
~~~ruby
|
|
5921
5926
|
# load the gem
|
|
@@ -5986,7 +5991,6 @@ Requires NO permissions:
|
|
|
5986
5991
|
|
|
5987
5992
|
|
|
5988
5993
|
|
|
5989
|
-
|
|
5990
5994
|
### Example
|
|
5991
5995
|
~~~ruby
|
|
5992
5996
|
# load the gem
|
|
@@ -6054,7 +6058,6 @@ Requires NO permissions:
|
|
|
6054
6058
|
|
|
6055
6059
|
|
|
6056
6060
|
|
|
6057
|
-
|
|
6058
6061
|
### Example
|
|
6059
6062
|
~~~ruby
|
|
6060
6063
|
# load the gem
|
|
@@ -6122,7 +6125,6 @@ Requires NO permissions:
|
|
|
6122
6125
|
|
|
6123
6126
|
|
|
6124
6127
|
|
|
6125
|
-
|
|
6126
6128
|
### Example
|
|
6127
6129
|
~~~ruby
|
|
6128
6130
|
# load the gem
|
|
@@ -6257,7 +6259,6 @@ Requires NO permissions:
|
|
|
6257
6259
|
|
|
6258
6260
|
|
|
6259
6261
|
|
|
6260
|
-
|
|
6261
6262
|
### Example
|
|
6262
6263
|
~~~ruby
|
|
6263
6264
|
# load the gem
|
|
@@ -6377,6 +6378,74 @@ Name | Type | Description | Notes
|
|
|
6377
6378
|
|
|
6378
6379
|
|
|
6379
6380
|
|
|
6381
|
+
<a name="post_conversations_message_communication_messages_media"></a>
|
|
6382
|
+
|
|
6383
|
+
## -[**MessageMediaData**](MessageMediaData.html) post_conversations_message_communication_messages_media(conversation_id, communication_id)
|
|
6384
|
+
|
|
6385
|
+
|
|
6386
|
+
|
|
6387
|
+
Create media
|
|
6388
|
+
|
|
6389
|
+
|
|
6390
|
+
|
|
6391
|
+
Wraps POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media
|
|
6392
|
+
|
|
6393
|
+
Requires ANY permissions:
|
|
6394
|
+
|
|
6395
|
+
* conversation:message:create
|
|
6396
|
+
|
|
6397
|
+
|
|
6398
|
+
### Example
|
|
6399
|
+
~~~ruby
|
|
6400
|
+
# load the gem
|
|
6401
|
+
require 'purecloudplatformclientv2'
|
|
6402
|
+
# setup authorization
|
|
6403
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6404
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6405
|
+
environment = "mypurecloud.com"
|
|
6406
|
+
|
|
6407
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6408
|
+
|
|
6409
|
+
PureCloud.configure do |config|
|
|
6410
|
+
config.access_token = @authToken
|
|
6411
|
+
end
|
|
6412
|
+
|
|
6413
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
6414
|
+
|
|
6415
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
6416
|
+
|
|
6417
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
6418
|
+
|
|
6419
|
+
|
|
6420
|
+
begin
|
|
6421
|
+
#Create media
|
|
6422
|
+
result = api_instance.post_conversations_message_communication_messages_media(conversation_id, communication_id)
|
|
6423
|
+
p result
|
|
6424
|
+
rescue PureCloud::ApiError => e
|
|
6425
|
+
puts "Exception when calling ConversationsApi->post_conversations_message_communication_messages_media: #{e}"
|
|
6426
|
+
end
|
|
6427
|
+
~~~
|
|
6428
|
+
|
|
6429
|
+
### Parameters
|
|
6430
|
+
|
|
6431
|
+
Name | Type | Description | Notes
|
|
6432
|
+
------------- | ------------- | ------------- | -------------
|
|
6433
|
+
**conversation_id** | **String**| conversationId | |
|
|
6434
|
+
**communication_id** | **String**| communicationId | |
|
|
6435
|
+
{: class="table table-striped"}
|
|
6436
|
+
|
|
6437
|
+
|
|
6438
|
+
### Return type
|
|
6439
|
+
|
|
6440
|
+
[**MessageMediaData**](MessageMediaData.html)
|
|
6441
|
+
|
|
6442
|
+
### HTTP request headers
|
|
6443
|
+
|
|
6444
|
+
- **Content-Type**: application/json
|
|
6445
|
+
- **Accept**: application/json
|
|
6446
|
+
|
|
6447
|
+
|
|
6448
|
+
|
|
6380
6449
|
<a name="post_conversations_message_messages_bulk"></a>
|
|
6381
6450
|
|
|
6382
6451
|
## -[**TextMessageListing**](TextMessageListing.html) post_conversations_message_messages_bulk(conversation_id, opts)
|
|
@@ -6462,7 +6531,6 @@ Requires NO permissions:
|
|
|
6462
6531
|
|
|
6463
6532
|
|
|
6464
6533
|
|
|
6465
|
-
|
|
6466
6534
|
### Example
|
|
6467
6535
|
~~~ruby
|
|
6468
6536
|
# load the gem
|
|
@@ -6532,7 +6600,6 @@ Requires NO permissions:
|
|
|
6532
6600
|
|
|
6533
6601
|
|
|
6534
6602
|
|
|
6535
|
-
|
|
6536
6603
|
### Example
|
|
6537
6604
|
~~~ruby
|
|
6538
6605
|
# load the gem
|
|
@@ -6606,7 +6673,6 @@ Requires NO permissions:
|
|
|
6606
6673
|
|
|
6607
6674
|
|
|
6608
6675
|
|
|
6609
|
-
|
|
6610
6676
|
### Example
|
|
6611
6677
|
~~~ruby
|
|
6612
6678
|
# load the gem
|