purecloudplatformclientv2 2.0.40 → 3.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/AgentActivityEntityListing.md +1 -1
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +260 -260
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/Dependency.md +1 -0
- data/docs/DependencyObject.md +1 -0
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/HeartBeatAlertContainer.md +1 -1
- data/docs/HeartBeatRuleContainer.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IntradayDataGroup.md +19 -0
- data/docs/IntradayForecastData.md +15 -0
- data/docs/IntradayHistoricalAgentData.md +14 -0
- data/docs/IntradayHistoricalQueueData.md +20 -0
- data/docs/IntradayMetric.md +14 -0
- data/docs/IntradayPerformancePredictionAgentData.md +13 -0
- data/docs/IntradayPerformancePredictionQueueData.md +15 -0
- data/docs/IntradayQueryDataCommand.md +17 -0
- data/docs/IntradayQueue.md +15 -0
- data/docs/IntradayResponse.md +20 -0
- data/docs/IntradayScheduleData.md +14 -0
- data/docs/JsonNode.md +5 -5
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseDefinition.md +1 -0
- data/docs/LicenseDefinitionListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/MediaTranscription.md +15 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyActions.md +1 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingStatusAlertContainer.md +1 -1
- data/docs/RoutingStatusRuleContainer.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +60 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserPresenceAlertContainer.md +1 -1
- data/docs/UserPresenceRuleContainer.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WfmIntradayQueueListing.md +14 -0
- data/docs/WorkforceManagementApi.md +127 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +13 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +416 -416
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +58 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +121 -0
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/call.rb +14 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +14 -4
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/dependency.rb +12 -3
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +12 -3
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +10 -10
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/heart_beat_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/heart_beat_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +265 -0
- data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +199 -0
- data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +189 -0
- data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +249 -0
- data/lib/purecloudplatformclientv2/models/intraday_metric.rb +203 -0
- data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +179 -0
- data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +199 -0
- data/lib/purecloudplatformclientv2/models/intraday_query_data_command.rb +235 -0
- data/lib/purecloudplatformclientv2/models/intraday_queue.rb +201 -0
- data/lib/purecloudplatformclientv2/models/intraday_response.rb +269 -0
- data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +189 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +37 -37
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/license_definition.rb +12 -1
- data/lib/purecloudplatformclientv2/models/license_definition_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/media_transcription.rb +210 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/policy_actions.rb +15 -4
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +10 -10
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/routing_status_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/routing_status_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_presence_alert_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_presence_rule_container.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/wfm_intraday_queue_listing.rb +204 -0
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +10 -10
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +28 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5849aa47719d25046346ec804915204d1ba9f389
|
|
4
|
+
data.tar.gz: 9f9c34374d2414c30443af9224af344e261179b7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2536b2fc287286b2e33c2bc953e050f07d083e523a96c0e65aa78da307d217188a0c586cb00e75614ddff01e76cf2c467a4be719b85688f72c2e24b80e5d8d3b
|
|
7
|
+
data.tar.gz: 163a7eb1d5e5107abc4751dfe799a6ed131e2c7e2334f1b57ff2b557dabf69087196ae0123eeeb6615224c59a73d80f8bf32360688603203f83cbfebe3ab8149
|
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/latest/
|
|
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
|
~~~
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 3.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
|
@@ -14,8 +14,8 @@ title: AgentActivityEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: AttemptLimitsEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: AttributeEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CalibrationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Call.md
CHANGED
|
@@ -26,6 +26,7 @@ title: Call
|
|
|
26
26
|
| **disconnect_reasons** | [**Array<DisconnectReason>**](DisconnectReason.html) | List of reasons that this call was disconnected. This will be set once the call disconnects. | [optional] |
|
|
27
27
|
| **fax_status** | [**FaxStatus**](FaxStatus.html) | Extra information on fax transmission. | [optional] |
|
|
28
28
|
| **provider** | **String** | The source provider for the call. | [optional] |
|
|
29
|
+
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
|
29
30
|
{: class="table table-striped"}
|
|
30
31
|
|
|
31
32
|
|
data/docs/CallBasic.md
CHANGED
|
@@ -26,6 +26,7 @@ title: CallBasic
|
|
|
26
26
|
| **disconnect_reasons** | [**Array<DisconnectReason>**](DisconnectReason.html) | List of reasons that this call was disconnected. This will be set once the call disconnects. | [optional] |
|
|
27
27
|
| **fax_status** | [**FaxStatus**](FaxStatus.html) | Extra information on fax transmission. | [optional] |
|
|
28
28
|
| **provider** | **String** | The source provider for the call. | [optional] |
|
|
29
|
+
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
|
29
30
|
{: class="table table-striped"}
|
|
30
31
|
|
|
31
32
|
|
|
@@ -14,8 +14,8 @@ title: CallConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CallableTimeSetEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CallbackConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignRuleEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignSequenceEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CertificateAuthorityEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ChatConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CobrowseConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CommandStatusEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ConsumedResourcesEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ConsumingResourcesEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ContactListEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ContactListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: ContactListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -153,13 +153,13 @@ nil (empty response body)
|
|
|
153
153
|
|
|
154
154
|
<a name="delete_conversations_call_participant_consult"></a>
|
|
155
155
|
|
|
156
|
-
## -String** delete_conversations_call_participant_consult(
|
|
156
|
+
## -String** delete_conversations_call_participant_consult(conversation_id, participant_id)
|
|
157
157
|
|
|
158
158
|
Cancel the transfer
|
|
159
159
|
|
|
160
160
|
|
|
161
161
|
|
|
162
|
-
Wraps DELETE /api/v2/conversations/calls/{
|
|
162
|
+
Wraps DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
163
163
|
|
|
164
164
|
|
|
165
165
|
### Example
|
|
@@ -179,14 +179,14 @@ end
|
|
|
179
179
|
|
|
180
180
|
api_instance = PureCloud::ConversationsApi.new
|
|
181
181
|
|
|
182
|
-
|
|
182
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
183
183
|
|
|
184
184
|
participant_id = "participant_id_example" # String | participantId
|
|
185
185
|
|
|
186
186
|
|
|
187
187
|
begin
|
|
188
188
|
#Cancel the transfer
|
|
189
|
-
result = api_instance.delete_conversations_call_participant_consult(
|
|
189
|
+
result = api_instance.delete_conversations_call_participant_consult(conversation_id, participant_id)
|
|
190
190
|
p result
|
|
191
191
|
rescue PureCloud::ApiError => e
|
|
192
192
|
puts "Exception when calling ConversationsApi->delete_conversations_call_participant_consult: #{e}"
|
|
@@ -197,7 +197,7 @@ end
|
|
|
197
197
|
|
|
198
198
|
Name | Type | Description | Notes
|
|
199
199
|
------------- | ------------- | ------------- | -------------
|
|
200
|
-
**
|
|
200
|
+
**conversation_id** | **String**| conversationId |
|
|
201
201
|
**participant_id** | **String**| participantId |
|
|
202
202
|
{: class="table table-striped"}
|
|
203
203
|
|
|
@@ -215,13 +215,13 @@ Name | Type | Description | Notes
|
|
|
215
215
|
|
|
216
216
|
<a name="delete_conversations_email_messages_draft_attachment"></a>
|
|
217
217
|
|
|
218
|
-
## -String** delete_conversations_email_messages_draft_attachment(
|
|
218
|
+
## -String** delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id)
|
|
219
219
|
|
|
220
220
|
Delete attachment from draft
|
|
221
221
|
|
|
222
222
|
|
|
223
223
|
|
|
224
|
-
Wraps DELETE /api/v2/conversations/emails/{
|
|
224
|
+
Wraps DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}
|
|
225
225
|
|
|
226
226
|
|
|
227
227
|
### Example
|
|
@@ -241,14 +241,14 @@ end
|
|
|
241
241
|
|
|
242
242
|
api_instance = PureCloud::ConversationsApi.new
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
245
245
|
|
|
246
246
|
attachment_id = "attachment_id_example" # String | attachmentId
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
begin
|
|
250
250
|
#Delete attachment from draft
|
|
251
|
-
result = api_instance.delete_conversations_email_messages_draft_attachment(
|
|
251
|
+
result = api_instance.delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id)
|
|
252
252
|
p result
|
|
253
253
|
rescue PureCloud::ApiError => e
|
|
254
254
|
puts "Exception when calling ConversationsApi->delete_conversations_email_messages_draft_attachment: #{e}"
|
|
@@ -259,7 +259,7 @@ end
|
|
|
259
259
|
|
|
260
260
|
Name | Type | Description | Notes
|
|
261
261
|
------------- | ------------- | ------------- | -------------
|
|
262
|
-
**
|
|
262
|
+
**conversation_id** | **String**| conversationId |
|
|
263
263
|
**attachment_id** | **String**| attachmentId |
|
|
264
264
|
{: class="table table-striped"}
|
|
265
265
|
|
|
@@ -583,13 +583,13 @@ Name | Type | Description | Notes
|
|
|
583
583
|
|
|
584
584
|
<a name="get_conversations_call"></a>
|
|
585
585
|
|
|
586
|
-
## -[**CallConversation**](CallConversation.html) get_conversations_call(
|
|
586
|
+
## -[**CallConversation**](CallConversation.html) get_conversations_call(conversation_id)
|
|
587
587
|
|
|
588
588
|
Get call conversation
|
|
589
589
|
|
|
590
590
|
|
|
591
591
|
|
|
592
|
-
Wraps GET /api/v2/conversations/calls/{
|
|
592
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}
|
|
593
593
|
|
|
594
594
|
|
|
595
595
|
### Example
|
|
@@ -609,12 +609,12 @@ end
|
|
|
609
609
|
|
|
610
610
|
api_instance = PureCloud::ConversationsApi.new
|
|
611
611
|
|
|
612
|
-
|
|
612
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
613
613
|
|
|
614
614
|
|
|
615
615
|
begin
|
|
616
616
|
#Get call conversation
|
|
617
|
-
result = api_instance.get_conversations_call(
|
|
617
|
+
result = api_instance.get_conversations_call(conversation_id)
|
|
618
618
|
p result
|
|
619
619
|
rescue PureCloud::ApiError => e
|
|
620
620
|
puts "Exception when calling ConversationsApi->get_conversations_call: #{e}"
|
|
@@ -625,7 +625,7 @@ end
|
|
|
625
625
|
|
|
626
626
|
Name | Type | Description | Notes
|
|
627
627
|
------------- | ------------- | ------------- | -------------
|
|
628
|
-
**
|
|
628
|
+
**conversation_id** | **String**| conversationId |
|
|
629
629
|
{: class="table table-striped"}
|
|
630
630
|
|
|
631
631
|
|
|
@@ -642,13 +642,13 @@ Name | Type | Description | Notes
|
|
|
642
642
|
|
|
643
643
|
<a name="get_conversations_call_participant_wrapup"></a>
|
|
644
644
|
|
|
645
|
-
## -[**Wrapup**](Wrapup.html) get_conversations_call_participant_wrapup(
|
|
645
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
|
646
646
|
|
|
647
647
|
Get the wrap-up for this conversation participant.
|
|
648
648
|
|
|
649
649
|
|
|
650
650
|
|
|
651
|
-
Wraps GET /api/v2/conversations/calls/{
|
|
651
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup
|
|
652
652
|
|
|
653
653
|
|
|
654
654
|
### Example
|
|
@@ -668,7 +668,7 @@ end
|
|
|
668
668
|
|
|
669
669
|
api_instance = PureCloud::ConversationsApi.new
|
|
670
670
|
|
|
671
|
-
|
|
671
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
672
672
|
|
|
673
673
|
participant_id = "participant_id_example" # String | participantId
|
|
674
674
|
|
|
@@ -678,7 +678,7 @@ opts = {
|
|
|
678
678
|
|
|
679
679
|
begin
|
|
680
680
|
#Get the wrap-up for this conversation participant.
|
|
681
|
-
result = api_instance.get_conversations_call_participant_wrapup(
|
|
681
|
+
result = api_instance.get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
|
682
682
|
p result
|
|
683
683
|
rescue PureCloud::ApiError => e
|
|
684
684
|
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapup: #{e}"
|
|
@@ -689,7 +689,7 @@ end
|
|
|
689
689
|
|
|
690
690
|
Name | Type | Description | Notes
|
|
691
691
|
------------- | ------------- | ------------- | -------------
|
|
692
|
-
**
|
|
692
|
+
**conversation_id** | **String**| conversationId |
|
|
693
693
|
**participant_id** | **String**| participantId |
|
|
694
694
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
695
695
|
{: class="table table-striped"}
|
|
@@ -708,13 +708,13 @@ Name | Type | Description | Notes
|
|
|
708
708
|
|
|
709
709
|
<a name="get_conversations_call_participant_wrapupcodes"></a>
|
|
710
710
|
|
|
711
|
-
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(
|
|
711
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
|
712
712
|
|
|
713
713
|
Get list of wrapup codes for this conversation participant
|
|
714
714
|
|
|
715
715
|
|
|
716
716
|
|
|
717
|
-
Wraps GET /api/v2/conversations/calls/{
|
|
717
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes
|
|
718
718
|
|
|
719
719
|
|
|
720
720
|
### Example
|
|
@@ -734,14 +734,14 @@ end
|
|
|
734
734
|
|
|
735
735
|
api_instance = PureCloud::ConversationsApi.new
|
|
736
736
|
|
|
737
|
-
|
|
737
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
738
738
|
|
|
739
739
|
participant_id = "participant_id_example" # String | participantId
|
|
740
740
|
|
|
741
741
|
|
|
742
742
|
begin
|
|
743
743
|
#Get list of wrapup codes for this conversation participant
|
|
744
|
-
result = api_instance.get_conversations_call_participant_wrapupcodes(
|
|
744
|
+
result = api_instance.get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
|
745
745
|
p result
|
|
746
746
|
rescue PureCloud::ApiError => e
|
|
747
747
|
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapupcodes: #{e}"
|
|
@@ -752,7 +752,7 @@ end
|
|
|
752
752
|
|
|
753
753
|
Name | Type | Description | Notes
|
|
754
754
|
------------- | ------------- | ------------- | -------------
|
|
755
|
-
**
|
|
755
|
+
**conversation_id** | **String**| conversationId |
|
|
756
756
|
**participant_id** | **String**| participantId |
|
|
757
757
|
{: class="table table-striped"}
|
|
758
758
|
|
|
@@ -770,13 +770,13 @@ Name | Type | Description | Notes
|
|
|
770
770
|
|
|
771
771
|
<a name="get_conversations_callback"></a>
|
|
772
772
|
|
|
773
|
-
## -[**CallbackConversation**](CallbackConversation.html) get_conversations_callback(
|
|
773
|
+
## -[**CallbackConversation**](CallbackConversation.html) get_conversations_callback(conversation_id)
|
|
774
774
|
|
|
775
775
|
Get callback conversation
|
|
776
776
|
|
|
777
777
|
|
|
778
778
|
|
|
779
|
-
Wraps GET /api/v2/conversations/callbacks/{
|
|
779
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}
|
|
780
780
|
|
|
781
781
|
|
|
782
782
|
### Example
|
|
@@ -796,12 +796,12 @@ end
|
|
|
796
796
|
|
|
797
797
|
api_instance = PureCloud::ConversationsApi.new
|
|
798
798
|
|
|
799
|
-
|
|
799
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
800
800
|
|
|
801
801
|
|
|
802
802
|
begin
|
|
803
803
|
#Get callback conversation
|
|
804
|
-
result = api_instance.get_conversations_callback(
|
|
804
|
+
result = api_instance.get_conversations_callback(conversation_id)
|
|
805
805
|
p result
|
|
806
806
|
rescue PureCloud::ApiError => e
|
|
807
807
|
puts "Exception when calling ConversationsApi->get_conversations_callback: #{e}"
|
|
@@ -812,7 +812,7 @@ end
|
|
|
812
812
|
|
|
813
813
|
Name | Type | Description | Notes
|
|
814
814
|
------------- | ------------- | ------------- | -------------
|
|
815
|
-
**
|
|
815
|
+
**conversation_id** | **String**| conversationId |
|
|
816
816
|
{: class="table table-striped"}
|
|
817
817
|
|
|
818
818
|
|
|
@@ -829,13 +829,13 @@ Name | Type | Description | Notes
|
|
|
829
829
|
|
|
830
830
|
<a name="get_conversations_callback_participant_wrapup"></a>
|
|
831
831
|
|
|
832
|
-
## -[**Wrapup**](Wrapup.html) get_conversations_callback_participant_wrapup(
|
|
832
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
|
833
833
|
|
|
834
834
|
Get the wrap-up for this conversation participant.
|
|
835
835
|
|
|
836
836
|
|
|
837
837
|
|
|
838
|
-
Wraps GET /api/v2/conversations/callbacks/{
|
|
838
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup
|
|
839
839
|
|
|
840
840
|
|
|
841
841
|
### Example
|
|
@@ -855,7 +855,7 @@ end
|
|
|
855
855
|
|
|
856
856
|
api_instance = PureCloud::ConversationsApi.new
|
|
857
857
|
|
|
858
|
-
|
|
858
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
859
859
|
|
|
860
860
|
participant_id = "participant_id_example" # String | participantId
|
|
861
861
|
|
|
@@ -865,7 +865,7 @@ opts = {
|
|
|
865
865
|
|
|
866
866
|
begin
|
|
867
867
|
#Get the wrap-up for this conversation participant.
|
|
868
|
-
result = api_instance.get_conversations_callback_participant_wrapup(
|
|
868
|
+
result = api_instance.get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
|
869
869
|
p result
|
|
870
870
|
rescue PureCloud::ApiError => e
|
|
871
871
|
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: #{e}"
|
|
@@ -876,7 +876,7 @@ end
|
|
|
876
876
|
|
|
877
877
|
Name | Type | Description | Notes
|
|
878
878
|
------------- | ------------- | ------------- | -------------
|
|
879
|
-
**
|
|
879
|
+
**conversation_id** | **String**| conversationId |
|
|
880
880
|
**participant_id** | **String**| participantId |
|
|
881
881
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
882
882
|
{: class="table table-striped"}
|
|
@@ -895,13 +895,13 @@ Name | Type | Description | Notes
|
|
|
895
895
|
|
|
896
896
|
<a name="get_conversations_callback_participant_wrapupcodes"></a>
|
|
897
897
|
|
|
898
|
-
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(
|
|
898
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
|
899
899
|
|
|
900
900
|
Get list of wrapup codes for this conversation participant
|
|
901
901
|
|
|
902
902
|
|
|
903
903
|
|
|
904
|
-
Wraps GET /api/v2/conversations/callbacks/{
|
|
904
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes
|
|
905
905
|
|
|
906
906
|
|
|
907
907
|
### Example
|
|
@@ -921,14 +921,14 @@ end
|
|
|
921
921
|
|
|
922
922
|
api_instance = PureCloud::ConversationsApi.new
|
|
923
923
|
|
|
924
|
-
|
|
924
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
925
925
|
|
|
926
926
|
participant_id = "participant_id_example" # String | participantId
|
|
927
927
|
|
|
928
928
|
|
|
929
929
|
begin
|
|
930
930
|
#Get list of wrapup codes for this conversation participant
|
|
931
|
-
result = api_instance.get_conversations_callback_participant_wrapupcodes(
|
|
931
|
+
result = api_instance.get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
|
932
932
|
p result
|
|
933
933
|
rescue PureCloud::ApiError => e
|
|
934
934
|
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: #{e}"
|
|
@@ -939,7 +939,7 @@ end
|
|
|
939
939
|
|
|
940
940
|
Name | Type | Description | Notes
|
|
941
941
|
------------- | ------------- | ------------- | -------------
|
|
942
|
-
**
|
|
942
|
+
**conversation_id** | **String**| conversationId |
|
|
943
943
|
**participant_id** | **String**| participantId |
|
|
944
944
|
{: class="table table-striped"}
|
|
945
945
|
|
|
@@ -1180,13 +1180,13 @@ This endpoint does not need any parameter.
|
|
|
1180
1180
|
|
|
1181
1181
|
<a name="get_conversations_chat"></a>
|
|
1182
1182
|
|
|
1183
|
-
## -[**ChatConversation**](ChatConversation.html) get_conversations_chat(
|
|
1183
|
+
## -[**ChatConversation**](ChatConversation.html) get_conversations_chat(conversation_id)
|
|
1184
1184
|
|
|
1185
1185
|
Get chat conversation
|
|
1186
1186
|
|
|
1187
1187
|
|
|
1188
1188
|
|
|
1189
|
-
Wraps GET /api/v2/conversations/chats/{
|
|
1189
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}
|
|
1190
1190
|
|
|
1191
1191
|
|
|
1192
1192
|
### Example
|
|
@@ -1206,12 +1206,12 @@ end
|
|
|
1206
1206
|
|
|
1207
1207
|
api_instance = PureCloud::ConversationsApi.new
|
|
1208
1208
|
|
|
1209
|
-
|
|
1209
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1210
1210
|
|
|
1211
1211
|
|
|
1212
1212
|
begin
|
|
1213
1213
|
#Get chat conversation
|
|
1214
|
-
result = api_instance.get_conversations_chat(
|
|
1214
|
+
result = api_instance.get_conversations_chat(conversation_id)
|
|
1215
1215
|
p result
|
|
1216
1216
|
rescue PureCloud::ApiError => e
|
|
1217
1217
|
puts "Exception when calling ConversationsApi->get_conversations_chat: #{e}"
|
|
@@ -1222,7 +1222,7 @@ end
|
|
|
1222
1222
|
|
|
1223
1223
|
Name | Type | Description | Notes
|
|
1224
1224
|
------------- | ------------- | ------------- | -------------
|
|
1225
|
-
**
|
|
1225
|
+
**conversation_id** | **String**| conversationId |
|
|
1226
1226
|
{: class="table table-striped"}
|
|
1227
1227
|
|
|
1228
1228
|
|
|
@@ -1239,13 +1239,13 @@ Name | Type | Description | Notes
|
|
|
1239
1239
|
|
|
1240
1240
|
<a name="get_conversations_chat_participant_wrapup"></a>
|
|
1241
1241
|
|
|
1242
|
-
## -[**Wrapup**](Wrapup.html) get_conversations_chat_participant_wrapup(
|
|
1242
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
|
1243
1243
|
|
|
1244
1244
|
Get the wrap-up for this conversation participant.
|
|
1245
1245
|
|
|
1246
1246
|
|
|
1247
1247
|
|
|
1248
|
-
Wraps GET /api/v2/conversations/chats/{
|
|
1248
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup
|
|
1249
1249
|
|
|
1250
1250
|
|
|
1251
1251
|
### Example
|
|
@@ -1265,7 +1265,7 @@ end
|
|
|
1265
1265
|
|
|
1266
1266
|
api_instance = PureCloud::ConversationsApi.new
|
|
1267
1267
|
|
|
1268
|
-
|
|
1268
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1269
1269
|
|
|
1270
1270
|
participant_id = "participant_id_example" # String | participantId
|
|
1271
1271
|
|
|
@@ -1275,7 +1275,7 @@ opts = {
|
|
|
1275
1275
|
|
|
1276
1276
|
begin
|
|
1277
1277
|
#Get the wrap-up for this conversation participant.
|
|
1278
|
-
result = api_instance.get_conversations_chat_participant_wrapup(
|
|
1278
|
+
result = api_instance.get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
|
1279
1279
|
p result
|
|
1280
1280
|
rescue PureCloud::ApiError => e
|
|
1281
1281
|
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapup: #{e}"
|
|
@@ -1286,7 +1286,7 @@ end
|
|
|
1286
1286
|
|
|
1287
1287
|
Name | Type | Description | Notes
|
|
1288
1288
|
------------- | ------------- | ------------- | -------------
|
|
1289
|
-
**
|
|
1289
|
+
**conversation_id** | **String**| conversationId |
|
|
1290
1290
|
**participant_id** | **String**| participantId |
|
|
1291
1291
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1292
1292
|
{: class="table table-striped"}
|
|
@@ -1305,13 +1305,13 @@ Name | Type | Description | Notes
|
|
|
1305
1305
|
|
|
1306
1306
|
<a name="get_conversations_chat_participant_wrapupcodes"></a>
|
|
1307
1307
|
|
|
1308
|
-
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(
|
|
1308
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
|
1309
1309
|
|
|
1310
1310
|
Get list of wrapup codes for this conversation participant
|
|
1311
1311
|
|
|
1312
1312
|
|
|
1313
1313
|
|
|
1314
|
-
Wraps GET /api/v2/conversations/chats/{
|
|
1314
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1315
1315
|
|
|
1316
1316
|
|
|
1317
1317
|
### Example
|
|
@@ -1331,14 +1331,14 @@ end
|
|
|
1331
1331
|
|
|
1332
1332
|
api_instance = PureCloud::ConversationsApi.new
|
|
1333
1333
|
|
|
1334
|
-
|
|
1334
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1335
1335
|
|
|
1336
1336
|
participant_id = "participant_id_example" # String | participantId
|
|
1337
1337
|
|
|
1338
1338
|
|
|
1339
1339
|
begin
|
|
1340
1340
|
#Get list of wrapup codes for this conversation participant
|
|
1341
|
-
result = api_instance.get_conversations_chat_participant_wrapupcodes(
|
|
1341
|
+
result = api_instance.get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
|
1342
1342
|
p result
|
|
1343
1343
|
rescue PureCloud::ApiError => e
|
|
1344
1344
|
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapupcodes: #{e}"
|
|
@@ -1349,7 +1349,7 @@ end
|
|
|
1349
1349
|
|
|
1350
1350
|
Name | Type | Description | Notes
|
|
1351
1351
|
------------- | ------------- | ------------- | -------------
|
|
1352
|
-
**
|
|
1352
|
+
**conversation_id** | **String**| conversationId |
|
|
1353
1353
|
**participant_id** | **String**| participantId |
|
|
1354
1354
|
{: class="table table-striped"}
|
|
1355
1355
|
|
|
@@ -1420,13 +1420,13 @@ This endpoint does not need any parameter.
|
|
|
1420
1420
|
|
|
1421
1421
|
<a name="get_conversations_cobrowsesession"></a>
|
|
1422
1422
|
|
|
1423
|
-
## -[**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(
|
|
1423
|
+
## -[**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(conversation_id)
|
|
1424
1424
|
|
|
1425
1425
|
Get cobrowse conversation
|
|
1426
1426
|
|
|
1427
1427
|
|
|
1428
1428
|
|
|
1429
|
-
Wraps GET /api/v2/conversations/cobrowsesessions/{
|
|
1429
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
1430
1430
|
|
|
1431
1431
|
|
|
1432
1432
|
### Example
|
|
@@ -1446,12 +1446,12 @@ end
|
|
|
1446
1446
|
|
|
1447
1447
|
api_instance = PureCloud::ConversationsApi.new
|
|
1448
1448
|
|
|
1449
|
-
|
|
1449
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1450
1450
|
|
|
1451
1451
|
|
|
1452
1452
|
begin
|
|
1453
1453
|
#Get cobrowse conversation
|
|
1454
|
-
result = api_instance.get_conversations_cobrowsesession(
|
|
1454
|
+
result = api_instance.get_conversations_cobrowsesession(conversation_id)
|
|
1455
1455
|
p result
|
|
1456
1456
|
rescue PureCloud::ApiError => e
|
|
1457
1457
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession: #{e}"
|
|
@@ -1462,7 +1462,7 @@ end
|
|
|
1462
1462
|
|
|
1463
1463
|
Name | Type | Description | Notes
|
|
1464
1464
|
------------- | ------------- | ------------- | -------------
|
|
1465
|
-
**
|
|
1465
|
+
**conversation_id** | **String**| conversationId |
|
|
1466
1466
|
{: class="table table-striped"}
|
|
1467
1467
|
|
|
1468
1468
|
|
|
@@ -1479,13 +1479,13 @@ Name | Type | Description | Notes
|
|
|
1479
1479
|
|
|
1480
1480
|
<a name="get_conversations_cobrowsesession_participant_wrapup"></a>
|
|
1481
1481
|
|
|
1482
|
-
## -[**Wrapup**](Wrapup.html) get_conversations_cobrowsesession_participant_wrapup(
|
|
1482
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
|
1483
1483
|
|
|
1484
1484
|
Get the wrap-up for this conversation participant.
|
|
1485
1485
|
|
|
1486
1486
|
|
|
1487
1487
|
|
|
1488
|
-
Wraps GET /api/v2/conversations/cobrowsesessions/{
|
|
1488
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup
|
|
1489
1489
|
|
|
1490
1490
|
|
|
1491
1491
|
### Example
|
|
@@ -1505,7 +1505,7 @@ end
|
|
|
1505
1505
|
|
|
1506
1506
|
api_instance = PureCloud::ConversationsApi.new
|
|
1507
1507
|
|
|
1508
|
-
|
|
1508
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1509
1509
|
|
|
1510
1510
|
participant_id = "participant_id_example" # String | participantId
|
|
1511
1511
|
|
|
@@ -1515,7 +1515,7 @@ opts = {
|
|
|
1515
1515
|
|
|
1516
1516
|
begin
|
|
1517
1517
|
#Get the wrap-up for this conversation participant.
|
|
1518
|
-
result = api_instance.get_conversations_cobrowsesession_participant_wrapup(
|
|
1518
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
|
1519
1519
|
p result
|
|
1520
1520
|
rescue PureCloud::ApiError => e
|
|
1521
1521
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapup: #{e}"
|
|
@@ -1526,7 +1526,7 @@ end
|
|
|
1526
1526
|
|
|
1527
1527
|
Name | Type | Description | Notes
|
|
1528
1528
|
------------- | ------------- | ------------- | -------------
|
|
1529
|
-
**
|
|
1529
|
+
**conversation_id** | **String**| conversationId |
|
|
1530
1530
|
**participant_id** | **String**| participantId |
|
|
1531
1531
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1532
1532
|
{: class="table table-striped"}
|
|
@@ -1545,13 +1545,13 @@ Name | Type | Description | Notes
|
|
|
1545
1545
|
|
|
1546
1546
|
<a name="get_conversations_cobrowsesession_participant_wrapupcodes"></a>
|
|
1547
1547
|
|
|
1548
|
-
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(
|
|
1548
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
|
1549
1549
|
|
|
1550
1550
|
Get list of wrapup codes for this conversation participant
|
|
1551
1551
|
|
|
1552
1552
|
|
|
1553
1553
|
|
|
1554
|
-
Wraps GET /api/v2/conversations/cobrowsesessions/{
|
|
1554
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1555
1555
|
|
|
1556
1556
|
|
|
1557
1557
|
### Example
|
|
@@ -1571,14 +1571,14 @@ end
|
|
|
1571
1571
|
|
|
1572
1572
|
api_instance = PureCloud::ConversationsApi.new
|
|
1573
1573
|
|
|
1574
|
-
|
|
1574
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1575
1575
|
|
|
1576
1576
|
participant_id = "participant_id_example" # String | participantId
|
|
1577
1577
|
|
|
1578
1578
|
|
|
1579
1579
|
begin
|
|
1580
1580
|
#Get list of wrapup codes for this conversation participant
|
|
1581
|
-
result = api_instance.get_conversations_cobrowsesession_participant_wrapupcodes(
|
|
1581
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
|
1582
1582
|
p result
|
|
1583
1583
|
rescue PureCloud::ApiError => e
|
|
1584
1584
|
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapupcodes: #{e}"
|
|
@@ -1589,7 +1589,7 @@ end
|
|
|
1589
1589
|
|
|
1590
1590
|
Name | Type | Description | Notes
|
|
1591
1591
|
------------- | ------------- | ------------- | -------------
|
|
1592
|
-
**
|
|
1592
|
+
**conversation_id** | **String**| conversationId |
|
|
1593
1593
|
**participant_id** | **String**| participantId |
|
|
1594
1594
|
{: class="table table-striped"}
|
|
1595
1595
|
|
|
@@ -1660,13 +1660,13 @@ This endpoint does not need any parameter.
|
|
|
1660
1660
|
|
|
1661
1661
|
<a name="get_conversations_email"></a>
|
|
1662
1662
|
|
|
1663
|
-
## -[**EmailConversation**](EmailConversation.html) get_conversations_email(
|
|
1663
|
+
## -[**EmailConversation**](EmailConversation.html) get_conversations_email(conversation_id)
|
|
1664
1664
|
|
|
1665
1665
|
Get email conversation
|
|
1666
1666
|
|
|
1667
1667
|
|
|
1668
1668
|
|
|
1669
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1669
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}
|
|
1670
1670
|
|
|
1671
1671
|
|
|
1672
1672
|
### Example
|
|
@@ -1686,12 +1686,12 @@ end
|
|
|
1686
1686
|
|
|
1687
1687
|
api_instance = PureCloud::ConversationsApi.new
|
|
1688
1688
|
|
|
1689
|
-
|
|
1689
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1690
1690
|
|
|
1691
1691
|
|
|
1692
1692
|
begin
|
|
1693
1693
|
#Get email conversation
|
|
1694
|
-
result = api_instance.get_conversations_email(
|
|
1694
|
+
result = api_instance.get_conversations_email(conversation_id)
|
|
1695
1695
|
p result
|
|
1696
1696
|
rescue PureCloud::ApiError => e
|
|
1697
1697
|
puts "Exception when calling ConversationsApi->get_conversations_email: #{e}"
|
|
@@ -1702,7 +1702,7 @@ end
|
|
|
1702
1702
|
|
|
1703
1703
|
Name | Type | Description | Notes
|
|
1704
1704
|
------------- | ------------- | ------------- | -------------
|
|
1705
|
-
**
|
|
1705
|
+
**conversation_id** | **String**| conversationId |
|
|
1706
1706
|
{: class="table table-striped"}
|
|
1707
1707
|
|
|
1708
1708
|
|
|
@@ -1719,13 +1719,13 @@ Name | Type | Description | Notes
|
|
|
1719
1719
|
|
|
1720
1720
|
<a name="get_conversations_email_message"></a>
|
|
1721
1721
|
|
|
1722
|
-
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_message(
|
|
1722
|
+
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_message(conversation_id, message_id)
|
|
1723
1723
|
|
|
1724
1724
|
Get conversation message
|
|
1725
1725
|
|
|
1726
1726
|
|
|
1727
1727
|
|
|
1728
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1728
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}
|
|
1729
1729
|
|
|
1730
1730
|
|
|
1731
1731
|
### Example
|
|
@@ -1745,14 +1745,14 @@ end
|
|
|
1745
1745
|
|
|
1746
1746
|
api_instance = PureCloud::ConversationsApi.new
|
|
1747
1747
|
|
|
1748
|
-
|
|
1748
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1749
1749
|
|
|
1750
1750
|
message_id = "message_id_example" # String | messageId
|
|
1751
1751
|
|
|
1752
1752
|
|
|
1753
1753
|
begin
|
|
1754
1754
|
#Get conversation message
|
|
1755
|
-
result = api_instance.get_conversations_email_message(
|
|
1755
|
+
result = api_instance.get_conversations_email_message(conversation_id, message_id)
|
|
1756
1756
|
p result
|
|
1757
1757
|
rescue PureCloud::ApiError => e
|
|
1758
1758
|
puts "Exception when calling ConversationsApi->get_conversations_email_message: #{e}"
|
|
@@ -1763,7 +1763,7 @@ end
|
|
|
1763
1763
|
|
|
1764
1764
|
Name | Type | Description | Notes
|
|
1765
1765
|
------------- | ------------- | ------------- | -------------
|
|
1766
|
-
**
|
|
1766
|
+
**conversation_id** | **String**| conversationId |
|
|
1767
1767
|
**message_id** | **String**| messageId |
|
|
1768
1768
|
{: class="table table-striped"}
|
|
1769
1769
|
|
|
@@ -1781,13 +1781,13 @@ Name | Type | Description | Notes
|
|
|
1781
1781
|
|
|
1782
1782
|
<a name="get_conversations_email_messages"></a>
|
|
1783
1783
|
|
|
1784
|
-
## -[**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(
|
|
1784
|
+
## -[**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(conversation_id)
|
|
1785
1785
|
|
|
1786
1786
|
Get conversation messages
|
|
1787
1787
|
|
|
1788
1788
|
|
|
1789
1789
|
|
|
1790
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1790
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages
|
|
1791
1791
|
|
|
1792
1792
|
|
|
1793
1793
|
### Example
|
|
@@ -1807,12 +1807,12 @@ end
|
|
|
1807
1807
|
|
|
1808
1808
|
api_instance = PureCloud::ConversationsApi.new
|
|
1809
1809
|
|
|
1810
|
-
|
|
1810
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
1813
|
begin
|
|
1814
1814
|
#Get conversation messages
|
|
1815
|
-
result = api_instance.get_conversations_email_messages(
|
|
1815
|
+
result = api_instance.get_conversations_email_messages(conversation_id)
|
|
1816
1816
|
p result
|
|
1817
1817
|
rescue PureCloud::ApiError => e
|
|
1818
1818
|
puts "Exception when calling ConversationsApi->get_conversations_email_messages: #{e}"
|
|
@@ -1823,7 +1823,7 @@ end
|
|
|
1823
1823
|
|
|
1824
1824
|
Name | Type | Description | Notes
|
|
1825
1825
|
------------- | ------------- | ------------- | -------------
|
|
1826
|
-
**
|
|
1826
|
+
**conversation_id** | **String**| conversationId |
|
|
1827
1827
|
{: class="table table-striped"}
|
|
1828
1828
|
|
|
1829
1829
|
|
|
@@ -1840,13 +1840,13 @@ Name | Type | Description | Notes
|
|
|
1840
1840
|
|
|
1841
1841
|
<a name="get_conversations_email_messages_draft"></a>
|
|
1842
1842
|
|
|
1843
|
-
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(
|
|
1843
|
+
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(conversation_id)
|
|
1844
1844
|
|
|
1845
1845
|
Get conversation draft reply
|
|
1846
1846
|
|
|
1847
1847
|
|
|
1848
1848
|
|
|
1849
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1849
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/draft
|
|
1850
1850
|
|
|
1851
1851
|
|
|
1852
1852
|
### Example
|
|
@@ -1866,12 +1866,12 @@ end
|
|
|
1866
1866
|
|
|
1867
1867
|
api_instance = PureCloud::ConversationsApi.new
|
|
1868
1868
|
|
|
1869
|
-
|
|
1869
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1870
1870
|
|
|
1871
1871
|
|
|
1872
1872
|
begin
|
|
1873
1873
|
#Get conversation draft reply
|
|
1874
|
-
result = api_instance.get_conversations_email_messages_draft(
|
|
1874
|
+
result = api_instance.get_conversations_email_messages_draft(conversation_id)
|
|
1875
1875
|
p result
|
|
1876
1876
|
rescue PureCloud::ApiError => e
|
|
1877
1877
|
puts "Exception when calling ConversationsApi->get_conversations_email_messages_draft: #{e}"
|
|
@@ -1882,7 +1882,7 @@ end
|
|
|
1882
1882
|
|
|
1883
1883
|
Name | Type | Description | Notes
|
|
1884
1884
|
------------- | ------------- | ------------- | -------------
|
|
1885
|
-
**
|
|
1885
|
+
**conversation_id** | **String**| conversationId |
|
|
1886
1886
|
{: class="table table-striped"}
|
|
1887
1887
|
|
|
1888
1888
|
|
|
@@ -1899,13 +1899,13 @@ Name | Type | Description | Notes
|
|
|
1899
1899
|
|
|
1900
1900
|
<a name="get_conversations_email_participant_wrapup"></a>
|
|
1901
1901
|
|
|
1902
|
-
## -[**Wrapup**](Wrapup.html) get_conversations_email_participant_wrapup(
|
|
1902
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
|
1903
1903
|
|
|
1904
1904
|
Get the wrap-up for this conversation participant.
|
|
1905
1905
|
|
|
1906
1906
|
|
|
1907
1907
|
|
|
1908
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1908
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup
|
|
1909
1909
|
|
|
1910
1910
|
|
|
1911
1911
|
### Example
|
|
@@ -1925,7 +1925,7 @@ end
|
|
|
1925
1925
|
|
|
1926
1926
|
api_instance = PureCloud::ConversationsApi.new
|
|
1927
1927
|
|
|
1928
|
-
|
|
1928
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1929
1929
|
|
|
1930
1930
|
participant_id = "participant_id_example" # String | participantId
|
|
1931
1931
|
|
|
@@ -1935,7 +1935,7 @@ opts = {
|
|
|
1935
1935
|
|
|
1936
1936
|
begin
|
|
1937
1937
|
#Get the wrap-up for this conversation participant.
|
|
1938
|
-
result = api_instance.get_conversations_email_participant_wrapup(
|
|
1938
|
+
result = api_instance.get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
|
1939
1939
|
p result
|
|
1940
1940
|
rescue PureCloud::ApiError => e
|
|
1941
1941
|
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapup: #{e}"
|
|
@@ -1946,7 +1946,7 @@ end
|
|
|
1946
1946
|
|
|
1947
1947
|
Name | Type | Description | Notes
|
|
1948
1948
|
------------- | ------------- | ------------- | -------------
|
|
1949
|
-
**
|
|
1949
|
+
**conversation_id** | **String**| conversationId |
|
|
1950
1950
|
**participant_id** | **String**| participantId |
|
|
1951
1951
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1952
1952
|
{: class="table table-striped"}
|
|
@@ -1965,13 +1965,13 @@ Name | Type | Description | Notes
|
|
|
1965
1965
|
|
|
1966
1966
|
<a name="get_conversations_email_participant_wrapupcodes"></a>
|
|
1967
1967
|
|
|
1968
|
-
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(
|
|
1968
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
|
1969
1969
|
|
|
1970
1970
|
Get list of wrapup codes for this conversation participant
|
|
1971
1971
|
|
|
1972
1972
|
|
|
1973
1973
|
|
|
1974
|
-
Wraps GET /api/v2/conversations/emails/{
|
|
1974
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1975
1975
|
|
|
1976
1976
|
|
|
1977
1977
|
### Example
|
|
@@ -1991,14 +1991,14 @@ end
|
|
|
1991
1991
|
|
|
1992
1992
|
api_instance = PureCloud::ConversationsApi.new
|
|
1993
1993
|
|
|
1994
|
-
|
|
1994
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1995
1995
|
|
|
1996
1996
|
participant_id = "participant_id_example" # String | participantId
|
|
1997
1997
|
|
|
1998
1998
|
|
|
1999
1999
|
begin
|
|
2000
2000
|
#Get list of wrapup codes for this conversation participant
|
|
2001
|
-
result = api_instance.get_conversations_email_participant_wrapupcodes(
|
|
2001
|
+
result = api_instance.get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
|
2002
2002
|
p result
|
|
2003
2003
|
rescue PureCloud::ApiError => e
|
|
2004
2004
|
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapupcodes: #{e}"
|
|
@@ -2009,7 +2009,7 @@ end
|
|
|
2009
2009
|
|
|
2010
2010
|
Name | Type | Description | Notes
|
|
2011
2011
|
------------- | ------------- | ------------- | -------------
|
|
2012
|
-
**
|
|
2012
|
+
**conversation_id** | **String**| conversationId |
|
|
2013
2013
|
**participant_id** | **String**| participantId |
|
|
2014
2014
|
{: class="table table-striped"}
|
|
2015
2015
|
|
|
@@ -2208,13 +2208,13 @@ nil (empty response body)
|
|
|
2208
2208
|
|
|
2209
2209
|
<a name="patch_conversations_call"></a>
|
|
2210
2210
|
|
|
2211
|
-
## -[**Conversation**](Conversation.html) patch_conversations_call(
|
|
2211
|
+
## -[**Conversation**](Conversation.html) patch_conversations_call(conversation_id, body)
|
|
2212
2212
|
|
|
2213
2213
|
Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2214
2214
|
|
|
2215
2215
|
|
|
2216
2216
|
|
|
2217
|
-
Wraps PATCH /api/v2/conversations/calls/{
|
|
2217
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}
|
|
2218
2218
|
|
|
2219
2219
|
|
|
2220
2220
|
### Example
|
|
@@ -2234,14 +2234,14 @@ end
|
|
|
2234
2234
|
|
|
2235
2235
|
api_instance = PureCloud::ConversationsApi.new
|
|
2236
2236
|
|
|
2237
|
-
|
|
2237
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2238
2238
|
|
|
2239
2239
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2240
2240
|
|
|
2241
2241
|
|
|
2242
2242
|
begin
|
|
2243
2243
|
#Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2244
|
-
result = api_instance.patch_conversations_call(
|
|
2244
|
+
result = api_instance.patch_conversations_call(conversation_id, body)
|
|
2245
2245
|
p result
|
|
2246
2246
|
rescue PureCloud::ApiError => e
|
|
2247
2247
|
puts "Exception when calling ConversationsApi->patch_conversations_call: #{e}"
|
|
@@ -2252,7 +2252,7 @@ end
|
|
|
2252
2252
|
|
|
2253
2253
|
Name | Type | Description | Notes
|
|
2254
2254
|
------------- | ------------- | ------------- | -------------
|
|
2255
|
-
**
|
|
2255
|
+
**conversation_id** | **String**| conversationId |
|
|
2256
2256
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2257
2257
|
{: class="table table-striped"}
|
|
2258
2258
|
|
|
@@ -2270,13 +2270,13 @@ Name | Type | Description | Notes
|
|
|
2270
2270
|
|
|
2271
2271
|
<a name="patch_conversations_call_participant"></a>
|
|
2272
2272
|
|
|
2273
|
-
## - patch_conversations_call_participant(
|
|
2273
|
+
## - patch_conversations_call_participant(conversation_id, participant_id, body)
|
|
2274
2274
|
|
|
2275
2275
|
Update conversation participant
|
|
2276
2276
|
|
|
2277
2277
|
|
|
2278
2278
|
|
|
2279
|
-
Wraps PATCH /api/v2/conversations/calls/{
|
|
2279
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}
|
|
2280
2280
|
|
|
2281
2281
|
|
|
2282
2282
|
### Example
|
|
@@ -2296,7 +2296,7 @@ end
|
|
|
2296
2296
|
|
|
2297
2297
|
api_instance = PureCloud::ConversationsApi.new
|
|
2298
2298
|
|
|
2299
|
-
|
|
2299
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2300
2300
|
|
|
2301
2301
|
participant_id = "participant_id_example" # String | participantId
|
|
2302
2302
|
|
|
@@ -2305,7 +2305,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
2305
2305
|
|
|
2306
2306
|
begin
|
|
2307
2307
|
#Update conversation participant
|
|
2308
|
-
api_instance.patch_conversations_call_participant(
|
|
2308
|
+
api_instance.patch_conversations_call_participant(conversation_id, participant_id, body)
|
|
2309
2309
|
rescue PureCloud::ApiError => e
|
|
2310
2310
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant: #{e}"
|
|
2311
2311
|
end
|
|
@@ -2315,7 +2315,7 @@ end
|
|
|
2315
2315
|
|
|
2316
2316
|
Name | Type | Description | Notes
|
|
2317
2317
|
------------- | ------------- | ------------- | -------------
|
|
2318
|
-
**
|
|
2318
|
+
**conversation_id** | **String**| conversationId |
|
|
2319
2319
|
**participant_id** | **String**| participantId |
|
|
2320
2320
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request |
|
|
2321
2321
|
{: class="table table-striped"}
|
|
@@ -2334,13 +2334,13 @@ nil (empty response body)
|
|
|
2334
2334
|
|
|
2335
2335
|
<a name="patch_conversations_call_participant_attributes"></a>
|
|
2336
2336
|
|
|
2337
|
-
## - patch_conversations_call_participant_attributes(
|
|
2337
|
+
## - patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
|
2338
2338
|
|
|
2339
2339
|
Update the attributes on a conversation participant.
|
|
2340
2340
|
|
|
2341
2341
|
|
|
2342
2342
|
|
|
2343
|
-
Wraps PATCH /api/v2/conversations/calls/{
|
|
2343
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes
|
|
2344
2344
|
|
|
2345
2345
|
|
|
2346
2346
|
### Example
|
|
@@ -2360,7 +2360,7 @@ end
|
|
|
2360
2360
|
|
|
2361
2361
|
api_instance = PureCloud::ConversationsApi.new
|
|
2362
2362
|
|
|
2363
|
-
|
|
2363
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2364
2364
|
|
|
2365
2365
|
participant_id = "participant_id_example" # String | participantId
|
|
2366
2366
|
|
|
@@ -2369,7 +2369,7 @@ body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participan
|
|
|
2369
2369
|
|
|
2370
2370
|
begin
|
|
2371
2371
|
#Update the attributes on a conversation participant.
|
|
2372
|
-
api_instance.patch_conversations_call_participant_attributes(
|
|
2372
|
+
api_instance.patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
|
2373
2373
|
rescue PureCloud::ApiError => e
|
|
2374
2374
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: #{e}"
|
|
2375
2375
|
end
|
|
@@ -2379,7 +2379,7 @@ end
|
|
|
2379
2379
|
|
|
2380
2380
|
Name | Type | Description | Notes
|
|
2381
2381
|
------------- | ------------- | ------------- | -------------
|
|
2382
|
-
**
|
|
2382
|
+
**conversation_id** | **String**| conversationId |
|
|
2383
2383
|
**participant_id** | **String**| participantId |
|
|
2384
2384
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2385
2385
|
{: class="table table-striped"}
|
|
@@ -2398,13 +2398,13 @@ nil (empty response body)
|
|
|
2398
2398
|
|
|
2399
2399
|
<a name="patch_conversations_call_participant_communication"></a>
|
|
2400
2400
|
|
|
2401
|
-
## -[**Empty**](Empty.html) patch_conversations_call_participant_communication(
|
|
2401
|
+
## -[**Empty**](Empty.html) patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2402
2402
|
|
|
2403
2403
|
Update conversation participant's communication by disconnecting it.
|
|
2404
2404
|
|
|
2405
2405
|
|
|
2406
2406
|
|
|
2407
|
-
Wraps PATCH /api/v2/conversations/calls/{
|
|
2407
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2408
2408
|
|
|
2409
2409
|
|
|
2410
2410
|
### Example
|
|
@@ -2424,7 +2424,7 @@ end
|
|
|
2424
2424
|
|
|
2425
2425
|
api_instance = PureCloud::ConversationsApi.new
|
|
2426
2426
|
|
|
2427
|
-
|
|
2427
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2428
2428
|
|
|
2429
2429
|
participant_id = "participant_id_example" # String | participantId
|
|
2430
2430
|
|
|
@@ -2435,7 +2435,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
2435
2435
|
|
|
2436
2436
|
begin
|
|
2437
2437
|
#Update conversation participant's communication by disconnecting it.
|
|
2438
|
-
result = api_instance.patch_conversations_call_participant_communication(
|
|
2438
|
+
result = api_instance.patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2439
2439
|
p result
|
|
2440
2440
|
rescue PureCloud::ApiError => e
|
|
2441
2441
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_communication: #{e}"
|
|
@@ -2446,7 +2446,7 @@ end
|
|
|
2446
2446
|
|
|
2447
2447
|
Name | Type | Description | Notes
|
|
2448
2448
|
------------- | ------------- | ------------- | -------------
|
|
2449
|
-
**
|
|
2449
|
+
**conversation_id** | **String**| conversationId |
|
|
2450
2450
|
**participant_id** | **String**| participantId |
|
|
2451
2451
|
**communication_id** | **String**| communicationId |
|
|
2452
2452
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
@@ -2466,13 +2466,13 @@ Name | Type | Description | Notes
|
|
|
2466
2466
|
|
|
2467
2467
|
<a name="patch_conversations_call_participant_consult"></a>
|
|
2468
2468
|
|
|
2469
|
-
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(
|
|
2469
|
+
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
2470
2470
|
|
|
2471
2471
|
Change who can speak
|
|
2472
2472
|
|
|
2473
2473
|
|
|
2474
2474
|
|
|
2475
|
-
Wraps PATCH /api/v2/conversations/calls/{
|
|
2475
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
2476
2476
|
|
|
2477
2477
|
|
|
2478
2478
|
### Example
|
|
@@ -2492,7 +2492,7 @@ end
|
|
|
2492
2492
|
|
|
2493
2493
|
api_instance = PureCloud::ConversationsApi.new
|
|
2494
2494
|
|
|
2495
|
-
|
|
2495
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2496
2496
|
|
|
2497
2497
|
participant_id = "participant_id_example" # String | participantId
|
|
2498
2498
|
|
|
@@ -2501,7 +2501,7 @@ body = PureCloud::ConsultTransferUpdate.new # ConsultTransferUpdate | new speak
|
|
|
2501
2501
|
|
|
2502
2502
|
begin
|
|
2503
2503
|
#Change who can speak
|
|
2504
|
-
result = api_instance.patch_conversations_call_participant_consult(
|
|
2504
|
+
result = api_instance.patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
2505
2505
|
p result
|
|
2506
2506
|
rescue PureCloud::ApiError => e
|
|
2507
2507
|
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_consult: #{e}"
|
|
@@ -2512,7 +2512,7 @@ end
|
|
|
2512
2512
|
|
|
2513
2513
|
Name | Type | Description | Notes
|
|
2514
2514
|
------------- | ------------- | ------------- | -------------
|
|
2515
|
-
**
|
|
2515
|
+
**conversation_id** | **String**| conversationId |
|
|
2516
2516
|
**participant_id** | **String**| participantId |
|
|
2517
2517
|
**body** | [**ConsultTransferUpdate**](ConsultTransferUpdate.html)| new speak to |
|
|
2518
2518
|
{: class="table table-striped"}
|
|
@@ -2531,13 +2531,13 @@ Name | Type | Description | Notes
|
|
|
2531
2531
|
|
|
2532
2532
|
<a name="patch_conversations_callback"></a>
|
|
2533
2533
|
|
|
2534
|
-
## -[**Conversation**](Conversation.html) patch_conversations_callback(
|
|
2534
|
+
## -[**Conversation**](Conversation.html) patch_conversations_callback(conversation_id, body)
|
|
2535
2535
|
|
|
2536
2536
|
Update a conversation by disconnecting all of the participants
|
|
2537
2537
|
|
|
2538
2538
|
|
|
2539
2539
|
|
|
2540
|
-
Wraps PATCH /api/v2/conversations/callbacks/{
|
|
2540
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}
|
|
2541
2541
|
|
|
2542
2542
|
|
|
2543
2543
|
### Example
|
|
@@ -2557,14 +2557,14 @@ end
|
|
|
2557
2557
|
|
|
2558
2558
|
api_instance = PureCloud::ConversationsApi.new
|
|
2559
2559
|
|
|
2560
|
-
|
|
2560
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2561
2561
|
|
|
2562
2562
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2563
2563
|
|
|
2564
2564
|
|
|
2565
2565
|
begin
|
|
2566
2566
|
#Update a conversation by disconnecting all of the participants
|
|
2567
|
-
result = api_instance.patch_conversations_callback(
|
|
2567
|
+
result = api_instance.patch_conversations_callback(conversation_id, body)
|
|
2568
2568
|
p result
|
|
2569
2569
|
rescue PureCloud::ApiError => e
|
|
2570
2570
|
puts "Exception when calling ConversationsApi->patch_conversations_callback: #{e}"
|
|
@@ -2575,7 +2575,7 @@ end
|
|
|
2575
2575
|
|
|
2576
2576
|
Name | Type | Description | Notes
|
|
2577
2577
|
------------- | ------------- | ------------- | -------------
|
|
2578
|
-
**
|
|
2578
|
+
**conversation_id** | **String**| conversationId |
|
|
2579
2579
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2580
2580
|
{: class="table table-striped"}
|
|
2581
2581
|
|
|
@@ -2593,13 +2593,13 @@ Name | Type | Description | Notes
|
|
|
2593
2593
|
|
|
2594
2594
|
<a name="patch_conversations_callback_participant"></a>
|
|
2595
2595
|
|
|
2596
|
-
## - patch_conversations_callback_participant(
|
|
2596
|
+
## - patch_conversations_callback_participant(conversation_id, participant_id, body)
|
|
2597
2597
|
|
|
2598
2598
|
Update conversation participant
|
|
2599
2599
|
|
|
2600
2600
|
|
|
2601
2601
|
|
|
2602
|
-
Wraps PATCH /api/v2/conversations/callbacks/{
|
|
2602
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}
|
|
2603
2603
|
|
|
2604
2604
|
|
|
2605
2605
|
### Example
|
|
@@ -2619,7 +2619,7 @@ end
|
|
|
2619
2619
|
|
|
2620
2620
|
api_instance = PureCloud::ConversationsApi.new
|
|
2621
2621
|
|
|
2622
|
-
|
|
2622
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2623
2623
|
|
|
2624
2624
|
participant_id = "participant_id_example" # String | participantId
|
|
2625
2625
|
|
|
@@ -2628,7 +2628,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
2628
2628
|
|
|
2629
2629
|
begin
|
|
2630
2630
|
#Update conversation participant
|
|
2631
|
-
api_instance.patch_conversations_callback_participant(
|
|
2631
|
+
api_instance.patch_conversations_callback_participant(conversation_id, participant_id, body)
|
|
2632
2632
|
rescue PureCloud::ApiError => e
|
|
2633
2633
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant: #{e}"
|
|
2634
2634
|
end
|
|
@@ -2638,7 +2638,7 @@ end
|
|
|
2638
2638
|
|
|
2639
2639
|
Name | Type | Description | Notes
|
|
2640
2640
|
------------- | ------------- | ------------- | -------------
|
|
2641
|
-
**
|
|
2641
|
+
**conversation_id** | **String**| conversationId |
|
|
2642
2642
|
**participant_id** | **String**| participantId |
|
|
2643
2643
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2644
2644
|
{: class="table table-striped"}
|
|
@@ -2657,13 +2657,13 @@ nil (empty response body)
|
|
|
2657
2657
|
|
|
2658
2658
|
<a name="patch_conversations_callback_participant_attributes"></a>
|
|
2659
2659
|
|
|
2660
|
-
## - patch_conversations_callback_participant_attributes(
|
|
2660
|
+
## - patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
|
2661
2661
|
|
|
2662
2662
|
Update the attributes on a conversation participant.
|
|
2663
2663
|
|
|
2664
2664
|
|
|
2665
2665
|
|
|
2666
|
-
Wraps PATCH /api/v2/conversations/callbacks/{
|
|
2666
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes
|
|
2667
2667
|
|
|
2668
2668
|
|
|
2669
2669
|
### Example
|
|
@@ -2683,7 +2683,7 @@ end
|
|
|
2683
2683
|
|
|
2684
2684
|
api_instance = PureCloud::ConversationsApi.new
|
|
2685
2685
|
|
|
2686
|
-
|
|
2686
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2687
2687
|
|
|
2688
2688
|
participant_id = "participant_id_example" # String | participantId
|
|
2689
2689
|
|
|
@@ -2692,7 +2692,7 @@ body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Attributes
|
|
|
2692
2692
|
|
|
2693
2693
|
begin
|
|
2694
2694
|
#Update the attributes on a conversation participant.
|
|
2695
|
-
api_instance.patch_conversations_callback_participant_attributes(
|
|
2695
|
+
api_instance.patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
|
2696
2696
|
rescue PureCloud::ApiError => e
|
|
2697
2697
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: #{e}"
|
|
2698
2698
|
end
|
|
@@ -2702,7 +2702,7 @@ end
|
|
|
2702
2702
|
|
|
2703
2703
|
Name | Type | Description | Notes
|
|
2704
2704
|
------------- | ------------- | ------------- | -------------
|
|
2705
|
-
**
|
|
2705
|
+
**conversation_id** | **String**| conversationId |
|
|
2706
2706
|
**participant_id** | **String**| participantId |
|
|
2707
2707
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Attributes |
|
|
2708
2708
|
{: class="table table-striped"}
|
|
@@ -2721,13 +2721,13 @@ nil (empty response body)
|
|
|
2721
2721
|
|
|
2722
2722
|
<a name="patch_conversations_callback_participant_communication"></a>
|
|
2723
2723
|
|
|
2724
|
-
## -[**Empty**](Empty.html) patch_conversations_callback_participant_communication(
|
|
2724
|
+
## -[**Empty**](Empty.html) patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2725
2725
|
|
|
2726
2726
|
Update conversation participant's communication by disconnecting it.
|
|
2727
2727
|
|
|
2728
2728
|
|
|
2729
2729
|
|
|
2730
|
-
Wraps PATCH /api/v2/conversations/callbacks/{
|
|
2730
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2731
2731
|
|
|
2732
2732
|
|
|
2733
2733
|
### Example
|
|
@@ -2747,7 +2747,7 @@ end
|
|
|
2747
2747
|
|
|
2748
2748
|
api_instance = PureCloud::ConversationsApi.new
|
|
2749
2749
|
|
|
2750
|
-
|
|
2750
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2751
2751
|
|
|
2752
2752
|
participant_id = "participant_id_example" # String | participantId
|
|
2753
2753
|
|
|
@@ -2758,7 +2758,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
2758
2758
|
|
|
2759
2759
|
begin
|
|
2760
2760
|
#Update conversation participant's communication by disconnecting it.
|
|
2761
|
-
result = api_instance.patch_conversations_callback_participant_communication(
|
|
2761
|
+
result = api_instance.patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2762
2762
|
p result
|
|
2763
2763
|
rescue PureCloud::ApiError => e
|
|
2764
2764
|
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: #{e}"
|
|
@@ -2769,7 +2769,7 @@ end
|
|
|
2769
2769
|
|
|
2770
2770
|
Name | Type | Description | Notes
|
|
2771
2771
|
------------- | ------------- | ------------- | -------------
|
|
2772
|
-
**
|
|
2772
|
+
**conversation_id** | **String**| conversationId |
|
|
2773
2773
|
**participant_id** | **String**| participantId |
|
|
2774
2774
|
**communication_id** | **String**| communicationId |
|
|
2775
2775
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
@@ -2789,13 +2789,13 @@ Name | Type | Description | Notes
|
|
|
2789
2789
|
|
|
2790
2790
|
<a name="patch_conversations_chat"></a>
|
|
2791
2791
|
|
|
2792
|
-
## -[**Conversation**](Conversation.html) patch_conversations_chat(
|
|
2792
|
+
## -[**Conversation**](Conversation.html) patch_conversations_chat(conversation_id, body)
|
|
2793
2793
|
|
|
2794
2794
|
Update a conversation by disconnecting all of the participants
|
|
2795
2795
|
|
|
2796
2796
|
|
|
2797
2797
|
|
|
2798
|
-
Wraps PATCH /api/v2/conversations/chats/{
|
|
2798
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}
|
|
2799
2799
|
|
|
2800
2800
|
|
|
2801
2801
|
### Example
|
|
@@ -2815,14 +2815,14 @@ end
|
|
|
2815
2815
|
|
|
2816
2816
|
api_instance = PureCloud::ConversationsApi.new
|
|
2817
2817
|
|
|
2818
|
-
|
|
2818
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2819
2819
|
|
|
2820
2820
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2821
2821
|
|
|
2822
2822
|
|
|
2823
2823
|
begin
|
|
2824
2824
|
#Update a conversation by disconnecting all of the participants
|
|
2825
|
-
result = api_instance.patch_conversations_chat(
|
|
2825
|
+
result = api_instance.patch_conversations_chat(conversation_id, body)
|
|
2826
2826
|
p result
|
|
2827
2827
|
rescue PureCloud::ApiError => e
|
|
2828
2828
|
puts "Exception when calling ConversationsApi->patch_conversations_chat: #{e}"
|
|
@@ -2833,7 +2833,7 @@ end
|
|
|
2833
2833
|
|
|
2834
2834
|
Name | Type | Description | Notes
|
|
2835
2835
|
------------- | ------------- | ------------- | -------------
|
|
2836
|
-
**
|
|
2836
|
+
**conversation_id** | **String**| conversationId |
|
|
2837
2837
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2838
2838
|
{: class="table table-striped"}
|
|
2839
2839
|
|
|
@@ -2851,13 +2851,13 @@ Name | Type | Description | Notes
|
|
|
2851
2851
|
|
|
2852
2852
|
<a name="patch_conversations_chat_participant"></a>
|
|
2853
2853
|
|
|
2854
|
-
## - patch_conversations_chat_participant(
|
|
2854
|
+
## - patch_conversations_chat_participant(conversation_id, participant_id, body)
|
|
2855
2855
|
|
|
2856
2856
|
Update conversation participant
|
|
2857
2857
|
|
|
2858
2858
|
|
|
2859
2859
|
|
|
2860
|
-
Wraps PATCH /api/v2/conversations/chats/{
|
|
2860
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}
|
|
2861
2861
|
|
|
2862
2862
|
|
|
2863
2863
|
### Example
|
|
@@ -2877,7 +2877,7 @@ end
|
|
|
2877
2877
|
|
|
2878
2878
|
api_instance = PureCloud::ConversationsApi.new
|
|
2879
2879
|
|
|
2880
|
-
|
|
2880
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2881
2881
|
|
|
2882
2882
|
participant_id = "participant_id_example" # String | participantId
|
|
2883
2883
|
|
|
@@ -2886,7 +2886,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update
|
|
|
2886
2886
|
|
|
2887
2887
|
begin
|
|
2888
2888
|
#Update conversation participant
|
|
2889
|
-
api_instance.patch_conversations_chat_participant(
|
|
2889
|
+
api_instance.patch_conversations_chat_participant(conversation_id, participant_id, body)
|
|
2890
2890
|
rescue PureCloud::ApiError => e
|
|
2891
2891
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant: #{e}"
|
|
2892
2892
|
end
|
|
@@ -2896,7 +2896,7 @@ end
|
|
|
2896
2896
|
|
|
2897
2897
|
Name | Type | Description | Notes
|
|
2898
2898
|
------------- | ------------- | ------------- | -------------
|
|
2899
|
-
**
|
|
2899
|
+
**conversation_id** | **String**| conversationId |
|
|
2900
2900
|
**participant_id** | **String**| participantId |
|
|
2901
2901
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
2902
2902
|
{: class="table table-striped"}
|
|
@@ -2915,13 +2915,13 @@ nil (empty response body)
|
|
|
2915
2915
|
|
|
2916
2916
|
<a name="patch_conversations_chat_participant_attributes"></a>
|
|
2917
2917
|
|
|
2918
|
-
## - patch_conversations_chat_participant_attributes(
|
|
2918
|
+
## - patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
|
2919
2919
|
|
|
2920
2920
|
Update the attributes on a conversation participant.
|
|
2921
2921
|
|
|
2922
2922
|
|
|
2923
2923
|
|
|
2924
|
-
Wraps PATCH /api/v2/conversations/chats/{
|
|
2924
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes
|
|
2925
2925
|
|
|
2926
2926
|
|
|
2927
2927
|
### Example
|
|
@@ -2941,7 +2941,7 @@ end
|
|
|
2941
2941
|
|
|
2942
2942
|
api_instance = PureCloud::ConversationsApi.new
|
|
2943
2943
|
|
|
2944
|
-
|
|
2944
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2945
2945
|
|
|
2946
2946
|
participant_id = "participant_id_example" # String | participantId
|
|
2947
2947
|
|
|
@@ -2950,7 +2950,7 @@ body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participan
|
|
|
2950
2950
|
|
|
2951
2951
|
begin
|
|
2952
2952
|
#Update the attributes on a conversation participant.
|
|
2953
|
-
api_instance.patch_conversations_chat_participant_attributes(
|
|
2953
|
+
api_instance.patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
|
2954
2954
|
rescue PureCloud::ApiError => e
|
|
2955
2955
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_attributes: #{e}"
|
|
2956
2956
|
end
|
|
@@ -2960,7 +2960,7 @@ end
|
|
|
2960
2960
|
|
|
2961
2961
|
Name | Type | Description | Notes
|
|
2962
2962
|
------------- | ------------- | ------------- | -------------
|
|
2963
|
-
**
|
|
2963
|
+
**conversation_id** | **String**| conversationId |
|
|
2964
2964
|
**participant_id** | **String**| participantId |
|
|
2965
2965
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2966
2966
|
{: class="table table-striped"}
|
|
@@ -2979,13 +2979,13 @@ nil (empty response body)
|
|
|
2979
2979
|
|
|
2980
2980
|
<a name="patch_conversations_chat_participant_communication"></a>
|
|
2981
2981
|
|
|
2982
|
-
## -[**Empty**](Empty.html) patch_conversations_chat_participant_communication(
|
|
2982
|
+
## -[**Empty**](Empty.html) patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2983
2983
|
|
|
2984
2984
|
Update conversation participant's communication by disconnecting it.
|
|
2985
2985
|
|
|
2986
2986
|
|
|
2987
2987
|
|
|
2988
|
-
Wraps PATCH /api/v2/conversations/chats/{
|
|
2988
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2989
2989
|
|
|
2990
2990
|
|
|
2991
2991
|
### Example
|
|
@@ -3005,7 +3005,7 @@ end
|
|
|
3005
3005
|
|
|
3006
3006
|
api_instance = PureCloud::ConversationsApi.new
|
|
3007
3007
|
|
|
3008
|
-
|
|
3008
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3009
3009
|
|
|
3010
3010
|
participant_id = "participant_id_example" # String | participantId
|
|
3011
3011
|
|
|
@@ -3016,7 +3016,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3016
3016
|
|
|
3017
3017
|
begin
|
|
3018
3018
|
#Update conversation participant's communication by disconnecting it.
|
|
3019
|
-
result = api_instance.patch_conversations_chat_participant_communication(
|
|
3019
|
+
result = api_instance.patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3020
3020
|
p result
|
|
3021
3021
|
rescue PureCloud::ApiError => e
|
|
3022
3022
|
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_communication: #{e}"
|
|
@@ -3027,7 +3027,7 @@ end
|
|
|
3027
3027
|
|
|
3028
3028
|
Name | Type | Description | Notes
|
|
3029
3029
|
------------- | ------------- | ------------- | -------------
|
|
3030
|
-
**
|
|
3030
|
+
**conversation_id** | **String**| conversationId |
|
|
3031
3031
|
**participant_id** | **String**| participantId |
|
|
3032
3032
|
**communication_id** | **String**| communicationId |
|
|
3033
3033
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
@@ -3047,13 +3047,13 @@ Name | Type | Description | Notes
|
|
|
3047
3047
|
|
|
3048
3048
|
<a name="patch_conversations_cobrowsesession"></a>
|
|
3049
3049
|
|
|
3050
|
-
## -[**Conversation**](Conversation.html) patch_conversations_cobrowsesession(
|
|
3050
|
+
## -[**Conversation**](Conversation.html) patch_conversations_cobrowsesession(conversation_id, body)
|
|
3051
3051
|
|
|
3052
3052
|
Update a conversation by disconnecting all of the participants
|
|
3053
3053
|
|
|
3054
3054
|
|
|
3055
3055
|
|
|
3056
|
-
Wraps PATCH /api/v2/conversations/cobrowsesessions/{
|
|
3056
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
3057
3057
|
|
|
3058
3058
|
|
|
3059
3059
|
### Example
|
|
@@ -3073,14 +3073,14 @@ end
|
|
|
3073
3073
|
|
|
3074
3074
|
api_instance = PureCloud::ConversationsApi.new
|
|
3075
3075
|
|
|
3076
|
-
|
|
3076
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3077
3077
|
|
|
3078
3078
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
3079
3079
|
|
|
3080
3080
|
|
|
3081
3081
|
begin
|
|
3082
3082
|
#Update a conversation by disconnecting all of the participants
|
|
3083
|
-
result = api_instance.patch_conversations_cobrowsesession(
|
|
3083
|
+
result = api_instance.patch_conversations_cobrowsesession(conversation_id, body)
|
|
3084
3084
|
p result
|
|
3085
3085
|
rescue PureCloud::ApiError => e
|
|
3086
3086
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession: #{e}"
|
|
@@ -3091,7 +3091,7 @@ end
|
|
|
3091
3091
|
|
|
3092
3092
|
Name | Type | Description | Notes
|
|
3093
3093
|
------------- | ------------- | ------------- | -------------
|
|
3094
|
-
**
|
|
3094
|
+
**conversation_id** | **String**| conversationId |
|
|
3095
3095
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
3096
3096
|
{: class="table table-striped"}
|
|
3097
3097
|
|
|
@@ -3109,13 +3109,13 @@ Name | Type | Description | Notes
|
|
|
3109
3109
|
|
|
3110
3110
|
<a name="patch_conversations_cobrowsesession_participant"></a>
|
|
3111
3111
|
|
|
3112
|
-
## - patch_conversations_cobrowsesession_participant(
|
|
3112
|
+
## - patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
|
3113
3113
|
|
|
3114
3114
|
Update conversation participant
|
|
3115
3115
|
|
|
3116
3116
|
|
|
3117
3117
|
|
|
3118
|
-
Wraps PATCH /api/v2/conversations/cobrowsesessions/{
|
|
3118
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}
|
|
3119
3119
|
|
|
3120
3120
|
|
|
3121
3121
|
### Example
|
|
@@ -3135,7 +3135,7 @@ end
|
|
|
3135
3135
|
|
|
3136
3136
|
api_instance = PureCloud::ConversationsApi.new
|
|
3137
3137
|
|
|
3138
|
-
|
|
3138
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3139
3139
|
|
|
3140
3140
|
participant_id = "participant_id_example" # String | participantId
|
|
3141
3141
|
|
|
@@ -3145,7 +3145,7 @@ opts = {
|
|
|
3145
3145
|
|
|
3146
3146
|
begin
|
|
3147
3147
|
#Update conversation participant
|
|
3148
|
-
api_instance.patch_conversations_cobrowsesession_participant(
|
|
3148
|
+
api_instance.patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
|
3149
3149
|
rescue PureCloud::ApiError => e
|
|
3150
3150
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant: #{e}"
|
|
3151
3151
|
end
|
|
@@ -3155,7 +3155,7 @@ end
|
|
|
3155
3155
|
|
|
3156
3156
|
Name | Type | Description | Notes
|
|
3157
3157
|
------------- | ------------- | ------------- | -------------
|
|
3158
|
-
**
|
|
3158
|
+
**conversation_id** | **String**| conversationId |
|
|
3159
3159
|
**participant_id** | **String**| participantId |
|
|
3160
3160
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| | [optional]
|
|
3161
3161
|
{: class="table table-striped"}
|
|
@@ -3174,13 +3174,13 @@ nil (empty response body)
|
|
|
3174
3174
|
|
|
3175
3175
|
<a name="patch_conversations_cobrowsesession_participant_attributes"></a>
|
|
3176
3176
|
|
|
3177
|
-
## - patch_conversations_cobrowsesession_participant_attributes(
|
|
3177
|
+
## - patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
|
3178
3178
|
|
|
3179
3179
|
Update the attributes on a conversation participant.
|
|
3180
3180
|
|
|
3181
3181
|
|
|
3182
3182
|
|
|
3183
|
-
Wraps PATCH /api/v2/conversations/cobrowsesessions/{
|
|
3183
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes
|
|
3184
3184
|
|
|
3185
3185
|
|
|
3186
3186
|
### Example
|
|
@@ -3200,7 +3200,7 @@ end
|
|
|
3200
3200
|
|
|
3201
3201
|
api_instance = PureCloud::ConversationsApi.new
|
|
3202
3202
|
|
|
3203
|
-
|
|
3203
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3204
3204
|
|
|
3205
3205
|
participant_id = "participant_id_example" # String | participantId
|
|
3206
3206
|
|
|
@@ -3210,7 +3210,7 @@ opts = {
|
|
|
3210
3210
|
|
|
3211
3211
|
begin
|
|
3212
3212
|
#Update the attributes on a conversation participant.
|
|
3213
|
-
api_instance.patch_conversations_cobrowsesession_participant_attributes(
|
|
3213
|
+
api_instance.patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
|
3214
3214
|
rescue PureCloud::ApiError => e
|
|
3215
3215
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_attributes: #{e}"
|
|
3216
3216
|
end
|
|
@@ -3220,7 +3220,7 @@ end
|
|
|
3220
3220
|
|
|
3221
3221
|
Name | Type | Description | Notes
|
|
3222
3222
|
------------- | ------------- | ------------- | -------------
|
|
3223
|
-
**
|
|
3223
|
+
**conversation_id** | **String**| conversationId |
|
|
3224
3224
|
**participant_id** | **String**| participantId |
|
|
3225
3225
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| | [optional]
|
|
3226
3226
|
{: class="table table-striped"}
|
|
@@ -3239,13 +3239,13 @@ nil (empty response body)
|
|
|
3239
3239
|
|
|
3240
3240
|
<a name="patch_conversations_cobrowsesession_participant_communication"></a>
|
|
3241
3241
|
|
|
3242
|
-
## -[**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(
|
|
3242
|
+
## -[**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3243
3243
|
|
|
3244
3244
|
Update conversation participant's communication by disconnecting it.
|
|
3245
3245
|
|
|
3246
3246
|
|
|
3247
3247
|
|
|
3248
|
-
Wraps PATCH /api/v2/conversations/cobrowsesessions/{
|
|
3248
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3249
3249
|
|
|
3250
3250
|
|
|
3251
3251
|
### Example
|
|
@@ -3265,7 +3265,7 @@ end
|
|
|
3265
3265
|
|
|
3266
3266
|
api_instance = PureCloud::ConversationsApi.new
|
|
3267
3267
|
|
|
3268
|
-
|
|
3268
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3269
3269
|
|
|
3270
3270
|
participant_id = "participant_id_example" # String | participantId
|
|
3271
3271
|
|
|
@@ -3276,7 +3276,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3276
3276
|
|
|
3277
3277
|
begin
|
|
3278
3278
|
#Update conversation participant's communication by disconnecting it.
|
|
3279
|
-
result = api_instance.patch_conversations_cobrowsesession_participant_communication(
|
|
3279
|
+
result = api_instance.patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3280
3280
|
p result
|
|
3281
3281
|
rescue PureCloud::ApiError => e
|
|
3282
3282
|
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_communication: #{e}"
|
|
@@ -3287,7 +3287,7 @@ end
|
|
|
3287
3287
|
|
|
3288
3288
|
Name | Type | Description | Notes
|
|
3289
3289
|
------------- | ------------- | ------------- | -------------
|
|
3290
|
-
**
|
|
3290
|
+
**conversation_id** | **String**| conversationId |
|
|
3291
3291
|
**participant_id** | **String**| participantId |
|
|
3292
3292
|
**communication_id** | **String**| communicationId |
|
|
3293
3293
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
@@ -3307,13 +3307,13 @@ Name | Type | Description | Notes
|
|
|
3307
3307
|
|
|
3308
3308
|
<a name="patch_conversations_email"></a>
|
|
3309
3309
|
|
|
3310
|
-
## -[**Conversation**](Conversation.html) patch_conversations_email(
|
|
3310
|
+
## -[**Conversation**](Conversation.html) patch_conversations_email(conversation_id, body)
|
|
3311
3311
|
|
|
3312
3312
|
Update a conversation by disconnecting all of the participants
|
|
3313
3313
|
|
|
3314
3314
|
|
|
3315
3315
|
|
|
3316
|
-
Wraps PATCH /api/v2/conversations/emails/{
|
|
3316
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}
|
|
3317
3317
|
|
|
3318
3318
|
|
|
3319
3319
|
### Example
|
|
@@ -3333,14 +3333,14 @@ end
|
|
|
3333
3333
|
|
|
3334
3334
|
api_instance = PureCloud::ConversationsApi.new
|
|
3335
3335
|
|
|
3336
|
-
|
|
3336
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3337
3337
|
|
|
3338
3338
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
3339
3339
|
|
|
3340
3340
|
|
|
3341
3341
|
begin
|
|
3342
3342
|
#Update a conversation by disconnecting all of the participants
|
|
3343
|
-
result = api_instance.patch_conversations_email(
|
|
3343
|
+
result = api_instance.patch_conversations_email(conversation_id, body)
|
|
3344
3344
|
p result
|
|
3345
3345
|
rescue PureCloud::ApiError => e
|
|
3346
3346
|
puts "Exception when calling ConversationsApi->patch_conversations_email: #{e}"
|
|
@@ -3351,7 +3351,7 @@ end
|
|
|
3351
3351
|
|
|
3352
3352
|
Name | Type | Description | Notes
|
|
3353
3353
|
------------- | ------------- | ------------- | -------------
|
|
3354
|
-
**
|
|
3354
|
+
**conversation_id** | **String**| conversationId |
|
|
3355
3355
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
3356
3356
|
{: class="table table-striped"}
|
|
3357
3357
|
|
|
@@ -3369,13 +3369,13 @@ Name | Type | Description | Notes
|
|
|
3369
3369
|
|
|
3370
3370
|
<a name="patch_conversations_email_participant"></a>
|
|
3371
3371
|
|
|
3372
|
-
## - patch_conversations_email_participant(
|
|
3372
|
+
## - patch_conversations_email_participant(conversation_id, participant_id, body)
|
|
3373
3373
|
|
|
3374
3374
|
Update conversation participant
|
|
3375
3375
|
|
|
3376
3376
|
|
|
3377
3377
|
|
|
3378
|
-
Wraps PATCH /api/v2/conversations/emails/{
|
|
3378
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}
|
|
3379
3379
|
|
|
3380
3380
|
|
|
3381
3381
|
### Example
|
|
@@ -3395,7 +3395,7 @@ end
|
|
|
3395
3395
|
|
|
3396
3396
|
api_instance = PureCloud::ConversationsApi.new
|
|
3397
3397
|
|
|
3398
|
-
|
|
3398
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3399
3399
|
|
|
3400
3400
|
participant_id = "participant_id_example" # String | participantId
|
|
3401
3401
|
|
|
@@ -3404,7 +3404,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update
|
|
|
3404
3404
|
|
|
3405
3405
|
begin
|
|
3406
3406
|
#Update conversation participant
|
|
3407
|
-
api_instance.patch_conversations_email_participant(
|
|
3407
|
+
api_instance.patch_conversations_email_participant(conversation_id, participant_id, body)
|
|
3408
3408
|
rescue PureCloud::ApiError => e
|
|
3409
3409
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant: #{e}"
|
|
3410
3410
|
end
|
|
@@ -3414,7 +3414,7 @@ end
|
|
|
3414
3414
|
|
|
3415
3415
|
Name | Type | Description | Notes
|
|
3416
3416
|
------------- | ------------- | ------------- | -------------
|
|
3417
|
-
**
|
|
3417
|
+
**conversation_id** | **String**| conversationId |
|
|
3418
3418
|
**participant_id** | **String**| participantId |
|
|
3419
3419
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
3420
3420
|
{: class="table table-striped"}
|
|
@@ -3433,13 +3433,13 @@ nil (empty response body)
|
|
|
3433
3433
|
|
|
3434
3434
|
<a name="patch_conversations_email_participant_attributes"></a>
|
|
3435
3435
|
|
|
3436
|
-
## - patch_conversations_email_participant_attributes(
|
|
3436
|
+
## - patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
|
3437
3437
|
|
|
3438
3438
|
Update the attributes on a conversation participant.
|
|
3439
3439
|
|
|
3440
3440
|
|
|
3441
3441
|
|
|
3442
|
-
Wraps PATCH /api/v2/conversations/emails/{
|
|
3442
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes
|
|
3443
3443
|
|
|
3444
3444
|
|
|
3445
3445
|
### Example
|
|
@@ -3459,7 +3459,7 @@ end
|
|
|
3459
3459
|
|
|
3460
3460
|
api_instance = PureCloud::ConversationsApi.new
|
|
3461
3461
|
|
|
3462
|
-
|
|
3462
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3463
3463
|
|
|
3464
3464
|
participant_id = "participant_id_example" # String | participantId
|
|
3465
3465
|
|
|
@@ -3468,7 +3468,7 @@ body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participan
|
|
|
3468
3468
|
|
|
3469
3469
|
begin
|
|
3470
3470
|
#Update the attributes on a conversation participant.
|
|
3471
|
-
api_instance.patch_conversations_email_participant_attributes(
|
|
3471
|
+
api_instance.patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
|
3472
3472
|
rescue PureCloud::ApiError => e
|
|
3473
3473
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_attributes: #{e}"
|
|
3474
3474
|
end
|
|
@@ -3478,7 +3478,7 @@ end
|
|
|
3478
3478
|
|
|
3479
3479
|
Name | Type | Description | Notes
|
|
3480
3480
|
------------- | ------------- | ------------- | -------------
|
|
3481
|
-
**
|
|
3481
|
+
**conversation_id** | **String**| conversationId |
|
|
3482
3482
|
**participant_id** | **String**| participantId |
|
|
3483
3483
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
3484
3484
|
{: class="table table-striped"}
|
|
@@ -3497,13 +3497,13 @@ nil (empty response body)
|
|
|
3497
3497
|
|
|
3498
3498
|
<a name="patch_conversations_email_participant_communication"></a>
|
|
3499
3499
|
|
|
3500
|
-
## -[**Empty**](Empty.html) patch_conversations_email_participant_communication(
|
|
3500
|
+
## -[**Empty**](Empty.html) patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3501
3501
|
|
|
3502
3502
|
Update conversation participant's communication by disconnecting it.
|
|
3503
3503
|
|
|
3504
3504
|
|
|
3505
3505
|
|
|
3506
|
-
Wraps PATCH /api/v2/conversations/emails/{
|
|
3506
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3507
3507
|
|
|
3508
3508
|
|
|
3509
3509
|
### Example
|
|
@@ -3523,7 +3523,7 @@ end
|
|
|
3523
3523
|
|
|
3524
3524
|
api_instance = PureCloud::ConversationsApi.new
|
|
3525
3525
|
|
|
3526
|
-
|
|
3526
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3527
3527
|
|
|
3528
3528
|
participant_id = "participant_id_example" # String | participantId
|
|
3529
3529
|
|
|
@@ -3534,7 +3534,7 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3534
3534
|
|
|
3535
3535
|
begin
|
|
3536
3536
|
#Update conversation participant's communication by disconnecting it.
|
|
3537
|
-
result = api_instance.patch_conversations_email_participant_communication(
|
|
3537
|
+
result = api_instance.patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3538
3538
|
p result
|
|
3539
3539
|
rescue PureCloud::ApiError => e
|
|
3540
3540
|
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_communication: #{e}"
|
|
@@ -3545,7 +3545,7 @@ end
|
|
|
3545
3545
|
|
|
3546
3546
|
Name | Type | Description | Notes
|
|
3547
3547
|
------------- | ------------- | ------------- | -------------
|
|
3548
|
-
**
|
|
3548
|
+
**conversation_id** | **String**| conversationId |
|
|
3549
3549
|
**participant_id** | **String**| participantId |
|
|
3550
3550
|
**communication_id** | **String**| communicationId |
|
|
3551
3551
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
@@ -3874,13 +3874,13 @@ nil (empty response body)
|
|
|
3874
3874
|
|
|
3875
3875
|
<a name="post_conversations_call"></a>
|
|
3876
3876
|
|
|
3877
|
-
## -[**Conversation**](Conversation.html) post_conversations_call(
|
|
3877
|
+
## -[**Conversation**](Conversation.html) post_conversations_call(conversation_id, body)
|
|
3878
3878
|
|
|
3879
3879
|
Add a new call to a conversation
|
|
3880
3880
|
|
|
3881
3881
|
|
|
3882
3882
|
|
|
3883
|
-
Wraps POST /api/v2/conversations/calls/{
|
|
3883
|
+
Wraps POST /api/v2/conversations/calls/{conversationId}
|
|
3884
3884
|
|
|
3885
3885
|
|
|
3886
3886
|
### Example
|
|
@@ -3900,14 +3900,14 @@ end
|
|
|
3900
3900
|
|
|
3901
3901
|
api_instance = PureCloud::ConversationsApi.new
|
|
3902
3902
|
|
|
3903
|
-
|
|
3903
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3904
3904
|
|
|
3905
3905
|
body = PureCloud::CallCommand.new # CallCommand | Conversation
|
|
3906
3906
|
|
|
3907
3907
|
|
|
3908
3908
|
begin
|
|
3909
3909
|
#Add a new call to a conversation
|
|
3910
|
-
result = api_instance.post_conversations_call(
|
|
3910
|
+
result = api_instance.post_conversations_call(conversation_id, body)
|
|
3911
3911
|
p result
|
|
3912
3912
|
rescue PureCloud::ApiError => e
|
|
3913
3913
|
puts "Exception when calling ConversationsApi->post_conversations_call: #{e}"
|
|
@@ -3918,7 +3918,7 @@ end
|
|
|
3918
3918
|
|
|
3919
3919
|
Name | Type | Description | Notes
|
|
3920
3920
|
------------- | ------------- | ------------- | -------------
|
|
3921
|
-
**
|
|
3921
|
+
**conversation_id** | **String**| conversationId |
|
|
3922
3922
|
**body** | [**CallCommand**](CallCommand.html)| Conversation |
|
|
3923
3923
|
{: class="table table-striped"}
|
|
3924
3924
|
|
|
@@ -3936,13 +3936,13 @@ Name | Type | Description | Notes
|
|
|
3936
3936
|
|
|
3937
3937
|
<a name="post_conversations_call_participant_consult"></a>
|
|
3938
3938
|
|
|
3939
|
-
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) post_conversations_call_participant_consult(
|
|
3939
|
+
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) post_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
3940
3940
|
|
|
3941
3941
|
Initiate and update consult transfer
|
|
3942
3942
|
|
|
3943
3943
|
|
|
3944
3944
|
|
|
3945
|
-
Wraps POST /api/v2/conversations/calls/{
|
|
3945
|
+
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
3946
3946
|
|
|
3947
3947
|
|
|
3948
3948
|
### Example
|
|
@@ -3962,7 +3962,7 @@ end
|
|
|
3962
3962
|
|
|
3963
3963
|
api_instance = PureCloud::ConversationsApi.new
|
|
3964
3964
|
|
|
3965
|
-
|
|
3965
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3966
3966
|
|
|
3967
3967
|
participant_id = "participant_id_example" # String | participantId
|
|
3968
3968
|
|
|
@@ -3971,7 +3971,7 @@ body = PureCloud::ConsultTransfer.new # ConsultTransfer | Destination address &
|
|
|
3971
3971
|
|
|
3972
3972
|
begin
|
|
3973
3973
|
#Initiate and update consult transfer
|
|
3974
|
-
result = api_instance.post_conversations_call_participant_consult(
|
|
3974
|
+
result = api_instance.post_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
3975
3975
|
p result
|
|
3976
3976
|
rescue PureCloud::ApiError => e
|
|
3977
3977
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_consult: #{e}"
|
|
@@ -3982,7 +3982,7 @@ end
|
|
|
3982
3982
|
|
|
3983
3983
|
Name | Type | Description | Notes
|
|
3984
3984
|
------------- | ------------- | ------------- | -------------
|
|
3985
|
-
**
|
|
3985
|
+
**conversation_id** | **String**| conversationId |
|
|
3986
3986
|
**participant_id** | **String**| participantId |
|
|
3987
3987
|
**body** | [**ConsultTransfer**](ConsultTransfer.html)| Destination address & initial speak to |
|
|
3988
3988
|
{: class="table table-striped"}
|
|
@@ -4001,13 +4001,13 @@ Name | Type | Description | Notes
|
|
|
4001
4001
|
|
|
4002
4002
|
<a name="post_conversations_call_participant_monitor"></a>
|
|
4003
4003
|
|
|
4004
|
-
## - post_conversations_call_participant_monitor(
|
|
4004
|
+
## - post_conversations_call_participant_monitor(conversation_id, participant_id)
|
|
4005
4005
|
|
|
4006
4006
|
Listen in on the conversation from the point of view of a given participant.
|
|
4007
4007
|
|
|
4008
4008
|
|
|
4009
4009
|
|
|
4010
|
-
Wraps POST /api/v2/conversations/calls/{
|
|
4010
|
+
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor
|
|
4011
4011
|
|
|
4012
4012
|
|
|
4013
4013
|
### Example
|
|
@@ -4027,14 +4027,14 @@ end
|
|
|
4027
4027
|
|
|
4028
4028
|
api_instance = PureCloud::ConversationsApi.new
|
|
4029
4029
|
|
|
4030
|
-
|
|
4030
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4031
4031
|
|
|
4032
4032
|
participant_id = "participant_id_example" # String | participantId
|
|
4033
4033
|
|
|
4034
4034
|
|
|
4035
4035
|
begin
|
|
4036
4036
|
#Listen in on the conversation from the point of view of a given participant.
|
|
4037
|
-
api_instance.post_conversations_call_participant_monitor(
|
|
4037
|
+
api_instance.post_conversations_call_participant_monitor(conversation_id, participant_id)
|
|
4038
4038
|
rescue PureCloud::ApiError => e
|
|
4039
4039
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_monitor: #{e}"
|
|
4040
4040
|
end
|
|
@@ -4044,7 +4044,7 @@ end
|
|
|
4044
4044
|
|
|
4045
4045
|
Name | Type | Description | Notes
|
|
4046
4046
|
------------- | ------------- | ------------- | -------------
|
|
4047
|
-
**
|
|
4047
|
+
**conversation_id** | **String**| conversationId |
|
|
4048
4048
|
**participant_id** | **String**| participantId |
|
|
4049
4049
|
{: class="table table-striped"}
|
|
4050
4050
|
|
|
@@ -4062,13 +4062,13 @@ nil (empty response body)
|
|
|
4062
4062
|
|
|
4063
4063
|
<a name="post_conversations_call_participant_replace"></a>
|
|
4064
4064
|
|
|
4065
|
-
## - post_conversations_call_participant_replace(
|
|
4065
|
+
## - post_conversations_call_participant_replace(conversation_id, participant_id, body)
|
|
4066
4066
|
|
|
4067
4067
|
Replace this participant with the specified user and/or address
|
|
4068
4068
|
|
|
4069
4069
|
|
|
4070
4070
|
|
|
4071
|
-
Wraps POST /api/v2/conversations/calls/{
|
|
4071
|
+
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace
|
|
4072
4072
|
|
|
4073
4073
|
|
|
4074
4074
|
### Example
|
|
@@ -4088,7 +4088,7 @@ end
|
|
|
4088
4088
|
|
|
4089
4089
|
api_instance = PureCloud::ConversationsApi.new
|
|
4090
4090
|
|
|
4091
|
-
|
|
4091
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4092
4092
|
|
|
4093
4093
|
participant_id = "participant_id_example" # String | participantId
|
|
4094
4094
|
|
|
@@ -4097,7 +4097,7 @@ body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
|
4097
4097
|
|
|
4098
4098
|
begin
|
|
4099
4099
|
#Replace this participant with the specified user and/or address
|
|
4100
|
-
api_instance.post_conversations_call_participant_replace(
|
|
4100
|
+
api_instance.post_conversations_call_participant_replace(conversation_id, participant_id, body)
|
|
4101
4101
|
rescue PureCloud::ApiError => e
|
|
4102
4102
|
puts "Exception when calling ConversationsApi->post_conversations_call_participant_replace: #{e}"
|
|
4103
4103
|
end
|
|
@@ -4107,7 +4107,7 @@ end
|
|
|
4107
4107
|
|
|
4108
4108
|
Name | Type | Description | Notes
|
|
4109
4109
|
------------- | ------------- | ------------- | -------------
|
|
4110
|
-
**
|
|
4110
|
+
**conversation_id** | **String**| conversationId |
|
|
4111
4111
|
**participant_id** | **String**| participantId |
|
|
4112
4112
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4113
4113
|
{: class="table table-striped"}
|
|
@@ -4126,13 +4126,13 @@ nil (empty response body)
|
|
|
4126
4126
|
|
|
4127
4127
|
<a name="post_conversations_call_participants"></a>
|
|
4128
4128
|
|
|
4129
|
-
## -[**Conversation**](Conversation.html) post_conversations_call_participants(
|
|
4129
|
+
## -[**Conversation**](Conversation.html) post_conversations_call_participants(conversation_id, body)
|
|
4130
4130
|
|
|
4131
4131
|
Add participants to a conversation
|
|
4132
4132
|
|
|
4133
4133
|
|
|
4134
4134
|
|
|
4135
|
-
Wraps POST /api/v2/conversations/calls/{
|
|
4135
|
+
Wraps POST /api/v2/conversations/calls/{conversationId}/participants
|
|
4136
4136
|
|
|
4137
4137
|
|
|
4138
4138
|
### Example
|
|
@@ -4152,14 +4152,14 @@ end
|
|
|
4152
4152
|
|
|
4153
4153
|
api_instance = PureCloud::ConversationsApi.new
|
|
4154
4154
|
|
|
4155
|
-
|
|
4155
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4156
4156
|
|
|
4157
4157
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
4158
4158
|
|
|
4159
4159
|
|
|
4160
4160
|
begin
|
|
4161
4161
|
#Add participants to a conversation
|
|
4162
|
-
result = api_instance.post_conversations_call_participants(
|
|
4162
|
+
result = api_instance.post_conversations_call_participants(conversation_id, body)
|
|
4163
4163
|
p result
|
|
4164
4164
|
rescue PureCloud::ApiError => e
|
|
4165
4165
|
puts "Exception when calling ConversationsApi->post_conversations_call_participants: #{e}"
|
|
@@ -4170,7 +4170,7 @@ end
|
|
|
4170
4170
|
|
|
4171
4171
|
Name | Type | Description | Notes
|
|
4172
4172
|
------------- | ------------- | ------------- | -------------
|
|
4173
|
-
**
|
|
4173
|
+
**conversation_id** | **String**| conversationId |
|
|
4174
4174
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
4175
4175
|
{: class="table table-striped"}
|
|
4176
4176
|
|
|
@@ -4188,13 +4188,13 @@ Name | Type | Description | Notes
|
|
|
4188
4188
|
|
|
4189
4189
|
<a name="post_conversations_callback_participant_replace"></a>
|
|
4190
4190
|
|
|
4191
|
-
## - post_conversations_callback_participant_replace(
|
|
4191
|
+
## - post_conversations_callback_participant_replace(conversation_id, participant_id, body)
|
|
4192
4192
|
|
|
4193
4193
|
Replace this participant with the specified user and/or address
|
|
4194
4194
|
|
|
4195
4195
|
|
|
4196
4196
|
|
|
4197
|
-
Wraps POST /api/v2/conversations/callbacks/{
|
|
4197
|
+
Wraps POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace
|
|
4198
4198
|
|
|
4199
4199
|
|
|
4200
4200
|
### Example
|
|
@@ -4214,7 +4214,7 @@ end
|
|
|
4214
4214
|
|
|
4215
4215
|
api_instance = PureCloud::ConversationsApi.new
|
|
4216
4216
|
|
|
4217
|
-
|
|
4217
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4218
4218
|
|
|
4219
4219
|
participant_id = "participant_id_example" # String | participantId
|
|
4220
4220
|
|
|
@@ -4223,7 +4223,7 @@ body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
|
4223
4223
|
|
|
4224
4224
|
begin
|
|
4225
4225
|
#Replace this participant with the specified user and/or address
|
|
4226
|
-
api_instance.post_conversations_callback_participant_replace(
|
|
4226
|
+
api_instance.post_conversations_callback_participant_replace(conversation_id, participant_id, body)
|
|
4227
4227
|
rescue PureCloud::ApiError => e
|
|
4228
4228
|
puts "Exception when calling ConversationsApi->post_conversations_callback_participant_replace: #{e}"
|
|
4229
4229
|
end
|
|
@@ -4233,7 +4233,7 @@ end
|
|
|
4233
4233
|
|
|
4234
4234
|
Name | Type | Description | Notes
|
|
4235
4235
|
------------- | ------------- | ------------- | -------------
|
|
4236
|
-
**
|
|
4236
|
+
**conversation_id** | **String**| conversationId |
|
|
4237
4237
|
**participant_id** | **String**| participantId |
|
|
4238
4238
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4239
4239
|
{: class="table table-striped"}
|
|
@@ -4370,13 +4370,13 @@ Name | Type | Description | Notes
|
|
|
4370
4370
|
|
|
4371
4371
|
<a name="post_conversations_chat_participant_replace"></a>
|
|
4372
4372
|
|
|
4373
|
-
## - post_conversations_chat_participant_replace(
|
|
4373
|
+
## - post_conversations_chat_participant_replace(conversation_id, participant_id, body)
|
|
4374
4374
|
|
|
4375
4375
|
Replace this participant with the specified user and/or address
|
|
4376
4376
|
|
|
4377
4377
|
|
|
4378
4378
|
|
|
4379
|
-
Wraps POST /api/v2/conversations/chats/{
|
|
4379
|
+
Wraps POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace
|
|
4380
4380
|
|
|
4381
4381
|
|
|
4382
4382
|
### Example
|
|
@@ -4396,7 +4396,7 @@ end
|
|
|
4396
4396
|
|
|
4397
4397
|
api_instance = PureCloud::ConversationsApi.new
|
|
4398
4398
|
|
|
4399
|
-
|
|
4399
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4400
4400
|
|
|
4401
4401
|
participant_id = "participant_id_example" # String | participantId
|
|
4402
4402
|
|
|
@@ -4405,7 +4405,7 @@ body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
|
4405
4405
|
|
|
4406
4406
|
begin
|
|
4407
4407
|
#Replace this participant with the specified user and/or address
|
|
4408
|
-
api_instance.post_conversations_chat_participant_replace(
|
|
4408
|
+
api_instance.post_conversations_chat_participant_replace(conversation_id, participant_id, body)
|
|
4409
4409
|
rescue PureCloud::ApiError => e
|
|
4410
4410
|
puts "Exception when calling ConversationsApi->post_conversations_chat_participant_replace: #{e}"
|
|
4411
4411
|
end
|
|
@@ -4415,7 +4415,7 @@ end
|
|
|
4415
4415
|
|
|
4416
4416
|
Name | Type | Description | Notes
|
|
4417
4417
|
------------- | ------------- | ------------- | -------------
|
|
4418
|
-
**
|
|
4418
|
+
**conversation_id** | **String**| conversationId |
|
|
4419
4419
|
**participant_id** | **String**| participantId |
|
|
4420
4420
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4421
4421
|
{: class="table table-striped"}
|
|
@@ -4493,13 +4493,13 @@ Name | Type | Description | Notes
|
|
|
4493
4493
|
|
|
4494
4494
|
<a name="post_conversations_cobrowsesession_participant_replace"></a>
|
|
4495
4495
|
|
|
4496
|
-
## - post_conversations_cobrowsesession_participant_replace(
|
|
4496
|
+
## - post_conversations_cobrowsesession_participant_replace(conversation_id, participant_id, opts)
|
|
4497
4497
|
|
|
4498
4498
|
Replace this participant with the specified user and/or address
|
|
4499
4499
|
|
|
4500
4500
|
|
|
4501
4501
|
|
|
4502
|
-
Wraps POST /api/v2/conversations/cobrowsesessions/{
|
|
4502
|
+
Wraps POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace
|
|
4503
4503
|
|
|
4504
4504
|
|
|
4505
4505
|
### Example
|
|
@@ -4519,7 +4519,7 @@ end
|
|
|
4519
4519
|
|
|
4520
4520
|
api_instance = PureCloud::ConversationsApi.new
|
|
4521
4521
|
|
|
4522
|
-
|
|
4522
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4523
4523
|
|
|
4524
4524
|
participant_id = "participant_id_example" # String | participantId
|
|
4525
4525
|
|
|
@@ -4529,7 +4529,7 @@ opts = {
|
|
|
4529
4529
|
|
|
4530
4530
|
begin
|
|
4531
4531
|
#Replace this participant with the specified user and/or address
|
|
4532
|
-
api_instance.post_conversations_cobrowsesession_participant_replace(
|
|
4532
|
+
api_instance.post_conversations_cobrowsesession_participant_replace(conversation_id, participant_id, opts)
|
|
4533
4533
|
rescue PureCloud::ApiError => e
|
|
4534
4534
|
puts "Exception when calling ConversationsApi->post_conversations_cobrowsesession_participant_replace: #{e}"
|
|
4535
4535
|
end
|
|
@@ -4539,7 +4539,7 @@ end
|
|
|
4539
4539
|
|
|
4540
4540
|
Name | Type | Description | Notes
|
|
4541
4541
|
------------- | ------------- | ------------- | -------------
|
|
4542
|
-
**
|
|
4542
|
+
**conversation_id** | **String**| conversationId |
|
|
4543
4543
|
**participant_id** | **String**| participantId |
|
|
4544
4544
|
**body** | [**TransferRequest**](TransferRequest.html)| | [optional]
|
|
4545
4545
|
{: class="table table-striped"}
|
|
@@ -4558,13 +4558,13 @@ nil (empty response body)
|
|
|
4558
4558
|
|
|
4559
4559
|
<a name="post_conversations_email_messages"></a>
|
|
4560
4560
|
|
|
4561
|
-
## -[**EmailMessage**](EmailMessage.html) post_conversations_email_messages(
|
|
4561
|
+
## -[**EmailMessage**](EmailMessage.html) post_conversations_email_messages(conversation_id, body)
|
|
4562
4562
|
|
|
4563
4563
|
Send an email reply
|
|
4564
4564
|
|
|
4565
4565
|
|
|
4566
4566
|
|
|
4567
|
-
Wraps POST /api/v2/conversations/emails/{
|
|
4567
|
+
Wraps POST /api/v2/conversations/emails/{conversationId}/messages
|
|
4568
4568
|
|
|
4569
4569
|
|
|
4570
4570
|
### Example
|
|
@@ -4584,14 +4584,14 @@ end
|
|
|
4584
4584
|
|
|
4585
4585
|
api_instance = PureCloud::ConversationsApi.new
|
|
4586
4586
|
|
|
4587
|
-
|
|
4587
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4588
4588
|
|
|
4589
4589
|
body = PureCloud::EmailMessage.new # EmailMessage | Reply
|
|
4590
4590
|
|
|
4591
4591
|
|
|
4592
4592
|
begin
|
|
4593
4593
|
#Send an email reply
|
|
4594
|
-
result = api_instance.post_conversations_email_messages(
|
|
4594
|
+
result = api_instance.post_conversations_email_messages(conversation_id, body)
|
|
4595
4595
|
p result
|
|
4596
4596
|
rescue PureCloud::ApiError => e
|
|
4597
4597
|
puts "Exception when calling ConversationsApi->post_conversations_email_messages: #{e}"
|
|
@@ -4602,7 +4602,7 @@ end
|
|
|
4602
4602
|
|
|
4603
4603
|
Name | Type | Description | Notes
|
|
4604
4604
|
------------- | ------------- | ------------- | -------------
|
|
4605
|
-
**
|
|
4605
|
+
**conversation_id** | **String**| conversationId |
|
|
4606
4606
|
**body** | [**EmailMessage**](EmailMessage.html)| Reply |
|
|
4607
4607
|
{: class="table table-striped"}
|
|
4608
4608
|
|
|
@@ -4620,13 +4620,13 @@ Name | Type | Description | Notes
|
|
|
4620
4620
|
|
|
4621
4621
|
<a name="post_conversations_email_participant_replace"></a>
|
|
4622
4622
|
|
|
4623
|
-
## - post_conversations_email_participant_replace(
|
|
4623
|
+
## - post_conversations_email_participant_replace(conversation_id, participant_id, body)
|
|
4624
4624
|
|
|
4625
4625
|
Replace this participant with the specified user and/or address
|
|
4626
4626
|
|
|
4627
4627
|
|
|
4628
4628
|
|
|
4629
|
-
Wraps POST /api/v2/conversations/emails/{
|
|
4629
|
+
Wraps POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace
|
|
4630
4630
|
|
|
4631
4631
|
|
|
4632
4632
|
### Example
|
|
@@ -4646,7 +4646,7 @@ end
|
|
|
4646
4646
|
|
|
4647
4647
|
api_instance = PureCloud::ConversationsApi.new
|
|
4648
4648
|
|
|
4649
|
-
|
|
4649
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4650
4650
|
|
|
4651
4651
|
participant_id = "participant_id_example" # String | participantId
|
|
4652
4652
|
|
|
@@ -4655,7 +4655,7 @@ body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
|
4655
4655
|
|
|
4656
4656
|
begin
|
|
4657
4657
|
#Replace this participant with the specified user and/or address
|
|
4658
|
-
api_instance.post_conversations_email_participant_replace(
|
|
4658
|
+
api_instance.post_conversations_email_participant_replace(conversation_id, participant_id, body)
|
|
4659
4659
|
rescue PureCloud::ApiError => e
|
|
4660
4660
|
puts "Exception when calling ConversationsApi->post_conversations_email_participant_replace: #{e}"
|
|
4661
4661
|
end
|
|
@@ -4665,7 +4665,7 @@ end
|
|
|
4665
4665
|
|
|
4666
4666
|
Name | Type | Description | Notes
|
|
4667
4667
|
------------- | ------------- | ------------- | -------------
|
|
4668
|
-
**
|
|
4668
|
+
**conversation_id** | **String**| conversationId |
|
|
4669
4669
|
**participant_id** | **String**| participantId |
|
|
4670
4670
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
4671
4671
|
{: class="table table-striped"}
|
|
@@ -4802,13 +4802,13 @@ Name | Type | Description | Notes
|
|
|
4802
4802
|
|
|
4803
4803
|
<a name="put_conversations_email_messages_draft"></a>
|
|
4804
4804
|
|
|
4805
|
-
## -[**EmailMessage**](EmailMessage.html) put_conversations_email_messages_draft(
|
|
4805
|
+
## -[**EmailMessage**](EmailMessage.html) put_conversations_email_messages_draft(conversation_id, body)
|
|
4806
4806
|
|
|
4807
4807
|
Update conversation draft reply
|
|
4808
4808
|
|
|
4809
4809
|
|
|
4810
4810
|
|
|
4811
|
-
Wraps PUT /api/v2/conversations/emails/{
|
|
4811
|
+
Wraps PUT /api/v2/conversations/emails/{conversationId}/messages/draft
|
|
4812
4812
|
|
|
4813
4813
|
|
|
4814
4814
|
### Example
|
|
@@ -4828,14 +4828,14 @@ end
|
|
|
4828
4828
|
|
|
4829
4829
|
api_instance = PureCloud::ConversationsApi.new
|
|
4830
4830
|
|
|
4831
|
-
|
|
4831
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
4832
4832
|
|
|
4833
4833
|
body = PureCloud::EmailMessage.new # EmailMessage | Draft
|
|
4834
4834
|
|
|
4835
4835
|
|
|
4836
4836
|
begin
|
|
4837
4837
|
#Update conversation draft reply
|
|
4838
|
-
result = api_instance.put_conversations_email_messages_draft(
|
|
4838
|
+
result = api_instance.put_conversations_email_messages_draft(conversation_id, body)
|
|
4839
4839
|
p result
|
|
4840
4840
|
rescue PureCloud::ApiError => e
|
|
4841
4841
|
puts "Exception when calling ConversationsApi->put_conversations_email_messages_draft: #{e}"
|
|
@@ -4846,7 +4846,7 @@ end
|
|
|
4846
4846
|
|
|
4847
4847
|
Name | Type | Description | Notes
|
|
4848
4848
|
------------- | ------------- | ------------- | -------------
|
|
4849
|
-
**
|
|
4849
|
+
**conversation_id** | **String**| conversationId |
|
|
4850
4850
|
**body** | [**EmailMessage**](EmailMessage.html)| Draft |
|
|
4851
4851
|
{: class="table table-striped"}
|
|
4852
4852
|
|