purecloudplatformclientv2 20.0.0 → 21.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/AdherenceSettings.md +18 -0
- data/docs/AgentManagementUnitReference.md +14 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/AnalyticsView.md +1 -1
- data/docs/ArchitectApi.md +19 -15
- data/docs/CallForwarding.md +4 -2
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallRoute.md +14 -0
- data/docs/CallTarget.md +14 -0
- data/docs/Contact.md +1 -1
- data/docs/ConversationNotificationMessage.md +3 -0
- data/docs/ConversationNotificationMessageDetails.md +2 -0
- data/docs/ConversationNotificationMessages.md +2 -0
- data/docs/ConversationNotificationMessages1.md +3 -0
- data/docs/ConversationsApi.md +196 -0
- data/docs/CreateEmailRequest.md +2 -0
- data/docs/CreateQueueRequest.md +2 -0
- data/docs/CreateSecureSession.md +16 -0
- data/docs/ExternalContact.md +1 -0
- data/docs/ImportScriptStatusResponse.md +15 -0
- data/docs/InboundRoute.md +1 -0
- data/docs/JsonNode.md +1 -1
- data/docs/ManagementUnit.md +5 -3
- data/docs/ManagementUnitReference.md +14 -0
- data/docs/ManagementUnitSettings.md +19 -0
- data/docs/Message.md +3 -0
- data/docs/MessageConversationNotificationMessageDetails.md +2 -0
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +3 -0
- data/docs/MessageConversationNotificationMessages.md +2 -0
- data/docs/MessageConversationNotificationParticipants.md +3 -0
- data/docs/MessageDetails.md +2 -0
- data/docs/QualityApi.md +3 -1
- data/docs/Queue.md +2 -0
- data/docs/SchedulingSettings.md +14 -0
- data/docs/ScriptsApi.md +64 -0
- data/docs/SecureSession.md +19 -0
- data/docs/SecureSessionEntityListing.md +13 -0
- data/docs/ShortTermForecastingSettings.md +13 -0
- data/docs/SignedData.md +13 -0
- data/docs/SignedDataApi.md +73 -0
- data/docs/TimeOffRequestSettings.md +15 -0
- data/docs/UpdateUser.md +2 -2
- data/docs/UserConversationSummaryNotification.md +1 -0
- data/docs/UserQueue.md +2 -0
- data/docs/UserReference.md +14 -0
- data/docs/WorkforceManagementApi.md +61 -0
- data/lib/purecloudplatformclientv2.rb +16 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +243 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/signed_data_api.rb +90 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/adherence_settings.rb +335 -0
- data/lib/purecloudplatformclientv2/models/agent_management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_view.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_forwarding.rb +71 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_route.rb +230 -0
- data/lib/purecloudplatformclientv2/models/call_target.rb +242 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message.rb +90 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages_1.rb +90 -1
- data/lib/purecloudplatformclientv2/models/create_email_request.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_secure_session.rb +290 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
- data/lib/purecloudplatformclientv2/models/import_script_status_response.rb +251 -0
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +27 -1
- data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
- data/lib/purecloudplatformclientv2/models/management_unit.rb +59 -7
- data/lib/purecloudplatformclientv2/models/management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +364 -0
- data/lib/purecloudplatformclientv2/models/message.rb +93 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_details.rb +67 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +229 -0
- data/lib/purecloudplatformclientv2/models/secure_session.rb +382 -0
- data/lib/purecloudplatformclientv2/models/secure_session_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/short_term_forecasting_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/signed_data.rb +201 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_settings.rb +255 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/user_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +34 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f0290484bac4ae9254616679078b43623f6c371a
|
|
4
|
+
data.tar.gz: fcc472ff711c91a9021acbab6e5d319e5949c59f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 95fa2f0bf645387b68dc002e480815da61ba493bfc2d43c18034c3c69409ae337f25fedee5c3b5de0ae5c2a60902ec3542488ea2a963a35cd071ac8de4c658c6
|
|
7
|
+
data.tar.gz: c922fbc8e316d7919cf6c692d53d963cc2cc64210dfee9c43fb76226276040792718ff526ba37f29a7b0416c19d157717b6269aa4813275a00109de6d29d6639
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-

|
|
5
5
|
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
|
10
10
|
### from rubygems.org
|
|
11
11
|
|
|
12
12
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 21.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AdherenceSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AdherenceSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **severe_alert_threshold_minutes** | **Integer** | The threshold in minutes where an alert will be triggered when an agent is considered severely out of adherence | [optional] |
|
|
11
|
+
| **adherence_target_percent** | **Integer** | Target adherence percentage | [optional] |
|
|
12
|
+
| **adherence_exception_threshold_seconds** | **Integer** | The threshold in seconds for which agents should not be penalized for being momentarily out of adherence | [optional] |
|
|
13
|
+
| **non_on_queue_activities_equivalent** | **BOOLEAN** | Whether to treat all non-on-queue activities as equivalent for adherence purposes | [optional] |
|
|
14
|
+
| **track_on_queue_activity** | **BOOLEAN** | Whether to track on-queue activities | [optional] |
|
|
15
|
+
| **ignored_activity_categories** | **Array<String>** | Activity categories that should be ignored for adherence purposes | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AgentManagementUnitReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AgentManagementUnitReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **user** | [**UserReference**](UserReference.html) | The user (agent) for whom the management unit was requested | [optional] |
|
|
11
|
+
| **management_unit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management to which the user (agent) belongs | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/AnalyticsSession.md
CHANGED
|
@@ -13,6 +13,7 @@ title: AnalyticsSession
|
|
|
13
13
|
| **address_self** | **String** | | [optional] |
|
|
14
14
|
| **address_from** | **String** | | [optional] |
|
|
15
15
|
| **address_to** | **String** | | [optional] |
|
|
16
|
+
| **message_type** | **String** | Message type for messaging services such as sms | [optional] |
|
|
16
17
|
| **ani** | **String** | Automatic Number Identification (caller's number) | [optional] |
|
|
17
18
|
| **direction** | **String** | Direction | [optional] |
|
|
18
19
|
| **dnis** | **String** | Automatic Number Identification (caller's number) | [optional] |
|
data/docs/AnalyticsView.md
CHANGED
|
@@ -7,7 +7,7 @@ title: AnalyticsView
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **target** | **String** |
|
|
10
|
+
| **target** | **String** | CallTarget metric name | |
|
|
11
11
|
| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
|
|
12
12
|
| **function** | **String** | Type of view you wish to create | |
|
|
13
13
|
| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -665,11 +665,11 @@ Name | Type | Description | Notes
|
|
|
665
665
|
**name** | **String**| Object name to search for | |
|
|
666
666
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
667
667
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
668
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
668
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
669
669
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
|
670
670
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
|
671
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
672
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
671
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
672
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
673
673
|
{: class="table table-striped"}
|
|
674
674
|
|
|
675
675
|
|
|
@@ -790,8 +790,8 @@ Name | Type | Description | Notes
|
|
|
790
790
|
------------- | ------------- | ------------- | -------------
|
|
791
791
|
**id** | **String**| Consuming object ID | |
|
|
792
792
|
**version** | **String**| Consuming object version | |
|
|
793
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
794
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
793
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
794
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
795
795
|
{: class="table table-striped"}
|
|
796
796
|
|
|
797
797
|
|
|
@@ -856,8 +856,8 @@ end
|
|
|
856
856
|
Name | Type | Description | Notes
|
|
857
857
|
------------- | ------------- | ------------- | -------------
|
|
858
858
|
**id** | **String**| Consumed object ID | |
|
|
859
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
860
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
859
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
860
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
861
861
|
{: class="table table-striped"}
|
|
862
862
|
|
|
863
863
|
|
|
@@ -924,10 +924,10 @@ end
|
|
|
924
924
|
Name | Type | Description | Notes
|
|
925
925
|
------------- | ------------- | ------------- | -------------
|
|
926
926
|
**name** | **String**| Name to search for | [optional] |
|
|
927
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
927
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
928
928
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
|
929
929
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
930
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
930
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
931
931
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
932
932
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
933
933
|
{: class="table table-striped"}
|
|
@@ -998,11 +998,11 @@ Name | Type | Description | Notes
|
|
|
998
998
|
------------- | ------------- | ------------- | -------------
|
|
999
999
|
**id** | **String**| Object ID | |
|
|
1000
1000
|
**version** | **String**| Object version | [optional] |
|
|
1001
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1001
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1002
1002
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
|
1003
1003
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
|
1004
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1005
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1004
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1005
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1006
1006
|
{: class="table table-striped"}
|
|
1007
1007
|
|
|
1008
1008
|
|
|
@@ -1189,9 +1189,9 @@ end
|
|
|
1189
1189
|
Name | Type | Description | Notes
|
|
1190
1190
|
------------- | ------------- | ------------- | -------------
|
|
1191
1191
|
**name** | **String**| Name to search for | [optional] |
|
|
1192
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1192
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1193
1193
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
1194
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1194
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1195
1195
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1196
1196
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1197
1197
|
{: class="table table-striped"}
|
|
@@ -1628,7 +1628,9 @@ opts = {
|
|
|
1628
1628
|
page_size: 25, # Integer | Page size
|
|
1629
1629
|
name: "name_example", # String | Name
|
|
1630
1630
|
description: "description_example", # String | Description
|
|
1631
|
-
name_or_description: "name_or_description_example" # String | Name or description
|
|
1631
|
+
name_or_description: "name_or_description_example", # String | Name or description
|
|
1632
|
+
sort_by: "id", # String | Sort by
|
|
1633
|
+
sort_order: "asc" # String | Sort order
|
|
1632
1634
|
}
|
|
1633
1635
|
|
|
1634
1636
|
begin
|
|
@@ -1649,6 +1651,8 @@ Name | Type | Description | Notes
|
|
|
1649
1651
|
**name** | **String**| Name | [optional] |
|
|
1650
1652
|
**description** | **String**| Description | [optional] |
|
|
1651
1653
|
**name_or_description** | **String**| Name or description | [optional] |
|
|
1654
|
+
**sort_by** | **String**| Sort by | [optional] [default to id] |
|
|
1655
|
+
**sort_order** | **String**| Sort order | [optional] [default to asc] |
|
|
1652
1656
|
{: class="table table-striped"}
|
|
1653
1657
|
|
|
1654
1658
|
|
data/docs/CallForwarding.md
CHANGED
|
@@ -10,8 +10,10 @@ title: CallForwarding
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **user** | [**User**](User.html) | | [optional] |
|
|
13
|
-
| **enabled** | **BOOLEAN** |
|
|
14
|
-
| **phone_number** | **String** |
|
|
13
|
+
| **enabled** | **BOOLEAN** | Whether or not CallForwarding is enabled | [optional] |
|
|
14
|
+
| **phone_number** | **String** | This property is deprecated. Please use the calls property | [optional] |
|
|
15
|
+
| **calls** | [**Array<CallRoute>**](CallRoute.html) | An ordered list of CallRoutes to be executed when CallForwarding is enabled | [optional] |
|
|
16
|
+
| **voicemail** | **String** | The type of voicemail to use with the callForwarding configuration | [optional] |
|
|
15
17
|
| **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
19
|
{: class="table table-striped"}
|
|
@@ -44,6 +44,7 @@ title: CallMediaParticipant
|
|
|
44
44
|
| **fax_status** | [**FaxStatus**](FaxStatus.html) | Extra fax information if the call is a fax. | [optional] |
|
|
45
45
|
| **monitored_participant_id** | **String** | The ID of the participant being monitored when performing a call monitor. | [optional] |
|
|
46
46
|
| **consult_participant_id** | **String** | The ID of the consult transfer target participant when performing a consult transfer. | [optional] |
|
|
47
|
+
| **uui_data** | **String** | User-to-User information which maps to a SIP header field defined in RFC7433. UUI data is used in the Public Switched Telephone Network (PSTN) for use cases described in RFC6567. | [optional] |
|
|
47
48
|
{: class="table table-striped"}
|
|
48
49
|
|
|
49
50
|
|
data/docs/CallRoute.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallRoute
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallRoute
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **targets** | [**Array<CallTarget>**](CallTarget.html) | A list of CallTargets to be called when the CallRoute is executed | [optional] |
|
|
11
|
+
| **timeout_milliseconds** | **Integer** | The amount of time until the call times out | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/CallTarget.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallTarget
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallTarget
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | The type of call | [optional] |
|
|
11
|
+
| **value** | **String** | The id of the station or an E.164 formatted phone number | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/Contact.md
CHANGED
|
@@ -11,7 +11,7 @@ title: Contact
|
|
|
11
11
|
| **display** | **String** | Formatted version of the address property | [optional] |
|
|
12
12
|
| **media_type** | **String** | | [optional] |
|
|
13
13
|
| **type** | **String** | | [optional] |
|
|
14
|
-
| **extension** | **String** | Use extension instead of address
|
|
14
|
+
| **extension** | **String** | Use internal extension instead of address. Mutually exclusive with the address field. | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
|
|
@@ -21,6 +21,9 @@ title: ConversationNotificationMessage
|
|
|
21
21
|
| **from_address** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
22
22
|
| **messages** | [**Array<ConversationNotificationMessages>**](ConversationNotificationMessages.html) | | [optional] |
|
|
23
23
|
| **messages_transcript_uri** | **String** | | [optional] |
|
|
24
|
+
| **type** | **String** | | [optional] |
|
|
25
|
+
| **recipient_country** | **String** | | [optional] |
|
|
26
|
+
| **recipient_type** | **String** | | [optional] |
|
|
24
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
28
|
{: class="table table-striped"}
|
|
26
29
|
|
|
@@ -9,6 +9,8 @@ title: ConversationNotificationMessageDetails
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **message_id** | **String** | | [optional] |
|
|
11
11
|
| **message_time** | **DateTime** | | [optional] |
|
|
12
|
+
| **message_status** | **String** | | [optional] |
|
|
13
|
+
| **message_segment_count** | **Integer** | | [optional] |
|
|
12
14
|
{: class="table table-striped"}
|
|
13
15
|
|
|
14
16
|
|
|
@@ -9,6 +9,8 @@ title: ConversationNotificationMessages
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **message_id** | **String** | | [optional] |
|
|
11
11
|
| **message_time** | **DateTime** | | [optional] |
|
|
12
|
+
| **message_status** | **String** | | [optional] |
|
|
13
|
+
| **message_segment_count** | **Integer** | | [optional] |
|
|
12
14
|
{: class="table table-striped"}
|
|
13
15
|
|
|
14
16
|
|
|
@@ -21,6 +21,9 @@ title: ConversationNotificationMessages1
|
|
|
21
21
|
| **from_address** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
22
22
|
| **messages** | [**Array<ConversationNotificationMessages>**](ConversationNotificationMessages.html) | | [optional] |
|
|
23
23
|
| **messages_transcript_uri** | **String** | | [optional] |
|
|
24
|
+
| **type** | **String** | | [optional] |
|
|
25
|
+
| **recipient_country** | **String** | | [optional] |
|
|
26
|
+
| **recipient_type** | **String** | | [optional] |
|
|
24
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
28
|
{: class="table table-striped"}
|
|
26
29
|
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -13,6 +13,8 @@ Method | Description
|
|
|
13
13
|
[**delete_conversations_email_messages_draft_attachment**](ConversationsApi.html#delete_conversations_email_messages_draft_attachment) | Delete attachment from draft
|
|
14
14
|
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
15
15
|
[**get_conversation**](ConversationsApi.html#get_conversation) | Get conversation
|
|
16
|
+
[**get_conversation_participant_secureivrsession**](ConversationsApi.html#get_conversation_participant_secureivrsession) | Fetch info on a secure session
|
|
17
|
+
[**get_conversation_participant_secureivrsessions**](ConversationsApi.html#get_conversation_participant_secureivrsessions) | Get a list of secure sessions for this participant.
|
|
16
18
|
[**get_conversation_participant_wrapup**](ConversationsApi.html#get_conversation_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
17
19
|
[**get_conversation_participant_wrapupcodes**](ConversationsApi.html#get_conversation_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
18
20
|
[**get_conversations**](ConversationsApi.html#get_conversations) | Get conversations
|
|
@@ -70,6 +72,7 @@ Method | Description
|
|
|
70
72
|
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
71
73
|
[**post_conversation_participant_digits**](ConversationsApi.html#post_conversation_participant_digits) | Sends DTMF to the participant
|
|
72
74
|
[**post_conversation_participant_replace**](ConversationsApi.html#post_conversation_participant_replace) | Replace this participant with the specified user and/or address
|
|
75
|
+
[**post_conversation_participant_secureivrsessions**](ConversationsApi.html#post_conversation_participant_secureivrsessions) | Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
73
76
|
[**post_conversations_call**](ConversationsApi.html#post_conversations_call) | Place a new call as part of a callback conversation.
|
|
74
77
|
[**post_conversations_call_participant_consult**](ConversationsApi.html#post_conversations_call_participant_consult) | Initiate and update consult transfer
|
|
75
78
|
[**post_conversations_call_participant_monitor**](ConversationsApi.html#post_conversations_call_participant_monitor) | Listen in on the conversation from the point of view of a given participant.
|
|
@@ -394,6 +397,133 @@ Name | Type | Description | Notes
|
|
|
394
397
|
|
|
395
398
|
|
|
396
399
|
|
|
400
|
+
<a name="get_conversation_participant_secureivrsession"></a>
|
|
401
|
+
|
|
402
|
+
## -[**SecureSession**](SecureSession.html) get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
|
403
|
+
|
|
404
|
+
Fetch info on a secure session
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
### Example
|
|
412
|
+
~~~ruby
|
|
413
|
+
# load the gem
|
|
414
|
+
require 'purecloudplatformclientv2'
|
|
415
|
+
# setup authorization
|
|
416
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
417
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
418
|
+
environment = "mypurecloud.com"
|
|
419
|
+
|
|
420
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
421
|
+
|
|
422
|
+
PureCloud.configure do |config|
|
|
423
|
+
config.access_token = @authToken
|
|
424
|
+
end
|
|
425
|
+
|
|
426
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
427
|
+
|
|
428
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
429
|
+
|
|
430
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
431
|
+
|
|
432
|
+
secure_session_id = "secure_session_id_example" # String | secure IVR session ID
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
begin
|
|
436
|
+
#Fetch info on a secure session
|
|
437
|
+
result = api_instance.get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
|
438
|
+
p result
|
|
439
|
+
rescue PureCloud::ApiError => e
|
|
440
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsession: #{e}"
|
|
441
|
+
end
|
|
442
|
+
~~~
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
Name | Type | Description | Notes
|
|
447
|
+
------------- | ------------- | ------------- | -------------
|
|
448
|
+
**conversation_id** | **String**| conversation ID | |
|
|
449
|
+
**participant_id** | **String**| participant ID | |
|
|
450
|
+
**secure_session_id** | **String**| secure IVR session ID | |
|
|
451
|
+
{: class="table table-striped"}
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
### Return type
|
|
455
|
+
|
|
456
|
+
[**SecureSession**](SecureSession.html)
|
|
457
|
+
|
|
458
|
+
### HTTP request headers
|
|
459
|
+
|
|
460
|
+
- **Content-Type**: application/json
|
|
461
|
+
- **Accept**: application/json
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
<a name="get_conversation_participant_secureivrsessions"></a>
|
|
466
|
+
|
|
467
|
+
## -[**SecureSessionEntityListing**](SecureSessionEntityListing.html) get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
|
468
|
+
|
|
469
|
+
Get a list of secure sessions for this participant.
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
### Example
|
|
477
|
+
~~~ruby
|
|
478
|
+
# load the gem
|
|
479
|
+
require 'purecloudplatformclientv2'
|
|
480
|
+
# setup authorization
|
|
481
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
482
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
483
|
+
environment = "mypurecloud.com"
|
|
484
|
+
|
|
485
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
486
|
+
|
|
487
|
+
PureCloud.configure do |config|
|
|
488
|
+
config.access_token = @authToken
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
492
|
+
|
|
493
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
494
|
+
|
|
495
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
begin
|
|
499
|
+
#Get a list of secure sessions for this participant.
|
|
500
|
+
result = api_instance.get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
|
501
|
+
p result
|
|
502
|
+
rescue PureCloud::ApiError => e
|
|
503
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsessions: #{e}"
|
|
504
|
+
end
|
|
505
|
+
~~~
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
Name | Type | Description | Notes
|
|
510
|
+
------------- | ------------- | ------------- | -------------
|
|
511
|
+
**conversation_id** | **String**| conversation ID | |
|
|
512
|
+
**participant_id** | **String**| participant ID | |
|
|
513
|
+
{: class="table table-striped"}
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
### Return type
|
|
517
|
+
|
|
518
|
+
[**SecureSessionEntityListing**](SecureSessionEntityListing.html)
|
|
519
|
+
|
|
520
|
+
### HTTP request headers
|
|
521
|
+
|
|
522
|
+
- **Content-Type**: application/json
|
|
523
|
+
- **Accept**: application/json
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
397
527
|
<a name="get_conversation_participant_wrapup"></a>
|
|
398
528
|
|
|
399
529
|
## -[**WrapupCode**](WrapupCode.html) get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
@@ -3940,6 +4070,72 @@ nil (empty response body)
|
|
|
3940
4070
|
|
|
3941
4071
|
|
|
3942
4072
|
|
|
4073
|
+
<a name="post_conversation_participant_secureivrsessions"></a>
|
|
4074
|
+
|
|
4075
|
+
## -[**SecureSession**](SecureSession.html) post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts)
|
|
4076
|
+
|
|
4077
|
+
Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
4078
|
+
|
|
4079
|
+
|
|
4080
|
+
|
|
4081
|
+
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
|
|
4082
|
+
|
|
4083
|
+
|
|
4084
|
+
### Example
|
|
4085
|
+
~~~ruby
|
|
4086
|
+
# load the gem
|
|
4087
|
+
require 'purecloudplatformclientv2'
|
|
4088
|
+
# setup authorization
|
|
4089
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4090
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4091
|
+
environment = "mypurecloud.com"
|
|
4092
|
+
|
|
4093
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4094
|
+
|
|
4095
|
+
PureCloud.configure do |config|
|
|
4096
|
+
config.access_token = @authToken
|
|
4097
|
+
end
|
|
4098
|
+
|
|
4099
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
4100
|
+
|
|
4101
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
4102
|
+
|
|
4103
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
4104
|
+
|
|
4105
|
+
opts = {
|
|
4106
|
+
body: PureCloud::CreateSecureSession.new # CreateSecureSession |
|
|
4107
|
+
}
|
|
4108
|
+
|
|
4109
|
+
begin
|
|
4110
|
+
#Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
4111
|
+
result = api_instance.post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts)
|
|
4112
|
+
p result
|
|
4113
|
+
rescue PureCloud::ApiError => e
|
|
4114
|
+
puts "Exception when calling ConversationsApi->post_conversation_participant_secureivrsessions: #{e}"
|
|
4115
|
+
end
|
|
4116
|
+
~~~
|
|
4117
|
+
|
|
4118
|
+
### Parameters
|
|
4119
|
+
|
|
4120
|
+
Name | Type | Description | Notes
|
|
4121
|
+
------------- | ------------- | ------------- | -------------
|
|
4122
|
+
**conversation_id** | **String**| conversation ID | |
|
|
4123
|
+
**participant_id** | **String**| participant ID | |
|
|
4124
|
+
**body** | [**CreateSecureSession**](CreateSecureSession.html)| | [optional] |
|
|
4125
|
+
{: class="table table-striped"}
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
### Return type
|
|
4129
|
+
|
|
4130
|
+
[**SecureSession**](SecureSession.html)
|
|
4131
|
+
|
|
4132
|
+
### HTTP request headers
|
|
4133
|
+
|
|
4134
|
+
- **Content-Type**: application/json
|
|
4135
|
+
- **Accept**: application/json
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
3943
4139
|
<a name="post_conversations_call"></a>
|
|
3944
4140
|
|
|
3945
4141
|
## -[**Conversation**](Conversation.html) post_conversations_call(conversation_id, body)
|