purecloudplatformclientv2 60.0.0 → 64.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +299 -32
- data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectApi.md +85 -16
- data/docs/ArrayNode.md +4 -4
- data/docs/AsyncConversationQuery.md +6 -6
- data/docs/AsyncQueryResponse.md +13 -0
- data/docs/AsyncQueryStatus.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/Attribute.md +2 -2
- data/docs/AuthorizationApi.md +11 -7
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BillingApi.md +4 -4
- data/docs/BillingUsageReport.md +1 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +6 -6
- data/docs/CallableContactsDiagnostic.md +4 -4
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +5 -5
- data/docs/Campaign.md +11 -11
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignInteraction.md +6 -6
- data/docs/CampaignInteractions.md +1 -1
- data/docs/CampaignProgress.md +2 -2
- data/docs/CampaignRuleActionEntities.md +2 -2
- data/docs/CampaignRuleEntities.md +2 -2
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSchedule.md +1 -1
- data/docs/CampaignSequence.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +5 -5
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +5 -5
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactList.md +2 -2
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilter.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationAggregateDataContainer.md +14 -0
- data/docs/ConversationAggregateQueryClause.md +14 -0
- data/docs/ConversationAggregateQueryFilter.md +15 -0
- data/docs/ConversationAggregateQueryPredicate.md +17 -0
- data/docs/ConversationAggregateQueryResponse.md +13 -0
- data/docs/ConversationAggregationQuery.md +20 -0
- data/docs/ConversationAggregationView.md +16 -0
- data/docs/ConversationDetailQueryClause.md +14 -0
- data/docs/ConversationDetailQueryFilter.md +15 -0
- data/docs/ConversationDetailQueryPredicate.md +18 -0
- data/docs/ConversationDivisionMembership.md +2 -2
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationQuery.md +6 -6
- data/docs/ConversationsApi.md +2259 -498
- data/docs/CreateCallbackResponse.md +1 -1
- data/docs/CreateQueueMediaAssociationRequest.md +1 -0
- data/docs/CreateQueueRequest.md +2 -2
- data/docs/CreateShareResponse.md +4 -4
- data/docs/CreateUser.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DID.md +2 -2
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +3 -3
- data/docs/DataTableImportJob.md +24 -0
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyStatus.md +2 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncList.md +1 -1
- data/docs/DncListCreate.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/Document.md +4 -4
- data/docs/DocumentAudit.md +2 -2
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DocumentUpload.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/{UriReference.md → DomainEntityRef.md} +2 -2
- data/docs/DomainOrganizationRole.md +1 -0
- data/docs/DomainOrganizationRoleCreate.md +1 -0
- data/docs/DomainOrganizationRoleUpdate.md +1 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeInterface.md +1 -1
- data/docs/EdgeLine.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EdgeMetrics.md +1 -1
- data/docs/EdgeTrunkBase.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +5 -5
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmbeddedIntegration.md +14 -0
- data/docs/EmergencyCallFlow.md +2 -2
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/Endpoint.md +2 -2
- data/docs/EvaluationAggregateDataContainer.md +14 -0
- data/docs/EvaluationAggregateQueryClause.md +14 -0
- data/docs/EvaluationAggregateQueryFilter.md +15 -0
- data/docs/EvaluationAggregateQueryPredicate.md +17 -0
- data/docs/EvaluationAggregateQueryResponse.md +13 -0
- data/docs/EvaluationAggregationQuery.md +20 -0
- data/docs/EvaluationAggregationView.md +16 -0
- data/docs/EvaluationDetailQueryClause.md +14 -0
- data/docs/EvaluationDetailQueryFilter.md +15 -0
- data/docs/EvaluationDetailQueryPredicate.md +18 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/EventLog.md +2 -2
- data/docs/Extension.md +2 -2
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegration.md +3 -3
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocument.md +2 -2
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +2 -1
- data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md} +2 -2
- data/docs/FlowAggregateQueryClause.md +14 -0
- data/docs/FlowAggregateQueryFilter.md +15 -0
- data/docs/FlowAggregateQueryPredicate.md +17 -0
- data/docs/FlowAggregateQueryResponse.md +13 -0
- data/docs/{AggregationQuery.md → FlowAggregationQuery.md} +4 -4
- data/docs/{AnalyticsView.md → FlowAggregationView.md} +3 -3
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md} +2 -2
- data/docs/{ObservationQuery.md → FlowObservationQuery.md} +3 -3
- data/docs/FlowObservationQueryClause.md +14 -0
- data/docs/FlowObservationQueryFilter.md +15 -0
- data/docs/FlowObservationQueryPredicate.md +17 -0
- data/docs/FlowObservationQueryResponse.md +13 -0
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersion.md +1 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/FlowsApi.md +8 -8
- data/docs/GDPRRequest.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupContact.md +1 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +1 -1
- data/docs/HistoryEntry.md +2 -1
- data/docs/HistoryListing.md +1 -0
- data/docs/IVR.md +4 -4
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRoute.md +5 -5
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationExport.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/Line.md +6 -6
- data/docs/LineBase.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegration.md +3 -3
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/Location.md +4 -4
- data/docs/{LocationUpdateDefinition.md → LocationCreateUpdateDefinition.md} +7 -6
- data/docs/LocationDefinition.md +1 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationSearchRequest.md +1 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/LockInfo.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +2 -2
- data/docs/MediaEndpointStatDetailQueryClause.md +14 -0
- data/docs/MediaEndpointStatDetailQueryFilter.md +15 -0
- data/docs/MediaEndpointStatDetailQueryPredicate.md +17 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageInfo.md +4 -4
- data/docs/MessageMediaParticipant.md +5 -5
- data/docs/MessagingApi.md +7 -1015
- data/docs/MessagingIntegration.md +3 -3
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClient.md +2 -2
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthClientListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObjectsApi.md +1 -1
- data/docs/Operation.md +1 -0
- data/docs/OrgOAuthClient.md +2 -2
- data/docs/OrganizationApi.md +133 -8
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +4 -4
- data/docs/OutboundRoute.md +1 -1
- data/docs/OutboundRouteBase.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/Phone.md +5 -5
- data/docs/PhoneBase.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhoneStatus.md +1 -1
- data/docs/Photo.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceDetailQueryClause.md +14 -0
- data/docs/PresenceDetailQueryFilter.md +15 -0
- data/docs/PresenceDetailQueryPredicate.md +17 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +8 -8
- data/docs/QualityAuditPage.md +1 -1
- data/docs/Queue.md +2 -2
- data/docs/QueueEmailAddress.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMediaAssociation.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueMessagingAddresses.md +1 -1
- data/docs/QueueObservationDataContainer.md +14 -0
- data/docs/QueueObservationQuery.md +15 -0
- data/docs/QueueObservationQueryClause.md +14 -0
- data/docs/QueueObservationQueryFilter.md +15 -0
- data/docs/QueueObservationQueryPredicate.md +17 -0
- data/docs/{QualifierMappingObservationQueryResponse.md → QueueObservationQueryResponse.md} +3 -3
- data/docs/QueueRequest.md +2 -2
- data/docs/QueueUtilizationDiagnostic.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +4 -4
- data/docs/RecordingApi.md +11 -3
- data/docs/RecordingJob.md +1 -0
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +2 -0
- data/docs/RecordingMetadata.md +29 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReplaceResponse.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/Response.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +144 -7
- data/docs/RoutingStatusDetailQueryClause.md +14 -0
- data/docs/RoutingStatusDetailQueryFilter.md +15 -0
- data/docs/RoutingStatusDetailQueryPredicate.md +17 -0
- data/docs/RuleSet.md +2 -2
- data/docs/RuleSetDiagnostic.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +278 -0
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroup.md +3 -3
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +20 -0
- data/docs/ScimConfigResourceTypeSchemaExtension.md +14 -0
- data/docs/ScimConfigResourceTypesListResponse.md +17 -0
- data/docs/ScimEmail.md +3 -3
- data/docs/ScimError.md +16 -0
- data/docs/ScimGroupListResponse.md +4 -4
- data/docs/ScimMetadata.md +4 -4
- data/docs/ScimPhoneNumber.md +3 -3
- data/docs/ScimServiceProviderConfig.md +9 -1
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +18 -0
- data/docs/ScimServiceProviderConfigBulkFeature.md +15 -0
- data/docs/ScimServiceProviderConfigFilterFeature.md +14 -0
- data/docs/ScimServiceProviderConfigSimpleFeature.md +13 -0
- data/docs/ScimUserListResponse.md +4 -4
- data/docs/ScimV2CreateUser.md +12 -12
- data/docs/ScimV2EnterpriseUser.md +3 -3
- data/docs/ScimV2Group.md +4 -4
- data/docs/ScimV2GroupReference.md +3 -4
- data/docs/ScimV2MemberReference.md +3 -4
- data/docs/ScimV2PatchOperation.md +3 -3
- data/docs/ScimV2PatchRequest.md +1 -1
- data/docs/ScimV2User.md +14 -13
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +4 -4
- data/docs/SecureSession.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SegmentDetailQueryClause.md +14 -0
- data/docs/SegmentDetailQueryFilter.md +15 -0
- data/docs/{AnalyticsQueryPredicate.md → SegmentDetailQueryPredicate.md} +4 -4
- data/docs/SequenceSchedule.md +1 -1
- data/docs/Share.md +4 -4
- data/docs/ShareEntityListing.md +1 -1
- data/docs/Site.md +2 -2
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddress.md +21 -0
- data/docs/SmsAddressEntityListing.md +22 -0
- data/docs/SmsPhoneNumber.md +2 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SmsPhoneNumberProvision.md +1 -0
- data/docs/SpeechTextAnalyticsApi.md +14 -144
- data/docs/Station.md +2 -2
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SuggestApi.md +2 -2
- data/docs/Survey.md +1 -1
- data/docs/SurveyAggregateDataContainer.md +14 -0
- data/docs/SurveyAggregateQueryClause.md +14 -0
- data/docs/SurveyAggregateQueryFilter.md +15 -0
- data/docs/SurveyAggregateQueryPredicate.md +17 -0
- data/docs/SurveyAggregateQueryResponse.md +13 -0
- data/docs/SurveyAggregationQuery.md +20 -0
- data/docs/SurveyAggregationView.md +16 -0
- data/docs/SurveyAssignment.md +1 -1
- data/docs/SurveyDetailQueryClause.md +14 -0
- data/docs/SurveyDetailQueryFilter.md +15 -0
- data/docs/SurveyDetailQueryPredicate.md +18 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +10 -6
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TimeZoneMappingPreview.md +1 -1
- data/docs/TokenInfo.md +1 -0
- data/docs/TokensApi.md +2 -1
- data/docs/TranscriptProperty.md +15 -0
- data/docs/Trunk.md +5 -5
- data/docs/TrunkBase.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrunkMetrics.md +2 -2
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegration.md +3 -3
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregateDataContainer.md +14 -0
- data/docs/UserAggregateQueryClause.md +14 -0
- data/docs/UserAggregateQueryFilter.md +15 -0
- data/docs/UserAggregateQueryPredicate.md +17 -0
- data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md} +3 -3
- data/docs/UserAggregationQuery.md +20 -0
- data/docs/UserAggregationView.md +16 -0
- data/docs/UserAuthorization.md +1 -0
- data/docs/UserDetailQueryClause.md +14 -0
- data/docs/UserDetailQueryFilter.md +15 -0
- data/docs/UserDetailQueryPredicate.md +17 -0
- data/docs/UserDetailsQuery.md +3 -3
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserObservationDataContainer.md +14 -0
- data/docs/UserObservationQuery.md +15 -0
- data/docs/UserObservationQueryClause.md +14 -0
- data/docs/UserObservationQueryFilter.md +15 -0
- data/docs/UserObservationQueryPredicate.md +17 -0
- data/docs/UserObservationQueryResponse.md +13 -0
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueue.md +2 -2
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecording.md +2 -2
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UserTokensTopicTokenNotification.md +3 -0
- data/docs/UsersApi.md +19 -19
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatDeployment.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WhatsAppIntegration.md +25 -0
- data/docs/WhatsAppIntegrationEntityListing.md +22 -0
- data/docs/WhatsAppIntegrationUpdateRequest.md +18 -0
- data/docs/WidgetDeployment.md +1 -1
- data/docs/WorkforceManagementApi.md +1 -1
- data/docs/Workspace.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMember.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +99 -20
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +292 -24
- data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +2663 -810
- data/lib/purecloudplatformclientv2/api/flows_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/locations_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +10 -1042
- data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/organization_api.rb +124 -4
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/quality_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +51 -3
- data/lib/purecloudplatformclientv2/api/routing_api.rb +153 -6
- data/lib/purecloudplatformclientv2/api/scim_api.rb +332 -0
- data/lib/purecloudplatformclientv2/api/search_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +19 -139
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +22 -4
- data/lib/purecloudplatformclientv2/api/users_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +1 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +229 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +31 -3
- data/lib/purecloudplatformclientv2/models/array_node.rb +57 -57
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +28 -28
- data/lib/purecloudplatformclientv2/models/async_query_response.rb +202 -0
- data/lib/purecloudplatformclientv2/models/async_query_status.rb +320 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +6 -6
- data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +4 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/campaign.rb +11 -11
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +6 -6
- data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_clause.rb → conversation_aggregate_query_clause.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/{analytics_query_filter.rb → conversation_aggregate_query_filter.rb} +4 -4
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/conversation_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +28 -28
- data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_media_association_request.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/create_share_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/create_user.rb +44 -4
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +3 -3
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +521 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_status.rb +28 -1
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did.rb +2 -2
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document.rb +4 -4
- data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +29 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +29 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +29 -1
- data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_metrics.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{base_topic_entitiy.rb → embedded_integration.rb} +16 -41
- data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/{analytics_view.rb → evaluation_aggregation_view.rb} +17 -3
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/{create_topic_request.rb → evaluation_detail_query_predicate.rb} +91 -141
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +30 -3
- data/lib/purecloudplatformclientv2/models/{aggregate_data_container.rb → flow_aggregate_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{aggregate_query_response.rb → flow_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/{aggregation_query.rb → flow_aggregation_query.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/flow_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{observation_data_container.rb → flow_observation_data_container.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/{observation_query.rb → flow_observation_query.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/flow_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{observation_query_response.rb → flow_observation_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version.rb +26 -1
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_contact.rb +27 -1
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/history_entry.rb +28 -1
- data/lib/purecloudplatformclientv2/models/history_listing.rb +26 -1
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +57 -57
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line.rb +6 -6
- data/lib/purecloudplatformclientv2/models/line_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location.rb +4 -0
- data/lib/purecloudplatformclientv2/models/{location_update_definition.rb → location_create_update_definition.rb} +56 -25
- data/lib/purecloudplatformclientv2/models/location_definition.rb +27 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_search_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +3 -3
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/media_endpoint_stat_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_info.rb +4 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +1 -15
- data/lib/purecloudplatformclientv2/models/operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone.rb +5 -5
- data/lib/purecloudplatformclientv2/models/phone_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
- data/lib/purecloudplatformclientv2/models/photo.rb +2 -2
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/presence_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/presence_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_email_address.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_media_association.rb +17 -17
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/queue_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{qualifier_mapping_observation_query_response.rb → queue_observation_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +4 -2
- data/lib/purecloudplatformclientv2/models/recording_job.rb +30 -4
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +55 -3
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +644 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +30 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/routing_status_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/rule_set.rb +2 -2
- data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +389 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_email.rb +3 -3
- data/lib/purecloudplatformclientv2/models/{phrase.rb → scim_error.rb} +57 -57
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +215 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +362 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +255 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +21 -19
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +6 -32
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +6 -32
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +52 -24
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/segment_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/{analytics_query_predicate.rb → segment_detail_query_predicate.rb} +7 -7
- data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/share.rb +4 -4
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{program.rb → sms_address.rb} +45 -83
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +67 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +27 -1
- data/lib/purecloudplatformclientv2/models/station.rb +2 -2
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +2 -2
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/survey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/survey_detail_query_predicate.rb +388 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -4
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
- data/lib/purecloudplatformclientv2/models/token_info.rb +29 -1
- data/lib/purecloudplatformclientv2/models/{base_program_entity.rb → transcript_property.rb} +23 -22
- data/lib/purecloudplatformclientv2/models/trunk.rb +5 -5
- data/lib/purecloudplatformclientv2/models/trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/{presence_query_response.rb → user_aggregate_query_response.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +390 -0
- data/lib/purecloudplatformclientv2/models/user_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_detail_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_detail_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +33 -34
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_observation_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query.rb +263 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/user_observation_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_tokens_topic_token_notification.rb +79 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{topic.rb → whats_app_integration.rb} +120 -96
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_update_request.rb +365 -0
- data/lib/purecloudplatformclientv2/models/widget_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +200 -42
- data/docs/AggregateQueryResponse.md +0 -13
- data/docs/AnalyticsQueryClause.md +0 -14
- data/docs/AnalyticsQueryFilter.md +0 -15
- data/docs/BaseProgramEntity.md +0 -15
- data/docs/BaseTopicEntitiy.md +0 -15
- data/docs/CreateTopicRequest.md +0 -20
- data/docs/ObservationQueryResponse.md +0 -13
- data/docs/Phrase.md +0 -15
- data/docs/Program.md +0 -22
- data/docs/Topic.md +0 -25
data/docs/ContactListFilter.md
CHANGED
|
@@ -12,7 +12,7 @@ title: ContactListFilter
|
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
-
| **contact_list** | [**
|
|
15
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The contact list the filter is based on. | |
|
|
16
16
|
| **clauses** | [**Array<ContactListFilterClause>**](ContactListFilterClause.html) | Groups of conditions to filter the contacts by. | [optional] |
|
|
17
17
|
| **filter_type** | **String** | How to join clauses together. | [optional] |
|
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
@@ -14,8 +14,8 @@ title: ContactListFilterEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ContactListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: ContactListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregateDataContainer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregateDataContainer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
|
|
11
|
+
| **data** | [**Array<StatisticalResponse>**](StatisticalResponse.html) | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregateQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregateQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<ConversationAggregateQueryPredicate>**](ConversationAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregateQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregateQueryFilter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
|
11
|
+
| **clauses** | [**Array<ConversationAggregateQueryClause>**](ConversationAggregateQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<ConversationAggregateQueryPredicate>**](ConversationAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregateQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregateQueryPredicate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
|
12
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
|
13
|
+
| **value** | **String** | Right hand side for dimension predicates | [optional] |
|
|
14
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregateQueryResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregateQueryResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **results** | [**Array<ConversationAggregateDataContainer>**](ConversationAggregateDataContainer.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregationQuery
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregationQuery
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
|
11
|
+
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
|
12
|
+
| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
|
13
|
+
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
|
14
|
+
| **filter** | [**ConversationAggregateQueryFilter**](ConversationAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
|
15
|
+
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
|
16
|
+
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
|
17
|
+
| **views** | [**Array<ConversationAggregationView>**](ConversationAggregationView.html) | Custom derived metric views | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationAggregationView
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationAggregationView
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **target** | **String** | Target metric name | |
|
|
11
|
+
| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
|
|
12
|
+
| **function** | **String** | Type of view you wish to create | |
|
|
13
|
+
| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationDetailQueryClause
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationDetailQueryClause
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates | |
|
|
11
|
+
| **predicates** | [**Array<ConversationDetailQueryPredicate>**](ConversationDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationDetailQueryFilter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationDetailQueryFilter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
|
|
11
|
+
| **clauses** | [**Array<ConversationDetailQueryClause>**](ConversationDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
|
|
12
|
+
| **predicates** | [**Array<ConversationDetailQueryPredicate>**](ConversationDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationDetailQueryPredicate
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationDetailQueryPredicate
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Optional type, can usually be inferred | [optional] |
|
|
11
|
+
| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
|
|
12
|
+
| **metric** | **String** | Left hand side for metric predicates | [optional] |
|
|
13
|
+
| **operator** | **String** | Optional operator, default is matches | [optional] |
|
|
14
|
+
| **value** | **String** | Right hand side for dimension or metric predicates | [optional] |
|
|
15
|
+
| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension or metric predicates | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -7,8 +7,8 @@ title: ConversationDivisionMembership
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **division** | [**
|
|
11
|
-
| **entities** | [**Array<
|
|
10
|
+
| **division** | [**DomainEntityRef**](DomainEntityRef.html) | A division the conversation belongs to. | [optional] |
|
|
11
|
+
| **entities** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -14,8 +14,8 @@ title: ConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ConversationQuery.md
CHANGED
|
@@ -7,12 +7,12 @@ title: ConversationQuery
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval.
|
|
11
|
-
| **conversation_filters** | [**Array<
|
|
12
|
-
| **
|
|
13
|
-
| **
|
|
14
|
-
| **media_endpoint_stat_filters** | [**Array<
|
|
15
|
-
| **
|
|
10
|
+
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
|
11
|
+
| **conversation_filters** | [**Array<ConversationDetailQueryFilter>**](ConversationDetailQueryFilter.html) | Filters that target conversation-level data | [optional] |
|
|
12
|
+
| **segment_filters** | [**Array<SegmentDetailQueryFilter>**](SegmentDetailQueryFilter.html) | Filters that target individual segments within a conversation | [optional] |
|
|
13
|
+
| **evaluation_filters** | [**Array<EvaluationDetailQueryFilter>**](EvaluationDetailQueryFilter.html) | Filters that target evaluations | [optional] |
|
|
14
|
+
| **media_endpoint_stat_filters** | [**Array<MediaEndpointStatDetailQueryFilter>**](MediaEndpointStatDetailQueryFilter.html) | Filters that target mediaEndpointStats | [optional] |
|
|
15
|
+
| **survey_filters** | [**Array<SurveyDetailQueryFilter>**](SurveyDetailQueryFilter.html) | Filters that target surveys | [optional] |
|
|
16
16
|
| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
|
|
17
17
|
| **order_by** | **String** | Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart | [optional] |
|
|
18
18
|
| **aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters | [optional] |
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -8,12 +8,18 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
+
[**delete_analytics_conversations_details_job**](ConversationsApi.html#delete_analytics_conversations_details_job) | Delete/cancel an async request
|
|
11
12
|
[**delete_conversation_participant_code**](ConversationsApi.html#delete_conversation_participant_code) | Delete a code used to add a communication to this participant
|
|
12
13
|
[**delete_conversation_participant_flaggedreason**](ConversationsApi.html#delete_conversation_participant_flaggedreason) | Remove flagged reason from conversation participant.
|
|
13
14
|
[**delete_conversations_call_participant_consult**](ConversationsApi.html#delete_conversations_call_participant_consult) | Cancel the transfer
|
|
14
15
|
[**delete_conversations_email_messages_draft_attachment**](ConversationsApi.html#delete_conversations_email_messages_draft_attachment) | Delete attachment from draft
|
|
16
|
+
[**delete_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
|
17
|
+
[**delete_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
|
18
|
+
[**delete_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
|
15
19
|
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
16
20
|
[**get_analytics_conversations_details**](ConversationsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
|
|
21
|
+
[**get_analytics_conversations_details_job**](ConversationsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
|
|
22
|
+
[**get_analytics_conversations_details_job_results**](ConversationsApi.html#get_analytics_conversations_details_job_results) | Fetch a page of results for an async query
|
|
17
23
|
[**get_conversation**](ConversationsApi.html#get_conversation) | Get conversation
|
|
18
24
|
[**get_conversation_participant_secureivrsession**](ConversationsApi.html#get_conversation_participant_secureivrsession) | Fetch info on a secure session
|
|
19
25
|
[**get_conversation_participant_secureivrsessions**](ConversationsApi.html#get_conversation_participant_secureivrsessions) | Get a list of secure sessions for this participant.
|
|
@@ -31,6 +37,8 @@ Method | Description
|
|
|
31
37
|
[**get_conversations_calls_history**](ConversationsApi.html#get_conversations_calls_history) | Get call history
|
|
32
38
|
[**get_conversations_calls_maximumconferenceparties**](ConversationsApi.html#get_conversations_calls_maximumconferenceparties) | Get the maximum number of participants that this user can have on a conference
|
|
33
39
|
[**get_conversations_chat**](ConversationsApi.html#get_conversations_chat) | Get chat conversation
|
|
40
|
+
[**get_conversations_chat_message**](ConversationsApi.html#get_conversations_chat_message) | Get a web chat conversation message
|
|
41
|
+
[**get_conversations_chat_messages**](ConversationsApi.html#get_conversations_chat_messages) | Get the messages of a chat conversation.
|
|
34
42
|
[**get_conversations_chat_participant_wrapup**](ConversationsApi.html#get_conversations_chat_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
35
43
|
[**get_conversations_chat_participant_wrapupcodes**](ConversationsApi.html#get_conversations_chat_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
36
44
|
[**get_conversations_chats**](ConversationsApi.html#get_conversations_chats) | Get active chat conversations for the logged in user
|
|
@@ -51,6 +59,16 @@ Method | Description
|
|
|
51
59
|
[**get_conversations_message_participant_wrapup**](ConversationsApi.html#get_conversations_message_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
52
60
|
[**get_conversations_message_participant_wrapupcodes**](ConversationsApi.html#get_conversations_message_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
53
61
|
[**get_conversations_messages**](ConversationsApi.html#get_conversations_messages) | Get active message conversations for the logged in user
|
|
62
|
+
[**get_conversations_messaging_integrations**](ConversationsApi.html#get_conversations_messaging_integrations) | Get a list of Integrations
|
|
63
|
+
[**get_conversations_messaging_integrations_facebook**](ConversationsApi.html#get_conversations_messaging_integrations_facebook) | Get a list of Facebook Integrations
|
|
64
|
+
[**get_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_facebook_integration_id) | Get a Facebook messaging integration
|
|
65
|
+
[**get_conversations_messaging_integrations_line**](ConversationsApi.html#get_conversations_messaging_integrations_line) | Get a list of LINE messenger Integrations
|
|
66
|
+
[**get_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
|
67
|
+
[**get_conversations_messaging_integrations_twitter**](ConversationsApi.html#get_conversations_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
|
68
|
+
[**get_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
|
69
|
+
[**get_conversations_messaging_integrations_whatsapp**](ConversationsApi.html#get_conversations_messaging_integrations_whatsapp) | Get a list of WhatsApp Integrations
|
|
70
|
+
[**get_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_whatsapp_integration_id) | Get a WhatsApp messaging integration
|
|
71
|
+
[**get_conversations_messaging_sticker**](ConversationsApi.html#get_conversations_messaging_sticker) | Get a list of Messaging Stickers
|
|
54
72
|
[**patch_conversation_participant**](ConversationsApi.html#patch_conversation_participant) | Update a participant.
|
|
55
73
|
[**patch_conversation_participant_attributes**](ConversationsApi.html#patch_conversation_participant_attributes) | Update the attributes on a conversation participant.
|
|
56
74
|
[**patch_conversations_call**](ConversationsApi.html#patch_conversations_call) | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
@@ -78,8 +96,10 @@ Method | Description
|
|
|
78
96
|
[**patch_conversations_message_participant**](ConversationsApi.html#patch_conversations_message_participant) | Update conversation participant
|
|
79
97
|
[**patch_conversations_message_participant_attributes**](ConversationsApi.html#patch_conversations_message_participant_attributes) | Update the attributes on a conversation participant.
|
|
80
98
|
[**patch_conversations_message_participant_communication**](ConversationsApi.html#patch_conversations_message_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
99
|
+
[**patch_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#patch_conversations_messaging_integrations_whatsapp_integration_id) | Activate a WhatsApp messaging integration.
|
|
81
100
|
[**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
82
101
|
[**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
102
|
+
[**post_analytics_conversations_details_jobs**](ConversationsApi.html#post_analytics_conversations_details_jobs) | Query for conversation details asynchronously
|
|
83
103
|
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
84
104
|
[**post_conversation_disconnect**](ConversationsApi.html#post_conversation_disconnect) | Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
85
105
|
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
@@ -94,6 +114,8 @@ Method | Description
|
|
|
94
114
|
[**post_conversations_callback_participant_replace**](ConversationsApi.html#post_conversations_callback_participant_replace) | Replace this participant with the specified user and/or address
|
|
95
115
|
[**post_conversations_callbacks**](ConversationsApi.html#post_conversations_callbacks) | Create a Callback
|
|
96
116
|
[**post_conversations_calls**](ConversationsApi.html#post_conversations_calls) | Create a call conversation
|
|
117
|
+
[**post_conversations_chat_communication_messages**](ConversationsApi.html#post_conversations_chat_communication_messages) | Send a message on behalf of a communication in a chat conversation.
|
|
118
|
+
[**post_conversations_chat_communication_typing**](ConversationsApi.html#post_conversations_chat_communication_typing) | Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
97
119
|
[**post_conversations_chat_participant_replace**](ConversationsApi.html#post_conversations_chat_participant_replace) | Replace this participant with the specified user and/or address
|
|
98
120
|
[**post_conversations_chats**](ConversationsApi.html#post_conversations_chats) | Create a web chat conversation
|
|
99
121
|
[**post_conversations_cobrowsesession_participant_replace**](ConversationsApi.html#post_conversations_cobrowsesession_participant_replace) | Replace this participant with the specified user and/or address
|
|
@@ -107,11 +129,79 @@ Method | Description
|
|
|
107
129
|
[**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
|
|
108
130
|
[**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
|
|
109
131
|
[**post_conversations_messages**](ConversationsApi.html#post_conversations_messages) | Create an outbound messaging conversation.
|
|
132
|
+
[**post_conversations_messaging_integrations_facebook**](ConversationsApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
|
|
133
|
+
[**post_conversations_messaging_integrations_line**](ConversationsApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
|
|
134
|
+
[**post_conversations_messaging_integrations_twitter**](ConversationsApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
|
|
110
135
|
[**put_conversation_participant_flaggedreason**](ConversationsApi.html#put_conversation_participant_flaggedreason) | Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
111
136
|
[**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
|
|
112
137
|
[**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
|
|
138
|
+
[**put_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#put_conversations_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
|
113
139
|
{: class="table table-striped"}
|
|
114
140
|
|
|
141
|
+
<a name="delete_analytics_conversations_details_job"></a>
|
|
142
|
+
|
|
143
|
+
## delete_analytics_conversations_details_job(job_id)
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
Delete/cancel an async request
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
Wraps DELETE /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
152
|
+
|
|
153
|
+
Requires ANY permissions:
|
|
154
|
+
|
|
155
|
+
* analytics:conversationDetail:view
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Example
|
|
159
|
+
```{"language":"ruby"}
|
|
160
|
+
# load the gem
|
|
161
|
+
require 'purecloudplatformclientv2'
|
|
162
|
+
# setup authorization
|
|
163
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
164
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
165
|
+
environment = "mypurecloud.com"
|
|
166
|
+
|
|
167
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
168
|
+
|
|
169
|
+
PureCloud.configure do |config|
|
|
170
|
+
config.access_token = @authToken
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
174
|
+
|
|
175
|
+
job_id = "job_id_example" # String | jobId
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
begin
|
|
179
|
+
#Delete/cancel an async request
|
|
180
|
+
api_instance.delete_analytics_conversations_details_job(job_id)
|
|
181
|
+
rescue PureCloud::ApiError => e
|
|
182
|
+
puts "Exception when calling ConversationsApi->delete_analytics_conversations_details_job: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
Name | Type | Description | Notes
|
|
189
|
+
------------- | ------------- | ------------- | -------------
|
|
190
|
+
**job_id** | **String**| jobId | |
|
|
191
|
+
{: class="table table-striped"}
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### Return type
|
|
195
|
+
|
|
196
|
+
nil (empty response body)
|
|
197
|
+
|
|
198
|
+
### HTTP request headers
|
|
199
|
+
|
|
200
|
+
- **Content-Type**: application/json
|
|
201
|
+
- **Accept**: application/json
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
115
205
|
<a name="delete_conversation_participant_code"></a>
|
|
116
206
|
|
|
117
207
|
## delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
|
@@ -379,21 +469,21 @@ nil (empty response body)
|
|
|
379
469
|
|
|
380
470
|
|
|
381
471
|
|
|
382
|
-
<a name="
|
|
472
|
+
<a name="delete_conversations_messaging_integrations_facebook_integration_id"></a>
|
|
383
473
|
|
|
384
|
-
##
|
|
474
|
+
## delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
385
475
|
|
|
386
476
|
|
|
387
477
|
|
|
388
|
-
|
|
478
|
+
Delete a Facebook messaging integration
|
|
389
479
|
|
|
390
480
|
|
|
391
481
|
|
|
392
|
-
Wraps
|
|
482
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
|
393
483
|
|
|
394
484
|
Requires ANY permissions:
|
|
395
485
|
|
|
396
|
-
*
|
|
486
|
+
* messaging:integration:delete
|
|
397
487
|
|
|
398
488
|
|
|
399
489
|
### Example
|
|
@@ -413,15 +503,14 @@ end
|
|
|
413
503
|
|
|
414
504
|
api_instance = PureCloud::ConversationsApi.new
|
|
415
505
|
|
|
416
|
-
|
|
506
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
417
507
|
|
|
418
508
|
|
|
419
509
|
begin
|
|
420
|
-
#
|
|
421
|
-
|
|
422
|
-
p result
|
|
510
|
+
#Delete a Facebook messaging integration
|
|
511
|
+
api_instance.delete_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
423
512
|
rescue PureCloud::ApiError => e
|
|
424
|
-
puts "Exception when calling ConversationsApi->
|
|
513
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
|
425
514
|
end
|
|
426
515
|
```
|
|
427
516
|
|
|
@@ -429,13 +518,13 @@ end
|
|
|
429
518
|
|
|
430
519
|
Name | Type | Description | Notes
|
|
431
520
|
------------- | ------------- | ------------- | -------------
|
|
432
|
-
**
|
|
521
|
+
**integration_id** | **String**| Integration ID | |
|
|
433
522
|
{: class="table table-striped"}
|
|
434
523
|
|
|
435
524
|
|
|
436
525
|
### Return type
|
|
437
526
|
|
|
438
|
-
|
|
527
|
+
nil (empty response body)
|
|
439
528
|
|
|
440
529
|
### HTTP request headers
|
|
441
530
|
|
|
@@ -444,21 +533,21 @@ Name | Type | Description | Notes
|
|
|
444
533
|
|
|
445
534
|
|
|
446
535
|
|
|
447
|
-
<a name="
|
|
536
|
+
<a name="delete_conversations_messaging_integrations_line_integration_id"></a>
|
|
448
537
|
|
|
449
|
-
##
|
|
538
|
+
## delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
450
539
|
|
|
451
540
|
|
|
452
541
|
|
|
453
|
-
|
|
542
|
+
Delete a LINE messenger integration
|
|
454
543
|
|
|
455
544
|
|
|
456
545
|
|
|
457
|
-
Wraps
|
|
546
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
458
547
|
|
|
459
548
|
Requires ANY permissions:
|
|
460
549
|
|
|
461
|
-
*
|
|
550
|
+
* messaging:integration:delete
|
|
462
551
|
|
|
463
552
|
|
|
464
553
|
### Example
|
|
@@ -478,16 +567,14 @@ end
|
|
|
478
567
|
|
|
479
568
|
api_instance = PureCloud::ConversationsApi.new
|
|
480
569
|
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
}
|
|
570
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
571
|
+
|
|
484
572
|
|
|
485
573
|
begin
|
|
486
|
-
#
|
|
487
|
-
|
|
488
|
-
p result
|
|
574
|
+
#Delete a LINE messenger integration
|
|
575
|
+
api_instance.delete_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
489
576
|
rescue PureCloud::ApiError => e
|
|
490
|
-
puts "Exception when calling ConversationsApi->
|
|
577
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
491
578
|
end
|
|
492
579
|
```
|
|
493
580
|
|
|
@@ -495,13 +582,13 @@ end
|
|
|
495
582
|
|
|
496
583
|
Name | Type | Description | Notes
|
|
497
584
|
------------- | ------------- | ------------- | -------------
|
|
498
|
-
**
|
|
585
|
+
**integration_id** | **String**| Integration ID | |
|
|
499
586
|
{: class="table table-striped"}
|
|
500
587
|
|
|
501
588
|
|
|
502
589
|
### Return type
|
|
503
590
|
|
|
504
|
-
|
|
591
|
+
nil (empty response body)
|
|
505
592
|
|
|
506
593
|
### HTTP request headers
|
|
507
594
|
|
|
@@ -510,21 +597,21 @@ Name | Type | Description | Notes
|
|
|
510
597
|
|
|
511
598
|
|
|
512
599
|
|
|
513
|
-
<a name="
|
|
600
|
+
<a name="delete_conversations_messaging_integrations_twitter_integration_id"></a>
|
|
514
601
|
|
|
515
|
-
##
|
|
602
|
+
## delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
516
603
|
|
|
517
604
|
|
|
518
605
|
|
|
519
|
-
|
|
606
|
+
Delete a Twitter messaging integration
|
|
520
607
|
|
|
521
608
|
|
|
522
609
|
|
|
523
|
-
Wraps
|
|
610
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
|
524
611
|
|
|
525
612
|
Requires ANY permissions:
|
|
526
613
|
|
|
527
|
-
*
|
|
614
|
+
* messaging:integration:delete
|
|
528
615
|
|
|
529
616
|
|
|
530
617
|
### Example
|
|
@@ -544,15 +631,14 @@ end
|
|
|
544
631
|
|
|
545
632
|
api_instance = PureCloud::ConversationsApi.new
|
|
546
633
|
|
|
547
|
-
|
|
634
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
548
635
|
|
|
549
636
|
|
|
550
637
|
begin
|
|
551
|
-
#
|
|
552
|
-
|
|
553
|
-
p result
|
|
638
|
+
#Delete a Twitter messaging integration
|
|
639
|
+
api_instance.delete_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
554
640
|
rescue PureCloud::ApiError => e
|
|
555
|
-
puts "Exception when calling ConversationsApi->
|
|
641
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
|
556
642
|
end
|
|
557
643
|
```
|
|
558
644
|
|
|
@@ -560,13 +646,13 @@ end
|
|
|
560
646
|
|
|
561
647
|
Name | Type | Description | Notes
|
|
562
648
|
------------- | ------------- | ------------- | -------------
|
|
563
|
-
**
|
|
649
|
+
**integration_id** | **String**| Integration ID | |
|
|
564
650
|
{: class="table table-striped"}
|
|
565
651
|
|
|
566
652
|
|
|
567
653
|
### Return type
|
|
568
654
|
|
|
569
|
-
|
|
655
|
+
nil (empty response body)
|
|
570
656
|
|
|
571
657
|
### HTTP request headers
|
|
572
658
|
|
|
@@ -575,20 +661,21 @@ Name | Type | Description | Notes
|
|
|
575
661
|
|
|
576
662
|
|
|
577
663
|
|
|
578
|
-
<a name="
|
|
664
|
+
<a name="get_analytics_conversation_details"></a>
|
|
579
665
|
|
|
580
|
-
## [**
|
|
666
|
+
## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
|
581
667
|
|
|
582
668
|
|
|
583
669
|
|
|
584
|
-
|
|
670
|
+
Get a conversation by id
|
|
585
671
|
|
|
586
672
|
|
|
587
673
|
|
|
588
|
-
Wraps GET /api/v2/conversations/{conversationId}/
|
|
674
|
+
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
589
675
|
|
|
590
|
-
Requires
|
|
676
|
+
Requires ANY permissions:
|
|
591
677
|
|
|
678
|
+
* analytics:conversationDetail:view
|
|
592
679
|
|
|
593
680
|
|
|
594
681
|
### Example
|
|
@@ -608,19 +695,15 @@ end
|
|
|
608
695
|
|
|
609
696
|
api_instance = PureCloud::ConversationsApi.new
|
|
610
697
|
|
|
611
|
-
conversation_id = "conversation_id_example" # String |
|
|
612
|
-
|
|
613
|
-
participant_id = "participant_id_example" # String | participant ID
|
|
614
|
-
|
|
615
|
-
secure_session_id = "secure_session_id_example" # String | secure IVR session ID
|
|
698
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
616
699
|
|
|
617
700
|
|
|
618
701
|
begin
|
|
619
|
-
#
|
|
620
|
-
result = api_instance.
|
|
702
|
+
#Get a conversation by id
|
|
703
|
+
result = api_instance.get_analytics_conversation_details(conversation_id)
|
|
621
704
|
p result
|
|
622
705
|
rescue PureCloud::ApiError => e
|
|
623
|
-
puts "Exception when calling ConversationsApi->
|
|
706
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversation_details: #{e}"
|
|
624
707
|
end
|
|
625
708
|
```
|
|
626
709
|
|
|
@@ -628,15 +711,13 @@ end
|
|
|
628
711
|
|
|
629
712
|
Name | Type | Description | Notes
|
|
630
713
|
------------- | ------------- | ------------- | -------------
|
|
631
|
-
**conversation_id** | **String**|
|
|
632
|
-
**participant_id** | **String**| participant ID | |
|
|
633
|
-
**secure_session_id** | **String**| secure IVR session ID | |
|
|
714
|
+
**conversation_id** | **String**| conversationId | |
|
|
634
715
|
{: class="table table-striped"}
|
|
635
716
|
|
|
636
717
|
|
|
637
718
|
### Return type
|
|
638
719
|
|
|
639
|
-
[**
|
|
720
|
+
[**AnalyticsConversation**](AnalyticsConversation.html)
|
|
640
721
|
|
|
641
722
|
### HTTP request headers
|
|
642
723
|
|
|
@@ -645,20 +726,21 @@ Name | Type | Description | Notes
|
|
|
645
726
|
|
|
646
727
|
|
|
647
728
|
|
|
648
|
-
<a name="
|
|
729
|
+
<a name="get_analytics_conversations_details"></a>
|
|
649
730
|
|
|
650
|
-
## [**
|
|
731
|
+
## [**AnalyticsConversationMultiGetResponse**](AnalyticsConversationMultiGetResponse.html) get_analytics_conversations_details(opts)
|
|
651
732
|
|
|
652
733
|
|
|
653
734
|
|
|
654
|
-
|
|
735
|
+
Gets multiple conversations by id
|
|
655
736
|
|
|
656
737
|
|
|
657
738
|
|
|
658
|
-
Wraps GET /api/v2/conversations/
|
|
739
|
+
Wraps GET /api/v2/analytics/conversations/details
|
|
659
740
|
|
|
660
|
-
Requires
|
|
741
|
+
Requires ANY permissions:
|
|
661
742
|
|
|
743
|
+
* analytics:conversationDetail:view
|
|
662
744
|
|
|
663
745
|
|
|
664
746
|
### Example
|
|
@@ -678,17 +760,16 @@ end
|
|
|
678
760
|
|
|
679
761
|
api_instance = PureCloud::ConversationsApi.new
|
|
680
762
|
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
763
|
+
opts = {
|
|
764
|
+
id: ["id_example"] # Array<String> | Comma-separated conversation ids
|
|
765
|
+
}
|
|
685
766
|
|
|
686
767
|
begin
|
|
687
|
-
#
|
|
688
|
-
result = api_instance.
|
|
768
|
+
#Gets multiple conversations by id
|
|
769
|
+
result = api_instance.get_analytics_conversations_details(opts)
|
|
689
770
|
p result
|
|
690
771
|
rescue PureCloud::ApiError => e
|
|
691
|
-
puts "Exception when calling ConversationsApi->
|
|
772
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversations_details: #{e}"
|
|
692
773
|
end
|
|
693
774
|
```
|
|
694
775
|
|
|
@@ -696,14 +777,13 @@ end
|
|
|
696
777
|
|
|
697
778
|
Name | Type | Description | Notes
|
|
698
779
|
------------- | ------------- | ------------- | -------------
|
|
699
|
-
**
|
|
700
|
-
**participant_id** | **String**| participant ID | |
|
|
780
|
+
**id** | [**Array<String>**](String.html)| Comma-separated conversation ids | [optional] |
|
|
701
781
|
{: class="table table-striped"}
|
|
702
782
|
|
|
703
783
|
|
|
704
784
|
### Return type
|
|
705
785
|
|
|
706
|
-
[**
|
|
786
|
+
[**AnalyticsConversationMultiGetResponse**](AnalyticsConversationMultiGetResponse.html)
|
|
707
787
|
|
|
708
788
|
### HTTP request headers
|
|
709
789
|
|
|
@@ -712,20 +792,21 @@ Name | Type | Description | Notes
|
|
|
712
792
|
|
|
713
793
|
|
|
714
794
|
|
|
715
|
-
<a name="
|
|
795
|
+
<a name="get_analytics_conversations_details_job"></a>
|
|
716
796
|
|
|
717
|
-
## [**
|
|
797
|
+
## [**AsyncQueryStatus**](AsyncQueryStatus.html) get_analytics_conversations_details_job(job_id)
|
|
718
798
|
|
|
719
799
|
|
|
720
800
|
|
|
721
|
-
Get
|
|
801
|
+
Get status for async query for conversation details
|
|
722
802
|
|
|
723
803
|
|
|
724
804
|
|
|
725
|
-
Wraps GET /api/v2/conversations/
|
|
805
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
726
806
|
|
|
727
|
-
Requires
|
|
807
|
+
Requires ANY permissions:
|
|
728
808
|
|
|
809
|
+
* analytics:conversationDetail:view
|
|
729
810
|
|
|
730
811
|
|
|
731
812
|
### Example
|
|
@@ -745,20 +826,15 @@ end
|
|
|
745
826
|
|
|
746
827
|
api_instance = PureCloud::ConversationsApi.new
|
|
747
828
|
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
participant_id = "participant_id_example" # String | participant ID
|
|
829
|
+
job_id = "job_id_example" # String | jobId
|
|
751
830
|
|
|
752
|
-
opts = {
|
|
753
|
-
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
754
|
-
}
|
|
755
831
|
|
|
756
832
|
begin
|
|
757
|
-
#Get
|
|
758
|
-
result = api_instance.
|
|
833
|
+
#Get status for async query for conversation details
|
|
834
|
+
result = api_instance.get_analytics_conversations_details_job(job_id)
|
|
759
835
|
p result
|
|
760
836
|
rescue PureCloud::ApiError => e
|
|
761
|
-
puts "Exception when calling ConversationsApi->
|
|
837
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversations_details_job: #{e}"
|
|
762
838
|
end
|
|
763
839
|
```
|
|
764
840
|
|
|
@@ -766,15 +842,13 @@ end
|
|
|
766
842
|
|
|
767
843
|
Name | Type | Description | Notes
|
|
768
844
|
------------- | ------------- | ------------- | -------------
|
|
769
|
-
**
|
|
770
|
-
**participant_id** | **String**| participant ID | |
|
|
771
|
-
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
845
|
+
**job_id** | **String**| jobId | |
|
|
772
846
|
{: class="table table-striped"}
|
|
773
847
|
|
|
774
848
|
|
|
775
849
|
### Return type
|
|
776
850
|
|
|
777
|
-
[**
|
|
851
|
+
[**AsyncQueryStatus**](AsyncQueryStatus.html)
|
|
778
852
|
|
|
779
853
|
### HTTP request headers
|
|
780
854
|
|
|
@@ -783,20 +857,21 @@ Name | Type | Description | Notes
|
|
|
783
857
|
|
|
784
858
|
|
|
785
859
|
|
|
786
|
-
<a name="
|
|
860
|
+
<a name="get_analytics_conversations_details_job_results"></a>
|
|
787
861
|
|
|
788
|
-
## [**
|
|
862
|
+
## [**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html) get_analytics_conversations_details_job_results(job_id, opts)
|
|
789
863
|
|
|
790
864
|
|
|
791
865
|
|
|
792
|
-
|
|
866
|
+
Fetch a page of results for an async query
|
|
793
867
|
|
|
794
868
|
|
|
795
869
|
|
|
796
|
-
Wraps GET /api/v2/conversations/
|
|
870
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}/results
|
|
797
871
|
|
|
798
|
-
Requires
|
|
872
|
+
Requires ANY permissions:
|
|
799
873
|
|
|
874
|
+
* analytics:conversationDetail:view
|
|
800
875
|
|
|
801
876
|
|
|
802
877
|
### Example
|
|
@@ -816,17 +891,18 @@ end
|
|
|
816
891
|
|
|
817
892
|
api_instance = PureCloud::ConversationsApi.new
|
|
818
893
|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
participant_id = "participant_id_example" # String | participant ID
|
|
894
|
+
job_id = "job_id_example" # String | jobId
|
|
822
895
|
|
|
896
|
+
opts = {
|
|
897
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
|
|
898
|
+
}
|
|
823
899
|
|
|
824
900
|
begin
|
|
825
|
-
#
|
|
826
|
-
result = api_instance.
|
|
901
|
+
#Fetch a page of results for an async query
|
|
902
|
+
result = api_instance.get_analytics_conversations_details_job_results(job_id, opts)
|
|
827
903
|
p result
|
|
828
904
|
rescue PureCloud::ApiError => e
|
|
829
|
-
puts "Exception when calling ConversationsApi->
|
|
905
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: #{e}"
|
|
830
906
|
end
|
|
831
907
|
```
|
|
832
908
|
|
|
@@ -834,14 +910,14 @@ end
|
|
|
834
910
|
|
|
835
911
|
Name | Type | Description | Notes
|
|
836
912
|
------------- | ------------- | ------------- | -------------
|
|
837
|
-
**
|
|
838
|
-
**
|
|
913
|
+
**job_id** | **String**| jobId | |
|
|
914
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
|
|
839
915
|
{: class="table table-striped"}
|
|
840
916
|
|
|
841
917
|
|
|
842
918
|
### Return type
|
|
843
919
|
|
|
844
|
-
[**
|
|
920
|
+
[**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html)
|
|
845
921
|
|
|
846
922
|
### HTTP request headers
|
|
847
923
|
|
|
@@ -850,20 +926,21 @@ Name | Type | Description | Notes
|
|
|
850
926
|
|
|
851
927
|
|
|
852
928
|
|
|
853
|
-
<a name="
|
|
929
|
+
<a name="get_conversation"></a>
|
|
854
930
|
|
|
855
|
-
## [**
|
|
931
|
+
## [**Conversation**](Conversation.html) get_conversation(conversation_id)
|
|
856
932
|
|
|
857
933
|
|
|
858
934
|
|
|
859
|
-
Get
|
|
935
|
+
Get conversation
|
|
860
936
|
|
|
861
937
|
|
|
862
938
|
|
|
863
|
-
Wraps GET /api/v2/conversations
|
|
939
|
+
Wraps GET /api/v2/conversations/{conversationId}
|
|
864
940
|
|
|
865
|
-
Requires
|
|
941
|
+
Requires ANY permissions:
|
|
866
942
|
|
|
943
|
+
* conversation:communication:view
|
|
867
944
|
|
|
868
945
|
|
|
869
946
|
### Example
|
|
@@ -883,16 +960,15 @@ end
|
|
|
883
960
|
|
|
884
961
|
api_instance = PureCloud::ConversationsApi.new
|
|
885
962
|
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
}
|
|
963
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
964
|
+
|
|
889
965
|
|
|
890
966
|
begin
|
|
891
|
-
#Get
|
|
892
|
-
result = api_instance.
|
|
967
|
+
#Get conversation
|
|
968
|
+
result = api_instance.get_conversation(conversation_id)
|
|
893
969
|
p result
|
|
894
970
|
rescue PureCloud::ApiError => e
|
|
895
|
-
puts "Exception when calling ConversationsApi->
|
|
971
|
+
puts "Exception when calling ConversationsApi->get_conversation: #{e}"
|
|
896
972
|
end
|
|
897
973
|
```
|
|
898
974
|
|
|
@@ -900,13 +976,13 @@ end
|
|
|
900
976
|
|
|
901
977
|
Name | Type | Description | Notes
|
|
902
978
|
------------- | ------------- | ------------- | -------------
|
|
903
|
-
**
|
|
979
|
+
**conversation_id** | **String**| conversation ID | |
|
|
904
980
|
{: class="table table-striped"}
|
|
905
981
|
|
|
906
982
|
|
|
907
983
|
### Return type
|
|
908
984
|
|
|
909
|
-
[**
|
|
985
|
+
[**Conversation**](Conversation.html)
|
|
910
986
|
|
|
911
987
|
### HTTP request headers
|
|
912
988
|
|
|
@@ -915,17 +991,17 @@ Name | Type | Description | Notes
|
|
|
915
991
|
|
|
916
992
|
|
|
917
993
|
|
|
918
|
-
<a name="
|
|
994
|
+
<a name="get_conversation_participant_secureivrsession"></a>
|
|
919
995
|
|
|
920
|
-
## [**
|
|
996
|
+
## [**SecureSession**](SecureSession.html) get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
|
921
997
|
|
|
922
998
|
|
|
923
999
|
|
|
924
|
-
|
|
1000
|
+
Fetch info on a secure session
|
|
925
1001
|
|
|
926
1002
|
|
|
927
1003
|
|
|
928
|
-
Wraps GET /api/v2/conversations/
|
|
1004
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}
|
|
929
1005
|
|
|
930
1006
|
Requires NO permissions:
|
|
931
1007
|
|
|
@@ -948,15 +1024,19 @@ end
|
|
|
948
1024
|
|
|
949
1025
|
api_instance = PureCloud::ConversationsApi.new
|
|
950
1026
|
|
|
951
|
-
conversation_id = "conversation_id_example" # String |
|
|
1027
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
1028
|
+
|
|
1029
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
1030
|
+
|
|
1031
|
+
secure_session_id = "secure_session_id_example" # String | secure IVR session ID
|
|
952
1032
|
|
|
953
1033
|
|
|
954
1034
|
begin
|
|
955
|
-
#
|
|
956
|
-
result = api_instance.
|
|
1035
|
+
#Fetch info on a secure session
|
|
1036
|
+
result = api_instance.get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
|
957
1037
|
p result
|
|
958
1038
|
rescue PureCloud::ApiError => e
|
|
959
|
-
puts "Exception when calling ConversationsApi->
|
|
1039
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsession: #{e}"
|
|
960
1040
|
end
|
|
961
1041
|
```
|
|
962
1042
|
|
|
@@ -964,13 +1044,15 @@ end
|
|
|
964
1044
|
|
|
965
1045
|
Name | Type | Description | Notes
|
|
966
1046
|
------------- | ------------- | ------------- | -------------
|
|
967
|
-
**conversation_id** | **String**|
|
|
1047
|
+
**conversation_id** | **String**| conversation ID | |
|
|
1048
|
+
**participant_id** | **String**| participant ID | |
|
|
1049
|
+
**secure_session_id** | **String**| secure IVR session ID | |
|
|
968
1050
|
{: class="table table-striped"}
|
|
969
1051
|
|
|
970
1052
|
|
|
971
1053
|
### Return type
|
|
972
1054
|
|
|
973
|
-
[**
|
|
1055
|
+
[**SecureSession**](SecureSession.html)
|
|
974
1056
|
|
|
975
1057
|
### HTTP request headers
|
|
976
1058
|
|
|
@@ -979,17 +1061,17 @@ Name | Type | Description | Notes
|
|
|
979
1061
|
|
|
980
1062
|
|
|
981
1063
|
|
|
982
|
-
<a name="
|
|
1064
|
+
<a name="get_conversation_participant_secureivrsessions"></a>
|
|
983
1065
|
|
|
984
|
-
## [**
|
|
1066
|
+
## [**SecureSessionEntityListing**](SecureSessionEntityListing.html) get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
|
985
1067
|
|
|
986
1068
|
|
|
987
1069
|
|
|
988
|
-
Get
|
|
1070
|
+
Get a list of secure sessions for this participant.
|
|
989
1071
|
|
|
990
1072
|
|
|
991
1073
|
|
|
992
|
-
Wraps GET /api/v2/conversations/
|
|
1074
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
|
|
993
1075
|
|
|
994
1076
|
Requires NO permissions:
|
|
995
1077
|
|
|
@@ -1012,9 +1094,76 @@ end
|
|
|
1012
1094
|
|
|
1013
1095
|
api_instance = PureCloud::ConversationsApi.new
|
|
1014
1096
|
|
|
1015
|
-
conversation_id = "conversation_id_example" # String |
|
|
1097
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
1016
1098
|
|
|
1017
|
-
participant_id = "participant_id_example" # String |
|
|
1099
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
begin
|
|
1103
|
+
#Get a list of secure sessions for this participant.
|
|
1104
|
+
result = api_instance.get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
|
1105
|
+
p result
|
|
1106
|
+
rescue PureCloud::ApiError => e
|
|
1107
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_secureivrsessions: #{e}"
|
|
1108
|
+
end
|
|
1109
|
+
```
|
|
1110
|
+
|
|
1111
|
+
### Parameters
|
|
1112
|
+
|
|
1113
|
+
Name | Type | Description | Notes
|
|
1114
|
+
------------- | ------------- | ------------- | -------------
|
|
1115
|
+
**conversation_id** | **String**| conversation ID | |
|
|
1116
|
+
**participant_id** | **String**| participant ID | |
|
|
1117
|
+
{: class="table table-striped"}
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
### Return type
|
|
1121
|
+
|
|
1122
|
+
[**SecureSessionEntityListing**](SecureSessionEntityListing.html)
|
|
1123
|
+
|
|
1124
|
+
### HTTP request headers
|
|
1125
|
+
|
|
1126
|
+
- **Content-Type**: application/json
|
|
1127
|
+
- **Accept**: application/json
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
<a name="get_conversation_participant_wrapup"></a>
|
|
1132
|
+
|
|
1133
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
Get the wrap-up for this conversation participant.
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup
|
|
1142
|
+
|
|
1143
|
+
Requires NO permissions:
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
### Example
|
|
1148
|
+
```{"language":"ruby"}
|
|
1149
|
+
# load the gem
|
|
1150
|
+
require 'purecloudplatformclientv2'
|
|
1151
|
+
# setup authorization
|
|
1152
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1153
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1154
|
+
environment = "mypurecloud.com"
|
|
1155
|
+
|
|
1156
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1157
|
+
|
|
1158
|
+
PureCloud.configure do |config|
|
|
1159
|
+
config.access_token = @authToken
|
|
1160
|
+
end
|
|
1161
|
+
|
|
1162
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1163
|
+
|
|
1164
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
1165
|
+
|
|
1166
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
1018
1167
|
|
|
1019
1168
|
opts = {
|
|
1020
1169
|
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
@@ -1022,10 +1171,10 @@ opts = {
|
|
|
1022
1171
|
|
|
1023
1172
|
begin
|
|
1024
1173
|
#Get the wrap-up for this conversation participant.
|
|
1025
|
-
result = api_instance.
|
|
1174
|
+
result = api_instance.get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
1026
1175
|
p result
|
|
1027
1176
|
rescue PureCloud::ApiError => e
|
|
1028
|
-
puts "Exception when calling ConversationsApi->
|
|
1177
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapup: #{e}"
|
|
1029
1178
|
end
|
|
1030
1179
|
```
|
|
1031
1180
|
|
|
@@ -1033,8 +1182,8 @@ end
|
|
|
1033
1182
|
|
|
1034
1183
|
Name | Type | Description | Notes
|
|
1035
1184
|
------------- | ------------- | ------------- | -------------
|
|
1036
|
-
**conversation_id** | **String**|
|
|
1037
|
-
**participant_id** | **String**|
|
|
1185
|
+
**conversation_id** | **String**| conversation ID | |
|
|
1186
|
+
**participant_id** | **String**| participant ID | |
|
|
1038
1187
|
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
1039
1188
|
{: class="table table-striped"}
|
|
1040
1189
|
|
|
@@ -1050,9 +1199,9 @@ Name | Type | Description | Notes
|
|
|
1050
1199
|
|
|
1051
1200
|
|
|
1052
1201
|
|
|
1053
|
-
<a name="
|
|
1202
|
+
<a name="get_conversation_participant_wrapupcodes"></a>
|
|
1054
1203
|
|
|
1055
|
-
## [**Array<WrapupCode>**](WrapupCode.html)
|
|
1204
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
|
1056
1205
|
|
|
1057
1206
|
|
|
1058
1207
|
|
|
@@ -1060,7 +1209,7 @@ Get list of wrapup codes for this conversation participant
|
|
|
1060
1209
|
|
|
1061
1210
|
|
|
1062
1211
|
|
|
1063
|
-
Wraps GET /api/v2/conversations/
|
|
1212
|
+
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1064
1213
|
|
|
1065
1214
|
Requires NO permissions:
|
|
1066
1215
|
|
|
@@ -1083,17 +1232,17 @@ end
|
|
|
1083
1232
|
|
|
1084
1233
|
api_instance = PureCloud::ConversationsApi.new
|
|
1085
1234
|
|
|
1086
|
-
conversation_id = "conversation_id_example" # String |
|
|
1235
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
1087
1236
|
|
|
1088
|
-
participant_id = "participant_id_example" # String |
|
|
1237
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
1089
1238
|
|
|
1090
1239
|
|
|
1091
1240
|
begin
|
|
1092
1241
|
#Get list of wrapup codes for this conversation participant
|
|
1093
|
-
result = api_instance.
|
|
1242
|
+
result = api_instance.get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
|
1094
1243
|
p result
|
|
1095
1244
|
rescue PureCloud::ApiError => e
|
|
1096
|
-
puts "Exception when calling ConversationsApi->
|
|
1245
|
+
puts "Exception when calling ConversationsApi->get_conversation_participant_wrapupcodes: #{e}"
|
|
1097
1246
|
end
|
|
1098
1247
|
```
|
|
1099
1248
|
|
|
@@ -1101,8 +1250,8 @@ end
|
|
|
1101
1250
|
|
|
1102
1251
|
Name | Type | Description | Notes
|
|
1103
1252
|
------------- | ------------- | ------------- | -------------
|
|
1104
|
-
**conversation_id** | **String**|
|
|
1105
|
-
**participant_id** | **String**|
|
|
1253
|
+
**conversation_id** | **String**| conversation ID | |
|
|
1254
|
+
**participant_id** | **String**| participant ID | |
|
|
1106
1255
|
{: class="table table-striped"}
|
|
1107
1256
|
|
|
1108
1257
|
|
|
@@ -1117,17 +1266,82 @@ Name | Type | Description | Notes
|
|
|
1117
1266
|
|
|
1118
1267
|
|
|
1119
1268
|
|
|
1120
|
-
<a name="
|
|
1269
|
+
<a name="get_conversations"></a>
|
|
1121
1270
|
|
|
1122
|
-
## [**
|
|
1271
|
+
## [**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
|
1123
1272
|
|
|
1124
1273
|
|
|
1125
1274
|
|
|
1126
|
-
Get
|
|
1275
|
+
Get active conversations for the logged in user
|
|
1127
1276
|
|
|
1128
1277
|
|
|
1129
1278
|
|
|
1130
|
-
Wraps GET /api/v2/conversations
|
|
1279
|
+
Wraps GET /api/v2/conversations
|
|
1280
|
+
|
|
1281
|
+
Requires NO permissions:
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
### Example
|
|
1286
|
+
```{"language":"ruby"}
|
|
1287
|
+
# load the gem
|
|
1288
|
+
require 'purecloudplatformclientv2'
|
|
1289
|
+
# setup authorization
|
|
1290
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1291
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1292
|
+
environment = "mypurecloud.com"
|
|
1293
|
+
|
|
1294
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1295
|
+
|
|
1296
|
+
PureCloud.configure do |config|
|
|
1297
|
+
config.access_token = @authToken
|
|
1298
|
+
end
|
|
1299
|
+
|
|
1300
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1301
|
+
|
|
1302
|
+
opts = {
|
|
1303
|
+
communication_type: "communication_type_example" # String | Call or Chat communication filtering
|
|
1304
|
+
}
|
|
1305
|
+
|
|
1306
|
+
begin
|
|
1307
|
+
#Get active conversations for the logged in user
|
|
1308
|
+
result = api_instance.get_conversations(opts)
|
|
1309
|
+
p result
|
|
1310
|
+
rescue PureCloud::ApiError => e
|
|
1311
|
+
puts "Exception when calling ConversationsApi->get_conversations: #{e}"
|
|
1312
|
+
end
|
|
1313
|
+
```
|
|
1314
|
+
|
|
1315
|
+
### Parameters
|
|
1316
|
+
|
|
1317
|
+
Name | Type | Description | Notes
|
|
1318
|
+
------------- | ------------- | ------------- | -------------
|
|
1319
|
+
**communication_type** | **String**| Call or Chat communication filtering | [optional] |
|
|
1320
|
+
{: class="table table-striped"}
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
### Return type
|
|
1324
|
+
|
|
1325
|
+
[**ConversationEntityListing**](ConversationEntityListing.html)
|
|
1326
|
+
|
|
1327
|
+
### HTTP request headers
|
|
1328
|
+
|
|
1329
|
+
- **Content-Type**: application/json
|
|
1330
|
+
- **Accept**: application/json
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
<a name="get_conversations_call"></a>
|
|
1335
|
+
|
|
1336
|
+
## [**CallConversation**](CallConversation.html) get_conversations_call(conversation_id)
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
Get call conversation
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}
|
|
1131
1345
|
|
|
1132
1346
|
Requires NO permissions:
|
|
1133
1347
|
|
|
@@ -1154,11 +1368,11 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
1154
1368
|
|
|
1155
1369
|
|
|
1156
1370
|
begin
|
|
1157
|
-
#Get
|
|
1158
|
-
result = api_instance.
|
|
1371
|
+
#Get call conversation
|
|
1372
|
+
result = api_instance.get_conversations_call(conversation_id)
|
|
1159
1373
|
p result
|
|
1160
1374
|
rescue PureCloud::ApiError => e
|
|
1161
|
-
puts "Exception when calling ConversationsApi->
|
|
1375
|
+
puts "Exception when calling ConversationsApi->get_conversations_call: #{e}"
|
|
1162
1376
|
end
|
|
1163
1377
|
```
|
|
1164
1378
|
|
|
@@ -1172,7 +1386,7 @@ Name | Type | Description | Notes
|
|
|
1172
1386
|
|
|
1173
1387
|
### Return type
|
|
1174
1388
|
|
|
1175
|
-
[**
|
|
1389
|
+
[**CallConversation**](CallConversation.html)
|
|
1176
1390
|
|
|
1177
1391
|
### HTTP request headers
|
|
1178
1392
|
|
|
@@ -1181,9 +1395,9 @@ Name | Type | Description | Notes
|
|
|
1181
1395
|
|
|
1182
1396
|
|
|
1183
1397
|
|
|
1184
|
-
<a name="
|
|
1398
|
+
<a name="get_conversations_call_participant_wrapup"></a>
|
|
1185
1399
|
|
|
1186
|
-
## [**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1400
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
|
1187
1401
|
|
|
1188
1402
|
|
|
1189
1403
|
|
|
@@ -1191,7 +1405,7 @@ Get the wrap-up for this conversation participant.
|
|
|
1191
1405
|
|
|
1192
1406
|
|
|
1193
1407
|
|
|
1194
|
-
Wraps GET /api/v2/conversations/
|
|
1408
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup
|
|
1195
1409
|
|
|
1196
1410
|
Requires NO permissions:
|
|
1197
1411
|
|
|
@@ -1224,10 +1438,10 @@ opts = {
|
|
|
1224
1438
|
|
|
1225
1439
|
begin
|
|
1226
1440
|
#Get the wrap-up for this conversation participant.
|
|
1227
|
-
result = api_instance.
|
|
1441
|
+
result = api_instance.get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
|
1228
1442
|
p result
|
|
1229
1443
|
rescue PureCloud::ApiError => e
|
|
1230
|
-
puts "Exception when calling ConversationsApi->
|
|
1444
|
+
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapup: #{e}"
|
|
1231
1445
|
end
|
|
1232
1446
|
```
|
|
1233
1447
|
|
|
@@ -1252,9 +1466,9 @@ Name | Type | Description | Notes
|
|
|
1252
1466
|
|
|
1253
1467
|
|
|
1254
1468
|
|
|
1255
|
-
<a name="
|
|
1469
|
+
<a name="get_conversations_call_participant_wrapupcodes"></a>
|
|
1256
1470
|
|
|
1257
|
-
## [**Array<WrapupCode>**](WrapupCode.html)
|
|
1471
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
|
1258
1472
|
|
|
1259
1473
|
|
|
1260
1474
|
|
|
@@ -1262,7 +1476,7 @@ Get list of wrapup codes for this conversation participant
|
|
|
1262
1476
|
|
|
1263
1477
|
|
|
1264
1478
|
|
|
1265
|
-
Wraps GET /api/v2/conversations/
|
|
1479
|
+
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1266
1480
|
|
|
1267
1481
|
Requires NO permissions:
|
|
1268
1482
|
|
|
@@ -1292,10 +1506,10 @@ participant_id = "participant_id_example" # String | participantId
|
|
|
1292
1506
|
|
|
1293
1507
|
begin
|
|
1294
1508
|
#Get list of wrapup codes for this conversation participant
|
|
1295
|
-
result = api_instance.
|
|
1509
|
+
result = api_instance.get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
|
1296
1510
|
p result
|
|
1297
1511
|
rescue PureCloud::ApiError => e
|
|
1298
|
-
puts "Exception when calling ConversationsApi->
|
|
1512
|
+
puts "Exception when calling ConversationsApi->get_conversations_call_participant_wrapupcodes: #{e}"
|
|
1299
1513
|
end
|
|
1300
1514
|
```
|
|
1301
1515
|
|
|
@@ -1319,17 +1533,1000 @@ Name | Type | Description | Notes
|
|
|
1319
1533
|
|
|
1320
1534
|
|
|
1321
1535
|
|
|
1322
|
-
<a name="
|
|
1536
|
+
<a name="get_conversations_callback"></a>
|
|
1537
|
+
|
|
1538
|
+
## [**CallbackConversation**](CallbackConversation.html) get_conversations_callback(conversation_id)
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
Get callback conversation
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}
|
|
1547
|
+
|
|
1548
|
+
Requires NO permissions:
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
### Example
|
|
1553
|
+
```{"language":"ruby"}
|
|
1554
|
+
# load the gem
|
|
1555
|
+
require 'purecloudplatformclientv2'
|
|
1556
|
+
# setup authorization
|
|
1557
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1558
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1559
|
+
environment = "mypurecloud.com"
|
|
1560
|
+
|
|
1561
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1562
|
+
|
|
1563
|
+
PureCloud.configure do |config|
|
|
1564
|
+
config.access_token = @authToken
|
|
1565
|
+
end
|
|
1566
|
+
|
|
1567
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1568
|
+
|
|
1569
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
begin
|
|
1573
|
+
#Get callback conversation
|
|
1574
|
+
result = api_instance.get_conversations_callback(conversation_id)
|
|
1575
|
+
p result
|
|
1576
|
+
rescue PureCloud::ApiError => e
|
|
1577
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback: #{e}"
|
|
1578
|
+
end
|
|
1579
|
+
```
|
|
1580
|
+
|
|
1581
|
+
### Parameters
|
|
1582
|
+
|
|
1583
|
+
Name | Type | Description | Notes
|
|
1584
|
+
------------- | ------------- | ------------- | -------------
|
|
1585
|
+
**conversation_id** | **String**| conversationId | |
|
|
1586
|
+
{: class="table table-striped"}
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
### Return type
|
|
1590
|
+
|
|
1591
|
+
[**CallbackConversation**](CallbackConversation.html)
|
|
1592
|
+
|
|
1593
|
+
### HTTP request headers
|
|
1594
|
+
|
|
1595
|
+
- **Content-Type**: application/json
|
|
1596
|
+
- **Accept**: application/json
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<a name="get_conversations_callback_participant_wrapup"></a>
|
|
1601
|
+
|
|
1602
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
Get the wrap-up for this conversation participant.
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup
|
|
1611
|
+
|
|
1612
|
+
Requires NO permissions:
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
### Example
|
|
1617
|
+
```{"language":"ruby"}
|
|
1618
|
+
# load the gem
|
|
1619
|
+
require 'purecloudplatformclientv2'
|
|
1620
|
+
# setup authorization
|
|
1621
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1622
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1623
|
+
environment = "mypurecloud.com"
|
|
1624
|
+
|
|
1625
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1626
|
+
|
|
1627
|
+
PureCloud.configure do |config|
|
|
1628
|
+
config.access_token = @authToken
|
|
1629
|
+
end
|
|
1630
|
+
|
|
1631
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1632
|
+
|
|
1633
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1634
|
+
|
|
1635
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1636
|
+
|
|
1637
|
+
opts = {
|
|
1638
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1639
|
+
}
|
|
1640
|
+
|
|
1641
|
+
begin
|
|
1642
|
+
#Get the wrap-up for this conversation participant.
|
|
1643
|
+
result = api_instance.get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
|
1644
|
+
p result
|
|
1645
|
+
rescue PureCloud::ApiError => e
|
|
1646
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: #{e}"
|
|
1647
|
+
end
|
|
1648
|
+
```
|
|
1649
|
+
|
|
1650
|
+
### Parameters
|
|
1651
|
+
|
|
1652
|
+
Name | Type | Description | Notes
|
|
1653
|
+
------------- | ------------- | ------------- | -------------
|
|
1654
|
+
**conversation_id** | **String**| conversationId | |
|
|
1655
|
+
**participant_id** | **String**| participantId | |
|
|
1656
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
1657
|
+
{: class="table table-striped"}
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
### Return type
|
|
1661
|
+
|
|
1662
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1663
|
+
|
|
1664
|
+
### HTTP request headers
|
|
1665
|
+
|
|
1666
|
+
- **Content-Type**: application/json
|
|
1667
|
+
- **Accept**: application/json
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
<a name="get_conversations_callback_participant_wrapupcodes"></a>
|
|
1672
|
+
|
|
1673
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
Get list of wrapup codes for this conversation participant
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1682
|
+
|
|
1683
|
+
Requires NO permissions:
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
### Example
|
|
1688
|
+
```{"language":"ruby"}
|
|
1689
|
+
# load the gem
|
|
1690
|
+
require 'purecloudplatformclientv2'
|
|
1691
|
+
# setup authorization
|
|
1692
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1693
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1694
|
+
environment = "mypurecloud.com"
|
|
1695
|
+
|
|
1696
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1697
|
+
|
|
1698
|
+
PureCloud.configure do |config|
|
|
1699
|
+
config.access_token = @authToken
|
|
1700
|
+
end
|
|
1701
|
+
|
|
1702
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1703
|
+
|
|
1704
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
1705
|
+
|
|
1706
|
+
participant_id = "participant_id_example" # String | participantId
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
begin
|
|
1710
|
+
#Get list of wrapup codes for this conversation participant
|
|
1711
|
+
result = api_instance.get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
|
1712
|
+
p result
|
|
1713
|
+
rescue PureCloud::ApiError => e
|
|
1714
|
+
puts "Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: #{e}"
|
|
1715
|
+
end
|
|
1716
|
+
```
|
|
1717
|
+
|
|
1718
|
+
### Parameters
|
|
1719
|
+
|
|
1720
|
+
Name | Type | Description | Notes
|
|
1721
|
+
------------- | ------------- | ------------- | -------------
|
|
1722
|
+
**conversation_id** | **String**| conversationId | |
|
|
1723
|
+
**participant_id** | **String**| participantId | |
|
|
1724
|
+
{: class="table table-striped"}
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
### Return type
|
|
1728
|
+
|
|
1729
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1730
|
+
|
|
1731
|
+
### HTTP request headers
|
|
1732
|
+
|
|
1733
|
+
- **Content-Type**: application/json
|
|
1734
|
+
- **Accept**: application/json
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
<a name="get_conversations_callbacks"></a>
|
|
1739
|
+
|
|
1740
|
+
## [**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_conversations_callbacks
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
Get active callback conversations for the logged in user
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
Wraps GET /api/v2/conversations/callbacks
|
|
1749
|
+
|
|
1750
|
+
Requires NO permissions:
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
### Example
|
|
1755
|
+
```{"language":"ruby"}
|
|
1756
|
+
# load the gem
|
|
1757
|
+
require 'purecloudplatformclientv2'
|
|
1758
|
+
# setup authorization
|
|
1759
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1760
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1761
|
+
environment = "mypurecloud.com"
|
|
1762
|
+
|
|
1763
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1764
|
+
|
|
1765
|
+
PureCloud.configure do |config|
|
|
1766
|
+
config.access_token = @authToken
|
|
1767
|
+
end
|
|
1768
|
+
|
|
1769
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1770
|
+
|
|
1771
|
+
begin
|
|
1772
|
+
#Get active callback conversations for the logged in user
|
|
1773
|
+
result = api_instance.get_conversations_callbacks
|
|
1774
|
+
p result
|
|
1775
|
+
rescue PureCloud::ApiError => e
|
|
1776
|
+
puts "Exception when calling ConversationsApi->get_conversations_callbacks: #{e}"
|
|
1777
|
+
end
|
|
1778
|
+
```
|
|
1779
|
+
|
|
1780
|
+
### Parameters
|
|
1781
|
+
This endpoint does not need any parameter.
|
|
1782
|
+
{: class="table table-striped"}
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
### Return type
|
|
1786
|
+
|
|
1787
|
+
[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html)
|
|
1788
|
+
|
|
1789
|
+
### HTTP request headers
|
|
1790
|
+
|
|
1791
|
+
- **Content-Type**: application/json
|
|
1792
|
+
- **Accept**: application/json
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
<a name="get_conversations_calls"></a>
|
|
1797
|
+
|
|
1798
|
+
## [**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
Get active call conversations for the logged in user
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
Wraps GET /api/v2/conversations/calls
|
|
1807
|
+
|
|
1808
|
+
Requires NO permissions:
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
### Example
|
|
1813
|
+
```{"language":"ruby"}
|
|
1814
|
+
# load the gem
|
|
1815
|
+
require 'purecloudplatformclientv2'
|
|
1816
|
+
# setup authorization
|
|
1817
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1818
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1819
|
+
environment = "mypurecloud.com"
|
|
1820
|
+
|
|
1821
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1822
|
+
|
|
1823
|
+
PureCloud.configure do |config|
|
|
1824
|
+
config.access_token = @authToken
|
|
1825
|
+
end
|
|
1826
|
+
|
|
1827
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1828
|
+
|
|
1829
|
+
begin
|
|
1830
|
+
#Get active call conversations for the logged in user
|
|
1831
|
+
result = api_instance.get_conversations_calls
|
|
1832
|
+
p result
|
|
1833
|
+
rescue PureCloud::ApiError => e
|
|
1834
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls: #{e}"
|
|
1835
|
+
end
|
|
1836
|
+
```
|
|
1837
|
+
|
|
1838
|
+
### Parameters
|
|
1839
|
+
This endpoint does not need any parameter.
|
|
1840
|
+
{: class="table table-striped"}
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
### Return type
|
|
1844
|
+
|
|
1845
|
+
[**CallConversationEntityListing**](CallConversationEntityListing.html)
|
|
1846
|
+
|
|
1847
|
+
### HTTP request headers
|
|
1848
|
+
|
|
1849
|
+
- **Content-Type**: application/json
|
|
1850
|
+
- **Accept**: application/json
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
|
|
1854
|
+
<a name="get_conversations_calls_history"></a>
|
|
1855
|
+
|
|
1856
|
+
## [**CallHistoryConversationEntityListing**](CallHistoryConversationEntityListing.html) get_conversations_calls_history(opts)
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
Get call history
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
Wraps GET /api/v2/conversations/calls/history
|
|
1865
|
+
|
|
1866
|
+
Requires NO permissions:
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
### Example
|
|
1871
|
+
```{"language":"ruby"}
|
|
1872
|
+
# load the gem
|
|
1873
|
+
require 'purecloudplatformclientv2'
|
|
1874
|
+
# setup authorization
|
|
1875
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1876
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1877
|
+
environment = "mypurecloud.com"
|
|
1878
|
+
|
|
1879
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1880
|
+
|
|
1881
|
+
PureCloud.configure do |config|
|
|
1882
|
+
config.access_token = @authToken
|
|
1883
|
+
end
|
|
1884
|
+
|
|
1885
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1886
|
+
|
|
1887
|
+
opts = {
|
|
1888
|
+
page_size: 25, # Integer | Page size, maximum 50
|
|
1889
|
+
page_number: 1, # Integer | Page number
|
|
1890
|
+
interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
1891
|
+
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
|
|
1892
|
+
}
|
|
1893
|
+
|
|
1894
|
+
begin
|
|
1895
|
+
#Get call history
|
|
1896
|
+
result = api_instance.get_conversations_calls_history(opts)
|
|
1897
|
+
p result
|
|
1898
|
+
rescue PureCloud::ApiError => e
|
|
1899
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls_history: #{e}"
|
|
1900
|
+
end
|
|
1901
|
+
```
|
|
1902
|
+
|
|
1903
|
+
### Parameters
|
|
1904
|
+
|
|
1905
|
+
Name | Type | Description | Notes
|
|
1906
|
+
------------- | ------------- | ------------- | -------------
|
|
1907
|
+
**page_size** | **Integer**| Page size, maximum 50 | [optional] [default to 25] |
|
|
1908
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1909
|
+
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional] |
|
|
1910
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: externalorganization, externalcontact, user, queue, group |
|
|
1911
|
+
{: class="table table-striped"}
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
### Return type
|
|
1915
|
+
|
|
1916
|
+
[**CallHistoryConversationEntityListing**](CallHistoryConversationEntityListing.html)
|
|
1917
|
+
|
|
1918
|
+
### HTTP request headers
|
|
1919
|
+
|
|
1920
|
+
- **Content-Type**: application/json
|
|
1921
|
+
- **Accept**: application/json
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
<a name="get_conversations_calls_maximumconferenceparties"></a>
|
|
1926
|
+
|
|
1927
|
+
## [**MaxParticipants**](MaxParticipants.html) get_conversations_calls_maximumconferenceparties
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
Get the maximum number of participants that this user can have on a conference
|
|
1932
|
+
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
Wraps GET /api/v2/conversations/calls/maximumconferenceparties
|
|
1936
|
+
|
|
1937
|
+
Requires NO permissions:
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
### Example
|
|
1942
|
+
```{"language":"ruby"}
|
|
1943
|
+
# load the gem
|
|
1944
|
+
require 'purecloudplatformclientv2'
|
|
1945
|
+
# setup authorization
|
|
1946
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1947
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1948
|
+
environment = "mypurecloud.com"
|
|
1949
|
+
|
|
1950
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1951
|
+
|
|
1952
|
+
PureCloud.configure do |config|
|
|
1953
|
+
config.access_token = @authToken
|
|
1954
|
+
end
|
|
1955
|
+
|
|
1956
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
1957
|
+
|
|
1958
|
+
begin
|
|
1959
|
+
#Get the maximum number of participants that this user can have on a conference
|
|
1960
|
+
result = api_instance.get_conversations_calls_maximumconferenceparties
|
|
1961
|
+
p result
|
|
1962
|
+
rescue PureCloud::ApiError => e
|
|
1963
|
+
puts "Exception when calling ConversationsApi->get_conversations_calls_maximumconferenceparties: #{e}"
|
|
1964
|
+
end
|
|
1965
|
+
```
|
|
1966
|
+
|
|
1967
|
+
### Parameters
|
|
1968
|
+
This endpoint does not need any parameter.
|
|
1969
|
+
{: class="table table-striped"}
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
### Return type
|
|
1973
|
+
|
|
1974
|
+
[**MaxParticipants**](MaxParticipants.html)
|
|
1975
|
+
|
|
1976
|
+
### HTTP request headers
|
|
1977
|
+
|
|
1978
|
+
- **Content-Type**: application/json
|
|
1979
|
+
- **Accept**: application/json
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
<a name="get_conversations_chat"></a>
|
|
1984
|
+
|
|
1985
|
+
## [**ChatConversation**](ChatConversation.html) get_conversations_chat(conversation_id)
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
Get chat conversation
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}
|
|
1994
|
+
|
|
1995
|
+
Requires NO permissions:
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
### Example
|
|
2000
|
+
```{"language":"ruby"}
|
|
2001
|
+
# load the gem
|
|
2002
|
+
require 'purecloudplatformclientv2'
|
|
2003
|
+
# setup authorization
|
|
2004
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2005
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2006
|
+
environment = "mypurecloud.com"
|
|
2007
|
+
|
|
2008
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2009
|
+
|
|
2010
|
+
PureCloud.configure do |config|
|
|
2011
|
+
config.access_token = @authToken
|
|
2012
|
+
end
|
|
2013
|
+
|
|
2014
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2015
|
+
|
|
2016
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
begin
|
|
2020
|
+
#Get chat conversation
|
|
2021
|
+
result = api_instance.get_conversations_chat(conversation_id)
|
|
2022
|
+
p result
|
|
2023
|
+
rescue PureCloud::ApiError => e
|
|
2024
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat: #{e}"
|
|
2025
|
+
end
|
|
2026
|
+
```
|
|
2027
|
+
|
|
2028
|
+
### Parameters
|
|
2029
|
+
|
|
2030
|
+
Name | Type | Description | Notes
|
|
2031
|
+
------------- | ------------- | ------------- | -------------
|
|
2032
|
+
**conversation_id** | **String**| conversationId | |
|
|
2033
|
+
{: class="table table-striped"}
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
### Return type
|
|
2037
|
+
|
|
2038
|
+
[**ChatConversation**](ChatConversation.html)
|
|
2039
|
+
|
|
2040
|
+
### HTTP request headers
|
|
2041
|
+
|
|
2042
|
+
- **Content-Type**: application/json
|
|
2043
|
+
- **Accept**: application/json
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
<a name="get_conversations_chat_message"></a>
|
|
2048
|
+
|
|
2049
|
+
## [**WebChatMessage**](WebChatMessage.html) get_conversations_chat_message(conversation_id, message_id)
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
Get a web chat conversation message
|
|
2054
|
+
|
|
2055
|
+
The current user must be involved with the conversation to get its messages.
|
|
2056
|
+
|
|
2057
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/messages/{messageId}
|
|
2058
|
+
|
|
2059
|
+
Requires NO permissions:
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
### Example
|
|
2064
|
+
```{"language":"ruby"}
|
|
2065
|
+
# load the gem
|
|
2066
|
+
require 'purecloudplatformclientv2'
|
|
2067
|
+
# setup authorization
|
|
2068
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2069
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2070
|
+
environment = "mypurecloud.com"
|
|
2071
|
+
|
|
2072
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2073
|
+
|
|
2074
|
+
PureCloud.configure do |config|
|
|
2075
|
+
config.access_token = @authToken
|
|
2076
|
+
end
|
|
2077
|
+
|
|
2078
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2079
|
+
|
|
2080
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2081
|
+
|
|
2082
|
+
message_id = "message_id_example" # String | messageId
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
begin
|
|
2086
|
+
#Get a web chat conversation message
|
|
2087
|
+
result = api_instance.get_conversations_chat_message(conversation_id, message_id)
|
|
2088
|
+
p result
|
|
2089
|
+
rescue PureCloud::ApiError => e
|
|
2090
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_message: #{e}"
|
|
2091
|
+
end
|
|
2092
|
+
```
|
|
2093
|
+
|
|
2094
|
+
### Parameters
|
|
2095
|
+
|
|
2096
|
+
Name | Type | Description | Notes
|
|
2097
|
+
------------- | ------------- | ------------- | -------------
|
|
2098
|
+
**conversation_id** | **String**| conversationId | |
|
|
2099
|
+
**message_id** | **String**| messageId | |
|
|
2100
|
+
{: class="table table-striped"}
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
### Return type
|
|
2104
|
+
|
|
2105
|
+
[**WebChatMessage**](WebChatMessage.html)
|
|
2106
|
+
|
|
2107
|
+
### HTTP request headers
|
|
2108
|
+
|
|
2109
|
+
- **Content-Type**: application/json
|
|
2110
|
+
- **Accept**: application/json
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
<a name="get_conversations_chat_messages"></a>
|
|
2115
|
+
|
|
2116
|
+
## [**WebChatMessageEntityList**](WebChatMessageEntityList.html) get_conversations_chat_messages(conversation_id, opts)
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
Get the messages of a chat conversation.
|
|
2121
|
+
|
|
2122
|
+
The current user must be involved with the conversation to get its messages.
|
|
2123
|
+
|
|
2124
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/messages
|
|
2125
|
+
|
|
2126
|
+
Requires NO permissions:
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
### Example
|
|
2131
|
+
```{"language":"ruby"}
|
|
2132
|
+
# load the gem
|
|
2133
|
+
require 'purecloudplatformclientv2'
|
|
2134
|
+
# setup authorization
|
|
2135
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2136
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2137
|
+
environment = "mypurecloud.com"
|
|
2138
|
+
|
|
2139
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2140
|
+
|
|
2141
|
+
PureCloud.configure do |config|
|
|
2142
|
+
config.access_token = @authToken
|
|
2143
|
+
end
|
|
2144
|
+
|
|
2145
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2146
|
+
|
|
2147
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2148
|
+
|
|
2149
|
+
opts = {
|
|
2150
|
+
after: "after_example", # String | If specified, get the messages chronologically after the id of this message
|
|
2151
|
+
before: "before_example", # String | If specified, get the messages chronologically before the id of this message
|
|
2152
|
+
sort_order: "ascending", # String | Sort order
|
|
2153
|
+
max_results: 100 # Integer | Limit the returned number of messages, up to a maximum of 100
|
|
2154
|
+
}
|
|
2155
|
+
|
|
2156
|
+
begin
|
|
2157
|
+
#Get the messages of a chat conversation.
|
|
2158
|
+
result = api_instance.get_conversations_chat_messages(conversation_id, opts)
|
|
2159
|
+
p result
|
|
2160
|
+
rescue PureCloud::ApiError => e
|
|
2161
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_messages: #{e}"
|
|
2162
|
+
end
|
|
2163
|
+
```
|
|
2164
|
+
|
|
2165
|
+
### Parameters
|
|
2166
|
+
|
|
2167
|
+
Name | Type | Description | Notes
|
|
2168
|
+
------------- | ------------- | ------------- | -------------
|
|
2169
|
+
**conversation_id** | **String**| conversationId | |
|
|
2170
|
+
**after** | **String**| If specified, get the messages chronologically after the id of this message | [optional] |
|
|
2171
|
+
**before** | **String**| If specified, get the messages chronologically before the id of this message | [optional] |
|
|
2172
|
+
**sort_order** | **String**| Sort order | [optional] [default to ascending]<br />**Values**: ascending, descending |
|
|
2173
|
+
**max_results** | **Integer**| Limit the returned number of messages, up to a maximum of 100 | [optional] [default to 100] |
|
|
2174
|
+
{: class="table table-striped"}
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
### Return type
|
|
2178
|
+
|
|
2179
|
+
[**WebChatMessageEntityList**](WebChatMessageEntityList.html)
|
|
2180
|
+
|
|
2181
|
+
### HTTP request headers
|
|
2182
|
+
|
|
2183
|
+
- **Content-Type**: application/json
|
|
2184
|
+
- **Accept**: application/json
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
<a name="get_conversations_chat_participant_wrapup"></a>
|
|
2189
|
+
|
|
2190
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
Get the wrap-up for this conversation participant.
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup
|
|
2199
|
+
|
|
2200
|
+
Requires NO permissions:
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
### Example
|
|
2205
|
+
```{"language":"ruby"}
|
|
2206
|
+
# load the gem
|
|
2207
|
+
require 'purecloudplatformclientv2'
|
|
2208
|
+
# setup authorization
|
|
2209
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2210
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2211
|
+
environment = "mypurecloud.com"
|
|
2212
|
+
|
|
2213
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2214
|
+
|
|
2215
|
+
PureCloud.configure do |config|
|
|
2216
|
+
config.access_token = @authToken
|
|
2217
|
+
end
|
|
2218
|
+
|
|
2219
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2220
|
+
|
|
2221
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2222
|
+
|
|
2223
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2224
|
+
|
|
2225
|
+
opts = {
|
|
2226
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
2227
|
+
}
|
|
2228
|
+
|
|
2229
|
+
begin
|
|
2230
|
+
#Get the wrap-up for this conversation participant.
|
|
2231
|
+
result = api_instance.get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
|
2232
|
+
p result
|
|
2233
|
+
rescue PureCloud::ApiError => e
|
|
2234
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapup: #{e}"
|
|
2235
|
+
end
|
|
2236
|
+
```
|
|
2237
|
+
|
|
2238
|
+
### Parameters
|
|
2239
|
+
|
|
2240
|
+
Name | Type | Description | Notes
|
|
2241
|
+
------------- | ------------- | ------------- | -------------
|
|
2242
|
+
**conversation_id** | **String**| conversationId | |
|
|
2243
|
+
**participant_id** | **String**| participantId | |
|
|
2244
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
2245
|
+
{: class="table table-striped"}
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
### Return type
|
|
2249
|
+
|
|
2250
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
2251
|
+
|
|
2252
|
+
### HTTP request headers
|
|
2253
|
+
|
|
2254
|
+
- **Content-Type**: application/json
|
|
2255
|
+
- **Accept**: application/json
|
|
2256
|
+
|
|
2257
|
+
|
|
2258
|
+
|
|
2259
|
+
<a name="get_conversations_chat_participant_wrapupcodes"></a>
|
|
2260
|
+
|
|
2261
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
Get list of wrapup codes for this conversation participant
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes
|
|
2270
|
+
|
|
2271
|
+
Requires NO permissions:
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
### Example
|
|
2276
|
+
```{"language":"ruby"}
|
|
2277
|
+
# load the gem
|
|
2278
|
+
require 'purecloudplatformclientv2'
|
|
2279
|
+
# setup authorization
|
|
2280
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2281
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2282
|
+
environment = "mypurecloud.com"
|
|
2283
|
+
|
|
2284
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2285
|
+
|
|
2286
|
+
PureCloud.configure do |config|
|
|
2287
|
+
config.access_token = @authToken
|
|
2288
|
+
end
|
|
2289
|
+
|
|
2290
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2291
|
+
|
|
2292
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2293
|
+
|
|
2294
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
begin
|
|
2298
|
+
#Get list of wrapup codes for this conversation participant
|
|
2299
|
+
result = api_instance.get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
|
2300
|
+
p result
|
|
2301
|
+
rescue PureCloud::ApiError => e
|
|
2302
|
+
puts "Exception when calling ConversationsApi->get_conversations_chat_participant_wrapupcodes: #{e}"
|
|
2303
|
+
end
|
|
2304
|
+
```
|
|
2305
|
+
|
|
2306
|
+
### Parameters
|
|
2307
|
+
|
|
2308
|
+
Name | Type | Description | Notes
|
|
2309
|
+
------------- | ------------- | ------------- | -------------
|
|
2310
|
+
**conversation_id** | **String**| conversationId | |
|
|
2311
|
+
**participant_id** | **String**| participantId | |
|
|
2312
|
+
{: class="table table-striped"}
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
### Return type
|
|
2316
|
+
|
|
2317
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
2318
|
+
|
|
2319
|
+
### HTTP request headers
|
|
2320
|
+
|
|
2321
|
+
- **Content-Type**: application/json
|
|
2322
|
+
- **Accept**: application/json
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
<a name="get_conversations_chats"></a>
|
|
2327
|
+
|
|
2328
|
+
## [**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_conversations_chats
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
Get active chat conversations for the logged in user
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
Wraps GET /api/v2/conversations/chats
|
|
2337
|
+
|
|
2338
|
+
Requires NO permissions:
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
### Example
|
|
2343
|
+
```{"language":"ruby"}
|
|
2344
|
+
# load the gem
|
|
2345
|
+
require 'purecloudplatformclientv2'
|
|
2346
|
+
# setup authorization
|
|
2347
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2348
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2349
|
+
environment = "mypurecloud.com"
|
|
2350
|
+
|
|
2351
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2352
|
+
|
|
2353
|
+
PureCloud.configure do |config|
|
|
2354
|
+
config.access_token = @authToken
|
|
2355
|
+
end
|
|
2356
|
+
|
|
2357
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2358
|
+
|
|
2359
|
+
begin
|
|
2360
|
+
#Get active chat conversations for the logged in user
|
|
2361
|
+
result = api_instance.get_conversations_chats
|
|
2362
|
+
p result
|
|
2363
|
+
rescue PureCloud::ApiError => e
|
|
2364
|
+
puts "Exception when calling ConversationsApi->get_conversations_chats: #{e}"
|
|
2365
|
+
end
|
|
2366
|
+
```
|
|
2367
|
+
|
|
2368
|
+
### Parameters
|
|
2369
|
+
This endpoint does not need any parameter.
|
|
2370
|
+
{: class="table table-striped"}
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
### Return type
|
|
2374
|
+
|
|
2375
|
+
[**ChatConversationEntityListing**](ChatConversationEntityListing.html)
|
|
2376
|
+
|
|
2377
|
+
### HTTP request headers
|
|
2378
|
+
|
|
2379
|
+
- **Content-Type**: application/json
|
|
2380
|
+
- **Accept**: application/json
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
<a name="get_conversations_cobrowsesession"></a>
|
|
2385
|
+
|
|
2386
|
+
## [**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(conversation_id)
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
Get cobrowse conversation
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
2395
|
+
|
|
2396
|
+
Requires NO permissions:
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
### Example
|
|
2401
|
+
```{"language":"ruby"}
|
|
2402
|
+
# load the gem
|
|
2403
|
+
require 'purecloudplatformclientv2'
|
|
2404
|
+
# setup authorization
|
|
2405
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2406
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2407
|
+
environment = "mypurecloud.com"
|
|
2408
|
+
|
|
2409
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2410
|
+
|
|
2411
|
+
PureCloud.configure do |config|
|
|
2412
|
+
config.access_token = @authToken
|
|
2413
|
+
end
|
|
2414
|
+
|
|
2415
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2416
|
+
|
|
2417
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
begin
|
|
2421
|
+
#Get cobrowse conversation
|
|
2422
|
+
result = api_instance.get_conversations_cobrowsesession(conversation_id)
|
|
2423
|
+
p result
|
|
2424
|
+
rescue PureCloud::ApiError => e
|
|
2425
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession: #{e}"
|
|
2426
|
+
end
|
|
2427
|
+
```
|
|
2428
|
+
|
|
2429
|
+
### Parameters
|
|
2430
|
+
|
|
2431
|
+
Name | Type | Description | Notes
|
|
2432
|
+
------------- | ------------- | ------------- | -------------
|
|
2433
|
+
**conversation_id** | **String**| conversationId | |
|
|
2434
|
+
{: class="table table-striped"}
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
### Return type
|
|
2438
|
+
|
|
2439
|
+
[**CobrowseConversation**](CobrowseConversation.html)
|
|
2440
|
+
|
|
2441
|
+
### HTTP request headers
|
|
2442
|
+
|
|
2443
|
+
- **Content-Type**: application/json
|
|
2444
|
+
- **Accept**: application/json
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
<a name="get_conversations_cobrowsesession_participant_wrapup"></a>
|
|
2449
|
+
|
|
2450
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
Get the wrap-up for this conversation participant.
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup
|
|
2459
|
+
|
|
2460
|
+
Requires NO permissions:
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
### Example
|
|
2465
|
+
```{"language":"ruby"}
|
|
2466
|
+
# load the gem
|
|
2467
|
+
require 'purecloudplatformclientv2'
|
|
2468
|
+
# setup authorization
|
|
2469
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2470
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2471
|
+
environment = "mypurecloud.com"
|
|
2472
|
+
|
|
2473
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2474
|
+
|
|
2475
|
+
PureCloud.configure do |config|
|
|
2476
|
+
config.access_token = @authToken
|
|
2477
|
+
end
|
|
2478
|
+
|
|
2479
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2480
|
+
|
|
2481
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2482
|
+
|
|
2483
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2484
|
+
|
|
2485
|
+
opts = {
|
|
2486
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
2487
|
+
}
|
|
2488
|
+
|
|
2489
|
+
begin
|
|
2490
|
+
#Get the wrap-up for this conversation participant.
|
|
2491
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
|
2492
|
+
p result
|
|
2493
|
+
rescue PureCloud::ApiError => e
|
|
2494
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapup: #{e}"
|
|
2495
|
+
end
|
|
2496
|
+
```
|
|
2497
|
+
|
|
2498
|
+
### Parameters
|
|
2499
|
+
|
|
2500
|
+
Name | Type | Description | Notes
|
|
2501
|
+
------------- | ------------- | ------------- | -------------
|
|
2502
|
+
**conversation_id** | **String**| conversationId | |
|
|
2503
|
+
**participant_id** | **String**| participantId | |
|
|
2504
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
2505
|
+
{: class="table table-striped"}
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
### Return type
|
|
2509
|
+
|
|
2510
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
2511
|
+
|
|
2512
|
+
### HTTP request headers
|
|
2513
|
+
|
|
2514
|
+
- **Content-Type**: application/json
|
|
2515
|
+
- **Accept**: application/json
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
<a name="get_conversations_cobrowsesession_participant_wrapupcodes"></a>
|
|
1323
2520
|
|
|
1324
|
-
## [**
|
|
2521
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
|
1325
2522
|
|
|
1326
2523
|
|
|
1327
2524
|
|
|
1328
|
-
Get
|
|
2525
|
+
Get list of wrapup codes for this conversation participant
|
|
1329
2526
|
|
|
1330
2527
|
|
|
1331
2528
|
|
|
1332
|
-
Wraps GET /api/v2/conversations/
|
|
2529
|
+
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1333
2530
|
|
|
1334
2531
|
Requires NO permissions:
|
|
1335
2532
|
|
|
@@ -1352,23 +2549,32 @@ end
|
|
|
1352
2549
|
|
|
1353
2550
|
api_instance = PureCloud::ConversationsApi.new
|
|
1354
2551
|
|
|
2552
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2553
|
+
|
|
2554
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2555
|
+
|
|
2556
|
+
|
|
1355
2557
|
begin
|
|
1356
|
-
#Get
|
|
1357
|
-
result = api_instance.
|
|
2558
|
+
#Get list of wrapup codes for this conversation participant
|
|
2559
|
+
result = api_instance.get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
|
1358
2560
|
p result
|
|
1359
2561
|
rescue PureCloud::ApiError => e
|
|
1360
|
-
puts "Exception when calling ConversationsApi->
|
|
2562
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesession_participant_wrapupcodes: #{e}"
|
|
1361
2563
|
end
|
|
1362
2564
|
```
|
|
1363
2565
|
|
|
1364
2566
|
### Parameters
|
|
1365
|
-
|
|
2567
|
+
|
|
2568
|
+
Name | Type | Description | Notes
|
|
2569
|
+
------------- | ------------- | ------------- | -------------
|
|
2570
|
+
**conversation_id** | **String**| conversationId | |
|
|
2571
|
+
**participant_id** | **String**| participantId | |
|
|
1366
2572
|
{: class="table table-striped"}
|
|
1367
2573
|
|
|
1368
2574
|
|
|
1369
2575
|
### Return type
|
|
1370
2576
|
|
|
1371
|
-
[**
|
|
2577
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1372
2578
|
|
|
1373
2579
|
### HTTP request headers
|
|
1374
2580
|
|
|
@@ -1377,17 +2583,17 @@ This endpoint does not need any parameter.
|
|
|
1377
2583
|
|
|
1378
2584
|
|
|
1379
2585
|
|
|
1380
|
-
<a name="
|
|
2586
|
+
<a name="get_conversations_cobrowsesessions"></a>
|
|
1381
2587
|
|
|
1382
|
-
## [**
|
|
2588
|
+
## [**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_conversations_cobrowsesessions
|
|
1383
2589
|
|
|
1384
2590
|
|
|
1385
2591
|
|
|
1386
|
-
Get active
|
|
2592
|
+
Get active cobrowse conversations for the logged in user
|
|
1387
2593
|
|
|
1388
2594
|
|
|
1389
2595
|
|
|
1390
|
-
Wraps GET /api/v2/conversations/
|
|
2596
|
+
Wraps GET /api/v2/conversations/cobrowsesessions
|
|
1391
2597
|
|
|
1392
2598
|
Requires NO permissions:
|
|
1393
2599
|
|
|
@@ -1411,11 +2617,11 @@ end
|
|
|
1411
2617
|
api_instance = PureCloud::ConversationsApi.new
|
|
1412
2618
|
|
|
1413
2619
|
begin
|
|
1414
|
-
#Get active
|
|
1415
|
-
result = api_instance.
|
|
2620
|
+
#Get active cobrowse conversations for the logged in user
|
|
2621
|
+
result = api_instance.get_conversations_cobrowsesessions
|
|
1416
2622
|
p result
|
|
1417
2623
|
rescue PureCloud::ApiError => e
|
|
1418
|
-
puts "Exception when calling ConversationsApi->
|
|
2624
|
+
puts "Exception when calling ConversationsApi->get_conversations_cobrowsesessions: #{e}"
|
|
1419
2625
|
end
|
|
1420
2626
|
```
|
|
1421
2627
|
|
|
@@ -1426,7 +2632,7 @@ This endpoint does not need any parameter.
|
|
|
1426
2632
|
|
|
1427
2633
|
### Return type
|
|
1428
2634
|
|
|
1429
|
-
[**
|
|
2635
|
+
[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html)
|
|
1430
2636
|
|
|
1431
2637
|
### HTTP request headers
|
|
1432
2638
|
|
|
@@ -1435,17 +2641,17 @@ This endpoint does not need any parameter.
|
|
|
1435
2641
|
|
|
1436
2642
|
|
|
1437
2643
|
|
|
1438
|
-
<a name="
|
|
2644
|
+
<a name="get_conversations_email"></a>
|
|
1439
2645
|
|
|
1440
|
-
## [**
|
|
2646
|
+
## [**EmailConversation**](EmailConversation.html) get_conversations_email(conversation_id)
|
|
1441
2647
|
|
|
1442
2648
|
|
|
1443
2649
|
|
|
1444
|
-
Get
|
|
2650
|
+
Get email conversation
|
|
1445
2651
|
|
|
1446
2652
|
|
|
1447
2653
|
|
|
1448
|
-
Wraps GET /api/v2/conversations/
|
|
2654
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}
|
|
1449
2655
|
|
|
1450
2656
|
Requires NO permissions:
|
|
1451
2657
|
|
|
@@ -1468,19 +2674,15 @@ end
|
|
|
1468
2674
|
|
|
1469
2675
|
api_instance = PureCloud::ConversationsApi.new
|
|
1470
2676
|
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
page_number: 1, # Integer | Page number
|
|
1474
|
-
interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
|
|
1475
|
-
expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
|
|
1476
|
-
}
|
|
2677
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2678
|
+
|
|
1477
2679
|
|
|
1478
2680
|
begin
|
|
1479
|
-
#Get
|
|
1480
|
-
result = api_instance.
|
|
2681
|
+
#Get email conversation
|
|
2682
|
+
result = api_instance.get_conversations_email(conversation_id)
|
|
1481
2683
|
p result
|
|
1482
2684
|
rescue PureCloud::ApiError => e
|
|
1483
|
-
puts "Exception when calling ConversationsApi->
|
|
2685
|
+
puts "Exception when calling ConversationsApi->get_conversations_email: #{e}"
|
|
1484
2686
|
end
|
|
1485
2687
|
```
|
|
1486
2688
|
|
|
@@ -1488,16 +2690,13 @@ end
|
|
|
1488
2690
|
|
|
1489
2691
|
Name | Type | Description | Notes
|
|
1490
2692
|
------------- | ------------- | ------------- | -------------
|
|
1491
|
-
**
|
|
1492
|
-
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1493
|
-
**interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash '/' | [optional] |
|
|
1494
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: externalorganization, externalcontact, user, queue, group |
|
|
2693
|
+
**conversation_id** | **String**| conversationId | |
|
|
1495
2694
|
{: class="table table-striped"}
|
|
1496
2695
|
|
|
1497
2696
|
|
|
1498
2697
|
### Return type
|
|
1499
2698
|
|
|
1500
|
-
[**
|
|
2699
|
+
[**EmailConversation**](EmailConversation.html)
|
|
1501
2700
|
|
|
1502
2701
|
### HTTP request headers
|
|
1503
2702
|
|
|
@@ -1506,17 +2705,17 @@ Name | Type | Description | Notes
|
|
|
1506
2705
|
|
|
1507
2706
|
|
|
1508
2707
|
|
|
1509
|
-
<a name="
|
|
2708
|
+
<a name="get_conversations_email_message"></a>
|
|
1510
2709
|
|
|
1511
|
-
## [**
|
|
2710
|
+
## [**EmailMessage**](EmailMessage.html) get_conversations_email_message(conversation_id, message_id)
|
|
1512
2711
|
|
|
1513
2712
|
|
|
1514
2713
|
|
|
1515
|
-
Get
|
|
2714
|
+
Get conversation message
|
|
1516
2715
|
|
|
1517
2716
|
|
|
1518
2717
|
|
|
1519
|
-
Wraps GET /api/v2/conversations/
|
|
2718
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}
|
|
1520
2719
|
|
|
1521
2720
|
Requires NO permissions:
|
|
1522
2721
|
|
|
@@ -1539,23 +2738,32 @@ end
|
|
|
1539
2738
|
|
|
1540
2739
|
api_instance = PureCloud::ConversationsApi.new
|
|
1541
2740
|
|
|
2741
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2742
|
+
|
|
2743
|
+
message_id = "message_id_example" # String | messageId
|
|
2744
|
+
|
|
2745
|
+
|
|
1542
2746
|
begin
|
|
1543
|
-
#Get
|
|
1544
|
-
result = api_instance.
|
|
2747
|
+
#Get conversation message
|
|
2748
|
+
result = api_instance.get_conversations_email_message(conversation_id, message_id)
|
|
1545
2749
|
p result
|
|
1546
2750
|
rescue PureCloud::ApiError => e
|
|
1547
|
-
puts "Exception when calling ConversationsApi->
|
|
2751
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_message: #{e}"
|
|
1548
2752
|
end
|
|
1549
2753
|
```
|
|
1550
2754
|
|
|
1551
2755
|
### Parameters
|
|
1552
|
-
|
|
2756
|
+
|
|
2757
|
+
Name | Type | Description | Notes
|
|
2758
|
+
------------- | ------------- | ------------- | -------------
|
|
2759
|
+
**conversation_id** | **String**| conversationId | |
|
|
2760
|
+
**message_id** | **String**| messageId | |
|
|
1553
2761
|
{: class="table table-striped"}
|
|
1554
2762
|
|
|
1555
2763
|
|
|
1556
2764
|
### Return type
|
|
1557
2765
|
|
|
1558
|
-
[**
|
|
2766
|
+
[**EmailMessage**](EmailMessage.html)
|
|
1559
2767
|
|
|
1560
2768
|
### HTTP request headers
|
|
1561
2769
|
|
|
@@ -1564,17 +2772,17 @@ This endpoint does not need any parameter.
|
|
|
1564
2772
|
|
|
1565
2773
|
|
|
1566
2774
|
|
|
1567
|
-
<a name="
|
|
2775
|
+
<a name="get_conversations_email_messages"></a>
|
|
1568
2776
|
|
|
1569
|
-
## [**
|
|
2777
|
+
## [**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(conversation_id)
|
|
1570
2778
|
|
|
1571
2779
|
|
|
1572
2780
|
|
|
1573
|
-
Get
|
|
2781
|
+
Get conversation messages
|
|
1574
2782
|
|
|
1575
2783
|
|
|
1576
2784
|
|
|
1577
|
-
Wraps GET /api/v2/conversations/
|
|
2785
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages
|
|
1578
2786
|
|
|
1579
2787
|
Requires NO permissions:
|
|
1580
2788
|
|
|
@@ -1601,11 +2809,11 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
1601
2809
|
|
|
1602
2810
|
|
|
1603
2811
|
begin
|
|
1604
|
-
#Get
|
|
1605
|
-
result = api_instance.
|
|
2812
|
+
#Get conversation messages
|
|
2813
|
+
result = api_instance.get_conversations_email_messages(conversation_id)
|
|
1606
2814
|
p result
|
|
1607
2815
|
rescue PureCloud::ApiError => e
|
|
1608
|
-
puts "Exception when calling ConversationsApi->
|
|
2816
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_messages: #{e}"
|
|
1609
2817
|
end
|
|
1610
2818
|
```
|
|
1611
2819
|
|
|
@@ -1619,7 +2827,7 @@ Name | Type | Description | Notes
|
|
|
1619
2827
|
|
|
1620
2828
|
### Return type
|
|
1621
2829
|
|
|
1622
|
-
[**
|
|
2830
|
+
[**EmailMessageListing**](EmailMessageListing.html)
|
|
1623
2831
|
|
|
1624
2832
|
### HTTP request headers
|
|
1625
2833
|
|
|
@@ -1628,17 +2836,17 @@ Name | Type | Description | Notes
|
|
|
1628
2836
|
|
|
1629
2837
|
|
|
1630
2838
|
|
|
1631
|
-
<a name="
|
|
2839
|
+
<a name="get_conversations_email_messages_draft"></a>
|
|
1632
2840
|
|
|
1633
|
-
## [**
|
|
2841
|
+
## [**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(conversation_id)
|
|
1634
2842
|
|
|
1635
2843
|
|
|
1636
2844
|
|
|
1637
|
-
Get
|
|
2845
|
+
Get conversation draft reply
|
|
1638
2846
|
|
|
1639
2847
|
|
|
1640
2848
|
|
|
1641
|
-
Wraps GET /api/v2/conversations/
|
|
2849
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/draft
|
|
1642
2850
|
|
|
1643
2851
|
Requires NO permissions:
|
|
1644
2852
|
|
|
@@ -1663,18 +2871,13 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
1663
2871
|
|
|
1664
2872
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
1665
2873
|
|
|
1666
|
-
participant_id = "participant_id_example" # String | participantId
|
|
1667
|
-
|
|
1668
|
-
opts = {
|
|
1669
|
-
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1670
|
-
}
|
|
1671
2874
|
|
|
1672
2875
|
begin
|
|
1673
|
-
#Get
|
|
1674
|
-
result = api_instance.
|
|
2876
|
+
#Get conversation draft reply
|
|
2877
|
+
result = api_instance.get_conversations_email_messages_draft(conversation_id)
|
|
1675
2878
|
p result
|
|
1676
2879
|
rescue PureCloud::ApiError => e
|
|
1677
|
-
puts "Exception when calling ConversationsApi->
|
|
2880
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_messages_draft: #{e}"
|
|
1678
2881
|
end
|
|
1679
2882
|
```
|
|
1680
2883
|
|
|
@@ -1683,14 +2886,12 @@ end
|
|
|
1683
2886
|
Name | Type | Description | Notes
|
|
1684
2887
|
------------- | ------------- | ------------- | -------------
|
|
1685
2888
|
**conversation_id** | **String**| conversationId | |
|
|
1686
|
-
**participant_id** | **String**| participantId | |
|
|
1687
|
-
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
1688
2889
|
{: class="table table-striped"}
|
|
1689
2890
|
|
|
1690
2891
|
|
|
1691
2892
|
### Return type
|
|
1692
2893
|
|
|
1693
|
-
[**
|
|
2894
|
+
[**EmailMessage**](EmailMessage.html)
|
|
1694
2895
|
|
|
1695
2896
|
### HTTP request headers
|
|
1696
2897
|
|
|
@@ -1699,17 +2900,17 @@ Name | Type | Description | Notes
|
|
|
1699
2900
|
|
|
1700
2901
|
|
|
1701
2902
|
|
|
1702
|
-
<a name="
|
|
2903
|
+
<a name="get_conversations_email_participant_wrapup"></a>
|
|
1703
2904
|
|
|
1704
|
-
## [**
|
|
2905
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
|
1705
2906
|
|
|
1706
2907
|
|
|
1707
2908
|
|
|
1708
|
-
Get
|
|
2909
|
+
Get the wrap-up for this conversation participant.
|
|
1709
2910
|
|
|
1710
2911
|
|
|
1711
2912
|
|
|
1712
|
-
Wraps GET /api/v2/conversations/
|
|
2913
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup
|
|
1713
2914
|
|
|
1714
2915
|
Requires NO permissions:
|
|
1715
2916
|
|
|
@@ -1736,13 +2937,16 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
1736
2937
|
|
|
1737
2938
|
participant_id = "participant_id_example" # String | participantId
|
|
1738
2939
|
|
|
2940
|
+
opts = {
|
|
2941
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
2942
|
+
}
|
|
1739
2943
|
|
|
1740
2944
|
begin
|
|
1741
|
-
#Get
|
|
1742
|
-
result = api_instance.
|
|
2945
|
+
#Get the wrap-up for this conversation participant.
|
|
2946
|
+
result = api_instance.get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
|
1743
2947
|
p result
|
|
1744
2948
|
rescue PureCloud::ApiError => e
|
|
1745
|
-
puts "Exception when calling ConversationsApi->
|
|
2949
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapup: #{e}"
|
|
1746
2950
|
end
|
|
1747
2951
|
```
|
|
1748
2952
|
|
|
@@ -1752,12 +2956,13 @@ Name | Type | Description | Notes
|
|
|
1752
2956
|
------------- | ------------- | ------------- | -------------
|
|
1753
2957
|
**conversation_id** | **String**| conversationId | |
|
|
1754
2958
|
**participant_id** | **String**| participantId | |
|
|
2959
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
1755
2960
|
{: class="table table-striped"}
|
|
1756
2961
|
|
|
1757
2962
|
|
|
1758
2963
|
### Return type
|
|
1759
2964
|
|
|
1760
|
-
[**
|
|
2965
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1761
2966
|
|
|
1762
2967
|
### HTTP request headers
|
|
1763
2968
|
|
|
@@ -1766,17 +2971,17 @@ Name | Type | Description | Notes
|
|
|
1766
2971
|
|
|
1767
2972
|
|
|
1768
2973
|
|
|
1769
|
-
<a name="
|
|
2974
|
+
<a name="get_conversations_email_participant_wrapupcodes"></a>
|
|
1770
2975
|
|
|
1771
|
-
## [**
|
|
2976
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
|
1772
2977
|
|
|
1773
2978
|
|
|
1774
2979
|
|
|
1775
|
-
Get
|
|
2980
|
+
Get list of wrapup codes for this conversation participant
|
|
1776
2981
|
|
|
1777
2982
|
|
|
1778
2983
|
|
|
1779
|
-
Wraps GET /api/v2/conversations/
|
|
2984
|
+
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1780
2985
|
|
|
1781
2986
|
Requires NO permissions:
|
|
1782
2987
|
|
|
@@ -1799,23 +3004,32 @@ end
|
|
|
1799
3004
|
|
|
1800
3005
|
api_instance = PureCloud::ConversationsApi.new
|
|
1801
3006
|
|
|
3007
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3008
|
+
|
|
3009
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3010
|
+
|
|
3011
|
+
|
|
1802
3012
|
begin
|
|
1803
|
-
#Get
|
|
1804
|
-
result = api_instance.
|
|
3013
|
+
#Get list of wrapup codes for this conversation participant
|
|
3014
|
+
result = api_instance.get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
|
1805
3015
|
p result
|
|
1806
3016
|
rescue PureCloud::ApiError => e
|
|
1807
|
-
puts "Exception when calling ConversationsApi->
|
|
3017
|
+
puts "Exception when calling ConversationsApi->get_conversations_email_participant_wrapupcodes: #{e}"
|
|
1808
3018
|
end
|
|
1809
3019
|
```
|
|
1810
3020
|
|
|
1811
3021
|
### Parameters
|
|
1812
|
-
|
|
3022
|
+
|
|
3023
|
+
Name | Type | Description | Notes
|
|
3024
|
+
------------- | ------------- | ------------- | -------------
|
|
3025
|
+
**conversation_id** | **String**| conversationId | |
|
|
3026
|
+
**participant_id** | **String**| participantId | |
|
|
1813
3027
|
{: class="table table-striped"}
|
|
1814
3028
|
|
|
1815
3029
|
|
|
1816
3030
|
### Return type
|
|
1817
3031
|
|
|
1818
|
-
[**
|
|
3032
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
1819
3033
|
|
|
1820
3034
|
### HTTP request headers
|
|
1821
3035
|
|
|
@@ -1824,17 +3038,17 @@ This endpoint does not need any parameter.
|
|
|
1824
3038
|
|
|
1825
3039
|
|
|
1826
3040
|
|
|
1827
|
-
<a name="
|
|
3041
|
+
<a name="get_conversations_emails"></a>
|
|
1828
3042
|
|
|
1829
|
-
## [**
|
|
3043
|
+
## [**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_conversations_emails
|
|
1830
3044
|
|
|
1831
3045
|
|
|
1832
3046
|
|
|
1833
|
-
Get
|
|
3047
|
+
Get active email conversations for the logged in user
|
|
1834
3048
|
|
|
1835
3049
|
|
|
1836
3050
|
|
|
1837
|
-
Wraps GET /api/v2/conversations/
|
|
3051
|
+
Wraps GET /api/v2/conversations/emails
|
|
1838
3052
|
|
|
1839
3053
|
Requires NO permissions:
|
|
1840
3054
|
|
|
@@ -1857,29 +3071,23 @@ end
|
|
|
1857
3071
|
|
|
1858
3072
|
api_instance = PureCloud::ConversationsApi.new
|
|
1859
3073
|
|
|
1860
|
-
conversation_id = "conversation_id_example" # String | conversationId
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
3074
|
begin
|
|
1864
|
-
#Get
|
|
1865
|
-
result = api_instance.
|
|
3075
|
+
#Get active email conversations for the logged in user
|
|
3076
|
+
result = api_instance.get_conversations_emails
|
|
1866
3077
|
p result
|
|
1867
3078
|
rescue PureCloud::ApiError => e
|
|
1868
|
-
puts "Exception when calling ConversationsApi->
|
|
3079
|
+
puts "Exception when calling ConversationsApi->get_conversations_emails: #{e}"
|
|
1869
3080
|
end
|
|
1870
3081
|
```
|
|
1871
3082
|
|
|
1872
3083
|
### Parameters
|
|
1873
|
-
|
|
1874
|
-
Name | Type | Description | Notes
|
|
1875
|
-
------------- | ------------- | ------------- | -------------
|
|
1876
|
-
**conversation_id** | **String**| conversationId | |
|
|
3084
|
+
This endpoint does not need any parameter.
|
|
1877
3085
|
{: class="table table-striped"}
|
|
1878
3086
|
|
|
1879
3087
|
|
|
1880
3088
|
### Return type
|
|
1881
3089
|
|
|
1882
|
-
[**
|
|
3090
|
+
[**EmailConversationEntityListing**](EmailConversationEntityListing.html)
|
|
1883
3091
|
|
|
1884
3092
|
### HTTP request headers
|
|
1885
3093
|
|
|
@@ -1888,17 +3096,17 @@ Name | Type | Description | Notes
|
|
|
1888
3096
|
|
|
1889
3097
|
|
|
1890
3098
|
|
|
1891
|
-
<a name="
|
|
3099
|
+
<a name="get_conversations_message"></a>
|
|
1892
3100
|
|
|
1893
|
-
## [**
|
|
3101
|
+
## [**MessageConversation**](MessageConversation.html) get_conversations_message(conversation_id)
|
|
1894
3102
|
|
|
1895
3103
|
|
|
1896
3104
|
|
|
1897
|
-
Get
|
|
3105
|
+
Get message conversation
|
|
1898
3106
|
|
|
1899
3107
|
|
|
1900
3108
|
|
|
1901
|
-
Wraps GET /api/v2/conversations/
|
|
3109
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}
|
|
1902
3110
|
|
|
1903
3111
|
Requires NO permissions:
|
|
1904
3112
|
|
|
@@ -1923,18 +3131,13 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
1923
3131
|
|
|
1924
3132
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
1925
3133
|
|
|
1926
|
-
participant_id = "participant_id_example" # String | participantId
|
|
1927
|
-
|
|
1928
|
-
opts = {
|
|
1929
|
-
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
1930
|
-
}
|
|
1931
3134
|
|
|
1932
3135
|
begin
|
|
1933
|
-
#Get
|
|
1934
|
-
result = api_instance.
|
|
3136
|
+
#Get message conversation
|
|
3137
|
+
result = api_instance.get_conversations_message(conversation_id)
|
|
1935
3138
|
p result
|
|
1936
3139
|
rescue PureCloud::ApiError => e
|
|
1937
|
-
puts "Exception when calling ConversationsApi->
|
|
3140
|
+
puts "Exception when calling ConversationsApi->get_conversations_message: #{e}"
|
|
1938
3141
|
end
|
|
1939
3142
|
```
|
|
1940
3143
|
|
|
@@ -1943,14 +3146,12 @@ end
|
|
|
1943
3146
|
Name | Type | Description | Notes
|
|
1944
3147
|
------------- | ------------- | ------------- | -------------
|
|
1945
3148
|
**conversation_id** | **String**| conversationId | |
|
|
1946
|
-
**participant_id** | **String**| participantId | |
|
|
1947
|
-
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
1948
3149
|
{: class="table table-striped"}
|
|
1949
3150
|
|
|
1950
3151
|
|
|
1951
3152
|
### Return type
|
|
1952
3153
|
|
|
1953
|
-
[**
|
|
3154
|
+
[**MessageConversation**](MessageConversation.html)
|
|
1954
3155
|
|
|
1955
3156
|
### HTTP request headers
|
|
1956
3157
|
|
|
@@ -1959,20 +3160,21 @@ Name | Type | Description | Notes
|
|
|
1959
3160
|
|
|
1960
3161
|
|
|
1961
3162
|
|
|
1962
|
-
<a name="
|
|
3163
|
+
<a name="get_conversations_message_communication_messages_media_media_id"></a>
|
|
1963
3164
|
|
|
1964
|
-
## [**
|
|
3165
|
+
## [**MessageMediaData**](MessageMediaData.html) get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id)
|
|
1965
3166
|
|
|
1966
3167
|
|
|
1967
3168
|
|
|
1968
|
-
Get
|
|
3169
|
+
Get media
|
|
1969
3170
|
|
|
1970
3171
|
|
|
1971
3172
|
|
|
1972
|
-
Wraps GET /api/v2/conversations/
|
|
3173
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}
|
|
1973
3174
|
|
|
1974
|
-
Requires
|
|
3175
|
+
Requires ANY permissions:
|
|
1975
3176
|
|
|
3177
|
+
* conversation:message:view
|
|
1976
3178
|
|
|
1977
3179
|
|
|
1978
3180
|
### Example
|
|
@@ -1994,15 +3196,17 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
1994
3196
|
|
|
1995
3197
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
1996
3198
|
|
|
1997
|
-
|
|
3199
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
3200
|
+
|
|
3201
|
+
media_id = "media_id_example" # String | mediaId
|
|
1998
3202
|
|
|
1999
3203
|
|
|
2000
3204
|
begin
|
|
2001
|
-
#Get
|
|
2002
|
-
result = api_instance.
|
|
3205
|
+
#Get media
|
|
3206
|
+
result = api_instance.get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id)
|
|
2003
3207
|
p result
|
|
2004
3208
|
rescue PureCloud::ApiError => e
|
|
2005
|
-
puts "Exception when calling ConversationsApi->
|
|
3209
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_communication_messages_media_media_id: #{e}"
|
|
2006
3210
|
end
|
|
2007
3211
|
```
|
|
2008
3212
|
|
|
@@ -2011,13 +3215,14 @@ end
|
|
|
2011
3215
|
Name | Type | Description | Notes
|
|
2012
3216
|
------------- | ------------- | ------------- | -------------
|
|
2013
3217
|
**conversation_id** | **String**| conversationId | |
|
|
2014
|
-
**
|
|
3218
|
+
**communication_id** | **String**| communicationId | |
|
|
3219
|
+
**media_id** | **String**| mediaId | |
|
|
2015
3220
|
{: class="table table-striped"}
|
|
2016
3221
|
|
|
2017
3222
|
|
|
2018
3223
|
### Return type
|
|
2019
3224
|
|
|
2020
|
-
[**
|
|
3225
|
+
[**MessageMediaData**](MessageMediaData.html)
|
|
2021
3226
|
|
|
2022
3227
|
### HTTP request headers
|
|
2023
3228
|
|
|
@@ -2026,20 +3231,21 @@ Name | Type | Description | Notes
|
|
|
2026
3231
|
|
|
2027
3232
|
|
|
2028
3233
|
|
|
2029
|
-
<a name="
|
|
3234
|
+
<a name="get_conversations_message_message"></a>
|
|
2030
3235
|
|
|
2031
|
-
## [**
|
|
3236
|
+
## [**MessageData**](MessageData.html) get_conversations_message_message(conversation_id, message_id)
|
|
2032
3237
|
|
|
2033
3238
|
|
|
2034
3239
|
|
|
2035
|
-
Get
|
|
3240
|
+
Get message
|
|
2036
3241
|
|
|
2037
3242
|
|
|
2038
3243
|
|
|
2039
|
-
Wraps GET /api/v2/conversations/
|
|
3244
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
|
|
2040
3245
|
|
|
2041
|
-
Requires
|
|
3246
|
+
Requires ANY permissions:
|
|
2042
3247
|
|
|
3248
|
+
* conversation:message:view
|
|
2043
3249
|
|
|
2044
3250
|
|
|
2045
3251
|
### Example
|
|
@@ -2059,23 +3265,32 @@ end
|
|
|
2059
3265
|
|
|
2060
3266
|
api_instance = PureCloud::ConversationsApi.new
|
|
2061
3267
|
|
|
3268
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3269
|
+
|
|
3270
|
+
message_id = "message_id_example" # String | messageId
|
|
3271
|
+
|
|
3272
|
+
|
|
2062
3273
|
begin
|
|
2063
|
-
#Get
|
|
2064
|
-
result = api_instance.
|
|
3274
|
+
#Get message
|
|
3275
|
+
result = api_instance.get_conversations_message_message(conversation_id, message_id)
|
|
2065
3276
|
p result
|
|
2066
3277
|
rescue PureCloud::ApiError => e
|
|
2067
|
-
puts "Exception when calling ConversationsApi->
|
|
3278
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_message: #{e}"
|
|
2068
3279
|
end
|
|
2069
3280
|
```
|
|
2070
3281
|
|
|
2071
3282
|
### Parameters
|
|
2072
|
-
|
|
3283
|
+
|
|
3284
|
+
Name | Type | Description | Notes
|
|
3285
|
+
------------- | ------------- | ------------- | -------------
|
|
3286
|
+
**conversation_id** | **String**| conversationId | |
|
|
3287
|
+
**message_id** | **String**| messageId | |
|
|
2073
3288
|
{: class="table table-striped"}
|
|
2074
3289
|
|
|
2075
3290
|
|
|
2076
3291
|
### Return type
|
|
2077
3292
|
|
|
2078
|
-
[**
|
|
3293
|
+
[**MessageData**](MessageData.html)
|
|
2079
3294
|
|
|
2080
3295
|
### HTTP request headers
|
|
2081
3296
|
|
|
@@ -2084,17 +3299,17 @@ This endpoint does not need any parameter.
|
|
|
2084
3299
|
|
|
2085
3300
|
|
|
2086
3301
|
|
|
2087
|
-
<a name="
|
|
3302
|
+
<a name="get_conversations_message_participant_wrapup"></a>
|
|
2088
3303
|
|
|
2089
|
-
## [**
|
|
3304
|
+
## [**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
|
2090
3305
|
|
|
2091
3306
|
|
|
2092
3307
|
|
|
2093
|
-
Get
|
|
3308
|
+
Get the wrap-up for this conversation participant.
|
|
2094
3309
|
|
|
2095
3310
|
|
|
2096
3311
|
|
|
2097
|
-
Wraps GET /api/v2/conversations/
|
|
3312
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup
|
|
2098
3313
|
|
|
2099
3314
|
Requires NO permissions:
|
|
2100
3315
|
|
|
@@ -2119,13 +3334,18 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
2119
3334
|
|
|
2120
3335
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
2121
3336
|
|
|
3337
|
+
participant_id = "participant_id_example" # String | participantId
|
|
3338
|
+
|
|
3339
|
+
opts = {
|
|
3340
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
3341
|
+
}
|
|
2122
3342
|
|
|
2123
3343
|
begin
|
|
2124
|
-
#Get
|
|
2125
|
-
result = api_instance.
|
|
3344
|
+
#Get the wrap-up for this conversation participant.
|
|
3345
|
+
result = api_instance.get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
|
2126
3346
|
p result
|
|
2127
3347
|
rescue PureCloud::ApiError => e
|
|
2128
|
-
puts "Exception when calling ConversationsApi->
|
|
3348
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapup: #{e}"
|
|
2129
3349
|
end
|
|
2130
3350
|
```
|
|
2131
3351
|
|
|
@@ -2134,12 +3354,14 @@ end
|
|
|
2134
3354
|
Name | Type | Description | Notes
|
|
2135
3355
|
------------- | ------------- | ------------- | -------------
|
|
2136
3356
|
**conversation_id** | **String**| conversationId | |
|
|
3357
|
+
**participant_id** | **String**| participantId | |
|
|
3358
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
2137
3359
|
{: class="table table-striped"}
|
|
2138
3360
|
|
|
2139
3361
|
|
|
2140
3362
|
### Return type
|
|
2141
3363
|
|
|
2142
|
-
[**
|
|
3364
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
2143
3365
|
|
|
2144
3366
|
### HTTP request headers
|
|
2145
3367
|
|
|
@@ -2148,17 +3370,17 @@ Name | Type | Description | Notes
|
|
|
2148
3370
|
|
|
2149
3371
|
|
|
2150
3372
|
|
|
2151
|
-
<a name="
|
|
3373
|
+
<a name="get_conversations_message_participant_wrapupcodes"></a>
|
|
2152
3374
|
|
|
2153
|
-
## [**
|
|
3375
|
+
## [**Array<WrapupCode>**](WrapupCode.html) get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
|
2154
3376
|
|
|
2155
3377
|
|
|
2156
3378
|
|
|
2157
|
-
Get conversation
|
|
3379
|
+
Get list of wrapup codes for this conversation participant
|
|
2158
3380
|
|
|
2159
3381
|
|
|
2160
3382
|
|
|
2161
|
-
Wraps GET /api/v2/conversations/
|
|
3383
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes
|
|
2162
3384
|
|
|
2163
3385
|
Requires NO permissions:
|
|
2164
3386
|
|
|
@@ -2181,17 +3403,17 @@ end
|
|
|
2181
3403
|
|
|
2182
3404
|
api_instance = PureCloud::ConversationsApi.new
|
|
2183
3405
|
|
|
2184
|
-
conversation_id = "conversation_id_example" # String |
|
|
3406
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2185
3407
|
|
|
2186
|
-
|
|
3408
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2187
3409
|
|
|
2188
3410
|
|
|
2189
3411
|
begin
|
|
2190
|
-
#Get conversation
|
|
2191
|
-
result = api_instance.
|
|
3412
|
+
#Get list of wrapup codes for this conversation participant
|
|
3413
|
+
result = api_instance.get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
|
2192
3414
|
p result
|
|
2193
3415
|
rescue PureCloud::ApiError => e
|
|
2194
|
-
puts "Exception when calling ConversationsApi->
|
|
3416
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapupcodes: #{e}"
|
|
2195
3417
|
end
|
|
2196
3418
|
```
|
|
2197
3419
|
|
|
@@ -2199,14 +3421,14 @@ end
|
|
|
2199
3421
|
|
|
2200
3422
|
Name | Type | Description | Notes
|
|
2201
3423
|
------------- | ------------- | ------------- | -------------
|
|
2202
|
-
**conversation_id** | **String**|
|
|
2203
|
-
**
|
|
3424
|
+
**conversation_id** | **String**| conversationId | |
|
|
3425
|
+
**participant_id** | **String**| participantId | |
|
|
2204
3426
|
{: class="table table-striped"}
|
|
2205
3427
|
|
|
2206
3428
|
|
|
2207
3429
|
### Return type
|
|
2208
3430
|
|
|
2209
|
-
[**
|
|
3431
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
2210
3432
|
|
|
2211
3433
|
### HTTP request headers
|
|
2212
3434
|
|
|
@@ -2215,17 +3437,17 @@ Name | Type | Description | Notes
|
|
|
2215
3437
|
|
|
2216
3438
|
|
|
2217
3439
|
|
|
2218
|
-
<a name="
|
|
3440
|
+
<a name="get_conversations_messages"></a>
|
|
2219
3441
|
|
|
2220
|
-
## [**
|
|
3442
|
+
## [**MessageConversationEntityListing**](MessageConversationEntityListing.html) get_conversations_messages
|
|
2221
3443
|
|
|
2222
3444
|
|
|
2223
3445
|
|
|
2224
|
-
Get
|
|
3446
|
+
Get active message conversations for the logged in user
|
|
2225
3447
|
|
|
2226
3448
|
|
|
2227
3449
|
|
|
2228
|
-
Wraps GET /api/v2/conversations/
|
|
3450
|
+
Wraps GET /api/v2/conversations/messages
|
|
2229
3451
|
|
|
2230
3452
|
Requires NO permissions:
|
|
2231
3453
|
|
|
@@ -2248,29 +3470,23 @@ end
|
|
|
2248
3470
|
|
|
2249
3471
|
api_instance = PureCloud::ConversationsApi.new
|
|
2250
3472
|
|
|
2251
|
-
conversation_id = "conversation_id_example" # String | conversationId
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
3473
|
begin
|
|
2255
|
-
#Get
|
|
2256
|
-
result = api_instance.
|
|
3474
|
+
#Get active message conversations for the logged in user
|
|
3475
|
+
result = api_instance.get_conversations_messages
|
|
2257
3476
|
p result
|
|
2258
3477
|
rescue PureCloud::ApiError => e
|
|
2259
|
-
puts "Exception when calling ConversationsApi->
|
|
3478
|
+
puts "Exception when calling ConversationsApi->get_conversations_messages: #{e}"
|
|
2260
3479
|
end
|
|
2261
3480
|
```
|
|
2262
3481
|
|
|
2263
3482
|
### Parameters
|
|
2264
|
-
|
|
2265
|
-
Name | Type | Description | Notes
|
|
2266
|
-
------------- | ------------- | ------------- | -------------
|
|
2267
|
-
**conversation_id** | **String**| conversationId | |
|
|
3483
|
+
This endpoint does not need any parameter.
|
|
2268
3484
|
{: class="table table-striped"}
|
|
2269
3485
|
|
|
2270
3486
|
|
|
2271
3487
|
### Return type
|
|
2272
3488
|
|
|
2273
|
-
[**
|
|
3489
|
+
[**MessageConversationEntityListing**](MessageConversationEntityListing.html)
|
|
2274
3490
|
|
|
2275
3491
|
### HTTP request headers
|
|
2276
3492
|
|
|
@@ -2279,20 +3495,21 @@ Name | Type | Description | Notes
|
|
|
2279
3495
|
|
|
2280
3496
|
|
|
2281
3497
|
|
|
2282
|
-
<a name="
|
|
3498
|
+
<a name="get_conversations_messaging_integrations"></a>
|
|
2283
3499
|
|
|
2284
|
-
## [**
|
|
3500
|
+
## [**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html) get_conversations_messaging_integrations(opts)
|
|
2285
3501
|
|
|
2286
3502
|
|
|
2287
3503
|
|
|
2288
|
-
Get
|
|
3504
|
+
Get a list of Integrations
|
|
2289
3505
|
|
|
2290
3506
|
|
|
2291
3507
|
|
|
2292
|
-
Wraps GET /api/v2/conversations/
|
|
3508
|
+
Wraps GET /api/v2/conversations/messaging/integrations
|
|
2293
3509
|
|
|
2294
|
-
Requires
|
|
3510
|
+
Requires ANY permissions:
|
|
2295
3511
|
|
|
3512
|
+
* messaging:integration:view
|
|
2296
3513
|
|
|
2297
3514
|
|
|
2298
3515
|
### Example
|
|
@@ -2312,15 +3529,17 @@ end
|
|
|
2312
3529
|
|
|
2313
3530
|
api_instance = PureCloud::ConversationsApi.new
|
|
2314
3531
|
|
|
2315
|
-
|
|
2316
|
-
|
|
3532
|
+
opts = {
|
|
3533
|
+
page_size: 25, # Integer | Page size
|
|
3534
|
+
page_number: 1 # Integer | Page number
|
|
3535
|
+
}
|
|
2317
3536
|
|
|
2318
3537
|
begin
|
|
2319
|
-
#Get
|
|
2320
|
-
result = api_instance.
|
|
3538
|
+
#Get a list of Integrations
|
|
3539
|
+
result = api_instance.get_conversations_messaging_integrations(opts)
|
|
2321
3540
|
p result
|
|
2322
3541
|
rescue PureCloud::ApiError => e
|
|
2323
|
-
puts "Exception when calling ConversationsApi->
|
|
3542
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations: #{e}"
|
|
2324
3543
|
end
|
|
2325
3544
|
```
|
|
2326
3545
|
|
|
@@ -2328,13 +3547,14 @@ end
|
|
|
2328
3547
|
|
|
2329
3548
|
Name | Type | Description | Notes
|
|
2330
3549
|
------------- | ------------- | ------------- | -------------
|
|
2331
|
-
**
|
|
3550
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3551
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2332
3552
|
{: class="table table-striped"}
|
|
2333
3553
|
|
|
2334
3554
|
|
|
2335
3555
|
### Return type
|
|
2336
3556
|
|
|
2337
|
-
[**
|
|
3557
|
+
[**MessagingIntegrationEntityListing**](MessagingIntegrationEntityListing.html)
|
|
2338
3558
|
|
|
2339
3559
|
### HTTP request headers
|
|
2340
3560
|
|
|
@@ -2343,20 +3563,21 @@ Name | Type | Description | Notes
|
|
|
2343
3563
|
|
|
2344
3564
|
|
|
2345
3565
|
|
|
2346
|
-
<a name="
|
|
3566
|
+
<a name="get_conversations_messaging_integrations_facebook"></a>
|
|
2347
3567
|
|
|
2348
|
-
## [**
|
|
3568
|
+
## [**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html) get_conversations_messaging_integrations_facebook(opts)
|
|
2349
3569
|
|
|
2350
3570
|
|
|
2351
3571
|
|
|
2352
|
-
Get
|
|
3572
|
+
Get a list of Facebook Integrations
|
|
2353
3573
|
|
|
2354
3574
|
|
|
2355
3575
|
|
|
2356
|
-
Wraps GET /api/v2/conversations/
|
|
3576
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook
|
|
2357
3577
|
|
|
2358
|
-
Requires
|
|
3578
|
+
Requires ANY permissions:
|
|
2359
3579
|
|
|
3580
|
+
* messaging:integration:view
|
|
2360
3581
|
|
|
2361
3582
|
|
|
2362
3583
|
### Example
|
|
@@ -2376,20 +3597,17 @@ end
|
|
|
2376
3597
|
|
|
2377
3598
|
api_instance = PureCloud::ConversationsApi.new
|
|
2378
3599
|
|
|
2379
|
-
conversation_id = "conversation_id_example" # String | conversationId
|
|
2380
|
-
|
|
2381
|
-
participant_id = "participant_id_example" # String | participantId
|
|
2382
|
-
|
|
2383
3600
|
opts = {
|
|
2384
|
-
|
|
3601
|
+
page_size: 25, # Integer | Page size
|
|
3602
|
+
page_number: 1 # Integer | Page number
|
|
2385
3603
|
}
|
|
2386
3604
|
|
|
2387
3605
|
begin
|
|
2388
|
-
#Get
|
|
2389
|
-
result = api_instance.
|
|
3606
|
+
#Get a list of Facebook Integrations
|
|
3607
|
+
result = api_instance.get_conversations_messaging_integrations_facebook(opts)
|
|
2390
3608
|
p result
|
|
2391
3609
|
rescue PureCloud::ApiError => e
|
|
2392
|
-
puts "Exception when calling ConversationsApi->
|
|
3610
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook: #{e}"
|
|
2393
3611
|
end
|
|
2394
3612
|
```
|
|
2395
3613
|
|
|
@@ -2397,15 +3615,14 @@ end
|
|
|
2397
3615
|
|
|
2398
3616
|
Name | Type | Description | Notes
|
|
2399
3617
|
------------- | ------------- | ------------- | -------------
|
|
2400
|
-
**
|
|
2401
|
-
**
|
|
2402
|
-
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
3618
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3619
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2403
3620
|
{: class="table table-striped"}
|
|
2404
3621
|
|
|
2405
3622
|
|
|
2406
3623
|
### Return type
|
|
2407
3624
|
|
|
2408
|
-
[**
|
|
3625
|
+
[**FacebookIntegrationEntityListing**](FacebookIntegrationEntityListing.html)
|
|
2409
3626
|
|
|
2410
3627
|
### HTTP request headers
|
|
2411
3628
|
|
|
@@ -2414,20 +3631,21 @@ Name | Type | Description | Notes
|
|
|
2414
3631
|
|
|
2415
3632
|
|
|
2416
3633
|
|
|
2417
|
-
<a name="
|
|
3634
|
+
<a name="get_conversations_messaging_integrations_facebook_integration_id"></a>
|
|
2418
3635
|
|
|
2419
|
-
## [**
|
|
3636
|
+
## [**FacebookIntegration**](FacebookIntegration.html) get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
2420
3637
|
|
|
2421
3638
|
|
|
2422
3639
|
|
|
2423
|
-
Get
|
|
3640
|
+
Get a Facebook messaging integration
|
|
2424
3641
|
|
|
2425
3642
|
|
|
2426
3643
|
|
|
2427
|
-
Wraps GET /api/v2/conversations/
|
|
3644
|
+
Wraps GET /api/v2/conversations/messaging/integrations/facebook/{integrationId}
|
|
2428
3645
|
|
|
2429
|
-
Requires
|
|
3646
|
+
Requires ANY permissions:
|
|
2430
3647
|
|
|
3648
|
+
* messaging:integration:view
|
|
2431
3649
|
|
|
2432
3650
|
|
|
2433
3651
|
### Example
|
|
@@ -2447,17 +3665,15 @@ end
|
|
|
2447
3665
|
|
|
2448
3666
|
api_instance = PureCloud::ConversationsApi.new
|
|
2449
3667
|
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
participant_id = "participant_id_example" # String | participantId
|
|
3668
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
2453
3669
|
|
|
2454
3670
|
|
|
2455
3671
|
begin
|
|
2456
|
-
#Get
|
|
2457
|
-
result = api_instance.
|
|
3672
|
+
#Get a Facebook messaging integration
|
|
3673
|
+
result = api_instance.get_conversations_messaging_integrations_facebook_integration_id(integration_id)
|
|
2458
3674
|
p result
|
|
2459
3675
|
rescue PureCloud::ApiError => e
|
|
2460
|
-
puts "Exception when calling ConversationsApi->
|
|
3676
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook_integration_id: #{e}"
|
|
2461
3677
|
end
|
|
2462
3678
|
```
|
|
2463
3679
|
|
|
@@ -2465,14 +3681,13 @@ end
|
|
|
2465
3681
|
|
|
2466
3682
|
Name | Type | Description | Notes
|
|
2467
3683
|
------------- | ------------- | ------------- | -------------
|
|
2468
|
-
**
|
|
2469
|
-
**participant_id** | **String**| participantId | |
|
|
3684
|
+
**integration_id** | **String**| Integration ID | |
|
|
2470
3685
|
{: class="table table-striped"}
|
|
2471
3686
|
|
|
2472
3687
|
|
|
2473
3688
|
### Return type
|
|
2474
3689
|
|
|
2475
|
-
[**
|
|
3690
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
|
2476
3691
|
|
|
2477
3692
|
### HTTP request headers
|
|
2478
3693
|
|
|
@@ -2481,20 +3696,21 @@ Name | Type | Description | Notes
|
|
|
2481
3696
|
|
|
2482
3697
|
|
|
2483
3698
|
|
|
2484
|
-
<a name="
|
|
3699
|
+
<a name="get_conversations_messaging_integrations_line"></a>
|
|
2485
3700
|
|
|
2486
|
-
## [**
|
|
3701
|
+
## [**LineIntegrationEntityListing**](LineIntegrationEntityListing.html) get_conversations_messaging_integrations_line(opts)
|
|
2487
3702
|
|
|
2488
3703
|
|
|
2489
3704
|
|
|
2490
|
-
Get
|
|
3705
|
+
Get a list of LINE messenger Integrations
|
|
2491
3706
|
|
|
2492
3707
|
|
|
2493
3708
|
|
|
2494
|
-
Wraps GET /api/v2/conversations/
|
|
3709
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line
|
|
2495
3710
|
|
|
2496
|
-
Requires
|
|
3711
|
+
Requires ANY permissions:
|
|
2497
3712
|
|
|
3713
|
+
* messaging:integration:view
|
|
2498
3714
|
|
|
2499
3715
|
|
|
2500
3716
|
### Example
|
|
@@ -2514,23 +3730,32 @@ end
|
|
|
2514
3730
|
|
|
2515
3731
|
api_instance = PureCloud::ConversationsApi.new
|
|
2516
3732
|
|
|
3733
|
+
opts = {
|
|
3734
|
+
page_size: 25, # Integer | Page size
|
|
3735
|
+
page_number: 1 # Integer | Page number
|
|
3736
|
+
}
|
|
3737
|
+
|
|
2517
3738
|
begin
|
|
2518
|
-
#Get
|
|
2519
|
-
result = api_instance.
|
|
3739
|
+
#Get a list of LINE messenger Integrations
|
|
3740
|
+
result = api_instance.get_conversations_messaging_integrations_line(opts)
|
|
2520
3741
|
p result
|
|
2521
3742
|
rescue PureCloud::ApiError => e
|
|
2522
|
-
puts "Exception when calling ConversationsApi->
|
|
3743
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_line: #{e}"
|
|
2523
3744
|
end
|
|
2524
3745
|
```
|
|
2525
3746
|
|
|
2526
3747
|
### Parameters
|
|
2527
|
-
|
|
3748
|
+
|
|
3749
|
+
Name | Type | Description | Notes
|
|
3750
|
+
------------- | ------------- | ------------- | -------------
|
|
3751
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3752
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2528
3753
|
{: class="table table-striped"}
|
|
2529
3754
|
|
|
2530
3755
|
|
|
2531
3756
|
### Return type
|
|
2532
3757
|
|
|
2533
|
-
[**
|
|
3758
|
+
[**LineIntegrationEntityListing**](LineIntegrationEntityListing.html)
|
|
2534
3759
|
|
|
2535
3760
|
### HTTP request headers
|
|
2536
3761
|
|
|
@@ -2539,20 +3764,21 @@ This endpoint does not need any parameter.
|
|
|
2539
3764
|
|
|
2540
3765
|
|
|
2541
3766
|
|
|
2542
|
-
<a name="
|
|
3767
|
+
<a name="get_conversations_messaging_integrations_line_integration_id"></a>
|
|
2543
3768
|
|
|
2544
|
-
## [**
|
|
3769
|
+
## [**LineIntegration**](LineIntegration.html) get_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
2545
3770
|
|
|
2546
3771
|
|
|
2547
3772
|
|
|
2548
|
-
Get
|
|
3773
|
+
Get a LINE messenger integration
|
|
2549
3774
|
|
|
2550
3775
|
|
|
2551
3776
|
|
|
2552
|
-
Wraps GET /api/v2/conversations/
|
|
3777
|
+
Wraps GET /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
2553
3778
|
|
|
2554
|
-
Requires
|
|
3779
|
+
Requires ANY permissions:
|
|
2555
3780
|
|
|
3781
|
+
* messaging:integration:view
|
|
2556
3782
|
|
|
2557
3783
|
|
|
2558
3784
|
### Example
|
|
@@ -2572,15 +3798,15 @@ end
|
|
|
2572
3798
|
|
|
2573
3799
|
api_instance = PureCloud::ConversationsApi.new
|
|
2574
3800
|
|
|
2575
|
-
|
|
3801
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
2576
3802
|
|
|
2577
3803
|
|
|
2578
3804
|
begin
|
|
2579
|
-
#Get
|
|
2580
|
-
result = api_instance.
|
|
3805
|
+
#Get a LINE messenger integration
|
|
3806
|
+
result = api_instance.get_conversations_messaging_integrations_line_integration_id(integration_id)
|
|
2581
3807
|
p result
|
|
2582
3808
|
rescue PureCloud::ApiError => e
|
|
2583
|
-
puts "Exception when calling ConversationsApi->
|
|
3809
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
2584
3810
|
end
|
|
2585
3811
|
```
|
|
2586
3812
|
|
|
@@ -2588,13 +3814,13 @@ end
|
|
|
2588
3814
|
|
|
2589
3815
|
Name | Type | Description | Notes
|
|
2590
3816
|
------------- | ------------- | ------------- | -------------
|
|
2591
|
-
**
|
|
3817
|
+
**integration_id** | **String**| Integration ID | |
|
|
2592
3818
|
{: class="table table-striped"}
|
|
2593
3819
|
|
|
2594
3820
|
|
|
2595
3821
|
### Return type
|
|
2596
3822
|
|
|
2597
|
-
[**
|
|
3823
|
+
[**LineIntegration**](LineIntegration.html)
|
|
2598
3824
|
|
|
2599
3825
|
### HTTP request headers
|
|
2600
3826
|
|
|
@@ -2603,21 +3829,21 @@ Name | Type | Description | Notes
|
|
|
2603
3829
|
|
|
2604
3830
|
|
|
2605
3831
|
|
|
2606
|
-
<a name="
|
|
3832
|
+
<a name="get_conversations_messaging_integrations_twitter"></a>
|
|
2607
3833
|
|
|
2608
|
-
## [**
|
|
3834
|
+
## [**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html) get_conversations_messaging_integrations_twitter(opts)
|
|
2609
3835
|
|
|
2610
3836
|
|
|
2611
3837
|
|
|
2612
|
-
Get
|
|
3838
|
+
Get a list of Twitter Integrations
|
|
2613
3839
|
|
|
2614
3840
|
|
|
2615
3841
|
|
|
2616
|
-
Wraps GET /api/v2/conversations/
|
|
3842
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter
|
|
2617
3843
|
|
|
2618
3844
|
Requires ANY permissions:
|
|
2619
3845
|
|
|
2620
|
-
*
|
|
3846
|
+
* messaging:integration:view
|
|
2621
3847
|
|
|
2622
3848
|
|
|
2623
3849
|
### Example
|
|
@@ -2637,19 +3863,17 @@ end
|
|
|
2637
3863
|
|
|
2638
3864
|
api_instance = PureCloud::ConversationsApi.new
|
|
2639
3865
|
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
media_id = "media_id_example" # String | mediaId
|
|
2645
|
-
|
|
3866
|
+
opts = {
|
|
3867
|
+
page_size: 25, # Integer | Page size
|
|
3868
|
+
page_number: 1 # Integer | Page number
|
|
3869
|
+
}
|
|
2646
3870
|
|
|
2647
3871
|
begin
|
|
2648
|
-
#Get
|
|
2649
|
-
result = api_instance.
|
|
3872
|
+
#Get a list of Twitter Integrations
|
|
3873
|
+
result = api_instance.get_conversations_messaging_integrations_twitter(opts)
|
|
2650
3874
|
p result
|
|
2651
3875
|
rescue PureCloud::ApiError => e
|
|
2652
|
-
puts "Exception when calling ConversationsApi->
|
|
3876
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_twitter: #{e}"
|
|
2653
3877
|
end
|
|
2654
3878
|
```
|
|
2655
3879
|
|
|
@@ -2657,15 +3881,14 @@ end
|
|
|
2657
3881
|
|
|
2658
3882
|
Name | Type | Description | Notes
|
|
2659
3883
|
------------- | ------------- | ------------- | -------------
|
|
2660
|
-
**
|
|
2661
|
-
**
|
|
2662
|
-
**media_id** | **String**| mediaId | |
|
|
3884
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3885
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2663
3886
|
{: class="table table-striped"}
|
|
2664
3887
|
|
|
2665
3888
|
|
|
2666
3889
|
### Return type
|
|
2667
3890
|
|
|
2668
|
-
[**
|
|
3891
|
+
[**TwitterIntegrationEntityListing**](TwitterIntegrationEntityListing.html)
|
|
2669
3892
|
|
|
2670
3893
|
### HTTP request headers
|
|
2671
3894
|
|
|
@@ -2674,21 +3897,21 @@ Name | Type | Description | Notes
|
|
|
2674
3897
|
|
|
2675
3898
|
|
|
2676
3899
|
|
|
2677
|
-
<a name="
|
|
3900
|
+
<a name="get_conversations_messaging_integrations_twitter_integration_id"></a>
|
|
2678
3901
|
|
|
2679
|
-
## [**
|
|
3902
|
+
## [**TwitterIntegration**](TwitterIntegration.html) get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
2680
3903
|
|
|
2681
3904
|
|
|
2682
3905
|
|
|
2683
|
-
Get
|
|
3906
|
+
Get a Twitter messaging integration
|
|
2684
3907
|
|
|
2685
3908
|
|
|
2686
3909
|
|
|
2687
|
-
Wraps GET /api/v2/conversations/
|
|
3910
|
+
Wraps GET /api/v2/conversations/messaging/integrations/twitter/{integrationId}
|
|
2688
3911
|
|
|
2689
3912
|
Requires ANY permissions:
|
|
2690
3913
|
|
|
2691
|
-
*
|
|
3914
|
+
* messaging:integration:view
|
|
2692
3915
|
|
|
2693
3916
|
|
|
2694
3917
|
### Example
|
|
@@ -2708,17 +3931,15 @@ end
|
|
|
2708
3931
|
|
|
2709
3932
|
api_instance = PureCloud::ConversationsApi.new
|
|
2710
3933
|
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
message_id = "message_id_example" # String | messageId
|
|
3934
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
2714
3935
|
|
|
2715
3936
|
|
|
2716
3937
|
begin
|
|
2717
|
-
#Get
|
|
2718
|
-
result = api_instance.
|
|
3938
|
+
#Get a Twitter messaging integration
|
|
3939
|
+
result = api_instance.get_conversations_messaging_integrations_twitter_integration_id(integration_id)
|
|
2719
3940
|
p result
|
|
2720
3941
|
rescue PureCloud::ApiError => e
|
|
2721
|
-
puts "Exception when calling ConversationsApi->
|
|
3942
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_twitter_integration_id: #{e}"
|
|
2722
3943
|
end
|
|
2723
3944
|
```
|
|
2724
3945
|
|
|
@@ -2726,14 +3947,13 @@ end
|
|
|
2726
3947
|
|
|
2727
3948
|
Name | Type | Description | Notes
|
|
2728
3949
|
------------- | ------------- | ------------- | -------------
|
|
2729
|
-
**
|
|
2730
|
-
**message_id** | **String**| messageId | |
|
|
3950
|
+
**integration_id** | **String**| Integration ID | |
|
|
2731
3951
|
{: class="table table-striped"}
|
|
2732
3952
|
|
|
2733
3953
|
|
|
2734
3954
|
### Return type
|
|
2735
3955
|
|
|
2736
|
-
[**
|
|
3956
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
|
2737
3957
|
|
|
2738
3958
|
### HTTP request headers
|
|
2739
3959
|
|
|
@@ -2742,20 +3962,21 @@ Name | Type | Description | Notes
|
|
|
2742
3962
|
|
|
2743
3963
|
|
|
2744
3964
|
|
|
2745
|
-
<a name="
|
|
3965
|
+
<a name="get_conversations_messaging_integrations_whatsapp"></a>
|
|
2746
3966
|
|
|
2747
|
-
## [**
|
|
3967
|
+
## [**WhatsAppIntegrationEntityListing**](WhatsAppIntegrationEntityListing.html) get_conversations_messaging_integrations_whatsapp(opts)
|
|
2748
3968
|
|
|
2749
3969
|
|
|
2750
3970
|
|
|
2751
|
-
Get
|
|
3971
|
+
Get a list of WhatsApp Integrations
|
|
2752
3972
|
|
|
2753
3973
|
|
|
2754
3974
|
|
|
2755
|
-
Wraps GET /api/v2/conversations/
|
|
3975
|
+
Wraps GET /api/v2/conversations/messaging/integrations/whatsapp
|
|
2756
3976
|
|
|
2757
|
-
Requires
|
|
3977
|
+
Requires ANY permissions:
|
|
2758
3978
|
|
|
3979
|
+
* messaging:integration:view
|
|
2759
3980
|
|
|
2760
3981
|
|
|
2761
3982
|
### Example
|
|
@@ -2775,20 +3996,17 @@ end
|
|
|
2775
3996
|
|
|
2776
3997
|
api_instance = PureCloud::ConversationsApi.new
|
|
2777
3998
|
|
|
2778
|
-
conversation_id = "conversation_id_example" # String | conversationId
|
|
2779
|
-
|
|
2780
|
-
participant_id = "participant_id_example" # String | participantId
|
|
2781
|
-
|
|
2782
3999
|
opts = {
|
|
2783
|
-
|
|
4000
|
+
page_size: 25, # Integer | Page size
|
|
4001
|
+
page_number: 1 # Integer | Page number
|
|
2784
4002
|
}
|
|
2785
4003
|
|
|
2786
4004
|
begin
|
|
2787
|
-
#Get
|
|
2788
|
-
result = api_instance.
|
|
4005
|
+
#Get a list of WhatsApp Integrations
|
|
4006
|
+
result = api_instance.get_conversations_messaging_integrations_whatsapp(opts)
|
|
2789
4007
|
p result
|
|
2790
4008
|
rescue PureCloud::ApiError => e
|
|
2791
|
-
puts "Exception when calling ConversationsApi->
|
|
4009
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp: #{e}"
|
|
2792
4010
|
end
|
|
2793
4011
|
```
|
|
2794
4012
|
|
|
@@ -2796,15 +4014,14 @@ end
|
|
|
2796
4014
|
|
|
2797
4015
|
Name | Type | Description | Notes
|
|
2798
4016
|
------------- | ------------- | ------------- | -------------
|
|
2799
|
-
**
|
|
2800
|
-
**
|
|
2801
|
-
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
4017
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
4018
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2802
4019
|
{: class="table table-striped"}
|
|
2803
4020
|
|
|
2804
4021
|
|
|
2805
4022
|
### Return type
|
|
2806
4023
|
|
|
2807
|
-
[**
|
|
4024
|
+
[**WhatsAppIntegrationEntityListing**](WhatsAppIntegrationEntityListing.html)
|
|
2808
4025
|
|
|
2809
4026
|
### HTTP request headers
|
|
2810
4027
|
|
|
@@ -2813,20 +4030,21 @@ Name | Type | Description | Notes
|
|
|
2813
4030
|
|
|
2814
4031
|
|
|
2815
4032
|
|
|
2816
|
-
<a name="
|
|
4033
|
+
<a name="get_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
2817
4034
|
|
|
2818
|
-
## [**
|
|
4035
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) get_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
2819
4036
|
|
|
2820
4037
|
|
|
2821
4038
|
|
|
2822
|
-
Get
|
|
4039
|
+
Get a WhatsApp messaging integration
|
|
2823
4040
|
|
|
2824
4041
|
|
|
2825
4042
|
|
|
2826
|
-
Wraps GET /api/v2/conversations/
|
|
4043
|
+
Wraps GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
|
|
2827
4044
|
|
|
2828
|
-
Requires
|
|
4045
|
+
Requires ANY permissions:
|
|
2829
4046
|
|
|
4047
|
+
* messaging:integration:view
|
|
2830
4048
|
|
|
2831
4049
|
|
|
2832
4050
|
### Example
|
|
@@ -2846,17 +4064,15 @@ end
|
|
|
2846
4064
|
|
|
2847
4065
|
api_instance = PureCloud::ConversationsApi.new
|
|
2848
4066
|
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
participant_id = "participant_id_example" # String | participantId
|
|
4067
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
2852
4068
|
|
|
2853
4069
|
|
|
2854
4070
|
begin
|
|
2855
|
-
#Get
|
|
2856
|
-
result = api_instance.
|
|
4071
|
+
#Get a WhatsApp messaging integration
|
|
4072
|
+
result = api_instance.get_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
2857
4073
|
p result
|
|
2858
4074
|
rescue PureCloud::ApiError => e
|
|
2859
|
-
puts "Exception when calling ConversationsApi->
|
|
4075
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
|
|
2860
4076
|
end
|
|
2861
4077
|
```
|
|
2862
4078
|
|
|
@@ -2864,14 +4080,13 @@ end
|
|
|
2864
4080
|
|
|
2865
4081
|
Name | Type | Description | Notes
|
|
2866
4082
|
------------- | ------------- | ------------- | -------------
|
|
2867
|
-
**
|
|
2868
|
-
**participant_id** | **String**| participantId | |
|
|
4083
|
+
**integration_id** | **String**| Integration ID | |
|
|
2869
4084
|
{: class="table table-striped"}
|
|
2870
4085
|
|
|
2871
4086
|
|
|
2872
4087
|
### Return type
|
|
2873
4088
|
|
|
2874
|
-
[**
|
|
4089
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
2875
4090
|
|
|
2876
4091
|
### HTTP request headers
|
|
2877
4092
|
|
|
@@ -2880,20 +4095,21 @@ Name | Type | Description | Notes
|
|
|
2880
4095
|
|
|
2881
4096
|
|
|
2882
4097
|
|
|
2883
|
-
<a name="
|
|
4098
|
+
<a name="get_conversations_messaging_sticker"></a>
|
|
2884
4099
|
|
|
2885
|
-
## [**
|
|
4100
|
+
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_conversations_messaging_sticker(messenger_type, opts)
|
|
2886
4101
|
|
|
2887
4102
|
|
|
2888
4103
|
|
|
2889
|
-
Get
|
|
4104
|
+
Get a list of Messaging Stickers
|
|
2890
4105
|
|
|
2891
4106
|
|
|
2892
4107
|
|
|
2893
|
-
Wraps GET /api/v2/conversations/
|
|
4108
|
+
Wraps GET /api/v2/conversations/messaging/stickers/{messengerType}
|
|
2894
4109
|
|
|
2895
|
-
Requires
|
|
4110
|
+
Requires ANY permissions:
|
|
2896
4111
|
|
|
4112
|
+
* conversation:message:create
|
|
2897
4113
|
|
|
2898
4114
|
|
|
2899
4115
|
### Example
|
|
@@ -2913,23 +4129,35 @@ end
|
|
|
2913
4129
|
|
|
2914
4130
|
api_instance = PureCloud::ConversationsApi.new
|
|
2915
4131
|
|
|
4132
|
+
messenger_type = "messenger_type_example" # String | Messenger Type
|
|
4133
|
+
|
|
4134
|
+
opts = {
|
|
4135
|
+
page_size: 25, # Integer | Page size
|
|
4136
|
+
page_number: 1 # Integer | Page number
|
|
4137
|
+
}
|
|
4138
|
+
|
|
2916
4139
|
begin
|
|
2917
|
-
#Get
|
|
2918
|
-
result = api_instance.
|
|
4140
|
+
#Get a list of Messaging Stickers
|
|
4141
|
+
result = api_instance.get_conversations_messaging_sticker(messenger_type, opts)
|
|
2919
4142
|
p result
|
|
2920
4143
|
rescue PureCloud::ApiError => e
|
|
2921
|
-
puts "Exception when calling ConversationsApi->
|
|
4144
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_sticker: #{e}"
|
|
2922
4145
|
end
|
|
2923
4146
|
```
|
|
2924
4147
|
|
|
2925
4148
|
### Parameters
|
|
2926
|
-
|
|
4149
|
+
|
|
4150
|
+
Name | Type | Description | Notes
|
|
4151
|
+
------------- | ------------- | ------------- | -------------
|
|
4152
|
+
**messenger_type** | **String**| Messenger Type | |
|
|
4153
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
4154
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2927
4155
|
{: class="table table-striped"}
|
|
2928
4156
|
|
|
2929
4157
|
|
|
2930
4158
|
### Return type
|
|
2931
4159
|
|
|
2932
|
-
[**
|
|
4160
|
+
[**MessagingStickerEntityListing**](MessagingStickerEntityListing.html)
|
|
2933
4161
|
|
|
2934
4162
|
### HTTP request headers
|
|
2935
4163
|
|
|
@@ -4824,6 +6052,74 @@ Name | Type | Description | Notes
|
|
|
4824
6052
|
|
|
4825
6053
|
|
|
4826
6054
|
|
|
6055
|
+
<a name="patch_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
6056
|
+
|
|
6057
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
|
|
6058
|
+
|
|
6059
|
+
|
|
6060
|
+
|
|
6061
|
+
Activate a WhatsApp messaging integration.
|
|
6062
|
+
|
|
6063
|
+
The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
6064
|
+
|
|
6065
|
+
Wraps PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
|
|
6066
|
+
|
|
6067
|
+
Requires ANY permissions:
|
|
6068
|
+
|
|
6069
|
+
* messaging:integration:edit
|
|
6070
|
+
|
|
6071
|
+
|
|
6072
|
+
### Example
|
|
6073
|
+
```{"language":"ruby"}
|
|
6074
|
+
# load the gem
|
|
6075
|
+
require 'purecloudplatformclientv2'
|
|
6076
|
+
# setup authorization
|
|
6077
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6078
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6079
|
+
environment = "mypurecloud.com"
|
|
6080
|
+
|
|
6081
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6082
|
+
|
|
6083
|
+
PureCloud.configure do |config|
|
|
6084
|
+
config.access_token = @authToken
|
|
6085
|
+
end
|
|
6086
|
+
|
|
6087
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
6088
|
+
|
|
6089
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
6090
|
+
|
|
6091
|
+
body = PureCloud::WhatsAppIntegrationUpdateRequest.new # WhatsAppIntegrationUpdateRequest | WhatsAppIntegrationUpdateRequest
|
|
6092
|
+
|
|
6093
|
+
|
|
6094
|
+
begin
|
|
6095
|
+
#Activate a WhatsApp messaging integration.
|
|
6096
|
+
result = api_instance.patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
|
|
6097
|
+
p result
|
|
6098
|
+
rescue PureCloud::ApiError => e
|
|
6099
|
+
puts "Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
|
|
6100
|
+
end
|
|
6101
|
+
```
|
|
6102
|
+
|
|
6103
|
+
### Parameters
|
|
6104
|
+
|
|
6105
|
+
Name | Type | Description | Notes
|
|
6106
|
+
------------- | ------------- | ------------- | -------------
|
|
6107
|
+
**integration_id** | **String**| Integration ID | |
|
|
6108
|
+
**body** | [**WhatsAppIntegrationUpdateRequest**](WhatsAppIntegrationUpdateRequest.html)| WhatsAppIntegrationUpdateRequest | |
|
|
6109
|
+
{: class="table table-striped"}
|
|
6110
|
+
|
|
6111
|
+
|
|
6112
|
+
### Return type
|
|
6113
|
+
|
|
6114
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
6115
|
+
|
|
6116
|
+
### HTTP request headers
|
|
6117
|
+
|
|
6118
|
+
- **Content-Type**: application/json
|
|
6119
|
+
- **Accept**: application/json
|
|
6120
|
+
|
|
6121
|
+
|
|
6122
|
+
|
|
4827
6123
|
<a name="post_analytics_conversation_details_properties"></a>
|
|
4828
6124
|
|
|
4829
6125
|
## [**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
|
@@ -4894,7 +6190,7 @@ Name | Type | Description | Notes
|
|
|
4894
6190
|
|
|
4895
6191
|
<a name="post_analytics_conversations_aggregates_query"></a>
|
|
4896
6192
|
|
|
4897
|
-
## [**
|
|
6193
|
+
## [**ConversationAggregateQueryResponse**](ConversationAggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
|
4898
6194
|
|
|
4899
6195
|
|
|
4900
6196
|
|
|
@@ -4926,7 +6222,7 @@ end
|
|
|
4926
6222
|
|
|
4927
6223
|
api_instance = PureCloud::ConversationsApi.new
|
|
4928
6224
|
|
|
4929
|
-
body = PureCloud::
|
|
6225
|
+
body = PureCloud::ConversationAggregationQuery.new # ConversationAggregationQuery | query
|
|
4930
6226
|
|
|
4931
6227
|
|
|
4932
6228
|
begin
|
|
@@ -4942,13 +6238,78 @@ end
|
|
|
4942
6238
|
|
|
4943
6239
|
Name | Type | Description | Notes
|
|
4944
6240
|
------------- | ------------- | ------------- | -------------
|
|
4945
|
-
**body** | [**
|
|
6241
|
+
**body** | [**ConversationAggregationQuery**](ConversationAggregationQuery.html)| query | |
|
|
6242
|
+
{: class="table table-striped"}
|
|
6243
|
+
|
|
6244
|
+
|
|
6245
|
+
### Return type
|
|
6246
|
+
|
|
6247
|
+
[**ConversationAggregateQueryResponse**](ConversationAggregateQueryResponse.html)
|
|
6248
|
+
|
|
6249
|
+
### HTTP request headers
|
|
6250
|
+
|
|
6251
|
+
- **Content-Type**: application/json
|
|
6252
|
+
- **Accept**: application/json
|
|
6253
|
+
|
|
6254
|
+
|
|
6255
|
+
|
|
6256
|
+
<a name="post_analytics_conversations_details_jobs"></a>
|
|
6257
|
+
|
|
6258
|
+
## [**AsyncQueryResponse**](AsyncQueryResponse.html) post_analytics_conversations_details_jobs(body)
|
|
6259
|
+
|
|
6260
|
+
|
|
6261
|
+
|
|
6262
|
+
Query for conversation details asynchronously
|
|
6263
|
+
|
|
6264
|
+
|
|
6265
|
+
|
|
6266
|
+
Wraps POST /api/v2/analytics/conversations/details/jobs
|
|
6267
|
+
|
|
6268
|
+
Requires ANY permissions:
|
|
6269
|
+
|
|
6270
|
+
* analytics:conversationDetail:view
|
|
6271
|
+
|
|
6272
|
+
|
|
6273
|
+
### Example
|
|
6274
|
+
```{"language":"ruby"}
|
|
6275
|
+
# load the gem
|
|
6276
|
+
require 'purecloudplatformclientv2'
|
|
6277
|
+
# setup authorization
|
|
6278
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6279
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6280
|
+
environment = "mypurecloud.com"
|
|
6281
|
+
|
|
6282
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6283
|
+
|
|
6284
|
+
PureCloud.configure do |config|
|
|
6285
|
+
config.access_token = @authToken
|
|
6286
|
+
end
|
|
6287
|
+
|
|
6288
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
6289
|
+
|
|
6290
|
+
body = PureCloud::AsyncConversationQuery.new # AsyncConversationQuery | query
|
|
6291
|
+
|
|
6292
|
+
|
|
6293
|
+
begin
|
|
6294
|
+
#Query for conversation details asynchronously
|
|
6295
|
+
result = api_instance.post_analytics_conversations_details_jobs(body)
|
|
6296
|
+
p result
|
|
6297
|
+
rescue PureCloud::ApiError => e
|
|
6298
|
+
puts "Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: #{e}"
|
|
6299
|
+
end
|
|
6300
|
+
```
|
|
6301
|
+
|
|
6302
|
+
### Parameters
|
|
6303
|
+
|
|
6304
|
+
Name | Type | Description | Notes
|
|
6305
|
+
------------- | ------------- | ------------- | -------------
|
|
6306
|
+
**body** | [**AsyncConversationQuery**](AsyncConversationQuery.html)| query | |
|
|
4946
6307
|
{: class="table table-striped"}
|
|
4947
6308
|
|
|
4948
6309
|
|
|
4949
6310
|
### Return type
|
|
4950
6311
|
|
|
4951
|
-
[**
|
|
6312
|
+
[**AsyncQueryResponse**](AsyncQueryResponse.html)
|
|
4952
6313
|
|
|
4953
6314
|
### HTTP request headers
|
|
4954
6315
|
|
|
@@ -5768,7 +7129,137 @@ Name | Type | Description | Notes
|
|
|
5768
7129
|
|
|
5769
7130
|
### Return type
|
|
5770
7131
|
|
|
5771
|
-
nil (empty response body)
|
|
7132
|
+
nil (empty response body)
|
|
7133
|
+
|
|
7134
|
+
### HTTP request headers
|
|
7135
|
+
|
|
7136
|
+
- **Content-Type**: application/json
|
|
7137
|
+
- **Accept**: application/json
|
|
7138
|
+
|
|
7139
|
+
|
|
7140
|
+
|
|
7141
|
+
<a name="post_conversations_callbacks"></a>
|
|
7142
|
+
|
|
7143
|
+
## [**CreateCallbackResponse**](CreateCallbackResponse.html) post_conversations_callbacks(body)
|
|
7144
|
+
|
|
7145
|
+
|
|
7146
|
+
|
|
7147
|
+
Create a Callback
|
|
7148
|
+
|
|
7149
|
+
|
|
7150
|
+
|
|
7151
|
+
Wraps POST /api/v2/conversations/callbacks
|
|
7152
|
+
|
|
7153
|
+
Requires ANY permissions:
|
|
7154
|
+
|
|
7155
|
+
* conversation:callback:create
|
|
7156
|
+
|
|
7157
|
+
|
|
7158
|
+
### Example
|
|
7159
|
+
```{"language":"ruby"}
|
|
7160
|
+
# load the gem
|
|
7161
|
+
require 'purecloudplatformclientv2'
|
|
7162
|
+
# setup authorization
|
|
7163
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
7164
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
7165
|
+
environment = "mypurecloud.com"
|
|
7166
|
+
|
|
7167
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
7168
|
+
|
|
7169
|
+
PureCloud.configure do |config|
|
|
7170
|
+
config.access_token = @authToken
|
|
7171
|
+
end
|
|
7172
|
+
|
|
7173
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
7174
|
+
|
|
7175
|
+
body = PureCloud::CreateCallbackCommand.new # CreateCallbackCommand | Callback
|
|
7176
|
+
|
|
7177
|
+
|
|
7178
|
+
begin
|
|
7179
|
+
#Create a Callback
|
|
7180
|
+
result = api_instance.post_conversations_callbacks(body)
|
|
7181
|
+
p result
|
|
7182
|
+
rescue PureCloud::ApiError => e
|
|
7183
|
+
puts "Exception when calling ConversationsApi->post_conversations_callbacks: #{e}"
|
|
7184
|
+
end
|
|
7185
|
+
```
|
|
7186
|
+
|
|
7187
|
+
### Parameters
|
|
7188
|
+
|
|
7189
|
+
Name | Type | Description | Notes
|
|
7190
|
+
------------- | ------------- | ------------- | -------------
|
|
7191
|
+
**body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)| Callback | |
|
|
7192
|
+
{: class="table table-striped"}
|
|
7193
|
+
|
|
7194
|
+
|
|
7195
|
+
### Return type
|
|
7196
|
+
|
|
7197
|
+
[**CreateCallbackResponse**](CreateCallbackResponse.html)
|
|
7198
|
+
|
|
7199
|
+
### HTTP request headers
|
|
7200
|
+
|
|
7201
|
+
- **Content-Type**: application/json
|
|
7202
|
+
- **Accept**: application/json
|
|
7203
|
+
|
|
7204
|
+
|
|
7205
|
+
|
|
7206
|
+
<a name="post_conversations_calls"></a>
|
|
7207
|
+
|
|
7208
|
+
## [**CreateCallResponse**](CreateCallResponse.html) post_conversations_calls(body)
|
|
7209
|
+
|
|
7210
|
+
|
|
7211
|
+
|
|
7212
|
+
Create a call conversation
|
|
7213
|
+
|
|
7214
|
+
|
|
7215
|
+
|
|
7216
|
+
Wraps POST /api/v2/conversations/calls
|
|
7217
|
+
|
|
7218
|
+
Requires ANY permissions:
|
|
7219
|
+
|
|
7220
|
+
* conversation:conference:add
|
|
7221
|
+
|
|
7222
|
+
|
|
7223
|
+
### Example
|
|
7224
|
+
```{"language":"ruby"}
|
|
7225
|
+
# load the gem
|
|
7226
|
+
require 'purecloudplatformclientv2'
|
|
7227
|
+
# setup authorization
|
|
7228
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
7229
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
7230
|
+
environment = "mypurecloud.com"
|
|
7231
|
+
|
|
7232
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
7233
|
+
|
|
7234
|
+
PureCloud.configure do |config|
|
|
7235
|
+
config.access_token = @authToken
|
|
7236
|
+
end
|
|
7237
|
+
|
|
7238
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
7239
|
+
|
|
7240
|
+
body = PureCloud::CreateCallRequest.new # CreateCallRequest | Call request
|
|
7241
|
+
|
|
7242
|
+
|
|
7243
|
+
begin
|
|
7244
|
+
#Create a call conversation
|
|
7245
|
+
result = api_instance.post_conversations_calls(body)
|
|
7246
|
+
p result
|
|
7247
|
+
rescue PureCloud::ApiError => e
|
|
7248
|
+
puts "Exception when calling ConversationsApi->post_conversations_calls: #{e}"
|
|
7249
|
+
end
|
|
7250
|
+
```
|
|
7251
|
+
|
|
7252
|
+
### Parameters
|
|
7253
|
+
|
|
7254
|
+
Name | Type | Description | Notes
|
|
7255
|
+
------------- | ------------- | ------------- | -------------
|
|
7256
|
+
**body** | [**CreateCallRequest**](CreateCallRequest.html)| Call request | |
|
|
7257
|
+
{: class="table table-striped"}
|
|
7258
|
+
|
|
7259
|
+
|
|
7260
|
+
### Return type
|
|
7261
|
+
|
|
7262
|
+
[**CreateCallResponse**](CreateCallResponse.html)
|
|
5772
7263
|
|
|
5773
7264
|
### HTTP request headers
|
|
5774
7265
|
|
|
@@ -5777,21 +7268,20 @@ nil (empty response body)
|
|
|
5777
7268
|
|
|
5778
7269
|
|
|
5779
7270
|
|
|
5780
|
-
<a name="
|
|
7271
|
+
<a name="post_conversations_chat_communication_messages"></a>
|
|
5781
7272
|
|
|
5782
|
-
## [**
|
|
7273
|
+
## [**WebChatMessage**](WebChatMessage.html) post_conversations_chat_communication_messages(conversation_id, communication_id, body)
|
|
5783
7274
|
|
|
5784
7275
|
|
|
5785
7276
|
|
|
5786
|
-
|
|
7277
|
+
Send a message on behalf of a communication in a chat conversation.
|
|
5787
7278
|
|
|
5788
7279
|
|
|
5789
7280
|
|
|
5790
|
-
Wraps POST /api/v2/conversations/
|
|
7281
|
+
Wraps POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages
|
|
5791
7282
|
|
|
5792
|
-
Requires
|
|
7283
|
+
Requires NO permissions:
|
|
5793
7284
|
|
|
5794
|
-
* conversation:callback:create
|
|
5795
7285
|
|
|
5796
7286
|
|
|
5797
7287
|
### Example
|
|
@@ -5811,15 +7301,19 @@ end
|
|
|
5811
7301
|
|
|
5812
7302
|
api_instance = PureCloud::ConversationsApi.new
|
|
5813
7303
|
|
|
5814
|
-
|
|
7304
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
7305
|
+
|
|
7306
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
7307
|
+
|
|
7308
|
+
body = PureCloud::CreateWebChatMessageRequest.new # CreateWebChatMessageRequest | Message
|
|
5815
7309
|
|
|
5816
7310
|
|
|
5817
7311
|
begin
|
|
5818
|
-
#
|
|
5819
|
-
result = api_instance.
|
|
7312
|
+
#Send a message on behalf of a communication in a chat conversation.
|
|
7313
|
+
result = api_instance.post_conversations_chat_communication_messages(conversation_id, communication_id, body)
|
|
5820
7314
|
p result
|
|
5821
7315
|
rescue PureCloud::ApiError => e
|
|
5822
|
-
puts "Exception when calling ConversationsApi->
|
|
7316
|
+
puts "Exception when calling ConversationsApi->post_conversations_chat_communication_messages: #{e}"
|
|
5823
7317
|
end
|
|
5824
7318
|
```
|
|
5825
7319
|
|
|
@@ -5827,13 +7321,15 @@ end
|
|
|
5827
7321
|
|
|
5828
7322
|
Name | Type | Description | Notes
|
|
5829
7323
|
------------- | ------------- | ------------- | -------------
|
|
5830
|
-
**
|
|
7324
|
+
**conversation_id** | **String**| conversationId | |
|
|
7325
|
+
**communication_id** | **String**| communicationId | |
|
|
7326
|
+
**body** | [**CreateWebChatMessageRequest**](CreateWebChatMessageRequest.html)| Message | |
|
|
5831
7327
|
{: class="table table-striped"}
|
|
5832
7328
|
|
|
5833
7329
|
|
|
5834
7330
|
### Return type
|
|
5835
7331
|
|
|
5836
|
-
[**
|
|
7332
|
+
[**WebChatMessage**](WebChatMessage.html)
|
|
5837
7333
|
|
|
5838
7334
|
### HTTP request headers
|
|
5839
7335
|
|
|
@@ -5842,21 +7338,20 @@ Name | Type | Description | Notes
|
|
|
5842
7338
|
|
|
5843
7339
|
|
|
5844
7340
|
|
|
5845
|
-
<a name="
|
|
7341
|
+
<a name="post_conversations_chat_communication_typing"></a>
|
|
5846
7342
|
|
|
5847
|
-
## [**
|
|
7343
|
+
## [**WebChatTyping**](WebChatTyping.html) post_conversations_chat_communication_typing(conversation_id, communication_id)
|
|
5848
7344
|
|
|
5849
7345
|
|
|
5850
7346
|
|
|
5851
|
-
|
|
7347
|
+
Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
5852
7348
|
|
|
5853
7349
|
|
|
5854
7350
|
|
|
5855
|
-
Wraps POST /api/v2/conversations/
|
|
7351
|
+
Wraps POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing
|
|
5856
7352
|
|
|
5857
|
-
Requires
|
|
7353
|
+
Requires NO permissions:
|
|
5858
7354
|
|
|
5859
|
-
* conversation:conference:add
|
|
5860
7355
|
|
|
5861
7356
|
|
|
5862
7357
|
### Example
|
|
@@ -5876,15 +7371,17 @@ end
|
|
|
5876
7371
|
|
|
5877
7372
|
api_instance = PureCloud::ConversationsApi.new
|
|
5878
7373
|
|
|
5879
|
-
|
|
7374
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
7375
|
+
|
|
7376
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
5880
7377
|
|
|
5881
7378
|
|
|
5882
7379
|
begin
|
|
5883
|
-
#
|
|
5884
|
-
result = api_instance.
|
|
7380
|
+
#Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
7381
|
+
result = api_instance.post_conversations_chat_communication_typing(conversation_id, communication_id)
|
|
5885
7382
|
p result
|
|
5886
7383
|
rescue PureCloud::ApiError => e
|
|
5887
|
-
puts "Exception when calling ConversationsApi->
|
|
7384
|
+
puts "Exception when calling ConversationsApi->post_conversations_chat_communication_typing: #{e}"
|
|
5888
7385
|
end
|
|
5889
7386
|
```
|
|
5890
7387
|
|
|
@@ -5892,13 +7389,14 @@ end
|
|
|
5892
7389
|
|
|
5893
7390
|
Name | Type | Description | Notes
|
|
5894
7391
|
------------- | ------------- | ------------- | -------------
|
|
5895
|
-
**
|
|
7392
|
+
**conversation_id** | **String**| conversationId | |
|
|
7393
|
+
**communication_id** | **String**| communicationId | |
|
|
5896
7394
|
{: class="table table-striped"}
|
|
5897
7395
|
|
|
5898
7396
|
|
|
5899
7397
|
### Return type
|
|
5900
7398
|
|
|
5901
|
-
[**
|
|
7399
|
+
[**WebChatTyping**](WebChatTyping.html)
|
|
5902
7400
|
|
|
5903
7401
|
### HTTP request headers
|
|
5904
7402
|
|
|
@@ -6785,6 +8283,201 @@ Name | Type | Description | Notes
|
|
|
6785
8283
|
|
|
6786
8284
|
|
|
6787
8285
|
|
|
8286
|
+
<a name="post_conversations_messaging_integrations_facebook"></a>
|
|
8287
|
+
|
|
8288
|
+
## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
|
|
8289
|
+
|
|
8290
|
+
|
|
8291
|
+
|
|
8292
|
+
Create a Facebook Integration
|
|
8293
|
+
|
|
8294
|
+
|
|
8295
|
+
|
|
8296
|
+
Wraps POST /api/v2/conversations/messaging/integrations/facebook
|
|
8297
|
+
|
|
8298
|
+
Requires ANY permissions:
|
|
8299
|
+
|
|
8300
|
+
* messaging:integration:add
|
|
8301
|
+
|
|
8302
|
+
|
|
8303
|
+
### Example
|
|
8304
|
+
```{"language":"ruby"}
|
|
8305
|
+
# load the gem
|
|
8306
|
+
require 'purecloudplatformclientv2'
|
|
8307
|
+
# setup authorization
|
|
8308
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8309
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8310
|
+
environment = "mypurecloud.com"
|
|
8311
|
+
|
|
8312
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8313
|
+
|
|
8314
|
+
PureCloud.configure do |config|
|
|
8315
|
+
config.access_token = @authToken
|
|
8316
|
+
end
|
|
8317
|
+
|
|
8318
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8319
|
+
|
|
8320
|
+
body = PureCloud::FacebookIntegrationRequest.new # FacebookIntegrationRequest | FacebookIntegrationRequest
|
|
8321
|
+
|
|
8322
|
+
|
|
8323
|
+
begin
|
|
8324
|
+
#Create a Facebook Integration
|
|
8325
|
+
result = api_instance.post_conversations_messaging_integrations_facebook(body)
|
|
8326
|
+
p result
|
|
8327
|
+
rescue PureCloud::ApiError => e
|
|
8328
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_facebook: #{e}"
|
|
8329
|
+
end
|
|
8330
|
+
```
|
|
8331
|
+
|
|
8332
|
+
### Parameters
|
|
8333
|
+
|
|
8334
|
+
Name | Type | Description | Notes
|
|
8335
|
+
------------- | ------------- | ------------- | -------------
|
|
8336
|
+
**body** | [**FacebookIntegrationRequest**](FacebookIntegrationRequest.html)| FacebookIntegrationRequest | |
|
|
8337
|
+
{: class="table table-striped"}
|
|
8338
|
+
|
|
8339
|
+
|
|
8340
|
+
### Return type
|
|
8341
|
+
|
|
8342
|
+
[**FacebookIntegration**](FacebookIntegration.html)
|
|
8343
|
+
|
|
8344
|
+
### HTTP request headers
|
|
8345
|
+
|
|
8346
|
+
- **Content-Type**: application/json
|
|
8347
|
+
- **Accept**: application/json
|
|
8348
|
+
|
|
8349
|
+
|
|
8350
|
+
|
|
8351
|
+
<a name="post_conversations_messaging_integrations_line"></a>
|
|
8352
|
+
|
|
8353
|
+
## [**LineIntegration**](LineIntegration.html) post_conversations_messaging_integrations_line(body)
|
|
8354
|
+
|
|
8355
|
+
|
|
8356
|
+
|
|
8357
|
+
Create a LINE messenger Integration
|
|
8358
|
+
|
|
8359
|
+
|
|
8360
|
+
|
|
8361
|
+
Wraps POST /api/v2/conversations/messaging/integrations/line
|
|
8362
|
+
|
|
8363
|
+
Requires ANY permissions:
|
|
8364
|
+
|
|
8365
|
+
* messaging:integration:add
|
|
8366
|
+
|
|
8367
|
+
|
|
8368
|
+
### Example
|
|
8369
|
+
```{"language":"ruby"}
|
|
8370
|
+
# load the gem
|
|
8371
|
+
require 'purecloudplatformclientv2'
|
|
8372
|
+
# setup authorization
|
|
8373
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8374
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8375
|
+
environment = "mypurecloud.com"
|
|
8376
|
+
|
|
8377
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8378
|
+
|
|
8379
|
+
PureCloud.configure do |config|
|
|
8380
|
+
config.access_token = @authToken
|
|
8381
|
+
end
|
|
8382
|
+
|
|
8383
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8384
|
+
|
|
8385
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
|
8386
|
+
|
|
8387
|
+
|
|
8388
|
+
begin
|
|
8389
|
+
#Create a LINE messenger Integration
|
|
8390
|
+
result = api_instance.post_conversations_messaging_integrations_line(body)
|
|
8391
|
+
p result
|
|
8392
|
+
rescue PureCloud::ApiError => e
|
|
8393
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_line: #{e}"
|
|
8394
|
+
end
|
|
8395
|
+
```
|
|
8396
|
+
|
|
8397
|
+
### Parameters
|
|
8398
|
+
|
|
8399
|
+
Name | Type | Description | Notes
|
|
8400
|
+
------------- | ------------- | ------------- | -------------
|
|
8401
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
|
8402
|
+
{: class="table table-striped"}
|
|
8403
|
+
|
|
8404
|
+
|
|
8405
|
+
### Return type
|
|
8406
|
+
|
|
8407
|
+
[**LineIntegration**](LineIntegration.html)
|
|
8408
|
+
|
|
8409
|
+
### HTTP request headers
|
|
8410
|
+
|
|
8411
|
+
- **Content-Type**: application/json
|
|
8412
|
+
- **Accept**: application/json
|
|
8413
|
+
|
|
8414
|
+
|
|
8415
|
+
|
|
8416
|
+
<a name="post_conversations_messaging_integrations_twitter"></a>
|
|
8417
|
+
|
|
8418
|
+
## [**TwitterIntegration**](TwitterIntegration.html) post_conversations_messaging_integrations_twitter(body)
|
|
8419
|
+
|
|
8420
|
+
|
|
8421
|
+
|
|
8422
|
+
Create a Twitter Integration
|
|
8423
|
+
|
|
8424
|
+
|
|
8425
|
+
|
|
8426
|
+
Wraps POST /api/v2/conversations/messaging/integrations/twitter
|
|
8427
|
+
|
|
8428
|
+
Requires ANY permissions:
|
|
8429
|
+
|
|
8430
|
+
* messaging:integration:add
|
|
8431
|
+
|
|
8432
|
+
|
|
8433
|
+
### Example
|
|
8434
|
+
```{"language":"ruby"}
|
|
8435
|
+
# load the gem
|
|
8436
|
+
require 'purecloudplatformclientv2'
|
|
8437
|
+
# setup authorization
|
|
8438
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8439
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8440
|
+
environment = "mypurecloud.com"
|
|
8441
|
+
|
|
8442
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8443
|
+
|
|
8444
|
+
PureCloud.configure do |config|
|
|
8445
|
+
config.access_token = @authToken
|
|
8446
|
+
end
|
|
8447
|
+
|
|
8448
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8449
|
+
|
|
8450
|
+
body = PureCloud::TwitterIntegrationRequest.new # TwitterIntegrationRequest | TwitterIntegrationRequest
|
|
8451
|
+
|
|
8452
|
+
|
|
8453
|
+
begin
|
|
8454
|
+
#Create a Twitter Integration
|
|
8455
|
+
result = api_instance.post_conversations_messaging_integrations_twitter(body)
|
|
8456
|
+
p result
|
|
8457
|
+
rescue PureCloud::ApiError => e
|
|
8458
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_twitter: #{e}"
|
|
8459
|
+
end
|
|
8460
|
+
```
|
|
8461
|
+
|
|
8462
|
+
### Parameters
|
|
8463
|
+
|
|
8464
|
+
Name | Type | Description | Notes
|
|
8465
|
+
------------- | ------------- | ------------- | -------------
|
|
8466
|
+
**body** | [**TwitterIntegrationRequest**](TwitterIntegrationRequest.html)| TwitterIntegrationRequest | |
|
|
8467
|
+
{: class="table table-striped"}
|
|
8468
|
+
|
|
8469
|
+
|
|
8470
|
+
### Return type
|
|
8471
|
+
|
|
8472
|
+
[**TwitterIntegration**](TwitterIntegration.html)
|
|
8473
|
+
|
|
8474
|
+
### HTTP request headers
|
|
8475
|
+
|
|
8476
|
+
- **Content-Type**: application/json
|
|
8477
|
+
- **Accept**: application/json
|
|
8478
|
+
|
|
8479
|
+
|
|
8480
|
+
|
|
6788
8481
|
<a name="put_conversation_participant_flaggedreason"></a>
|
|
6789
8482
|
|
|
6790
8483
|
## put_conversation_participant_flaggedreason(conversation_id, participant_id)
|
|
@@ -6991,3 +8684,71 @@ Name | Type | Description | Notes
|
|
|
6991
8684
|
|
|
6992
8685
|
|
|
6993
8686
|
|
|
8687
|
+
<a name="put_conversations_messaging_integrations_line_integration_id"></a>
|
|
8688
|
+
|
|
8689
|
+
## [**LineIntegration**](LineIntegration.html) put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
|
8690
|
+
|
|
8691
|
+
|
|
8692
|
+
|
|
8693
|
+
Update a LINE messenger integration
|
|
8694
|
+
|
|
8695
|
+
|
|
8696
|
+
|
|
8697
|
+
Wraps PUT /api/v2/conversations/messaging/integrations/line/{integrationId}
|
|
8698
|
+
|
|
8699
|
+
Requires ANY permissions:
|
|
8700
|
+
|
|
8701
|
+
* messaging:integration:edit
|
|
8702
|
+
|
|
8703
|
+
|
|
8704
|
+
### Example
|
|
8705
|
+
```{"language":"ruby"}
|
|
8706
|
+
# load the gem
|
|
8707
|
+
require 'purecloudplatformclientv2'
|
|
8708
|
+
# setup authorization
|
|
8709
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8710
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8711
|
+
environment = "mypurecloud.com"
|
|
8712
|
+
|
|
8713
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8714
|
+
|
|
8715
|
+
PureCloud.configure do |config|
|
|
8716
|
+
config.access_token = @authToken
|
|
8717
|
+
end
|
|
8718
|
+
|
|
8719
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8720
|
+
|
|
8721
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
8722
|
+
|
|
8723
|
+
body = PureCloud::LineIntegrationRequest.new # LineIntegrationRequest | LineIntegrationRequest
|
|
8724
|
+
|
|
8725
|
+
|
|
8726
|
+
begin
|
|
8727
|
+
#Update a LINE messenger integration
|
|
8728
|
+
result = api_instance.put_conversations_messaging_integrations_line_integration_id(integration_id, body)
|
|
8729
|
+
p result
|
|
8730
|
+
rescue PureCloud::ApiError => e
|
|
8731
|
+
puts "Exception when calling ConversationsApi->put_conversations_messaging_integrations_line_integration_id: #{e}"
|
|
8732
|
+
end
|
|
8733
|
+
```
|
|
8734
|
+
|
|
8735
|
+
### Parameters
|
|
8736
|
+
|
|
8737
|
+
Name | Type | Description | Notes
|
|
8738
|
+
------------- | ------------- | ------------- | -------------
|
|
8739
|
+
**integration_id** | **String**| Integration ID | |
|
|
8740
|
+
**body** | [**LineIntegrationRequest**](LineIntegrationRequest.html)| LineIntegrationRequest | |
|
|
8741
|
+
{: class="table table-striped"}
|
|
8742
|
+
|
|
8743
|
+
|
|
8744
|
+
### Return type
|
|
8745
|
+
|
|
8746
|
+
[**LineIntegration**](LineIntegration.html)
|
|
8747
|
+
|
|
8748
|
+
### HTTP request headers
|
|
8749
|
+
|
|
8750
|
+
- **Content-Type**: application/json
|
|
8751
|
+
- **Accept**: application/json
|
|
8752
|
+
|
|
8753
|
+
|
|
8754
|
+
|