purecloud-platform-client-v2 216.0.0 → 218.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.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.js +1546 -567
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +502 -282
- package/dist/web-cjs/purecloud-platform-client-v2.js +507 -285
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +951 -292
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -305
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +112 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -8
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +387 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +243 -4
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +13 -16
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -68
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +19 -7
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -29
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +182 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +403 -20
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +19 -10
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +58 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 218.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -270,6 +270,31 @@ class ConversationsApi {
|
|
|
270
270
|
);
|
|
271
271
|
}
|
|
272
272
|
|
|
273
|
+
/**
|
|
274
|
+
* Delete Twitter messaging integration
|
|
275
|
+
*
|
|
276
|
+
* @param {String} integrationId Integration ID
|
|
277
|
+
*/
|
|
278
|
+
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
279
|
+
// verify the required parameter 'integrationId' is set
|
|
280
|
+
if (integrationId === undefined || integrationId === null) {
|
|
281
|
+
throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
return this.apiClient.callApi(
|
|
285
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
286
|
+
'DELETE',
|
|
287
|
+
{ 'integrationId': integrationId },
|
|
288
|
+
{ },
|
|
289
|
+
{ },
|
|
290
|
+
{ },
|
|
291
|
+
null,
|
|
292
|
+
['PureCloud OAuth'],
|
|
293
|
+
['application/json'],
|
|
294
|
+
['application/json']
|
|
295
|
+
);
|
|
296
|
+
}
|
|
297
|
+
|
|
273
298
|
/**
|
|
274
299
|
* Delete a WhatsApp messaging integration
|
|
275
300
|
*
|
|
@@ -2182,6 +2207,109 @@ class ConversationsApi {
|
|
|
2182
2207
|
);
|
|
2183
2208
|
}
|
|
2184
2209
|
|
|
2210
|
+
/**
|
|
2211
|
+
* Get Facebook messaging integration identity resolution settings
|
|
2212
|
+
*
|
|
2213
|
+
* @param {String} integrationId Integration ID
|
|
2214
|
+
* getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2215
|
+
*/
|
|
2216
|
+
getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId) {
|
|
2217
|
+
// verify the required parameter 'integrationId' is set
|
|
2218
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2219
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
2220
|
+
}
|
|
2221
|
+
|
|
2222
|
+
return this.apiClient.callApi(
|
|
2223
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
2224
|
+
'GET',
|
|
2225
|
+
{ 'integrationId': integrationId },
|
|
2226
|
+
{ },
|
|
2227
|
+
{ },
|
|
2228
|
+
{ },
|
|
2229
|
+
null,
|
|
2230
|
+
['PureCloud OAuth'],
|
|
2231
|
+
['application/json'],
|
|
2232
|
+
['application/json']
|
|
2233
|
+
);
|
|
2234
|
+
}
|
|
2235
|
+
|
|
2236
|
+
/**
|
|
2237
|
+
* Get an open messaging integration Identity Resolution settings
|
|
2238
|
+
*
|
|
2239
|
+
* @param {String} integrationId Integration ID
|
|
2240
|
+
* getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2241
|
+
*/
|
|
2242
|
+
getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId) {
|
|
2243
|
+
// verify the required parameter 'integrationId' is set
|
|
2244
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2245
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
2246
|
+
}
|
|
2247
|
+
|
|
2248
|
+
return this.apiClient.callApi(
|
|
2249
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
2250
|
+
'GET',
|
|
2251
|
+
{ 'integrationId': integrationId },
|
|
2252
|
+
{ },
|
|
2253
|
+
{ },
|
|
2254
|
+
{ },
|
|
2255
|
+
null,
|
|
2256
|
+
['PureCloud OAuth'],
|
|
2257
|
+
['application/json'],
|
|
2258
|
+
['application/json']
|
|
2259
|
+
);
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2262
|
+
/**
|
|
2263
|
+
* Get a whatsApp integration Identity Resolution settings
|
|
2264
|
+
*
|
|
2265
|
+
* @param {String} integrationId Integration ID
|
|
2266
|
+
* getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2267
|
+
*/
|
|
2268
|
+
getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId) {
|
|
2269
|
+
// verify the required parameter 'integrationId' is set
|
|
2270
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2271
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
2272
|
+
}
|
|
2273
|
+
|
|
2274
|
+
return this.apiClient.callApi(
|
|
2275
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
2276
|
+
'GET',
|
|
2277
|
+
{ 'integrationId': integrationId },
|
|
2278
|
+
{ },
|
|
2279
|
+
{ },
|
|
2280
|
+
{ },
|
|
2281
|
+
null,
|
|
2282
|
+
['PureCloud OAuth'],
|
|
2283
|
+
['application/json'],
|
|
2284
|
+
['application/json']
|
|
2285
|
+
);
|
|
2286
|
+
}
|
|
2287
|
+
|
|
2288
|
+
/**
|
|
2289
|
+
* Get twitter oauth settings to patch an integration
|
|
2290
|
+
*
|
|
2291
|
+
* @param {String} integrationId Integration Id of an existing integration that needs to be patched with new oauth settings
|
|
2292
|
+
*/
|
|
2293
|
+
getConversationsMessagingIntegrationTwitterOauthSettings(integrationId) {
|
|
2294
|
+
// verify the required parameter 'integrationId' is set
|
|
2295
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2296
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationTwitterOauthSettings';
|
|
2297
|
+
}
|
|
2298
|
+
|
|
2299
|
+
return this.apiClient.callApi(
|
|
2300
|
+
'/api/v2/conversations/messaging/integrations/{integrationId}/twitter/oauth/settings',
|
|
2301
|
+
'GET',
|
|
2302
|
+
{ 'integrationId': integrationId },
|
|
2303
|
+
{ },
|
|
2304
|
+
{ },
|
|
2305
|
+
{ },
|
|
2306
|
+
null,
|
|
2307
|
+
['PureCloud OAuth'],
|
|
2308
|
+
['application/json'],
|
|
2309
|
+
['application/json']
|
|
2310
|
+
);
|
|
2311
|
+
}
|
|
2312
|
+
|
|
2185
2313
|
/**
|
|
2186
2314
|
* Get a list of Integrations
|
|
2187
2315
|
*
|
|
@@ -2381,6 +2509,83 @@ class ConversationsApi {
|
|
|
2381
2509
|
);
|
|
2382
2510
|
}
|
|
2383
2511
|
|
|
2512
|
+
/**
|
|
2513
|
+
* Get a list of Twitter Integrations
|
|
2514
|
+
*
|
|
2515
|
+
* @param {Object} opts Optional parameters
|
|
2516
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2517
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2518
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2519
|
+
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
2520
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
2521
|
+
*/
|
|
2522
|
+
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
2523
|
+
opts = opts || {};
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
return this.apiClient.callApi(
|
|
2527
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
2528
|
+
'GET',
|
|
2529
|
+
{ },
|
|
2530
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
2531
|
+
{ },
|
|
2532
|
+
{ },
|
|
2533
|
+
null,
|
|
2534
|
+
['PureCloud OAuth'],
|
|
2535
|
+
['application/json'],
|
|
2536
|
+
['application/json']
|
|
2537
|
+
);
|
|
2538
|
+
}
|
|
2539
|
+
|
|
2540
|
+
/**
|
|
2541
|
+
* Get Twitter messaging integration
|
|
2542
|
+
*
|
|
2543
|
+
* @param {String} integrationId Integration ID
|
|
2544
|
+
* @param {Object} opts Optional parameters
|
|
2545
|
+
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2546
|
+
*/
|
|
2547
|
+
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
2548
|
+
opts = opts || {};
|
|
2549
|
+
|
|
2550
|
+
// verify the required parameter 'integrationId' is set
|
|
2551
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2552
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
2553
|
+
}
|
|
2554
|
+
|
|
2555
|
+
return this.apiClient.callApi(
|
|
2556
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
2557
|
+
'GET',
|
|
2558
|
+
{ 'integrationId': integrationId },
|
|
2559
|
+
{ 'expand': opts['expand'] },
|
|
2560
|
+
{ },
|
|
2561
|
+
{ },
|
|
2562
|
+
null,
|
|
2563
|
+
['PureCloud OAuth'],
|
|
2564
|
+
['application/json'],
|
|
2565
|
+
['application/json']
|
|
2566
|
+
);
|
|
2567
|
+
}
|
|
2568
|
+
|
|
2569
|
+
/**
|
|
2570
|
+
* Get twitter oauth settings
|
|
2571
|
+
*
|
|
2572
|
+
*/
|
|
2573
|
+
getConversationsMessagingIntegrationsTwitterOauthSettings() {
|
|
2574
|
+
|
|
2575
|
+
return this.apiClient.callApi(
|
|
2576
|
+
'/api/v2/conversations/messaging/integrations/twitter/oauth/settings',
|
|
2577
|
+
'GET',
|
|
2578
|
+
{ },
|
|
2579
|
+
{ },
|
|
2580
|
+
{ },
|
|
2581
|
+
{ },
|
|
2582
|
+
null,
|
|
2583
|
+
['PureCloud OAuth'],
|
|
2584
|
+
['application/json'],
|
|
2585
|
+
['application/json']
|
|
2586
|
+
);
|
|
2587
|
+
}
|
|
2588
|
+
|
|
2384
2589
|
/**
|
|
2385
2590
|
* Get a list of WhatsApp Integrations
|
|
2386
2591
|
*
|
|
@@ -4018,6 +4223,36 @@ class ConversationsApi {
|
|
|
4018
4223
|
);
|
|
4019
4224
|
}
|
|
4020
4225
|
|
|
4226
|
+
/**
|
|
4227
|
+
* Update a Twitter messaging integration
|
|
4228
|
+
*
|
|
4229
|
+
* @param {String} integrationId Integration ID
|
|
4230
|
+
* @param {Object} body TwitterIntegrationUpdateRequest
|
|
4231
|
+
*/
|
|
4232
|
+
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
4233
|
+
// verify the required parameter 'integrationId' is set
|
|
4234
|
+
if (integrationId === undefined || integrationId === null) {
|
|
4235
|
+
throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
4236
|
+
}
|
|
4237
|
+
// verify the required parameter 'body' is set
|
|
4238
|
+
if (body === undefined || body === null) {
|
|
4239
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsTwitterIntegrationId';
|
|
4240
|
+
}
|
|
4241
|
+
|
|
4242
|
+
return this.apiClient.callApi(
|
|
4243
|
+
'/api/v2/conversations/messaging/integrations/twitter/{integrationId}',
|
|
4244
|
+
'PATCH',
|
|
4245
|
+
{ 'integrationId': integrationId },
|
|
4246
|
+
{ },
|
|
4247
|
+
{ },
|
|
4248
|
+
{ },
|
|
4249
|
+
body,
|
|
4250
|
+
['PureCloud OAuth'],
|
|
4251
|
+
['application/json'],
|
|
4252
|
+
['application/json']
|
|
4253
|
+
);
|
|
4254
|
+
}
|
|
4255
|
+
|
|
4021
4256
|
/**
|
|
4022
4257
|
* Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
|
|
4023
4258
|
* Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
|
@@ -6354,6 +6589,31 @@ class ConversationsApi {
|
|
|
6354
6589
|
);
|
|
6355
6590
|
}
|
|
6356
6591
|
|
|
6592
|
+
/**
|
|
6593
|
+
* Create Twitter Integration
|
|
6594
|
+
*
|
|
6595
|
+
* @param {Object} body TwitterIntegrationRequest
|
|
6596
|
+
*/
|
|
6597
|
+
postConversationsMessagingIntegrationsTwitter(body) {
|
|
6598
|
+
// verify the required parameter 'body' is set
|
|
6599
|
+
if (body === undefined || body === null) {
|
|
6600
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
6601
|
+
}
|
|
6602
|
+
|
|
6603
|
+
return this.apiClient.callApi(
|
|
6604
|
+
'/api/v2/conversations/messaging/integrations/twitter',
|
|
6605
|
+
'POST',
|
|
6606
|
+
{ },
|
|
6607
|
+
{ },
|
|
6608
|
+
{ },
|
|
6609
|
+
{ },
|
|
6610
|
+
body,
|
|
6611
|
+
['PureCloud OAuth'],
|
|
6612
|
+
['application/json'],
|
|
6613
|
+
['application/json']
|
|
6614
|
+
);
|
|
6615
|
+
}
|
|
6616
|
+
|
|
6357
6617
|
/**
|
|
6358
6618
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] Create a WhatsApp Integration
|
|
6359
6619
|
* [This API is deprecated. Use POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup instead] You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
@@ -6559,6 +6819,37 @@ class ConversationsApi {
|
|
|
6559
6819
|
);
|
|
6560
6820
|
}
|
|
6561
6821
|
|
|
6822
|
+
/**
|
|
6823
|
+
* Create an Agent-Type video conference and assign an agent to it
|
|
6824
|
+
*
|
|
6825
|
+
* @param {String} conversationId conversationId
|
|
6826
|
+
* @param {String} communicationId communicationId
|
|
6827
|
+
* postConversationsVideoAgentconferenceCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6828
|
+
*/
|
|
6829
|
+
postConversationsVideoAgentconferenceCommunication(conversationId, communicationId) {
|
|
6830
|
+
// verify the required parameter 'conversationId' is set
|
|
6831
|
+
if (conversationId === undefined || conversationId === null) {
|
|
6832
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
6833
|
+
}
|
|
6834
|
+
// verify the required parameter 'communicationId' is set
|
|
6835
|
+
if (communicationId === undefined || communicationId === null) {
|
|
6836
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsVideoAgentconferenceCommunication';
|
|
6837
|
+
}
|
|
6838
|
+
|
|
6839
|
+
return this.apiClient.callApi(
|
|
6840
|
+
'/api/v2/conversations/videos/{conversationId}/agentconference/communications/{communicationId}',
|
|
6841
|
+
'POST',
|
|
6842
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
6843
|
+
{ },
|
|
6844
|
+
{ },
|
|
6845
|
+
{ },
|
|
6846
|
+
null,
|
|
6847
|
+
['PureCloud OAuth'],
|
|
6848
|
+
['application/json'],
|
|
6849
|
+
['application/json']
|
|
6850
|
+
);
|
|
6851
|
+
}
|
|
6852
|
+
|
|
6562
6853
|
/**
|
|
6563
6854
|
* Apply wrap-up for this conversation communication
|
|
6564
6855
|
*
|
|
@@ -6847,9 +7138,10 @@ class ConversationsApi {
|
|
|
6847
7138
|
|
|
6848
7139
|
/**
|
|
6849
7140
|
* Update a conversation by setting its recording state
|
|
6850
|
-
*
|
|
7141
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6851
7142
|
* @param {String} conversationId conversationId
|
|
6852
7143
|
* @param {Object} body SetRecordingState
|
|
7144
|
+
* @deprecated
|
|
6853
7145
|
*/
|
|
6854
7146
|
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
6855
7147
|
// verify the required parameter 'conversationId' is set
|
|
@@ -6995,6 +7287,99 @@ class ConversationsApi {
|
|
|
6995
7287
|
);
|
|
6996
7288
|
}
|
|
6997
7289
|
|
|
7290
|
+
/**
|
|
7291
|
+
* Create an identity resolution settings for a Facebook messaging integration
|
|
7292
|
+
*
|
|
7293
|
+
* @param {String} integrationId Integration ID
|
|
7294
|
+
* @param {Object} body IdentityResolutionConfig
|
|
7295
|
+
* putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7296
|
+
*/
|
|
7297
|
+
putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId(integrationId, body) {
|
|
7298
|
+
// verify the required parameter 'integrationId' is set
|
|
7299
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7300
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
7301
|
+
}
|
|
7302
|
+
// verify the required parameter 'body' is set
|
|
7303
|
+
if (body === undefined || body === null) {
|
|
7304
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsFacebookIntegrationId';
|
|
7305
|
+
}
|
|
7306
|
+
|
|
7307
|
+
return this.apiClient.callApi(
|
|
7308
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/facebook/{integrationId}',
|
|
7309
|
+
'PUT',
|
|
7310
|
+
{ 'integrationId': integrationId },
|
|
7311
|
+
{ },
|
|
7312
|
+
{ },
|
|
7313
|
+
{ },
|
|
7314
|
+
body,
|
|
7315
|
+
['PureCloud OAuth'],
|
|
7316
|
+
['application/json'],
|
|
7317
|
+
['application/json']
|
|
7318
|
+
);
|
|
7319
|
+
}
|
|
7320
|
+
|
|
7321
|
+
/**
|
|
7322
|
+
* Update an open messaging integration Identity Resolution settings
|
|
7323
|
+
*
|
|
7324
|
+
* @param {String} integrationId Integration ID
|
|
7325
|
+
* @param {Object} body
|
|
7326
|
+
* putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7327
|
+
*/
|
|
7328
|
+
putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId(integrationId, body) {
|
|
7329
|
+
// verify the required parameter 'integrationId' is set
|
|
7330
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7331
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
7332
|
+
}
|
|
7333
|
+
// verify the required parameter 'body' is set
|
|
7334
|
+
if (body === undefined || body === null) {
|
|
7335
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsOpenIntegrationId';
|
|
7336
|
+
}
|
|
7337
|
+
|
|
7338
|
+
return this.apiClient.callApi(
|
|
7339
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/open/{integrationId}',
|
|
7340
|
+
'PUT',
|
|
7341
|
+
{ 'integrationId': integrationId },
|
|
7342
|
+
{ },
|
|
7343
|
+
{ },
|
|
7344
|
+
{ },
|
|
7345
|
+
body,
|
|
7346
|
+
['PureCloud OAuth'],
|
|
7347
|
+
['application/json'],
|
|
7348
|
+
['application/json']
|
|
7349
|
+
);
|
|
7350
|
+
}
|
|
7351
|
+
|
|
7352
|
+
/**
|
|
7353
|
+
* Update a whatsApp integration Identity Resolution settings
|
|
7354
|
+
*
|
|
7355
|
+
* @param {String} integrationId Integration ID
|
|
7356
|
+
* @param {Object} body
|
|
7357
|
+
* putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7358
|
+
*/
|
|
7359
|
+
putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId(integrationId, body) {
|
|
7360
|
+
// verify the required parameter 'integrationId' is set
|
|
7361
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7362
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
7363
|
+
}
|
|
7364
|
+
// verify the required parameter 'body' is set
|
|
7365
|
+
if (body === undefined || body === null) {
|
|
7366
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsWhatsappIntegrationId';
|
|
7367
|
+
}
|
|
7368
|
+
|
|
7369
|
+
return this.apiClient.callApi(
|
|
7370
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/whatsapp/{integrationId}',
|
|
7371
|
+
'PUT',
|
|
7372
|
+
{ 'integrationId': integrationId },
|
|
7373
|
+
{ },
|
|
7374
|
+
{ },
|
|
7375
|
+
{ },
|
|
7376
|
+
body,
|
|
7377
|
+
['PureCloud OAuth'],
|
|
7378
|
+
['application/json'],
|
|
7379
|
+
['application/json']
|
|
7380
|
+
);
|
|
7381
|
+
}
|
|
7382
|
+
|
|
6998
7383
|
/**
|
|
6999
7384
|
* Set the organization's default setting that may be applied to to integrations without settings
|
|
7000
7385
|
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|