purecloud 0.50.1 → 0.51.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -6
- data/bin/notificationMappings.json +96 -0
- data/config-ruby.json +1 -1
- data/doc_out/AcwSettings.html.md +2 -2
- data/doc_out/Address.html.md +17 -0
- data/doc_out/Agent.html.md +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AlertingApi.html.md +445 -0
- data/doc_out/AttemptLimits.html.md +22 -0
- data/doc_out/AttemptLimitsEntityListing.html.md +22 -0
- data/doc_out/Attribute.html.md +1 -1
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/AuditEntity.html.md +4 -4
- data/doc_out/AuditFacet.html.md +2 -2
- data/doc_out/AuditFilter.html.md +4 -4
- data/doc_out/AuditMessage.html.md +14 -14
- data/doc_out/AuditSearchResult.html.md +4 -4
- data/doc_out/AuditUser.html.md +3 -3
- data/doc_out/AuthorizationApi.html.md +2 -2
- data/doc_out/AvailableTopicEntityListing.html.md +2 -2
- data/doc_out/CalibrationCreate.html.md +28 -0
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/Call.html.md +17 -17
- data/doc_out/CallCommand.html.md +1 -1
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallConversationNotification.html.md +17 -0
- data/doc_out/CallConversationNotificationCallMediaParticipant.html.md +44 -0
- data/doc_out/CallConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/CallConversationNotificationParticipants.html.md +44 -0
- data/doc_out/CallConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallMediaParticipant.html.md +6 -3
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/Callback.html.md +16 -16
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationNotification.html.md +16 -0
- data/doc_out/CallbackConversationNotificationCallbackMediaParticipant.html.md +39 -0
- data/doc_out/CallbackConversationNotificationDetail.html.md +16 -0
- data/doc_out/CallbackConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/CallbackConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CallbackConversationNotificationErrorInfoDetails.html.md +16 -0
- data/doc_out/CallbackConversationNotificationParticipants.html.md +39 -0
- data/doc_out/CallbackConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/CallbackConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CallbackConversationNotificationUser.html.md +14 -0
- data/doc_out/CallbackMediaParticipant.html.md +6 -3
- data/doc_out/Campaign.html.md +1 -0
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignInteraction.html.md +33 -0
- data/doc_out/CampaignInteractions.html.md +17 -0
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/Change.html.md +3 -3
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChannelTopicEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/ChatConversationNotification.html.md +16 -0
- data/doc_out/ChatConversationNotificationChatMediaParticipant.html.md +34 -0
- data/doc_out/ChatConversationNotificationDetail.html.md +16 -0
- data/doc_out/ChatConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ChatConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ChatConversationNotificationParticipants.html.md +34 -0
- data/doc_out/ChatConversationNotificationUriReference.html.md +14 -0
- data/doc_out/ChatMediaParticipant.html.md +6 -3
- data/doc_out/CobrowseConversation.html.md +17 -0
- data/doc_out/CobrowseConversationEntityListing.html.md +22 -0
- data/doc_out/CobrowseConversationNotification.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationCobrowseMediaParticipant.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationDetail.html.md +16 -0
- data/doc_out/CobrowseConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/CobrowseConversationNotificationParticipants.html.md +38 -0
- data/doc_out/CobrowseConversationNotificationUriReference.html.md +14 -0
- data/doc_out/CobrowseMediaParticipant.html.md +41 -0
- data/doc_out/Cobrowsesession.html.md +23 -0
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ContentManagementApi.html.md +34 -33
- data/doc_out/ConversationChat.html.md +12 -11
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/ConversationNotification.html.md +17 -0
- data/doc_out/ConversationNotificationAddress.html.md +18 -0
- data/doc_out/ConversationNotificationCall.html.md +31 -0
- data/doc_out/ConversationNotificationCallback.html.md +28 -0
- data/doc_out/ConversationNotificationCallbacks.html.md +28 -0
- data/doc_out/ConversationNotificationCalls.html.md +31 -0
- data/doc_out/ConversationNotificationChat.html.md +21 -0
- data/doc_out/ConversationNotificationChats.html.md +21 -0
- data/doc_out/ConversationNotificationCobrowse.html.md +25 -0
- data/doc_out/ConversationNotificationCobrowsesessions.html.md +25 -0
- data/doc_out/ConversationNotificationDialerPreview.html.md +18 -0
- data/doc_out/ConversationNotificationDialerPreviewPhoneNumberColumns.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReason.html.md +15 -0
- data/doc_out/ConversationNotificationDisconnectReasons.html.md +15 -0
- data/doc_out/ConversationNotificationEmail.html.md +23 -0
- data/doc_out/ConversationNotificationEmails.html.md +23 -0
- data/doc_out/ConversationNotificationErrorDetails.html.md +20 -0
- data/doc_out/ConversationNotificationErrorInfo.html.md +20 -0
- data/doc_out/ConversationNotificationFaxStatus.html.md +20 -0
- data/doc_out/ConversationNotificationParticipant.html.md +39 -0
- data/doc_out/ConversationNotificationParticipants.html.md +39 -0
- data/doc_out/ConversationNotificationPhoneNumberColumn.html.md +15 -0
- data/doc_out/ConversationNotificationScreenShare.html.md +21 -0
- data/doc_out/ConversationNotificationScreenShares.html.md +21 -0
- data/doc_out/ConversationNotificationSelf.html.md +18 -0
- data/doc_out/ConversationNotificationSocialExpression.html.md +25 -0
- data/doc_out/ConversationNotificationSocialExpressions.html.md +25 -0
- data/doc_out/ConversationNotificationVideo.html.md +24 -0
- data/doc_out/ConversationNotificationVideos.html.md +24 -0
- data/doc_out/ConversationNotificationWrapup.html.md +18 -0
- data/doc_out/ConversationsApi.html.md +707 -161
- data/doc_out/CreateCallbackCommand.html.md +1 -1
- data/doc_out/CreateShareRequest.html.md +3 -3
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DialerAuditRequest.html.md +4 -4
- data/doc_out/DialerContact.html.md +1 -1
- data/doc_out/DialerPreview.html.md +4 -4
- data/doc_out/DisconnectReason.html.md +3 -3
- data/doc_out/DncList.html.md +1 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DocumentUpdate.html.md +1 -1
- data/doc_out/DocumentUpload.html.md +2 -2
- data/doc_out/DomainCapabilities.html.md +5 -3
- data/doc_out/DomainEdgeSoftwareVersionDto.html.md +1 -1
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +22 -0
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/DomainLogicalInterface.html.md +5 -8
- data/doc_out/DomainNetworkAddress.html.md +4 -4
- data/doc_out/DomainNetworkRoute.html.md +5 -5
- data/doc_out/DomainOrganizationRoleCreate.html.md +22 -0
- data/doc_out/Edge.html.md +2 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EdgeLogsJobRequest.html.md +3 -3
- data/doc_out/EdgeLogsJobUploadRequest.html.md +1 -1
- data/doc_out/EdgeOfflineConfiguration.html.md +14 -0
- data/doc_out/EdgeOfflineConfigurationInterface.html.md +16 -0
- data/doc_out/EdgeOfflineConfigurationNetwork.html.md +13 -0
- data/doc_out/EdgeOfflineConfigurationResponse.html.md +13 -0
- data/doc_out/Email.html.md +13 -12
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailConversationNotification.html.md +16 -0
- data/doc_out/EmailConversationNotificationDetail.html.md +16 -0
- data/doc_out/EmailConversationNotificationEmailMediaParticipant.html.md +35 -0
- data/doc_out/EmailConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/EmailConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/EmailConversationNotificationParticipants.html.md +35 -0
- data/doc_out/EmailConversationNotificationUriReference.html.md +14 -0
- data/doc_out/EmailMediaParticipant.html.md +6 -3
- data/doc_out/EmailMessage.html.md +3 -3
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/Entry.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationForm.html.md +3 -3
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FacetInfo.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/FaxStatus.html.md +8 -8
- data/doc_out/Group.html.md +1 -1
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/GroupMembersUpdate.html.md +2 -2
- data/doc_out/GroupUpdate.html.md +22 -0
- data/doc_out/GroupsApi.html.md +122 -4
- data/doc_out/HeartBeatAlert.html.md +24 -0
- data/doc_out/HeartBeatAlertContainer.html.md +22 -0
- data/doc_out/HeartBeatAlertNotification.html.md +22 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/HeartBeatAlertNotificationNotificationUsers.html.md +14 -0
- data/doc_out/HeartBeatRule.html.md +22 -0
- data/doc_out/HeartBeatRuleContainer.html.md +22 -0
- data/doc_out/HeartBeatRuleNotification.html.md +21 -0
- data/doc_out/HeartBeatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRoute.html.md +3 -3
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatAlertNotification.html.md +28 -0
- data/doc_out/InteractionStatAlertNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatRuleNotification.html.md +26 -0
- data/doc_out/InteractionStatRuleNotificationNotificationUser.html.md +14 -0
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/JsonNode.html.md +2 -2
- data/doc_out/Keyword.html.md +4 -1
- data/doc_out/KeywordSet.html.md +1 -1
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/Language.html.md +1 -1
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/Library.html.md +1 -1
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocationsApi.html.md +4 -4
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/MaxParticipants.html.md +1 -1
- data/doc_out/MetaData.html.md +15 -0
- data/doc_out/OAuthClientEntityListing.html.md +2 -2
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresence.html.md +1 -1
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OutOfOfficeNotification.html.md +17 -0
- data/doc_out/OutOfOfficeNotificationUser.html.md +13 -0
- data/doc_out/OutboundApi.html.md +356 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/Participant.html.md +28 -25
- data/doc_out/ParticipantAttributes.html.md +1 -1
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhonesReboot.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyCreate.html.md +24 -0
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/PresenceApi.html.md +10 -4
- data/doc_out/QualityApi.html.md +16 -16
- data/doc_out/QualityAudit.html.md +1 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +22 -0
- data/doc_out/RecordingApi.html.md +63 -3
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RoutingApi.html.md +93 -24
- data/doc_out/RoutingSkill.html.md +1 -1
- data/doc_out/RoutingStatus.html.md +3 -3
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSession.html.md +3 -0
- data/doc_out/ScreenRecordingSessionListing.html.md +5 -0
- data/doc_out/ScreenRecordingSessionRequest.html.md +15 -0
- data/doc_out/ScreenShareConversationNotification.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationDetail.html.md +16 -0
- data/doc_out/ScreenShareConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/ScreenShareConversationNotificationParticipants.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationScreenShareMediaParticipant.html.md +36 -0
- data/doc_out/ScreenShareConversationNotificationUriReference.html.md +14 -0
- data/doc_out/Screenshare.html.md +20 -0
- data/doc_out/SearchApi.html.md +26 -26
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/Segment.html.md +5 -5
- data/doc_out/ServiceContext.html.md +1 -1
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/Site.html.md +1 -1
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/SocialConversationNotification.html.md +16 -0
- data/doc_out/SocialConversationNotificationDetail.html.md +16 -0
- data/doc_out/SocialConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/SocialConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/SocialConversationNotificationParticipants.html.md +37 -0
- data/doc_out/SocialConversationNotificationSocialMediaParticipant.html.md +37 -0
- data/doc_out/SocialConversationNotificationUriReference.html.md +14 -0
- data/doc_out/SocialExpression.html.md +13 -13
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StreetAddress.html.md +1 -1
- data/doc_out/SubscriberResponse.html.md +2 -2
- data/doc_out/SuggestApi.html.md +14 -14
- data/doc_out/TagValue.html.md +1 -1
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +121 -7
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserConversationSummaryNotification.html.md +19 -0
- data/doc_out/UserConversationSummaryNotificationCall.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationCallContactCenter.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummary.html.md +14 -0
- data/doc_out/UserConversationSummaryNotificationMediaSummaryDetail.html.md +14 -0
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserMe.html.md +1 -0
- data/doc_out/UserPresenceNotification.html.md +16 -0
- data/doc_out/UserPresenceNotificationOrganizationPresence.html.md +14 -0
- data/doc_out/UserPresenceNotificationPresenceDefinition.html.md +14 -0
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserRecordingsApi.html.md +6 -6
- data/doc_out/UserRoutingSkillPost.html.md +16 -0
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +14 -14
- data/doc_out/UsersEntityListing.html.md +2 -2
- data/doc_out/ValidateAddressRequest.html.md +1 -1
- data/doc_out/ValidateAddressResponse.html.md +2 -2
- data/doc_out/Video.html.md +10 -10
- data/doc_out/VideoConversationNotification.html.md +16 -0
- data/doc_out/VideoConversationNotificationDetail.html.md +16 -0
- data/doc_out/VideoConversationNotificationErrorBody.html.md +22 -0
- data/doc_out/VideoConversationNotificationErrorInfo.html.md +22 -0
- data/doc_out/VideoConversationNotificationParticipants.html.md +39 -0
- data/doc_out/VideoConversationNotificationUriReference.html.md +14 -0
- data/doc_out/VideoConversationNotificationVideoMediaParticipant.html.md +39 -0
- data/doc_out/VmPairingInfo.html.md +16 -0
- data/doc_out/WorkspaceCreate.html.md +1 -1
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/Wrapup.html.md +7 -7
- data/doc_out/WrapupCode.html.md +1 -1
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +6 -6
- data/lib/purecloud.rb +138 -0
- data/lib/purecloud/api/alerting_api.rb +473 -0
- data/lib/purecloud/api/content_management_api.rb +49 -100
- data/lib/purecloud/api/conversations_api.rb +749 -164
- data/lib/purecloud/api/groups_api.rb +126 -4
- data/lib/purecloud/api/locations_api.rb +4 -4
- data/lib/purecloud/api/outbound_api.rb +386 -0
- data/lib/purecloud/api/presence_api.rb +8 -2
- data/lib/purecloud/api/quality_api.rb +14 -14
- data/lib/purecloud/api/recording_api.rb +63 -2
- data/lib/purecloud/api/routing_api.rb +108 -30
- data/lib/purecloud/api/search_api.rb +26 -26
- data/lib/purecloud/api/suggest_api.rb +14 -14
- data/lib/purecloud/api/telephony_providers_edge_api.rb +128 -8
- data/lib/purecloud/api/user_recordings_api.rb +9 -9
- data/lib/purecloud/api/users_api.rb +12 -12
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/acw_settings.rb +2 -0
- data/lib/purecloud/models/address.rb +210 -0
- data/lib/purecloud/models/agent.rb +1 -0
- data/lib/purecloud/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/analytics_session.rb +1 -1
- data/lib/purecloud/models/attempt_limits.rb +271 -0
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +257 -0
- data/lib/purecloud/models/attribute.rb +1 -0
- data/lib/purecloud/models/attribute_entity_listing.rb +13 -13
- data/lib/purecloud/models/audit_entity.rb +4 -0
- data/lib/purecloud/models/audit_facet.rb +2 -0
- data/lib/purecloud/models/audit_filter.rb +4 -0
- data/lib/purecloud/models/audit_message.rb +14 -0
- data/lib/purecloud/models/audit_search_result.rb +4 -0
- data/lib/purecloud/models/audit_user.rb +3 -0
- data/lib/purecloud/models/available_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/calibration_create.rb +323 -0
- data/lib/purecloud/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloud/models/call.rb +18 -4
- data/lib/purecloud/models/call_command.rb +1 -0
- data/lib/purecloud/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/call_conversation_notification.rb +218 -0
- data/lib/purecloud/models/call_conversation_notification_call_media_participant.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/call_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/call_conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/call_conversation_notification_participants.rb +513 -0
- data/lib/purecloud/models/call_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/call_media_participant.rb +38 -5
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback.rb +17 -5
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/callback_conversation_notification.rb +199 -0
- data/lib/purecloud/models/callback_conversation_notification_callback_media_participant.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/callback_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/callback_conversation_notification_error_info_details.rb +195 -0
- data/lib/purecloud/models/callback_conversation_notification_participants.rb +456 -0
- data/lib/purecloud/models/callback_conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/callback_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/callback_conversation_notification_user.rb +175 -0
- data/lib/purecloud/models/callback_media_participant.rb +38 -5
- data/lib/purecloud/models/campaign.rb +12 -1
- data/lib/purecloud/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloud/models/campaign_interaction.rb +388 -0
- data/lib/purecloud/models/campaign_interactions.rb +213 -0
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloud/models/change.rb +3 -0
- data/lib/purecloud/models/channel_entity_listing.rb +13 -13
- data/lib/purecloud/models/channel_topic_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/chat_conversation_notification.rb +199 -0
- data/lib/purecloud/models/chat_conversation_notification_chat_media_participant.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/chat_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/chat_conversation_notification_participants.rb +404 -0
- data/lib/purecloud/models/chat_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/chat_media_participant.rb +38 -5
- data/lib/purecloud/models/cobrowse_conversation.rb +213 -0
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +257 -0
- data/lib/purecloud/models/cobrowse_conversation_notification.rb +199 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_participants.rb +446 -0
- data/lib/purecloud/models/cobrowse_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/cobrowse_media_participant.rb +511 -0
- data/lib/purecloud/models/cobrowsesession.rb +296 -0
- data/lib/purecloud/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/contact_sort.rb +1 -0
- data/lib/purecloud/models/conversation_chat.rb +26 -7
- data/lib/purecloud/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/conversation_notification.rb +207 -0
- data/lib/purecloud/models/conversation_notification_address.rb +215 -0
- data/lib/purecloud/models/conversation_notification_call.rb +383 -0
- data/lib/purecloud/models/conversation_notification_callback.rb +344 -0
- data/lib/purecloud/models/conversation_notification_callbacks.rb +344 -0
- data/lib/purecloud/models/conversation_notification_calls.rb +383 -0
- data/lib/purecloud/models/conversation_notification_chat.rb +263 -0
- data/lib/purecloud/models/conversation_notification_chats.rb +263 -0
- data/lib/purecloud/models/conversation_notification_cobrowse.rb +305 -0
- data/lib/purecloud/models/conversation_notification_cobrowsesessions.rb +305 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview.rb +217 -0
- data/lib/purecloud/models/conversation_notification_dialer_preview_phone_number_columns.rb +185 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reason.rb +194 -0
- data/lib/purecloud/models/conversation_notification_disconnect_reasons.rb +194 -0
- data/lib/purecloud/models/conversation_notification_email.rb +283 -0
- data/lib/purecloud/models/conversation_notification_emails.rb +283 -0
- data/lib/purecloud/models/conversation_notification_error_details.rb +237 -0
- data/lib/purecloud/models/conversation_notification_error_info.rb +237 -0
- data/lib/purecloud/models/conversation_notification_fax_status.rb +235 -0
- data/lib/purecloud/models/conversation_notification_participant.rb +443 -0
- data/lib/purecloud/models/conversation_notification_participants.rb +443 -0
- data/lib/purecloud/models/conversation_notification_phone_number_column.rb +185 -0
- data/lib/purecloud/models/conversation_notification_screen_share.rb +263 -0
- data/lib/purecloud/models/conversation_notification_screen_shares.rb +263 -0
- data/lib/purecloud/models/conversation_notification_self.rb +215 -0
- data/lib/purecloud/models/conversation_notification_social_expression.rb +303 -0
- data/lib/purecloud/models/conversation_notification_social_expressions.rb +303 -0
- data/lib/purecloud/models/conversation_notification_video.rb +302 -0
- data/lib/purecloud/models/conversation_notification_videos.rb +302 -0
- data/lib/purecloud/models/conversation_notification_wrapup.rb +217 -0
- data/lib/purecloud/models/create_callback_command.rb +1 -1
- data/lib/purecloud/models/create_share_request.rb +3 -0
- data/lib/purecloud/models/dialer_audit_request.rb +4 -0
- data/lib/purecloud/models/dialer_contact.rb +1 -1
- data/lib/purecloud/models/dialer_preview.rb +4 -0
- data/lib/purecloud/models/did_entity_listing.rb +13 -13
- data/lib/purecloud/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/disconnect_reason.rb +3 -0
- data/lib/purecloud/models/dnc_list.rb +2 -14
- data/lib/purecloud/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_entity_listing.rb +13 -13
- data/lib/purecloud/models/document_update.rb +1 -0
- data/lib/purecloud/models/document_upload.rb +2 -0
- data/lib/purecloud/models/domain_capabilities.rb +33 -4
- data/lib/purecloud/models/domain_edge_software_version_dto.rb +13 -13
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +257 -0
- data/lib/purecloud/models/domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloud/models/domain_logical_interface.rb +25 -41
- data/lib/purecloud/models/domain_network_address.rb +22 -0
- data/lib/purecloud/models/domain_network_route.rb +14 -0
- data/lib/purecloud/models/domain_organization_role_create.rb +266 -0
- data/lib/purecloud/models/edge.rb +21 -1
- data/lib/purecloud/models/edge_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloud/models/edge_logs_job_request.rb +3 -0
- data/lib/purecloud/models/edge_logs_job_upload_request.rb +1 -1
- data/lib/purecloud/models/edge_offline_configuration.rb +177 -0
- data/lib/purecloud/models/edge_offline_configuration_interface.rb +203 -0
- data/lib/purecloud/models/edge_offline_configuration_network.rb +166 -0
- data/lib/purecloud/models/edge_offline_configuration_response.rb +166 -0
- data/lib/purecloud/models/email.rb +28 -8
- data/lib/purecloud/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloud/models/email_conversation_notification.rb +199 -0
- data/lib/purecloud/models/email_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/email_conversation_notification_email_media_participant.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/email_conversation_notification_participants.rb +414 -0
- data/lib/purecloud/models/email_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/email_media_participant.rb +38 -5
- data/lib/purecloud/models/email_message_listing.rb +13 -13
- data/lib/purecloud/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloud/models/endpoint_entity_listing.rb +13 -13
- data/lib/purecloud/models/entry.rb +2 -0
- data/lib/purecloud/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluation_form.rb +3 -0
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_entity_listing.rb +13 -13
- data/lib/purecloud/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloud/models/facet_info.rb +2 -0
- data/lib/purecloud/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloud/models/fax_status.rb +8 -0
- data/lib/purecloud/models/group.rb +1 -0
- data/lib/purecloud/models/group_entity_listing.rb +13 -13
- data/lib/purecloud/models/group_members_update.rb +2 -0
- data/lib/purecloud/models/group_update.rb +286 -0
- data/lib/purecloud/models/heart_beat_alert.rb +299 -0
- data/lib/purecloud/models/heart_beat_alert_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_alert_notification.rb +268 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/heart_beat_alert_notification_notification_users.rb +175 -0
- data/lib/purecloud/models/heart_beat_rule.rb +282 -0
- data/lib/purecloud/models/heart_beat_rule_container.rb +257 -0
- data/lib/purecloud/models/heart_beat_rule_notification.rb +258 -0
- data/lib/purecloud/models/heart_beat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloud/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/interaction_stat_alert_notification.rb +364 -0
- data/lib/purecloud/models/interaction_stat_alert_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stat_rule_notification.rb +344 -0
- data/lib/purecloud/models/interaction_stat_rule_notification_notification_user.rb +175 -0
- data/lib/purecloud/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloud/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloud/models/json_node.rb +20 -20
- data/lib/purecloud/models/keyword.rb +41 -1
- data/lib/purecloud/models/keyword_set.rb +1 -0
- data/lib/purecloud/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/language.rb +1 -0
- data/lib/purecloud/models/language_entity_listing.rb +13 -13
- data/lib/purecloud/models/library.rb +1 -0
- data/lib/purecloud/models/library_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/line_entity_listing.rb +13 -13
- data/lib/purecloud/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/max_participants.rb +1 -0
- data/lib/purecloud/models/meta_data.rb +187 -0
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_presence.rb +1 -0
- data/lib/purecloud/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloud/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloud/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloud/models/out_of_office_notification.rb +205 -0
- data/lib/purecloud/models/out_of_office_notification_user.rb +165 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloud/models/participant.rb +61 -4
- data/lib/purecloud/models/participant_attributes.rb +1 -0
- data/lib/purecloud/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_entity_listing.rb +13 -13
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloud/models/phones_reboot.rb +2 -0
- data/lib/purecloud/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloud/models/policy_create.rb +285 -0
- data/lib/purecloud/models/policy_entity_listing.rb +13 -13
- data/lib/purecloud/models/quality_audit.rb +11 -11
- data/lib/purecloud/models/quality_audit_page.rb +13 -13
- data/lib/purecloud/models/queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/queue_member_entity_listing.rb +257 -0
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloud/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_entity_list.rb +13 -13
- data/lib/purecloud/models/response_entity_listing.rb +13 -13
- data/lib/purecloud/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/routing_skill.rb +1 -0
- data/lib/purecloud/models/routing_status.rb +3 -1
- data/lib/purecloud/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloud/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloud/models/screen_recording_session.rb +36 -4
- data/lib/purecloud/models/screen_recording_session_listing.rb +51 -1
- data/lib/purecloud/models/screen_recording_session_request.rb +197 -0
- data/lib/purecloud/models/screen_share_conversation_notification.rb +199 -0
- data/lib/purecloud/models/screen_share_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/screen_share_conversation_notification_participants.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_screen_share_media_participant.rb +424 -0
- data/lib/purecloud/models/screen_share_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/screenshare.rb +263 -0
- data/lib/purecloud/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloud/models/segment.rb +5 -2
- data/lib/purecloud/models/service_context.rb +1 -0
- data/lib/purecloud/models/share_entity_listing.rb +13 -13
- data/lib/purecloud/models/site.rb +1 -1
- data/lib/purecloud/models/site_entity_listing.rb +13 -13
- data/lib/purecloud/models/skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/social_conversation_notification.rb +199 -0
- data/lib/purecloud/models/social_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/social_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/social_conversation_notification_participants.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_social_media_participant.rb +434 -0
- data/lib/purecloud/models/social_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/social_expression.rb +14 -4
- data/lib/purecloud/models/station_entity_listing.rb +13 -13
- data/lib/purecloud/models/street_address.rb +1 -0
- data/lib/purecloud/models/subscriber_response.rb +2 -0
- data/lib/purecloud/models/tag_value.rb +1 -0
- data/lib/purecloud/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloud/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_conversation_summary_notification.rb +225 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_call_contact_center.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary.rb +175 -0
- data/lib/purecloud/models/user_conversation_summary_notification_media_summary_detail.rb +175 -0
- data/lib/purecloud/models/user_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_me.rb +14 -1
- data/lib/purecloud/models/user_presence_notification.rb +195 -0
- data/lib/purecloud/models/user_presence_notification_organization_presence.rb +175 -0
- data/lib/purecloud/models/user_presence_notification_presence_definition.rb +175 -0
- data/lib/purecloud/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloud/models/user_routing_skill_post.rb +200 -0
- data/lib/purecloud/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloud/models/users_entity_listing.rb +13 -13
- data/lib/purecloud/models/validate_address_request.rb +1 -1
- data/lib/purecloud/models/validate_address_response.rb +2 -0
- data/lib/purecloud/models/video.rb +11 -3
- data/lib/purecloud/models/video_conversation_notification.rb +199 -0
- data/lib/purecloud/models/video_conversation_notification_detail.rb +195 -0
- data/lib/purecloud/models/video_conversation_notification_error_body.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_error_info.rb +261 -0
- data/lib/purecloud/models/video_conversation_notification_participants.rb +463 -0
- data/lib/purecloud/models/video_conversation_notification_uri_reference.rb +175 -0
- data/lib/purecloud/models/video_conversation_notification_video_media_participant.rb +463 -0
- data/lib/purecloud/models/vm_pairing_info.rb +196 -0
- data/lib/purecloud/models/workspace_create.rb +1 -0
- data/lib/purecloud/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloud/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloud/models/wrapup.rb +7 -1
- data/lib/purecloud/models/wrapup_code.rb +1 -0
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +279 -2
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationFaxStatus
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationFaxStatus
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **expected_pages** | **Integer** | | [optional] |
|
|
11
|
+
| **direction** | **String** | | [optional] |
|
|
12
|
+
| **baud_rate** | **Integer** | | [optional] |
|
|
13
|
+
| **page_errors** | **Integer** | | [optional] |
|
|
14
|
+
| **bytes_transmitted** | **Integer** | | [optional] |
|
|
15
|
+
| **line_errors** | **Integer** | | [optional] |
|
|
16
|
+
| **lines_transmitted** | **Integer** | | [optional] |
|
|
17
|
+
| **active_page** | **Integer** | | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationParticipant
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationParticipant
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
12
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
13
|
+
| **user_id** | **String** | | [optional] |
|
|
14
|
+
| **external_contact_id** | **String** | | [optional] |
|
|
15
|
+
| **name** | **String** | | [optional] |
|
|
16
|
+
| **queue_id** | **String** | | [optional] |
|
|
17
|
+
| **group_id** | **String** | | [optional] |
|
|
18
|
+
| **purpose** | **String** | | [optional] |
|
|
19
|
+
| **consult_participant_id** | **String** | | [optional] |
|
|
20
|
+
| **address** | **String** | | [optional] |
|
|
21
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
22
|
+
| **wrapup_expected** | **BOOLEAN** | | [optional] |
|
|
23
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
|
24
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
25
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
26
|
+
| **monitored_participant_id** | **String** | | [optional] |
|
|
27
|
+
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
28
|
+
| **calls** | [**Array<ConversationNotificationCalls>**](ConversationNotificationCalls.html) | | [optional] |
|
|
29
|
+
| **callbacks** | [**Array<ConversationNotificationCallbacks>**](ConversationNotificationCallbacks.html) | | [optional] |
|
|
30
|
+
| **chats** | [**Array<ConversationNotificationChats>**](ConversationNotificationChats.html) | | [optional] |
|
|
31
|
+
| **cobrowsesessions** | [**Array<ConversationNotificationCobrowsesessions>**](ConversationNotificationCobrowsesessions.html) | | [optional] |
|
|
32
|
+
| **emails** | [**Array<ConversationNotificationEmails>**](ConversationNotificationEmails.html) | | [optional] |
|
|
33
|
+
| **screen_shares** | [**Array<ConversationNotificationScreenShares>**](ConversationNotificationScreenShares.html) | | [optional] |
|
|
34
|
+
| **social_expressions** | [**Array<ConversationNotificationSocialExpressions>**](ConversationNotificationSocialExpressions.html) | | [optional] |
|
|
35
|
+
| **videos** | [**Array<ConversationNotificationVideos>**](ConversationNotificationVideos.html) | | [optional] |
|
|
36
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
37
|
+
{: class="table table-striped"}
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationParticipants
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationParticipants
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **screen_shares** | [**Array<ConversationNotificationScreenShares>**](ConversationNotificationScreenShares.html) | | [optional] |
|
|
11
|
+
| **external_contact_id** | **String** | | [optional] |
|
|
12
|
+
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
13
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
14
|
+
| **queue_id** | **String** | | [optional] |
|
|
15
|
+
| **consult_participant_id** | **String** | | [optional] |
|
|
16
|
+
| **videos** | [**Array<ConversationNotificationVideos>**](ConversationNotificationVideos.html) | | [optional] |
|
|
17
|
+
| **wrapup_required** | **BOOLEAN** | | [optional] |
|
|
18
|
+
| **social_expressions** | [**Array<ConversationNotificationSocialExpressions>**](ConversationNotificationSocialExpressions.html) | | [optional] |
|
|
19
|
+
| **emails** | [**Array<ConversationNotificationEmails>**](ConversationNotificationEmails.html) | | [optional] |
|
|
20
|
+
| **purpose** | **String** | | [optional] |
|
|
21
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
22
|
+
| **calls** | [**Array<ConversationNotificationCalls>**](ConversationNotificationCalls.html) | | [optional] |
|
|
23
|
+
| **monitored_participant_id** | **String** | | [optional] |
|
|
24
|
+
| **wrapup_expected** | **BOOLEAN** | | [optional] |
|
|
25
|
+
| **id** | **String** | | [optional] |
|
|
26
|
+
| **group_id** | **String** | | [optional] |
|
|
27
|
+
| **wrapup_prompt** | **String** | | [optional] |
|
|
28
|
+
| **address** | **String** | | [optional] |
|
|
29
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
30
|
+
| **callbacks** | [**Array<ConversationNotificationCallbacks>**](ConversationNotificationCallbacks.html) | | [optional] |
|
|
31
|
+
| **user_id** | **String** | | [optional] |
|
|
32
|
+
| **name** | **String** | | [optional] |
|
|
33
|
+
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
34
|
+
| **attributes** | **Hash<String, String>** | | [optional] |
|
|
35
|
+
| **cobrowsesessions** | [**Array<ConversationNotificationCobrowsesessions>**](ConversationNotificationCobrowsesessions.html) | | [optional] |
|
|
36
|
+
| **chats** | [**Array<ConversationNotificationChats>**](ConversationNotificationChats.html) | | [optional] |
|
|
37
|
+
{: class="table table-striped"}
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationPhoneNumberColumn
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationPhoneNumberColumn
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **column_name** | **String** | | [optional] |
|
|
11
|
+
| **type** | **String** | | [optional] |
|
|
12
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationScreenShare
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationScreenShare
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **state** | **String** | | [optional] |
|
|
11
|
+
| **_self** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
12
|
+
| **id** | **String** | | [optional] |
|
|
13
|
+
| **context** | **String** | | [optional] |
|
|
14
|
+
| **sharing** | **BOOLEAN** | | [optional] |
|
|
15
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
16
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
17
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
18
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationScreenShares
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationScreenShares
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
12
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
13
|
+
| **sharing** | **BOOLEAN** | | [optional] |
|
|
14
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
| **context** | **String** | | [optional] |
|
|
17
|
+
| **state** | **String** | | [optional] |
|
|
18
|
+
| **_self** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationSelf
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationSelf
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **name_raw** | **String** | | [optional] |
|
|
11
|
+
| **address_displayable** | **String** | | [optional] |
|
|
12
|
+
| **address_raw** | **String** | | [optional] |
|
|
13
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
14
|
+
| **name** | **String** | | [optional] |
|
|
15
|
+
| **address_normalized** | **String** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationSocialExpression
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationSocialExpression
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **state** | **String** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
12
|
+
| **social_media_id** | **String** | | [optional] |
|
|
13
|
+
| **social_media_hub** | **String** | | [optional] |
|
|
14
|
+
| **social_user_name** | **String** | | [optional] |
|
|
15
|
+
| **preview_text** | **String** | | [optional] |
|
|
16
|
+
| **recording_id** | **String** | | [optional] |
|
|
17
|
+
| **held** | **BOOLEAN** | | [optional] |
|
|
18
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
19
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
|
20
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
22
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
23
|
+
{: class="table table-striped"}
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationSocialExpressions
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationSocialExpressions
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **held** | **BOOLEAN** | | [optional] |
|
|
11
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
12
|
+
| **social_media_id** | **String** | | [optional] |
|
|
13
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
14
|
+
| **social_user_name** | **String** | | [optional] |
|
|
15
|
+
| **state** | **String** | | [optional] |
|
|
16
|
+
| **social_media_hub** | **String** | | [optional] |
|
|
17
|
+
| **id** | **String** | | [optional] |
|
|
18
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
19
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
20
|
+
| **recording_id** | **String** | | [optional] |
|
|
21
|
+
| **start_hold_time** | **DateTime** | | [optional] |
|
|
22
|
+
| **preview_text** | **String** | | [optional] |
|
|
23
|
+
{: class="table table-striped"}
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationVideo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationVideo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **state** | **String** | | [optional] |
|
|
11
|
+
| **_self** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
12
|
+
| **id** | **String** | | [optional] |
|
|
13
|
+
| **context** | **String** | | [optional] |
|
|
14
|
+
| **audio_muted** | **BOOLEAN** | | [optional] |
|
|
15
|
+
| **video_muted** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **provider** | **String** | | [optional] |
|
|
18
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
19
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
20
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
21
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
22
|
+
{: class="table table-striped"}
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationVideos
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationVideos
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **disconnect_type** | **String** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
12
|
+
| **disconnected_time** | **DateTime** | | [optional] |
|
|
13
|
+
| **video_muted** | **BOOLEAN** | | [optional] |
|
|
14
|
+
| **connected_time** | **DateTime** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
| **audio_muted** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **context** | **String** | | [optional] |
|
|
18
|
+
| **state** | **String** | | [optional] |
|
|
19
|
+
| **provider** | **String** | | [optional] |
|
|
20
|
+
| **_self** | [**ConversationNotificationAddress**](ConversationNotificationAddress.html) | | [optional] |
|
|
21
|
+
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
|
22
|
+
{: class="table table-striped"}
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationWrapup
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationWrapup
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **tags** | **Array<String>** | | [optional] |
|
|
11
|
+
| **duration_seconds** | **Integer** | | [optional] |
|
|
12
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
13
|
+
| **code** | **String** | | [optional] |
|
|
14
|
+
| **end_time** | **DateTime** | | [optional] |
|
|
15
|
+
| **notes** | **String** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -25,6 +25,10 @@ Method | HTTP request | Description
|
|
|
25
25
|
|[**get_chats_chat_id**](ConversationsApi.html#get_chats_chat_id) | **GET** /api/v2/conversations/chats/{chatId} | Get chat conversation|
|
|
26
26
|
|[**get_chats_chat_id_participants_participant_id_wrapup**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
|
27
27
|
|[**get_chats_chat_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
|
28
|
+
|[**get_cobrowsesessions**](ConversationsApi.html#get_cobrowsesessions) | **GET** /api/v2/conversations/cobrowsesessions | Get recent cobrowse conversations|
|
|
29
|
+
|[**get_cobrowsesessions_cobrowse_id**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id) | **GET** /api/v2/conversations/cobrowsesessions/{cobrowseId} | Get cobrowse conversation|
|
|
30
|
+
|[**get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
|
31
|
+
|[**get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
|
28
32
|
|[**get_conversation_id**](ConversationsApi.html#get_conversation_id) | **GET** /api/v2/conversations/{conversationId} | Get conversation|
|
|
29
33
|
|[**get_conversation_id_participants_participant_id_wrapup**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|
|
30
34
|
|[**get_conversation_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|
|
@@ -41,7 +45,7 @@ Method | HTTP request | Description
|
|
|
41
45
|
|[**patch_callbacks_callback_id_participants_participant_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId} | Update conversation participant|
|
|
42
46
|
|[**patch_callbacks_callback_id_participants_participant_id_attributes**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
|
43
47
|
|[**patch_callbacks_callback_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
|
44
|
-
|[**patch_calls_call_id**](ConversationsApi.html#patch_calls_call_id) | **PATCH** /api/v2/conversations/calls/{callId} | Update a conversation by setting it's recording state or disconnecting all of the participants|
|
|
48
|
+
|[**patch_calls_call_id**](ConversationsApi.html#patch_calls_call_id) | **PATCH** /api/v2/conversations/calls/{callId} | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants|
|
|
45
49
|
|[**patch_calls_call_id_participants_participant_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId} | Update conversation participant|
|
|
46
50
|
|[**patch_calls_call_id_participants_participant_id_attributes**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
|
47
51
|
|[**patch_calls_call_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
|
@@ -50,6 +54,10 @@ Method | HTTP request | Description
|
|
|
50
54
|
|[**patch_chats_chat_id_participants_participant_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId} | Update conversation participant|
|
|
51
55
|
|[**patch_chats_chat_id_participants_participant_id_attributes**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
|
52
56
|
|[**patch_chats_chat_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
|
57
|
+
|[**patch_cobrowsesessions_cobrowse_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id) | **PATCH** /api/v2/conversations/cobrowsesessions/{cobrowseId} | Update a conversation by disconnecting all of the participants|
|
|
58
|
+
|[**patch_cobrowsesessions_cobrowse_id_participants_participant_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id) | **PATCH** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId} | Update conversation participant|
|
|
59
|
+
|[**patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
|
60
|
+
|[**patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id**](ConversationsApi.html#patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id) | **PATCH** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/communications/{communicationId} | Update conversation participant's communication by disconnecting it.|
|
|
53
61
|
|[**patch_conversation_id_participants_participant_id**](ConversationsApi.html#patch_conversation_id_participants_participant_id) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId} | Update a participant.|
|
|
54
62
|
|[**patch_conversation_id_participants_participant_id_attributes**](ConversationsApi.html#patch_conversation_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|
|
55
63
|
|[**patch_emails_email_id**](ConversationsApi.html#patch_emails_email_id) | **PATCH** /api/v2/conversations/emails/{emailId} | Update a conversation by disconnecting all of the participants|
|
|
@@ -64,6 +72,7 @@ Method | HTTP request | Description
|
|
|
64
72
|
|[**post_calls_call_id_participants_participant_id_monitor**](ConversationsApi.html#post_calls_call_id_participants_participant_id_monitor) | **POST** /api/v2/conversations/calls/{callId}/participants/{participantId}/monitor | Listen in on the conversation from the point of view of a given participant.|
|
|
65
73
|
|[**post_calls_call_id_participants_participant_id_replace**](ConversationsApi.html#post_calls_call_id_participants_participant_id_replace) | **POST** /api/v2/conversations/calls/{callId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
|
66
74
|
|[**post_chats_chat_id_participants_participant_id_replace**](ConversationsApi.html#post_chats_chat_id_participants_participant_id_replace) | **POST** /api/v2/conversations/chats/{chatId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
|
75
|
+
|[**post_cobrowsesessions_cobrowse_id_participants_participant_id_replace**](ConversationsApi.html#post_cobrowsesessions_cobrowse_id_participants_participant_id_replace) | **POST** /api/v2/conversations/cobrowsesessions/{cobrowseId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
|
67
76
|
|[**post_conversation_id_participants_participant_id_callbacks**](ConversationsApi.html#post_conversation_id_participants_participant_id_callbacks) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks | Create a new callback for the specified participant on the conversation.|
|
|
68
77
|
|[**post_conversation_id_participants_participant_id_replace**](ConversationsApi.html#post_conversation_id_participants_participant_id_replace) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|
|
69
78
|
|[**post_conversations_aggregates_query**](ConversationsApi.html#post_conversations_aggregates_query) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates|
|
|
@@ -100,9 +109,9 @@ end
|
|
|
100
109
|
|
|
101
110
|
api_instance = PureCloud::ConversationsApi.new
|
|
102
111
|
|
|
103
|
-
call_id = "call_id_example" # String |
|
|
112
|
+
call_id = "call_id_example" # String | callId
|
|
104
113
|
|
|
105
|
-
participant_id = "participant_id_example" # String |
|
|
114
|
+
participant_id = "participant_id_example" # String | participantId
|
|
106
115
|
|
|
107
116
|
|
|
108
117
|
begin
|
|
@@ -118,8 +127,8 @@ end
|
|
|
118
127
|
|
|
119
128
|
Name | Type | Description | Notes
|
|
120
129
|
------------- | ------------- | ------------- | -------------
|
|
121
|
-
**call_id** | **String**|
|
|
122
|
-
**participant_id** | **String**|
|
|
130
|
+
**call_id** | **String**| callId |
|
|
131
|
+
**participant_id** | **String**| participantId |
|
|
123
132
|
{: class="table table-striped"}
|
|
124
133
|
|
|
125
134
|
|
|
@@ -220,9 +229,9 @@ end
|
|
|
220
229
|
|
|
221
230
|
api_instance = PureCloud::ConversationsApi.new
|
|
222
231
|
|
|
223
|
-
email_id = "email_id_example" # String |
|
|
232
|
+
email_id = "email_id_example" # String | emailId
|
|
224
233
|
|
|
225
|
-
attachment_id = "attachment_id_example" # String |
|
|
234
|
+
attachment_id = "attachment_id_example" # String | attachmentId
|
|
226
235
|
|
|
227
236
|
|
|
228
237
|
begin
|
|
@@ -238,8 +247,8 @@ end
|
|
|
238
247
|
|
|
239
248
|
Name | Type | Description | Notes
|
|
240
249
|
------------- | ------------- | ------------- | -------------
|
|
241
|
-
**email_id** | **String**|
|
|
242
|
-
**attachment_id** | **String**|
|
|
250
|
+
**email_id** | **String**| emailId |
|
|
251
|
+
**attachment_id** | **String**| attachmentId |
|
|
243
252
|
{: class="table table-striped"}
|
|
244
253
|
|
|
245
254
|
|
|
@@ -329,7 +338,7 @@ end
|
|
|
329
338
|
|
|
330
339
|
api_instance = PureCloud::ConversationsApi.new
|
|
331
340
|
|
|
332
|
-
callback_id = "callback_id_example" # String |
|
|
341
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
333
342
|
|
|
334
343
|
|
|
335
344
|
begin
|
|
@@ -345,7 +354,7 @@ end
|
|
|
345
354
|
|
|
346
355
|
Name | Type | Description | Notes
|
|
347
356
|
------------- | ------------- | ------------- | -------------
|
|
348
|
-
**callback_id** | **String**|
|
|
357
|
+
**callback_id** | **String**| callbackId |
|
|
349
358
|
{: class="table table-striped"}
|
|
350
359
|
|
|
351
360
|
|
|
@@ -385,9 +394,9 @@ end
|
|
|
385
394
|
|
|
386
395
|
api_instance = PureCloud::ConversationsApi.new
|
|
387
396
|
|
|
388
|
-
callback_id = "callback_id_example" # String |
|
|
397
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
389
398
|
|
|
390
|
-
participant_id = "participant_id_example" # String |
|
|
399
|
+
participant_id = "participant_id_example" # String | participantId
|
|
391
400
|
|
|
392
401
|
opts = {
|
|
393
402
|
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
@@ -406,8 +415,8 @@ end
|
|
|
406
415
|
|
|
407
416
|
Name | Type | Description | Notes
|
|
408
417
|
------------- | ------------- | ------------- | -------------
|
|
409
|
-
**callback_id** | **String**|
|
|
410
|
-
**participant_id** | **String**|
|
|
418
|
+
**callback_id** | **String**| callbackId |
|
|
419
|
+
**participant_id** | **String**| participantId |
|
|
411
420
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
412
421
|
{: class="table table-striped"}
|
|
413
422
|
|
|
@@ -425,7 +434,7 @@ Name | Type | Description | Notes
|
|
|
425
434
|
|
|
426
435
|
<a name="get_callbacks_callback_id_participants_participant_id_wrapupcodes"></a>
|
|
427
436
|
|
|
428
|
-
## -[**WrapupCode
|
|
437
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_callbacks_callback_id_participants_participant_id_wrapupcodes(callback_id, participant_id)
|
|
429
438
|
|
|
430
439
|
Get list of wrapup codes for this conversation participant
|
|
431
440
|
|
|
@@ -448,9 +457,9 @@ end
|
|
|
448
457
|
|
|
449
458
|
api_instance = PureCloud::ConversationsApi.new
|
|
450
459
|
|
|
451
|
-
callback_id = "callback_id_example" # String |
|
|
460
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
452
461
|
|
|
453
|
-
participant_id = "participant_id_example" # String |
|
|
462
|
+
participant_id = "participant_id_example" # String | participantId
|
|
454
463
|
|
|
455
464
|
|
|
456
465
|
begin
|
|
@@ -466,14 +475,14 @@ end
|
|
|
466
475
|
|
|
467
476
|
Name | Type | Description | Notes
|
|
468
477
|
------------- | ------------- | ------------- | -------------
|
|
469
|
-
**callback_id** | **String**|
|
|
470
|
-
**participant_id** | **String**|
|
|
478
|
+
**callback_id** | **String**| callbackId |
|
|
479
|
+
**participant_id** | **String**| participantId |
|
|
471
480
|
{: class="table table-striped"}
|
|
472
481
|
|
|
473
482
|
|
|
474
483
|
### Return type
|
|
475
484
|
|
|
476
|
-
[**WrapupCode
|
|
485
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
477
486
|
|
|
478
487
|
### HTTP request headers
|
|
479
488
|
|
|
@@ -557,7 +566,7 @@ end
|
|
|
557
566
|
|
|
558
567
|
api_instance = PureCloud::ConversationsApi.new
|
|
559
568
|
|
|
560
|
-
call_id = "call_id_example" # String |
|
|
569
|
+
call_id = "call_id_example" # String | callId
|
|
561
570
|
|
|
562
571
|
|
|
563
572
|
begin
|
|
@@ -573,7 +582,7 @@ end
|
|
|
573
582
|
|
|
574
583
|
Name | Type | Description | Notes
|
|
575
584
|
------------- | ------------- | ------------- | -------------
|
|
576
|
-
**call_id** | **String**|
|
|
585
|
+
**call_id** | **String**| callId |
|
|
577
586
|
{: class="table table-striped"}
|
|
578
587
|
|
|
579
588
|
|
|
@@ -613,9 +622,9 @@ end
|
|
|
613
622
|
|
|
614
623
|
api_instance = PureCloud::ConversationsApi.new
|
|
615
624
|
|
|
616
|
-
call_id = "call_id_example" # String |
|
|
625
|
+
call_id = "call_id_example" # String | callId
|
|
617
626
|
|
|
618
|
-
participant_id = "participant_id_example" # String |
|
|
627
|
+
participant_id = "participant_id_example" # String | participantId
|
|
619
628
|
|
|
620
629
|
opts = {
|
|
621
630
|
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
@@ -634,8 +643,8 @@ end
|
|
|
634
643
|
|
|
635
644
|
Name | Type | Description | Notes
|
|
636
645
|
------------- | ------------- | ------------- | -------------
|
|
637
|
-
**call_id** | **String**|
|
|
638
|
-
**participant_id** | **String**|
|
|
646
|
+
**call_id** | **String**| callId |
|
|
647
|
+
**participant_id** | **String**| participantId |
|
|
639
648
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
640
649
|
{: class="table table-striped"}
|
|
641
650
|
|
|
@@ -653,7 +662,7 @@ Name | Type | Description | Notes
|
|
|
653
662
|
|
|
654
663
|
<a name="get_calls_call_id_participants_participant_id_wrapupcodes"></a>
|
|
655
664
|
|
|
656
|
-
## -[**WrapupCode
|
|
665
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_calls_call_id_participants_participant_id_wrapupcodes(call_id, participant_id)
|
|
657
666
|
|
|
658
667
|
Get list of wrapup codes for this conversation participant
|
|
659
668
|
|
|
@@ -676,9 +685,9 @@ end
|
|
|
676
685
|
|
|
677
686
|
api_instance = PureCloud::ConversationsApi.new
|
|
678
687
|
|
|
679
|
-
call_id = "call_id_example" # String |
|
|
688
|
+
call_id = "call_id_example" # String | callId
|
|
680
689
|
|
|
681
|
-
participant_id = "participant_id_example" # String |
|
|
690
|
+
participant_id = "participant_id_example" # String | participantId
|
|
682
691
|
|
|
683
692
|
|
|
684
693
|
begin
|
|
@@ -694,14 +703,14 @@ end
|
|
|
694
703
|
|
|
695
704
|
Name | Type | Description | Notes
|
|
696
705
|
------------- | ------------- | ------------- | -------------
|
|
697
|
-
**call_id** | **String**|
|
|
698
|
-
**participant_id** | **String**|
|
|
706
|
+
**call_id** | **String**| callId |
|
|
707
|
+
**participant_id** | **String**| participantId |
|
|
699
708
|
{: class="table table-striped"}
|
|
700
709
|
|
|
701
710
|
|
|
702
711
|
### Return type
|
|
703
712
|
|
|
704
|
-
[**WrapupCode
|
|
713
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
705
714
|
|
|
706
715
|
### HTTP request headers
|
|
707
716
|
|
|
@@ -896,7 +905,7 @@ end
|
|
|
896
905
|
|
|
897
906
|
api_instance = PureCloud::ConversationsApi.new
|
|
898
907
|
|
|
899
|
-
chat_id = "chat_id_example" # String |
|
|
908
|
+
chat_id = "chat_id_example" # String | chatId
|
|
900
909
|
|
|
901
910
|
|
|
902
911
|
begin
|
|
@@ -912,7 +921,7 @@ end
|
|
|
912
921
|
|
|
913
922
|
Name | Type | Description | Notes
|
|
914
923
|
------------- | ------------- | ------------- | -------------
|
|
915
|
-
**chat_id** | **String**|
|
|
924
|
+
**chat_id** | **String**| chatId |
|
|
916
925
|
{: class="table table-striped"}
|
|
917
926
|
|
|
918
927
|
|
|
@@ -952,9 +961,9 @@ end
|
|
|
952
961
|
|
|
953
962
|
api_instance = PureCloud::ConversationsApi.new
|
|
954
963
|
|
|
955
|
-
chat_id = "chat_id_example" # String |
|
|
964
|
+
chat_id = "chat_id_example" # String | chatId
|
|
956
965
|
|
|
957
|
-
participant_id = "participant_id_example" # String |
|
|
966
|
+
participant_id = "participant_id_example" # String | participantId
|
|
958
967
|
|
|
959
968
|
opts = {
|
|
960
969
|
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
@@ -973,8 +982,8 @@ end
|
|
|
973
982
|
|
|
974
983
|
Name | Type | Description | Notes
|
|
975
984
|
------------- | ------------- | ------------- | -------------
|
|
976
|
-
**chat_id** | **String**|
|
|
977
|
-
**participant_id** | **String**|
|
|
985
|
+
**chat_id** | **String**| chatId |
|
|
986
|
+
**participant_id** | **String**| participantId |
|
|
978
987
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
979
988
|
{: class="table table-striped"}
|
|
980
989
|
|
|
@@ -992,7 +1001,7 @@ Name | Type | Description | Notes
|
|
|
992
1001
|
|
|
993
1002
|
<a name="get_chats_chat_id_participants_participant_id_wrapupcodes"></a>
|
|
994
1003
|
|
|
995
|
-
## -[**WrapupCode
|
|
1004
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_chats_chat_id_participants_participant_id_wrapupcodes(chat_id, participant_id)
|
|
996
1005
|
|
|
997
1006
|
Get list of wrapup codes for this conversation participant
|
|
998
1007
|
|
|
@@ -1015,9 +1024,9 @@ end
|
|
|
1015
1024
|
|
|
1016
1025
|
api_instance = PureCloud::ConversationsApi.new
|
|
1017
1026
|
|
|
1018
|
-
chat_id = "chat_id_example" # String |
|
|
1027
|
+
chat_id = "chat_id_example" # String | chatId
|
|
1019
1028
|
|
|
1020
|
-
participant_id = "participant_id_example" # String |
|
|
1029
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1021
1030
|
|
|
1022
1031
|
|
|
1023
1032
|
begin
|
|
@@ -1033,14 +1042,242 @@ end
|
|
|
1033
1042
|
|
|
1034
1043
|
Name | Type | Description | Notes
|
|
1035
1044
|
------------- | ------------- | ------------- | -------------
|
|
1036
|
-
**chat_id** | **String**|
|
|
1037
|
-
**participant_id** | **String**|
|
|
1045
|
+
**chat_id** | **String**| chatId |
|
|
1046
|
+
**participant_id** | **String**| participantId |
|
|
1038
1047
|
{: class="table table-striped"}
|
|
1039
1048
|
|
|
1040
1049
|
|
|
1041
1050
|
### Return type
|
|
1042
1051
|
|
|
1043
|
-
[**WrapupCode
|
|
1052
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1053
|
+
|
|
1054
|
+
### HTTP request headers
|
|
1055
|
+
|
|
1056
|
+
- **Content-Type**: application/json
|
|
1057
|
+
- **Accept**: application/json
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
<a name="get_cobrowsesessions"></a>
|
|
1062
|
+
|
|
1063
|
+
## -[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_cobrowsesessions
|
|
1064
|
+
|
|
1065
|
+
Get recent cobrowse conversations
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
### Example
|
|
1070
|
+
~~~ruby
|
|
1071
|
+
# load the gem
|
|
1072
|
+
require 'purecloud'
|
|
1073
|
+
# setup authorization
|
|
1074
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1075
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1076
|
+
environment = "mypurecloud.com"
|
|
1077
|
+
|
|
1078
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1079
|
+
|
|
1080
|
+
PureCloud.configure do |config|
|
|
1081
|
+
config.access_token = @authToken
|
|
1082
|
+
end
|
|
1083
|
+
|
|
1084
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1085
|
+
|
|
1086
|
+
begin
|
|
1087
|
+
#Get recent cobrowse conversations
|
|
1088
|
+
result = api_instance.get_cobrowsesessions
|
|
1089
|
+
p result
|
|
1090
|
+
rescue PureCloud::ApiError => e
|
|
1091
|
+
puts "Exception when calling ConversationsApi->get_cobrowsesessions: #{e}"
|
|
1092
|
+
end
|
|
1093
|
+
~~~
|
|
1094
|
+
|
|
1095
|
+
### Parameters
|
|
1096
|
+
This endpoint does not need any parameter.
|
|
1097
|
+
{: class="table table-striped"}
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
### Return type
|
|
1101
|
+
|
|
1102
|
+
[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html)
|
|
1103
|
+
|
|
1104
|
+
### HTTP request headers
|
|
1105
|
+
|
|
1106
|
+
- **Content-Type**: application/json
|
|
1107
|
+
- **Accept**: application/json
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<a name="get_cobrowsesessions_cobrowse_id"></a>
|
|
1112
|
+
|
|
1113
|
+
## -[**CobrowseConversation**](CobrowseConversation.html) get_cobrowsesessions_cobrowse_id(cobrowse_id)
|
|
1114
|
+
|
|
1115
|
+
Get cobrowse conversation
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
### Example
|
|
1120
|
+
~~~ruby
|
|
1121
|
+
# load the gem
|
|
1122
|
+
require 'purecloud'
|
|
1123
|
+
# setup authorization
|
|
1124
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1125
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1126
|
+
environment = "mypurecloud.com"
|
|
1127
|
+
|
|
1128
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1129
|
+
|
|
1130
|
+
PureCloud.configure do |config|
|
|
1131
|
+
config.access_token = @authToken
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1134
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1135
|
+
|
|
1136
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
begin
|
|
1140
|
+
#Get cobrowse conversation
|
|
1141
|
+
result = api_instance.get_cobrowsesessions_cobrowse_id(cobrowse_id)
|
|
1142
|
+
p result
|
|
1143
|
+
rescue PureCloud::ApiError => e
|
|
1144
|
+
puts "Exception when calling ConversationsApi->get_cobrowsesessions_cobrowse_id: #{e}"
|
|
1145
|
+
end
|
|
1146
|
+
~~~
|
|
1147
|
+
|
|
1148
|
+
### Parameters
|
|
1149
|
+
|
|
1150
|
+
Name | Type | Description | Notes
|
|
1151
|
+
------------- | ------------- | ------------- | -------------
|
|
1152
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1153
|
+
{: class="table table-striped"}
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
### Return type
|
|
1157
|
+
|
|
1158
|
+
[**CobrowseConversation**](CobrowseConversation.html)
|
|
1159
|
+
|
|
1160
|
+
### HTTP request headers
|
|
1161
|
+
|
|
1162
|
+
- **Content-Type**: application/json
|
|
1163
|
+
- **Accept**: application/json
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
<a name="get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup"></a>
|
|
1168
|
+
|
|
1169
|
+
## -[**Wrapup**](Wrapup.html) get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup(cobrowse_id, participant_id, opts)
|
|
1170
|
+
|
|
1171
|
+
Get the wrap-up for this conversation participant.
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
### Example
|
|
1176
|
+
~~~ruby
|
|
1177
|
+
# load the gem
|
|
1178
|
+
require 'purecloud'
|
|
1179
|
+
# setup authorization
|
|
1180
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1181
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1182
|
+
environment = "mypurecloud.com"
|
|
1183
|
+
|
|
1184
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1185
|
+
|
|
1186
|
+
PureCloud.configure do |config|
|
|
1187
|
+
config.access_token = @authToken
|
|
1188
|
+
end
|
|
1189
|
+
|
|
1190
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1191
|
+
|
|
1192
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1193
|
+
|
|
1194
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1195
|
+
|
|
1196
|
+
opts = {
|
|
1197
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
begin
|
|
1201
|
+
#Get the wrap-up for this conversation participant.
|
|
1202
|
+
result = api_instance.get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup(cobrowse_id, participant_id, opts)
|
|
1203
|
+
p result
|
|
1204
|
+
rescue PureCloud::ApiError => e
|
|
1205
|
+
puts "Exception when calling ConversationsApi->get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapup: #{e}"
|
|
1206
|
+
end
|
|
1207
|
+
~~~
|
|
1208
|
+
|
|
1209
|
+
### Parameters
|
|
1210
|
+
|
|
1211
|
+
Name | Type | Description | Notes
|
|
1212
|
+
------------- | ------------- | ------------- | -------------
|
|
1213
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1214
|
+
**participant_id** | **String**| participantId |
|
|
1215
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1216
|
+
{: class="table table-striped"}
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
### Return type
|
|
1220
|
+
|
|
1221
|
+
[**Wrapup**](Wrapup.html)
|
|
1222
|
+
|
|
1223
|
+
### HTTP request headers
|
|
1224
|
+
|
|
1225
|
+
- **Content-Type**: application/json
|
|
1226
|
+
- **Accept**: application/json
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
<a name="get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes"></a>
|
|
1231
|
+
|
|
1232
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes(cobrowse_id, participant_id)
|
|
1233
|
+
|
|
1234
|
+
Get list of wrapup codes for this conversation participant
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
### Example
|
|
1239
|
+
~~~ruby
|
|
1240
|
+
# load the gem
|
|
1241
|
+
require 'purecloud'
|
|
1242
|
+
# setup authorization
|
|
1243
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1244
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1245
|
+
environment = "mypurecloud.com"
|
|
1246
|
+
|
|
1247
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1248
|
+
|
|
1249
|
+
PureCloud.configure do |config|
|
|
1250
|
+
config.access_token = @authToken
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1254
|
+
|
|
1255
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
1256
|
+
|
|
1257
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
begin
|
|
1261
|
+
#Get list of wrapup codes for this conversation participant
|
|
1262
|
+
result = api_instance.get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes(cobrowse_id, participant_id)
|
|
1263
|
+
p result
|
|
1264
|
+
rescue PureCloud::ApiError => e
|
|
1265
|
+
puts "Exception when calling ConversationsApi->get_cobrowsesessions_cobrowse_id_participants_participant_id_wrapupcodes: #{e}"
|
|
1266
|
+
end
|
|
1267
|
+
~~~
|
|
1268
|
+
|
|
1269
|
+
### Parameters
|
|
1270
|
+
|
|
1271
|
+
Name | Type | Description | Notes
|
|
1272
|
+
------------- | ------------- | ------------- | -------------
|
|
1273
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
1274
|
+
**participant_id** | **String**| participantId |
|
|
1275
|
+
{: class="table table-striped"}
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
### Return type
|
|
1279
|
+
|
|
1280
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1044
1281
|
|
|
1045
1282
|
### HTTP request headers
|
|
1046
1283
|
|
|
@@ -1415,7 +1652,7 @@ end
|
|
|
1415
1652
|
|
|
1416
1653
|
api_instance = PureCloud::ConversationsApi.new
|
|
1417
1654
|
|
|
1418
|
-
email_id = "email_id_example" # String |
|
|
1655
|
+
email_id = "email_id_example" # String | emailId
|
|
1419
1656
|
|
|
1420
1657
|
|
|
1421
1658
|
begin
|
|
@@ -1431,7 +1668,7 @@ end
|
|
|
1431
1668
|
|
|
1432
1669
|
Name | Type | Description | Notes
|
|
1433
1670
|
------------- | ------------- | ------------- | -------------
|
|
1434
|
-
**email_id** | **String**|
|
|
1671
|
+
**email_id** | **String**| emailId |
|
|
1435
1672
|
{: class="table table-striped"}
|
|
1436
1673
|
|
|
1437
1674
|
|
|
@@ -1471,7 +1708,7 @@ end
|
|
|
1471
1708
|
|
|
1472
1709
|
api_instance = PureCloud::ConversationsApi.new
|
|
1473
1710
|
|
|
1474
|
-
email_id = "email_id_example" # String |
|
|
1711
|
+
email_id = "email_id_example" # String | emailId
|
|
1475
1712
|
|
|
1476
1713
|
|
|
1477
1714
|
begin
|
|
@@ -1487,7 +1724,7 @@ end
|
|
|
1487
1724
|
|
|
1488
1725
|
Name | Type | Description | Notes
|
|
1489
1726
|
------------- | ------------- | ------------- | -------------
|
|
1490
|
-
**email_id** | **String**|
|
|
1727
|
+
**email_id** | **String**| emailId |
|
|
1491
1728
|
{: class="table table-striped"}
|
|
1492
1729
|
|
|
1493
1730
|
|
|
@@ -1527,7 +1764,7 @@ end
|
|
|
1527
1764
|
|
|
1528
1765
|
api_instance = PureCloud::ConversationsApi.new
|
|
1529
1766
|
|
|
1530
|
-
email_id = "email_id_example" # String |
|
|
1767
|
+
email_id = "email_id_example" # String | emailId
|
|
1531
1768
|
|
|
1532
1769
|
|
|
1533
1770
|
begin
|
|
@@ -1543,7 +1780,7 @@ end
|
|
|
1543
1780
|
|
|
1544
1781
|
Name | Type | Description | Notes
|
|
1545
1782
|
------------- | ------------- | ------------- | -------------
|
|
1546
|
-
**email_id** | **String**|
|
|
1783
|
+
**email_id** | **String**| emailId |
|
|
1547
1784
|
{: class="table table-striped"}
|
|
1548
1785
|
|
|
1549
1786
|
|
|
@@ -1583,9 +1820,9 @@ end
|
|
|
1583
1820
|
|
|
1584
1821
|
api_instance = PureCloud::ConversationsApi.new
|
|
1585
1822
|
|
|
1586
|
-
email_id = "email_id_example" # String |
|
|
1823
|
+
email_id = "email_id_example" # String | emailId
|
|
1587
1824
|
|
|
1588
|
-
message_id = "message_id_example" # String |
|
|
1825
|
+
message_id = "message_id_example" # String | messageId
|
|
1589
1826
|
|
|
1590
1827
|
|
|
1591
1828
|
begin
|
|
@@ -1601,8 +1838,8 @@ end
|
|
|
1601
1838
|
|
|
1602
1839
|
Name | Type | Description | Notes
|
|
1603
1840
|
------------- | ------------- | ------------- | -------------
|
|
1604
|
-
**email_id** | **String**|
|
|
1605
|
-
**message_id** | **String**|
|
|
1841
|
+
**email_id** | **String**| emailId |
|
|
1842
|
+
**message_id** | **String**| messageId |
|
|
1606
1843
|
{: class="table table-striped"}
|
|
1607
1844
|
|
|
1608
1845
|
|
|
@@ -1642,9 +1879,9 @@ end
|
|
|
1642
1879
|
|
|
1643
1880
|
api_instance = PureCloud::ConversationsApi.new
|
|
1644
1881
|
|
|
1645
|
-
email_id = "email_id_example" # String |
|
|
1882
|
+
email_id = "email_id_example" # String | emailId
|
|
1646
1883
|
|
|
1647
|
-
participant_id = "participant_id_example" # String |
|
|
1884
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1648
1885
|
|
|
1649
1886
|
opts = {
|
|
1650
1887
|
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
@@ -1663,8 +1900,8 @@ end
|
|
|
1663
1900
|
|
|
1664
1901
|
Name | Type | Description | Notes
|
|
1665
1902
|
------------- | ------------- | ------------- | -------------
|
|
1666
|
-
**email_id** | **String**|
|
|
1667
|
-
**participant_id** | **String**|
|
|
1903
|
+
**email_id** | **String**| emailId |
|
|
1904
|
+
**participant_id** | **String**| participantId |
|
|
1668
1905
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
|
|
1669
1906
|
{: class="table table-striped"}
|
|
1670
1907
|
|
|
@@ -1682,7 +1919,7 @@ Name | Type | Description | Notes
|
|
|
1682
1919
|
|
|
1683
1920
|
<a name="get_emails_email_id_participants_participant_id_wrapupcodes"></a>
|
|
1684
1921
|
|
|
1685
|
-
## -[**WrapupCode
|
|
1922
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_emails_email_id_participants_participant_id_wrapupcodes(email_id, participant_id)
|
|
1686
1923
|
|
|
1687
1924
|
Get list of wrapup codes for this conversation participant
|
|
1688
1925
|
|
|
@@ -1705,9 +1942,9 @@ end
|
|
|
1705
1942
|
|
|
1706
1943
|
api_instance = PureCloud::ConversationsApi.new
|
|
1707
1944
|
|
|
1708
|
-
email_id = "email_id_example" # String |
|
|
1945
|
+
email_id = "email_id_example" # String | emailId
|
|
1709
1946
|
|
|
1710
|
-
participant_id = "participant_id_example" # String |
|
|
1947
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1711
1948
|
|
|
1712
1949
|
|
|
1713
1950
|
begin
|
|
@@ -1723,14 +1960,14 @@ end
|
|
|
1723
1960
|
|
|
1724
1961
|
Name | Type | Description | Notes
|
|
1725
1962
|
------------- | ------------- | ------------- | -------------
|
|
1726
|
-
**email_id** | **String**|
|
|
1727
|
-
**participant_id** | **String**|
|
|
1963
|
+
**email_id** | **String**| emailId |
|
|
1964
|
+
**participant_id** | **String**| participantId |
|
|
1728
1965
|
{: class="table table-striped"}
|
|
1729
1966
|
|
|
1730
1967
|
|
|
1731
1968
|
### Return type
|
|
1732
1969
|
|
|
1733
|
-
[**WrapupCode
|
|
1970
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1734
1971
|
|
|
1735
1972
|
### HTTP request headers
|
|
1736
1973
|
|
|
@@ -1764,7 +2001,7 @@ end
|
|
|
1764
2001
|
|
|
1765
2002
|
api_instance = PureCloud::ConversationsApi.new
|
|
1766
2003
|
|
|
1767
|
-
callback_id = "callback_id_example" # String |
|
|
2004
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
1768
2005
|
|
|
1769
2006
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
1770
2007
|
|
|
@@ -1782,7 +2019,7 @@ end
|
|
|
1782
2019
|
|
|
1783
2020
|
Name | Type | Description | Notes
|
|
1784
2021
|
------------- | ------------- | ------------- | -------------
|
|
1785
|
-
**callback_id** | **String**|
|
|
2022
|
+
**callback_id** | **String**| callbackId |
|
|
1786
2023
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
1787
2024
|
{: class="table table-striped"}
|
|
1788
2025
|
|
|
@@ -1823,9 +2060,9 @@ end
|
|
|
1823
2060
|
|
|
1824
2061
|
api_instance = PureCloud::ConversationsApi.new
|
|
1825
2062
|
|
|
1826
|
-
callback_id = "callback_id_example" # String |
|
|
2063
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
1827
2064
|
|
|
1828
|
-
participant_id = "participant_id_example" # String |
|
|
2065
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1829
2066
|
|
|
1830
2067
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
1831
2068
|
|
|
@@ -1842,8 +2079,8 @@ end
|
|
|
1842
2079
|
|
|
1843
2080
|
Name | Type | Description | Notes
|
|
1844
2081
|
------------- | ------------- | ------------- | -------------
|
|
1845
|
-
**callback_id** | **String**|
|
|
1846
|
-
**participant_id** | **String**|
|
|
2082
|
+
**callback_id** | **String**| callbackId |
|
|
2083
|
+
**participant_id** | **String**| participantId |
|
|
1847
2084
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
1848
2085
|
{: class="table table-striped"}
|
|
1849
2086
|
|
|
@@ -1884,9 +2121,9 @@ end
|
|
|
1884
2121
|
|
|
1885
2122
|
api_instance = PureCloud::ConversationsApi.new
|
|
1886
2123
|
|
|
1887
|
-
callback_id = "callback_id_example" # String |
|
|
2124
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
1888
2125
|
|
|
1889
|
-
participant_id = "participant_id_example" # String |
|
|
2126
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1890
2127
|
|
|
1891
2128
|
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Attributes
|
|
1892
2129
|
|
|
@@ -1903,8 +2140,8 @@ end
|
|
|
1903
2140
|
|
|
1904
2141
|
Name | Type | Description | Notes
|
|
1905
2142
|
------------- | ------------- | ------------- | -------------
|
|
1906
|
-
**callback_id** | **String**|
|
|
1907
|
-
**participant_id** | **String**|
|
|
2143
|
+
**callback_id** | **String**| callbackId |
|
|
2144
|
+
**participant_id** | **String**| participantId |
|
|
1908
2145
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Attributes |
|
|
1909
2146
|
{: class="table table-striped"}
|
|
1910
2147
|
|
|
@@ -1945,11 +2182,11 @@ end
|
|
|
1945
2182
|
|
|
1946
2183
|
api_instance = PureCloud::ConversationsApi.new
|
|
1947
2184
|
|
|
1948
|
-
callback_id = "callback_id_example" # String |
|
|
2185
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
1949
2186
|
|
|
1950
|
-
participant_id = "participant_id_example" # String |
|
|
2187
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1951
2188
|
|
|
1952
|
-
communication_id = "communication_id_example" # String |
|
|
2189
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
1953
2190
|
|
|
1954
2191
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
1955
2192
|
|
|
@@ -1966,9 +2203,9 @@ end
|
|
|
1966
2203
|
|
|
1967
2204
|
Name | Type | Description | Notes
|
|
1968
2205
|
------------- | ------------- | ------------- | -------------
|
|
1969
|
-
**callback_id** | **String**|
|
|
1970
|
-
**participant_id** | **String**|
|
|
1971
|
-
**communication_id** | **String**|
|
|
2206
|
+
**callback_id** | **String**| callbackId |
|
|
2207
|
+
**participant_id** | **String**| participantId |
|
|
2208
|
+
**communication_id** | **String**| communicationId |
|
|
1972
2209
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
1973
2210
|
{: class="table table-striped"}
|
|
1974
2211
|
|
|
@@ -1988,7 +2225,7 @@ nil (empty response body)
|
|
|
1988
2225
|
|
|
1989
2226
|
## -[**Conversation**](Conversation.html) patch_calls_call_id(call_id, body)
|
|
1990
2227
|
|
|
1991
|
-
Update a conversation by setting it's recording state or disconnecting all of the participants
|
|
2228
|
+
Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
1992
2229
|
|
|
1993
2230
|
|
|
1994
2231
|
|
|
@@ -2009,13 +2246,13 @@ end
|
|
|
2009
2246
|
|
|
2010
2247
|
api_instance = PureCloud::ConversationsApi.new
|
|
2011
2248
|
|
|
2012
|
-
call_id = "call_id_example" # String |
|
|
2249
|
+
call_id = "call_id_example" # String | callId
|
|
2013
2250
|
|
|
2014
2251
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2015
2252
|
|
|
2016
2253
|
|
|
2017
2254
|
begin
|
|
2018
|
-
#Update a conversation by setting it's recording state or disconnecting all of the participants
|
|
2255
|
+
#Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2019
2256
|
result = api_instance.patch_calls_call_id(call_id, body)
|
|
2020
2257
|
p result
|
|
2021
2258
|
rescue PureCloud::ApiError => e
|
|
@@ -2027,7 +2264,7 @@ end
|
|
|
2027
2264
|
|
|
2028
2265
|
Name | Type | Description | Notes
|
|
2029
2266
|
------------- | ------------- | ------------- | -------------
|
|
2030
|
-
**call_id** | **String**|
|
|
2267
|
+
**call_id** | **String**| callId |
|
|
2031
2268
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2032
2269
|
{: class="table table-striped"}
|
|
2033
2270
|
|
|
@@ -2068,9 +2305,9 @@ end
|
|
|
2068
2305
|
|
|
2069
2306
|
api_instance = PureCloud::ConversationsApi.new
|
|
2070
2307
|
|
|
2071
|
-
call_id = "call_id_example" # String |
|
|
2308
|
+
call_id = "call_id_example" # String | callId
|
|
2072
2309
|
|
|
2073
|
-
participant_id = "participant_id_example" # String |
|
|
2310
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2074
2311
|
|
|
2075
2312
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant request
|
|
2076
2313
|
|
|
@@ -2087,8 +2324,8 @@ end
|
|
|
2087
2324
|
|
|
2088
2325
|
Name | Type | Description | Notes
|
|
2089
2326
|
------------- | ------------- | ------------- | -------------
|
|
2090
|
-
**call_id** | **String**|
|
|
2091
|
-
**participant_id** | **String**|
|
|
2327
|
+
**call_id** | **String**| callId |
|
|
2328
|
+
**participant_id** | **String**| participantId |
|
|
2092
2329
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request |
|
|
2093
2330
|
{: class="table table-striped"}
|
|
2094
2331
|
|
|
@@ -2129,9 +2366,9 @@ end
|
|
|
2129
2366
|
|
|
2130
2367
|
api_instance = PureCloud::ConversationsApi.new
|
|
2131
2368
|
|
|
2132
|
-
call_id = "call_id_example" # String |
|
|
2369
|
+
call_id = "call_id_example" # String | callId
|
|
2133
2370
|
|
|
2134
|
-
participant_id = "participant_id_example" # String |
|
|
2371
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2135
2372
|
|
|
2136
2373
|
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2137
2374
|
|
|
@@ -2148,8 +2385,8 @@ end
|
|
|
2148
2385
|
|
|
2149
2386
|
Name | Type | Description | Notes
|
|
2150
2387
|
------------- | ------------- | ------------- | -------------
|
|
2151
|
-
**call_id** | **String**|
|
|
2152
|
-
**participant_id** | **String**|
|
|
2388
|
+
**call_id** | **String**| callId |
|
|
2389
|
+
**participant_id** | **String**| participantId |
|
|
2153
2390
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2154
2391
|
{: class="table table-striped"}
|
|
2155
2392
|
|
|
@@ -2190,11 +2427,11 @@ end
|
|
|
2190
2427
|
|
|
2191
2428
|
api_instance = PureCloud::ConversationsApi.new
|
|
2192
2429
|
|
|
2193
|
-
call_id = "call_id_example" # String |
|
|
2430
|
+
call_id = "call_id_example" # String | callId
|
|
2194
2431
|
|
|
2195
|
-
participant_id = "participant_id_example" # String |
|
|
2432
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2196
2433
|
|
|
2197
|
-
communication_id = "communication_id_example" # String |
|
|
2434
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2198
2435
|
|
|
2199
2436
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2200
2437
|
|
|
@@ -2211,9 +2448,9 @@ end
|
|
|
2211
2448
|
|
|
2212
2449
|
Name | Type | Description | Notes
|
|
2213
2450
|
------------- | ------------- | ------------- | -------------
|
|
2214
|
-
**call_id** | **String**|
|
|
2215
|
-
**participant_id** | **String**|
|
|
2216
|
-
**communication_id** | **String**|
|
|
2451
|
+
**call_id** | **String**| callId |
|
|
2452
|
+
**participant_id** | **String**| participantId |
|
|
2453
|
+
**communication_id** | **String**| communicationId |
|
|
2217
2454
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2218
2455
|
{: class="table table-striped"}
|
|
2219
2456
|
|
|
@@ -2254,9 +2491,9 @@ end
|
|
|
2254
2491
|
|
|
2255
2492
|
api_instance = PureCloud::ConversationsApi.new
|
|
2256
2493
|
|
|
2257
|
-
call_id = "call_id_example" # String |
|
|
2494
|
+
call_id = "call_id_example" # String | callId
|
|
2258
2495
|
|
|
2259
|
-
participant_id = "participant_id_example" # String |
|
|
2496
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2260
2497
|
|
|
2261
2498
|
body = PureCloud::ConsultTransferUpdate.new # ConsultTransferUpdate | new speak to
|
|
2262
2499
|
|
|
@@ -2274,8 +2511,8 @@ end
|
|
|
2274
2511
|
|
|
2275
2512
|
Name | Type | Description | Notes
|
|
2276
2513
|
------------- | ------------- | ------------- | -------------
|
|
2277
|
-
**call_id** | **String**|
|
|
2278
|
-
**participant_id** | **String**|
|
|
2514
|
+
**call_id** | **String**| callId |
|
|
2515
|
+
**participant_id** | **String**| participantId |
|
|
2279
2516
|
**body** | [**ConsultTransferUpdate**](ConsultTransferUpdate.html)| new speak to |
|
|
2280
2517
|
{: class="table table-striped"}
|
|
2281
2518
|
|
|
@@ -2316,7 +2553,7 @@ end
|
|
|
2316
2553
|
|
|
2317
2554
|
api_instance = PureCloud::ConversationsApi.new
|
|
2318
2555
|
|
|
2319
|
-
chat_id = "chat_id_example" # String |
|
|
2556
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2320
2557
|
|
|
2321
2558
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2322
2559
|
|
|
@@ -2334,7 +2571,7 @@ end
|
|
|
2334
2571
|
|
|
2335
2572
|
Name | Type | Description | Notes
|
|
2336
2573
|
------------- | ------------- | ------------- | -------------
|
|
2337
|
-
**chat_id** | **String**|
|
|
2574
|
+
**chat_id** | **String**| chatId |
|
|
2338
2575
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2339
2576
|
{: class="table table-striped"}
|
|
2340
2577
|
|
|
@@ -2375,9 +2612,9 @@ end
|
|
|
2375
2612
|
|
|
2376
2613
|
api_instance = PureCloud::ConversationsApi.new
|
|
2377
2614
|
|
|
2378
|
-
chat_id = "chat_id_example" # String |
|
|
2615
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2379
2616
|
|
|
2380
|
-
participant_id = "participant_id_example" # String |
|
|
2617
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2381
2618
|
|
|
2382
2619
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
2383
2620
|
|
|
@@ -2394,8 +2631,8 @@ end
|
|
|
2394
2631
|
|
|
2395
2632
|
Name | Type | Description | Notes
|
|
2396
2633
|
------------- | ------------- | ------------- | -------------
|
|
2397
|
-
**chat_id** | **String**|
|
|
2398
|
-
**participant_id** | **String**|
|
|
2634
|
+
**chat_id** | **String**| chatId |
|
|
2635
|
+
**participant_id** | **String**| participantId |
|
|
2399
2636
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
2400
2637
|
{: class="table table-striped"}
|
|
2401
2638
|
|
|
@@ -2436,9 +2673,9 @@ end
|
|
|
2436
2673
|
|
|
2437
2674
|
api_instance = PureCloud::ConversationsApi.new
|
|
2438
2675
|
|
|
2439
|
-
chat_id = "chat_id_example" # String |
|
|
2676
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2440
2677
|
|
|
2441
|
-
participant_id = "participant_id_example" # String |
|
|
2678
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2442
2679
|
|
|
2443
2680
|
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2444
2681
|
|
|
@@ -2455,8 +2692,8 @@ end
|
|
|
2455
2692
|
|
|
2456
2693
|
Name | Type | Description | Notes
|
|
2457
2694
|
------------- | ------------- | ------------- | -------------
|
|
2458
|
-
**chat_id** | **String**|
|
|
2459
|
-
**participant_id** | **String**|
|
|
2695
|
+
**chat_id** | **String**| chatId |
|
|
2696
|
+
**participant_id** | **String**| participantId |
|
|
2460
2697
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2461
2698
|
{: class="table table-striped"}
|
|
2462
2699
|
|
|
@@ -2497,11 +2734,11 @@ end
|
|
|
2497
2734
|
|
|
2498
2735
|
api_instance = PureCloud::ConversationsApi.new
|
|
2499
2736
|
|
|
2500
|
-
chat_id = "chat_id_example" # String |
|
|
2737
|
+
chat_id = "chat_id_example" # String | chatId
|
|
2501
2738
|
|
|
2502
|
-
participant_id = "participant_id_example" # String |
|
|
2739
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2503
2740
|
|
|
2504
|
-
communication_id = "communication_id_example" # String |
|
|
2741
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2505
2742
|
|
|
2506
2743
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2507
2744
|
|
|
@@ -2518,9 +2755,256 @@ end
|
|
|
2518
2755
|
|
|
2519
2756
|
Name | Type | Description | Notes
|
|
2520
2757
|
------------- | ------------- | ------------- | -------------
|
|
2521
|
-
**chat_id** | **String**|
|
|
2522
|
-
**participant_id** | **String**|
|
|
2523
|
-
**communication_id** | **String**|
|
|
2758
|
+
**chat_id** | **String**| chatId |
|
|
2759
|
+
**participant_id** | **String**| participantId |
|
|
2760
|
+
**communication_id** | **String**| communicationId |
|
|
2761
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2762
|
+
{: class="table table-striped"}
|
|
2763
|
+
|
|
2764
|
+
|
|
2765
|
+
### Return type
|
|
2766
|
+
|
|
2767
|
+
nil (empty response body)
|
|
2768
|
+
|
|
2769
|
+
### HTTP request headers
|
|
2770
|
+
|
|
2771
|
+
- **Content-Type**: application/json
|
|
2772
|
+
- **Accept**: application/json
|
|
2773
|
+
|
|
2774
|
+
|
|
2775
|
+
|
|
2776
|
+
<a name="patch_cobrowsesessions_cobrowse_id"></a>
|
|
2777
|
+
|
|
2778
|
+
## -[**Conversation**](Conversation.html) patch_cobrowsesessions_cobrowse_id(cobrowse_id, body)
|
|
2779
|
+
|
|
2780
|
+
Update a conversation by disconnecting all of the participants
|
|
2781
|
+
|
|
2782
|
+
|
|
2783
|
+
|
|
2784
|
+
### Example
|
|
2785
|
+
~~~ruby
|
|
2786
|
+
# load the gem
|
|
2787
|
+
require 'purecloud'
|
|
2788
|
+
# setup authorization
|
|
2789
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2790
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2791
|
+
environment = "mypurecloud.com"
|
|
2792
|
+
|
|
2793
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2794
|
+
|
|
2795
|
+
PureCloud.configure do |config|
|
|
2796
|
+
config.access_token = @authToken
|
|
2797
|
+
end
|
|
2798
|
+
|
|
2799
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2800
|
+
|
|
2801
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
2802
|
+
|
|
2803
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2804
|
+
|
|
2805
|
+
|
|
2806
|
+
begin
|
|
2807
|
+
#Update a conversation by disconnecting all of the participants
|
|
2808
|
+
result = api_instance.patch_cobrowsesessions_cobrowse_id(cobrowse_id, body)
|
|
2809
|
+
p result
|
|
2810
|
+
rescue PureCloud::ApiError => e
|
|
2811
|
+
puts "Exception when calling ConversationsApi->patch_cobrowsesessions_cobrowse_id: #{e}"
|
|
2812
|
+
end
|
|
2813
|
+
~~~
|
|
2814
|
+
|
|
2815
|
+
### Parameters
|
|
2816
|
+
|
|
2817
|
+
Name | Type | Description | Notes
|
|
2818
|
+
------------- | ------------- | ------------- | -------------
|
|
2819
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
2820
|
+
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2821
|
+
{: class="table table-striped"}
|
|
2822
|
+
|
|
2823
|
+
|
|
2824
|
+
### Return type
|
|
2825
|
+
|
|
2826
|
+
[**Conversation**](Conversation.html)
|
|
2827
|
+
|
|
2828
|
+
### HTTP request headers
|
|
2829
|
+
|
|
2830
|
+
- **Content-Type**: application/json
|
|
2831
|
+
- **Accept**: application/json
|
|
2832
|
+
|
|
2833
|
+
|
|
2834
|
+
|
|
2835
|
+
<a name="patch_cobrowsesessions_cobrowse_id_participants_participant_id"></a>
|
|
2836
|
+
|
|
2837
|
+
## - patch_cobrowsesessions_cobrowse_id_participants_participant_id(cobrowse_id, participant_id, opts)
|
|
2838
|
+
|
|
2839
|
+
Update conversation participant
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
|
|
2843
|
+
### Example
|
|
2844
|
+
~~~ruby
|
|
2845
|
+
# load the gem
|
|
2846
|
+
require 'purecloud'
|
|
2847
|
+
# setup authorization
|
|
2848
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2849
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2850
|
+
environment = "mypurecloud.com"
|
|
2851
|
+
|
|
2852
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2853
|
+
|
|
2854
|
+
PureCloud.configure do |config|
|
|
2855
|
+
config.access_token = @authToken
|
|
2856
|
+
end
|
|
2857
|
+
|
|
2858
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2859
|
+
|
|
2860
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
2861
|
+
|
|
2862
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2863
|
+
|
|
2864
|
+
opts = {
|
|
2865
|
+
body: PureCloud::MediaParticipantRequest.new # MediaParticipantRequest |
|
|
2866
|
+
}
|
|
2867
|
+
|
|
2868
|
+
begin
|
|
2869
|
+
#Update conversation participant
|
|
2870
|
+
api_instance.patch_cobrowsesessions_cobrowse_id_participants_participant_id(cobrowse_id, participant_id, opts)
|
|
2871
|
+
rescue PureCloud::ApiError => e
|
|
2872
|
+
puts "Exception when calling ConversationsApi->patch_cobrowsesessions_cobrowse_id_participants_participant_id: #{e}"
|
|
2873
|
+
end
|
|
2874
|
+
~~~
|
|
2875
|
+
|
|
2876
|
+
### Parameters
|
|
2877
|
+
|
|
2878
|
+
Name | Type | Description | Notes
|
|
2879
|
+
------------- | ------------- | ------------- | -------------
|
|
2880
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
2881
|
+
**participant_id** | **String**| participantId |
|
|
2882
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| | [optional]
|
|
2883
|
+
{: class="table table-striped"}
|
|
2884
|
+
|
|
2885
|
+
|
|
2886
|
+
### Return type
|
|
2887
|
+
|
|
2888
|
+
nil (empty response body)
|
|
2889
|
+
|
|
2890
|
+
### HTTP request headers
|
|
2891
|
+
|
|
2892
|
+
- **Content-Type**: application/json
|
|
2893
|
+
- **Accept**: application/json
|
|
2894
|
+
|
|
2895
|
+
|
|
2896
|
+
|
|
2897
|
+
<a name="patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes"></a>
|
|
2898
|
+
|
|
2899
|
+
## - patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes(cobrowse_id, participant_id, opts)
|
|
2900
|
+
|
|
2901
|
+
Update the attributes on a conversation participant.
|
|
2902
|
+
|
|
2903
|
+
|
|
2904
|
+
|
|
2905
|
+
### Example
|
|
2906
|
+
~~~ruby
|
|
2907
|
+
# load the gem
|
|
2908
|
+
require 'purecloud'
|
|
2909
|
+
# setup authorization
|
|
2910
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2911
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2912
|
+
environment = "mypurecloud.com"
|
|
2913
|
+
|
|
2914
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2915
|
+
|
|
2916
|
+
PureCloud.configure do |config|
|
|
2917
|
+
config.access_token = @authToken
|
|
2918
|
+
end
|
|
2919
|
+
|
|
2920
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2921
|
+
|
|
2922
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
2923
|
+
|
|
2924
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2925
|
+
|
|
2926
|
+
opts = {
|
|
2927
|
+
body: PureCloud::ParticipantAttributes.new # ParticipantAttributes |
|
|
2928
|
+
}
|
|
2929
|
+
|
|
2930
|
+
begin
|
|
2931
|
+
#Update the attributes on a conversation participant.
|
|
2932
|
+
api_instance.patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes(cobrowse_id, participant_id, opts)
|
|
2933
|
+
rescue PureCloud::ApiError => e
|
|
2934
|
+
puts "Exception when calling ConversationsApi->patch_cobrowsesessions_cobrowse_id_participants_participant_id_attributes: #{e}"
|
|
2935
|
+
end
|
|
2936
|
+
~~~
|
|
2937
|
+
|
|
2938
|
+
### Parameters
|
|
2939
|
+
|
|
2940
|
+
Name | Type | Description | Notes
|
|
2941
|
+
------------- | ------------- | ------------- | -------------
|
|
2942
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
2943
|
+
**participant_id** | **String**| participantId |
|
|
2944
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| | [optional]
|
|
2945
|
+
{: class="table table-striped"}
|
|
2946
|
+
|
|
2947
|
+
|
|
2948
|
+
### Return type
|
|
2949
|
+
|
|
2950
|
+
nil (empty response body)
|
|
2951
|
+
|
|
2952
|
+
### HTTP request headers
|
|
2953
|
+
|
|
2954
|
+
- **Content-Type**: application/json
|
|
2955
|
+
- **Accept**: application/json
|
|
2956
|
+
|
|
2957
|
+
|
|
2958
|
+
|
|
2959
|
+
<a name="patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id"></a>
|
|
2960
|
+
|
|
2961
|
+
## - patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id(cobrowse_id, participant_id, communication_id, body)
|
|
2962
|
+
|
|
2963
|
+
Update conversation participant's communication by disconnecting it.
|
|
2964
|
+
|
|
2965
|
+
|
|
2966
|
+
|
|
2967
|
+
### Example
|
|
2968
|
+
~~~ruby
|
|
2969
|
+
# load the gem
|
|
2970
|
+
require 'purecloud'
|
|
2971
|
+
# setup authorization
|
|
2972
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2973
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2974
|
+
environment = "mypurecloud.com"
|
|
2975
|
+
|
|
2976
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2977
|
+
|
|
2978
|
+
PureCloud.configure do |config|
|
|
2979
|
+
config.access_token = @authToken
|
|
2980
|
+
end
|
|
2981
|
+
|
|
2982
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2983
|
+
|
|
2984
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
2985
|
+
|
|
2986
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2987
|
+
|
|
2988
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2989
|
+
|
|
2990
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2991
|
+
|
|
2992
|
+
|
|
2993
|
+
begin
|
|
2994
|
+
#Update conversation participant's communication by disconnecting it.
|
|
2995
|
+
api_instance.patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id(cobrowse_id, participant_id, communication_id, body)
|
|
2996
|
+
rescue PureCloud::ApiError => e
|
|
2997
|
+
puts "Exception when calling ConversationsApi->patch_cobrowsesessions_cobrowse_id_participants_participant_id_communications_communication_id: #{e}"
|
|
2998
|
+
end
|
|
2999
|
+
~~~
|
|
3000
|
+
|
|
3001
|
+
### Parameters
|
|
3002
|
+
|
|
3003
|
+
Name | Type | Description | Notes
|
|
3004
|
+
------------- | ------------- | ------------- | -------------
|
|
3005
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3006
|
+
**participant_id** | **String**| participantId |
|
|
3007
|
+
**communication_id** | **String**| communicationId |
|
|
2524
3008
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant |
|
|
2525
3009
|
{: class="table table-striped"}
|
|
2526
3010
|
|
|
@@ -2683,7 +3167,7 @@ end
|
|
|
2683
3167
|
|
|
2684
3168
|
api_instance = PureCloud::ConversationsApi.new
|
|
2685
3169
|
|
|
2686
|
-
email_id = "email_id_example" # String |
|
|
3170
|
+
email_id = "email_id_example" # String | emailId
|
|
2687
3171
|
|
|
2688
3172
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2689
3173
|
|
|
@@ -2701,7 +3185,7 @@ end
|
|
|
2701
3185
|
|
|
2702
3186
|
Name | Type | Description | Notes
|
|
2703
3187
|
------------- | ------------- | ------------- | -------------
|
|
2704
|
-
**email_id** | **String**|
|
|
3188
|
+
**email_id** | **String**| emailId |
|
|
2705
3189
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
2706
3190
|
{: class="table table-striped"}
|
|
2707
3191
|
|
|
@@ -2742,9 +3226,9 @@ end
|
|
|
2742
3226
|
|
|
2743
3227
|
api_instance = PureCloud::ConversationsApi.new
|
|
2744
3228
|
|
|
2745
|
-
email_id = "email_id_example" # String |
|
|
3229
|
+
email_id = "email_id_example" # String | emailId
|
|
2746
3230
|
|
|
2747
|
-
participant_id = "participant_id_example" # String |
|
|
3231
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2748
3232
|
|
|
2749
3233
|
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
2750
3234
|
|
|
@@ -2761,8 +3245,8 @@ end
|
|
|
2761
3245
|
|
|
2762
3246
|
Name | Type | Description | Notes
|
|
2763
3247
|
------------- | ------------- | ------------- | -------------
|
|
2764
|
-
**email_id** | **String**|
|
|
2765
|
-
**participant_id** | **String**|
|
|
3248
|
+
**email_id** | **String**| emailId |
|
|
3249
|
+
**participant_id** | **String**| participantId |
|
|
2766
3250
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request |
|
|
2767
3251
|
{: class="table table-striped"}
|
|
2768
3252
|
|
|
@@ -2803,9 +3287,9 @@ end
|
|
|
2803
3287
|
|
|
2804
3288
|
api_instance = PureCloud::ConversationsApi.new
|
|
2805
3289
|
|
|
2806
|
-
email_id = "email_id_example" # String |
|
|
3290
|
+
email_id = "email_id_example" # String | emailId
|
|
2807
3291
|
|
|
2808
|
-
participant_id = "participant_id_example" # String |
|
|
3292
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2809
3293
|
|
|
2810
3294
|
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2811
3295
|
|
|
@@ -2822,8 +3306,8 @@ end
|
|
|
2822
3306
|
|
|
2823
3307
|
Name | Type | Description | Notes
|
|
2824
3308
|
------------- | ------------- | ------------- | -------------
|
|
2825
|
-
**email_id** | **String**|
|
|
2826
|
-
**participant_id** | **String**|
|
|
3309
|
+
**email_id** | **String**| emailId |
|
|
3310
|
+
**participant_id** | **String**| participantId |
|
|
2827
3311
|
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes |
|
|
2828
3312
|
{: class="table table-striped"}
|
|
2829
3313
|
|
|
@@ -2920,9 +3404,9 @@ end
|
|
|
2920
3404
|
|
|
2921
3405
|
api_instance = PureCloud::ConversationsApi.new
|
|
2922
3406
|
|
|
2923
|
-
callback_id = "callback_id_example" # String |
|
|
3407
|
+
callback_id = "callback_id_example" # String | callbackId
|
|
2924
3408
|
|
|
2925
|
-
participant_id = "participant_id_example" # String |
|
|
3409
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2926
3410
|
|
|
2927
3411
|
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
2928
3412
|
|
|
@@ -2939,8 +3423,8 @@ end
|
|
|
2939
3423
|
|
|
2940
3424
|
Name | Type | Description | Notes
|
|
2941
3425
|
------------- | ------------- | ------------- | -------------
|
|
2942
|
-
**callback_id** | **String**|
|
|
2943
|
-
**participant_id** | **String**|
|
|
3426
|
+
**callback_id** | **String**| callbackId |
|
|
3427
|
+
**participant_id** | **String**| participantId |
|
|
2944
3428
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
2945
3429
|
{: class="table table-striped"}
|
|
2946
3430
|
|
|
@@ -3037,7 +3521,7 @@ end
|
|
|
3037
3521
|
|
|
3038
3522
|
api_instance = PureCloud::ConversationsApi.new
|
|
3039
3523
|
|
|
3040
|
-
call_id = "call_id_example" # String |
|
|
3524
|
+
call_id = "call_id_example" # String | callId
|
|
3041
3525
|
|
|
3042
3526
|
body = PureCloud::CallCommand.new # CallCommand | Conversation
|
|
3043
3527
|
|
|
@@ -3055,7 +3539,7 @@ end
|
|
|
3055
3539
|
|
|
3056
3540
|
Name | Type | Description | Notes
|
|
3057
3541
|
------------- | ------------- | ------------- | -------------
|
|
3058
|
-
**call_id** | **String**|
|
|
3542
|
+
**call_id** | **String**| callId |
|
|
3059
3543
|
**body** | [**CallCommand**](CallCommand.html)| Conversation |
|
|
3060
3544
|
{: class="table table-striped"}
|
|
3061
3545
|
|
|
@@ -3096,7 +3580,7 @@ end
|
|
|
3096
3580
|
|
|
3097
3581
|
api_instance = PureCloud::ConversationsApi.new
|
|
3098
3582
|
|
|
3099
|
-
call_id = "call_id_example" # String |
|
|
3583
|
+
call_id = "call_id_example" # String | callId
|
|
3100
3584
|
|
|
3101
3585
|
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
3102
3586
|
|
|
@@ -3114,7 +3598,7 @@ end
|
|
|
3114
3598
|
|
|
3115
3599
|
Name | Type | Description | Notes
|
|
3116
3600
|
------------- | ------------- | ------------- | -------------
|
|
3117
|
-
**call_id** | **String**|
|
|
3601
|
+
**call_id** | **String**| callId |
|
|
3118
3602
|
**body** | [**Conversation**](Conversation.html)| Conversation |
|
|
3119
3603
|
{: class="table table-striped"}
|
|
3120
3604
|
|
|
@@ -3155,9 +3639,9 @@ end
|
|
|
3155
3639
|
|
|
3156
3640
|
api_instance = PureCloud::ConversationsApi.new
|
|
3157
3641
|
|
|
3158
|
-
call_id = "call_id_example" # String |
|
|
3642
|
+
call_id = "call_id_example" # String | callId
|
|
3159
3643
|
|
|
3160
|
-
participant_id = "participant_id_example" # String |
|
|
3644
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3161
3645
|
|
|
3162
3646
|
body = PureCloud::ConsultTransfer.new # ConsultTransfer | Destination address & initial speak to
|
|
3163
3647
|
|
|
@@ -3175,8 +3659,8 @@ end
|
|
|
3175
3659
|
|
|
3176
3660
|
Name | Type | Description | Notes
|
|
3177
3661
|
------------- | ------------- | ------------- | -------------
|
|
3178
|
-
**call_id** | **String**|
|
|
3179
|
-
**participant_id** | **String**|
|
|
3662
|
+
**call_id** | **String**| callId |
|
|
3663
|
+
**participant_id** | **String**| participantId |
|
|
3180
3664
|
**body** | [**ConsultTransfer**](ConsultTransfer.html)| Destination address & initial speak to |
|
|
3181
3665
|
{: class="table table-striped"}
|
|
3182
3666
|
|
|
@@ -3217,9 +3701,9 @@ end
|
|
|
3217
3701
|
|
|
3218
3702
|
api_instance = PureCloud::ConversationsApi.new
|
|
3219
3703
|
|
|
3220
|
-
call_id = "call_id_example" # String |
|
|
3704
|
+
call_id = "call_id_example" # String | callId
|
|
3221
3705
|
|
|
3222
|
-
participant_id = "participant_id_example" # String |
|
|
3706
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3223
3707
|
|
|
3224
3708
|
|
|
3225
3709
|
begin
|
|
@@ -3234,8 +3718,8 @@ end
|
|
|
3234
3718
|
|
|
3235
3719
|
Name | Type | Description | Notes
|
|
3236
3720
|
------------- | ------------- | ------------- | -------------
|
|
3237
|
-
**call_id** | **String**|
|
|
3238
|
-
**participant_id** | **String**|
|
|
3721
|
+
**call_id** | **String**| callId |
|
|
3722
|
+
**participant_id** | **String**| participantId |
|
|
3239
3723
|
{: class="table table-striped"}
|
|
3240
3724
|
|
|
3241
3725
|
|
|
@@ -3275,9 +3759,9 @@ end
|
|
|
3275
3759
|
|
|
3276
3760
|
api_instance = PureCloud::ConversationsApi.new
|
|
3277
3761
|
|
|
3278
|
-
call_id = "call_id_example" # String |
|
|
3762
|
+
call_id = "call_id_example" # String | callId
|
|
3279
3763
|
|
|
3280
|
-
participant_id = "participant_id_example" # String |
|
|
3764
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3281
3765
|
|
|
3282
3766
|
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
3283
3767
|
|
|
@@ -3294,8 +3778,8 @@ end
|
|
|
3294
3778
|
|
|
3295
3779
|
Name | Type | Description | Notes
|
|
3296
3780
|
------------- | ------------- | ------------- | -------------
|
|
3297
|
-
**call_id** | **String**|
|
|
3298
|
-
**participant_id** | **String**|
|
|
3781
|
+
**call_id** | **String**| callId |
|
|
3782
|
+
**participant_id** | **String**| participantId |
|
|
3299
3783
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
3300
3784
|
{: class="table table-striped"}
|
|
3301
3785
|
|
|
@@ -3336,9 +3820,9 @@ end
|
|
|
3336
3820
|
|
|
3337
3821
|
api_instance = PureCloud::ConversationsApi.new
|
|
3338
3822
|
|
|
3339
|
-
chat_id = "chat_id_example" # String |
|
|
3823
|
+
chat_id = "chat_id_example" # String | chatId
|
|
3340
3824
|
|
|
3341
|
-
participant_id = "participant_id_example" # String |
|
|
3825
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3342
3826
|
|
|
3343
3827
|
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
3344
3828
|
|
|
@@ -3355,8 +3839,8 @@ end
|
|
|
3355
3839
|
|
|
3356
3840
|
Name | Type | Description | Notes
|
|
3357
3841
|
------------- | ------------- | ------------- | -------------
|
|
3358
|
-
**chat_id** | **String**|
|
|
3359
|
-
**participant_id** | **String**|
|
|
3842
|
+
**chat_id** | **String**| chatId |
|
|
3843
|
+
**participant_id** | **String**| participantId |
|
|
3360
3844
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
3361
3845
|
{: class="table table-striped"}
|
|
3362
3846
|
|
|
@@ -3372,6 +3856,68 @@ nil (empty response body)
|
|
|
3372
3856
|
|
|
3373
3857
|
|
|
3374
3858
|
|
|
3859
|
+
<a name="post_cobrowsesessions_cobrowse_id_participants_participant_id_replace"></a>
|
|
3860
|
+
|
|
3861
|
+
## - post_cobrowsesessions_cobrowse_id_participants_participant_id_replace(cobrowse_id, participant_id, opts)
|
|
3862
|
+
|
|
3863
|
+
Replace this participant with the specified user and/or address
|
|
3864
|
+
|
|
3865
|
+
|
|
3866
|
+
|
|
3867
|
+
### Example
|
|
3868
|
+
~~~ruby
|
|
3869
|
+
# load the gem
|
|
3870
|
+
require 'purecloud'
|
|
3871
|
+
# setup authorization
|
|
3872
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3873
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3874
|
+
environment = "mypurecloud.com"
|
|
3875
|
+
|
|
3876
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3877
|
+
|
|
3878
|
+
PureCloud.configure do |config|
|
|
3879
|
+
config.access_token = @authToken
|
|
3880
|
+
end
|
|
3881
|
+
|
|
3882
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3883
|
+
|
|
3884
|
+
cobrowse_id = "cobrowse_id_example" # String | cobrowseId
|
|
3885
|
+
|
|
3886
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3887
|
+
|
|
3888
|
+
opts = {
|
|
3889
|
+
body: PureCloud::TransferRequest.new # TransferRequest |
|
|
3890
|
+
}
|
|
3891
|
+
|
|
3892
|
+
begin
|
|
3893
|
+
#Replace this participant with the specified user and/or address
|
|
3894
|
+
api_instance.post_cobrowsesessions_cobrowse_id_participants_participant_id_replace(cobrowse_id, participant_id, opts)
|
|
3895
|
+
rescue PureCloud::ApiError => e
|
|
3896
|
+
puts "Exception when calling ConversationsApi->post_cobrowsesessions_cobrowse_id_participants_participant_id_replace: #{e}"
|
|
3897
|
+
end
|
|
3898
|
+
~~~
|
|
3899
|
+
|
|
3900
|
+
### Parameters
|
|
3901
|
+
|
|
3902
|
+
Name | Type | Description | Notes
|
|
3903
|
+
------------- | ------------- | ------------- | -------------
|
|
3904
|
+
**cobrowse_id** | **String**| cobrowseId |
|
|
3905
|
+
**participant_id** | **String**| participantId |
|
|
3906
|
+
**body** | [**TransferRequest**](TransferRequest.html)| | [optional]
|
|
3907
|
+
{: class="table table-striped"}
|
|
3908
|
+
|
|
3909
|
+
|
|
3910
|
+
### Return type
|
|
3911
|
+
|
|
3912
|
+
nil (empty response body)
|
|
3913
|
+
|
|
3914
|
+
### HTTP request headers
|
|
3915
|
+
|
|
3916
|
+
- **Content-Type**: application/json
|
|
3917
|
+
- **Accept**: application/json
|
|
3918
|
+
|
|
3919
|
+
|
|
3920
|
+
|
|
3375
3921
|
<a name="post_conversation_id_participants_participant_id_callbacks"></a>
|
|
3376
3922
|
|
|
3377
3923
|
## - post_conversation_id_participants_participant_id_callbacks(conversation_id, participant_id, opts)
|
|
@@ -3691,7 +4237,7 @@ end
|
|
|
3691
4237
|
|
|
3692
4238
|
api_instance = PureCloud::ConversationsApi.new
|
|
3693
4239
|
|
|
3694
|
-
email_id = "email_id_example" # String |
|
|
4240
|
+
email_id = "email_id_example" # String | emailId
|
|
3695
4241
|
|
|
3696
4242
|
body = PureCloud::EmailMessage.new # EmailMessage | Reply
|
|
3697
4243
|
|
|
@@ -3709,7 +4255,7 @@ end
|
|
|
3709
4255
|
|
|
3710
4256
|
Name | Type | Description | Notes
|
|
3711
4257
|
------------- | ------------- | ------------- | -------------
|
|
3712
|
-
**email_id** | **String**|
|
|
4258
|
+
**email_id** | **String**| emailId |
|
|
3713
4259
|
**body** | [**EmailMessage**](EmailMessage.html)| Reply |
|
|
3714
4260
|
{: class="table table-striped"}
|
|
3715
4261
|
|
|
@@ -3750,9 +4296,9 @@ end
|
|
|
3750
4296
|
|
|
3751
4297
|
api_instance = PureCloud::ConversationsApi.new
|
|
3752
4298
|
|
|
3753
|
-
email_id = "email_id_example" # String |
|
|
4299
|
+
email_id = "email_id_example" # String | emailId
|
|
3754
4300
|
|
|
3755
|
-
participant_id = "participant_id_example" # String |
|
|
4301
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3756
4302
|
|
|
3757
4303
|
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
3758
4304
|
|
|
@@ -3769,8 +4315,8 @@ end
|
|
|
3769
4315
|
|
|
3770
4316
|
Name | Type | Description | Notes
|
|
3771
4317
|
------------- | ------------- | ------------- | -------------
|
|
3772
|
-
**email_id** | **String**|
|
|
3773
|
-
**participant_id** | **String**|
|
|
4318
|
+
**email_id** | **String**| emailId |
|
|
4319
|
+
**participant_id** | **String**| participantId |
|
|
3774
4320
|
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request |
|
|
3775
4321
|
{: class="table table-striped"}
|
|
3776
4322
|
|
|
@@ -3867,7 +4413,7 @@ end
|
|
|
3867
4413
|
|
|
3868
4414
|
api_instance = PureCloud::ConversationsApi.new
|
|
3869
4415
|
|
|
3870
|
-
email_id = "email_id_example" # String |
|
|
4416
|
+
email_id = "email_id_example" # String | emailId
|
|
3871
4417
|
|
|
3872
4418
|
body = PureCloud::EmailMessage.new # EmailMessage | Draft
|
|
3873
4419
|
|
|
@@ -3885,7 +4431,7 @@ end
|
|
|
3885
4431
|
|
|
3886
4432
|
Name | Type | Description | Notes
|
|
3887
4433
|
------------- | ------------- | ------------- | -------------
|
|
3888
|
-
**email_id** | **String**|
|
|
4434
|
+
**email_id** | **String**| emailId |
|
|
3889
4435
|
**body** | [**EmailMessage**](EmailMessage.html)| Draft |
|
|
3890
4436
|
{: class="table table-striped"}
|
|
3891
4437
|
|