purecloudplatformclientv2 91.0.0 → 96.0.0
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/AfterCallWork.md +15 -0
- data/docs/AmazonLexRequest.md +14 -0
- data/docs/AnalyticsApi.md +67 -1
- data/docs/AnalyticsProposedAgent.md +14 -0
- data/docs/AnalyticsSession.md +6 -0
- data/docs/ArchitectApi.md +51 -49
- data/docs/ArrayNode.md +4 -4
- data/docs/AuditApi.md +130 -0
- data/docs/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/AvailableTopic.md +1 -0
- data/docs/Biography.md +1 -0
- data/docs/BuAgentSchedulesQueryResponse.md +1 -0
- data/docs/ButtonComponent.md +16 -0
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/Callback.md +1 -0
- data/docs/CallbackBasic.md +1 -0
- data/docs/CoachingApi.md +115 -30
- data/docs/CoachingAppointmentAggregateRequest.md +16 -0
- data/docs/CoachingAppointmentAggregateResponse.md +13 -0
- data/docs/CoachingAppointmentResponse.md +1 -0
- data/docs/CoachingNotification.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommonCampaign.md +17 -0
- data/docs/CommonCampaignDivisionView.md +17 -0
- data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
- data/docs/CommonCampaignEntityListing.md +22 -0
- data/docs/Contact.md +1 -0
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/ConversationAssociation.md +1 -1
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEventTopicAfterCallWork.md +15 -0
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +2 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationMetrics.md +15 -0
- data/docs/ConversationsApi.md +73 -4
- data/docs/CreateCoachingAppointmentRequest.md +1 -1
- data/docs/CursorContactListing.md +16 -0
- data/docs/CursorNoteListing.md +16 -0
- data/docs/CursorOrganizationListing.md +16 -0
- data/docs/CursorRelationshipListing.md +16 -0
- data/docs/EdgeGroup.md +1 -0
- data/docs/Education.md +17 -0
- data/docs/Email.md +1 -0
- data/docs/EntityListing.md +1 -5
- data/docs/ExternalContactsApi.md +285 -9
- data/docs/ExternalOrganizationTrustorLink.md +1 -2
- data/docs/FacebookIntegrationUpdateRequest.md +14 -0
- data/docs/GoogleDialogflowCustomSettings.md +13 -0
- data/docs/HistoricalAdherenceActuals.md +15 -0
- data/docs/HistoricalAdherenceDayMetrics.md +23 -0
- data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
- data/docs/HistoricalAdherenceQueryResult.md +21 -0
- data/docs/JourneyAggregateDataContainer.md +14 -0
- data/docs/JourneyAggregateQueryClause.md +14 -0
- data/docs/JourneyAggregateQueryFilter.md +15 -0
- data/docs/JourneyAggregateQueryPredicate.md +17 -0
- data/docs/JourneyAggregateQueryResponse.md +13 -0
- data/docs/JourneyAggregationQuery.md +21 -0
- data/docs/JourneyAggregationView.md +16 -0
- data/docs/JourneyApi.md +78 -0
- data/docs/JsonNode.md +4 -4
- data/docs/KnowledgeSearchRequest.md +3 -3
- data/docs/LanguageUnderstandingApi.md +165 -31
- data/docs/ListItemComponent.md +19 -0
- data/docs/Message.md +1 -0
- data/docs/MessageContent.md +19 -0
- data/docs/MessagingCampaign.md +28 -0
- data/docs/MessagingCampaignDivisionView.md +16 -0
- data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
- data/docs/MessagingCampaignEntityListing.md +22 -0
- data/docs/NluDomainVersion.md +2 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClient.md +2 -0
- data/docs/OAuthClientListing.md +2 -0
- data/docs/OAuthClientRequest.md +2 -0
- data/docs/ObservationValue.md +3 -1
- data/docs/OrgOAuthClient.md +2 -0
- data/docs/OutboundApi.md +881 -76
- data/docs/Permissions.md +0 -2
- data/docs/PhoneCapabilities.md +1 -0
- data/docs/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/PresenceApi.md +206 -6
- data/docs/PresenceExpand.md +17 -0
- data/docs/QueryRequestClause.md +14 -0
- data/docs/QueryRequestFilter.md +14 -0
- data/docs/QueryRequestPredicate.md +14 -0
- data/docs/QueryResponseData.md +14 -0
- data/docs/QueryResponseGroupedData.md +14 -0
- data/docs/QueryResponseMetric.md +14 -0
- data/docs/QueryResponseStats.md +13 -0
- data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +2 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +2 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +2 -2
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +4 -0
- data/docs/RoutingApi.md +14 -14
- data/docs/SCIMApi.md +92 -104
- data/docs/ScimConfigResourceType.md +2 -2
- data/docs/ScimGenesysUserExternalId.md +14 -0
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimUserExtensions.md +3 -2
- data/docs/ScimUserRole.md +1 -1
- data/docs/ScimUserRoutingLanguage.md +2 -2
- data/docs/ScimUserRoutingSkill.md +2 -2
- data/docs/ScimV2CreateUser.md +3 -3
- data/docs/ScimV2Group.md +1 -1
- data/docs/ScimV2SchemaAttribute.md +11 -11
- data/docs/ScimV2SchemaDefinition.md +5 -5
- data/docs/ScimV2SchemaListResponse.md +1 -1
- data/docs/ScimV2User.md +4 -4
- data/docs/Screenshare.md +1 -0
- data/docs/SearchApi.md +5 -2
- data/docs/SmsConfig.md +15 -0
- data/docs/SmsPhoneNumberRef.md +14 -0
- data/docs/SocialExpression.md +1 -0
- data/docs/SpeechTextAnalyticsApi.md +147 -0
- data/docs/StatEventFlowOutcomeTopicDatum.md +14 -0
- data/docs/StatEventFlowOutcomeTopicMetric.md +15 -0
- data/docs/StatEventFlowOutcomeTopicStatsNotification.md +14 -0
- data/docs/StatEventFlowTopicDatum.md +14 -0
- data/docs/StatEventFlowTopicMetric.md +15 -0
- data/docs/StatEventFlowTopicStatsNotification.md +14 -0
- data/docs/StatEventWrapUpCodeTopicDatum.md +14 -0
- data/docs/StatEventWrapUpCodeTopicMetric.md +15 -0
- data/docs/StatEventWrapUpCodeTopicStatsNotification.md +14 -0
- data/docs/SurveyForm.md +0 -2
- data/docs/TelephonyProvidersEdgeApi.md +6 -2
- data/docs/TextbotsApi.md +78 -0
- data/docs/TranscriptUrl.md +13 -0
- data/docs/UpdateCoachingAppointmentRequest.md +2 -1
- data/docs/UserRoutingLanguage.md +3 -3
- data/docs/UserRoutingLanguagePost.md +1 -1
- data/docs/UserRoutingSkill.md +1 -1
- data/docs/UserScheduleAdherence.md +1 -0
- data/docs/UserSearchRequest.md +2 -0
- data/docs/UsersApi.md +19 -6
- data/docs/Video.md +1 -0
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailUserPolicy.md +1 -0
- data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md +1 -0
- data/docs/WfmBusinessUnitReference.md +14 -0
- data/docs/WfmHistoricalAdherenceResponse.md +1 -0
- data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
- data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
- data/docs/WfmScheduleReference.md +16 -0
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +1 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +28 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +1 -0
- data/lib/purecloudplatformclientv2.rb +91 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +155 -9
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
- data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
- data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
- data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
- data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +167 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/acw_settings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
- data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
- data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +178 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
- data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
- data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +30 -4
- data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/call.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_request.rb +294 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb +204 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_metrics.rb +254 -0
- data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/education.rb +304 -0
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +8 -34
- data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
- data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
- data/lib/purecloudplatformclientv2/models/ip_address_range.rb +2 -2
- data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
- data/lib/purecloudplatformclientv2/models/library.rb +2 -2
- data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/message.rb +32 -6
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +2 -2
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +67 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +67 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +70 -4
- data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +67 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/permissions.rb +1 -52
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
- data/lib/purecloudplatformclientv2/models/query_request_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_filter.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_predicate.rb +252 -0
- data/lib/purecloudplatformclientv2/models/query_response_data.rb +230 -0
- data/lib/purecloudplatformclientv2/models/query_response_grouped_data.rb +232 -0
- data/lib/purecloudplatformclientv2/models/query_response_metric.rb +242 -0
- data/lib/purecloudplatformclientv2/models/query_response_stats.rb +202 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +53 -3
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/recipient.rb +2 -2
- data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +109 -1
- data/lib/purecloudplatformclientv2/models/response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
- data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
- data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
- data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +70 -4
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/view_filter.rb +60 -4
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +33 -8
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +233 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +295 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update.rb +606 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +185 -3
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ListItemComponent
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ListItemComponent
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | An ID assigned to this component | [optional] |
|
|
11
|
+
| **rmid** | **String** | An ID of the rich message instance | [optional] |
|
|
12
|
+
| **type** | **String** | The type of component to render | [optional] |
|
|
13
|
+
| **image** | **String** | Path or URI to an image file | [optional] |
|
|
14
|
+
| **title** | **String** | The main headline of the list item | [optional] |
|
|
15
|
+
| **description** | **String** | Text to show in the description row | [optional] |
|
|
16
|
+
| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
data/docs/Message.md
CHANGED
|
@@ -29,6 +29,7 @@ title: Message
|
|
|
29
29
|
| **from_address** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
30
30
|
| **messages** | [**Array<MessageDetails>**](MessageDetails.html) | The messages sent on this communication channel. | [optional] |
|
|
31
31
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
|
|
32
|
+
| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
|
|
32
33
|
{: class="table table-striped"}
|
|
33
34
|
|
|
34
35
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessageContent
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessageContent
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **content_type** | **String** | Type of this content element. If contentType = \"Attachment\" only one item is allowed. | |
|
|
11
|
+
| **location** | [**ContentLocation**](ContentLocation.html) | Location object | [optional] |
|
|
12
|
+
| **attachment** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
|
|
13
|
+
| **quick_reply** | [**ContentQuickReply**](ContentQuickReply.html) | Quick reply object | [optional] |
|
|
14
|
+
| **generic** | [**ContentGeneric**](ContentGeneric.html) | Generic content object | [optional] |
|
|
15
|
+
| **list** | [**ContentList**](ContentList.html) | List content object | [optional] |
|
|
16
|
+
| **template** | [**ContentNotificationTemplate**](ContentNotificationTemplate.html) | Template notification object | [optional] |
|
|
17
|
+
{: class="table table-striped"}
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingCampaign
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingCampaign
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
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
|
+
| **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
|
+
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
+
| **division** | [**DomainEntityRef**](DomainEntityRef.html) | The division this entity belongs to. | [optional] |
|
|
16
|
+
| **campaign_status** | **String** | The current status of the messaging campaign. A messaging campaign may be turned 'on' or 'off'. | [optional] |
|
|
17
|
+
| **callable_time_set** | [**DomainEntityRef**](DomainEntityRef.html) | The callable time set for this messaging campaign. | [optional] |
|
|
18
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The contact list that this messaging campaign will send messages for. | |
|
|
19
|
+
| **dnc_lists** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The dnc lists to check before sending a message for this messaging campaign. | [optional] |
|
|
20
|
+
| **always_running** | **BOOLEAN** | Whether this messaging campaign is always running | [optional] |
|
|
21
|
+
| **contact_sorts** | [**Array<ContactSort>**](ContactSort.html) | The order in which to sort contacts for dialing, based on up to four columns. | [optional] |
|
|
22
|
+
| **messages_per_minute** | **Integer** | How many messages this messaging campaign will send per minute. | |
|
|
23
|
+
| **errors** | [**Array<RestErrorDetail>**](RestErrorDetail.html) | A list of current error conditions associated with this messaging campaign. | [optional] |
|
|
24
|
+
| **sms_config** | [**SmsConfig**](SmsConfig.html) | Configuration for this messaging campaign to send SMS messages. | [optional] |
|
|
25
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
26
|
+
{: class="table table-striped"}
|
|
27
|
+
|
|
28
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingCampaignDivisionView
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingCampaignDivisionView
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingCampaignDivisionViewEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingCampaignDivisionViewEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<MessagingCampaignDivisionView>**](MessagingCampaignDivisionView.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingCampaignEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingCampaignEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<MessagingCampaign>**](MessagingCampaign.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
data/docs/NluDomainVersion.md
CHANGED
|
@@ -10,7 +10,8 @@ title: NluDomainVersion
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **domain** | [**NluDomain**](NluDomain.html) | The NLU domain of the version. | [optional] |
|
|
12
12
|
| **description** | **String** | The description of the NLU domain version. | [optional] |
|
|
13
|
-
| **language** | **String** | The language that the NLU domain version supports. |
|
|
13
|
+
| **language** | **String** | The language that the NLU domain version supports. | |
|
|
14
|
+
| **published** | **BOOLEAN** | Whether this NLU domain version has been published. | [optional] |
|
|
14
15
|
| **date_created** | **DateTime** | The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
16
|
| **date_modified** | **DateTime** | The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
17
|
| **date_trained** | **DateTime** | The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: NotificationTemplateBody
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::NotificationTemplateBody
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **text** | **String** | Body text. For WhatsApp, ignored | [optional] |
|
|
11
|
+
| **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: NotificationTemplateFooter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::NotificationTemplateFooter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **text** | **String** | Footer text. For WhatsApp, ignored | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: NotificationTemplateHeader
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::NotificationTemplateHeader
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | Template header type | |
|
|
11
|
+
| **text** | **String** | Header text. For WhatsApp, ignored | [optional] |
|
|
12
|
+
| **media** | [**ContentAttachment**](ContentAttachment.html) | Attachment object | [optional] |
|
|
13
|
+
| **parameters** | [**Array<NotificationTemplateParameter>**](NotificationTemplateParameter.html) | Template parameters for placeholders in template | [optional] |
|
|
14
|
+
{: class="table table-striped"}
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: NotificationTemplateParameter
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::NotificationTemplateParameter
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **name** | **String** | Parameter name | [optional] |
|
|
11
|
+
| **text** | **String** | Parameter text value | |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/NotificationsApi.md
CHANGED
|
@@ -130,7 +130,7 @@ end
|
|
|
130
130
|
|
|
131
131
|
Name | Type | Description | Notes
|
|
132
132
|
------------- | ------------- | ------------- | -------------
|
|
133
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: description, requiresPermissions, schema |
|
|
133
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: description, requiresPermissions, schema, transports |
|
|
134
134
|
{: class="table table-striped"}
|
|
135
135
|
|
|
136
136
|
|
data/docs/OAuthClient.md
CHANGED
|
@@ -21,6 +21,8 @@ title: OAuthClient
|
|
|
21
21
|
| **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
|
|
22
22
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
|
23
23
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
|
24
|
+
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
|
25
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
24
26
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
25
27
|
{: class="table table-striped"}
|
|
26
28
|
|
data/docs/OAuthClientListing.md
CHANGED
|
@@ -20,6 +20,8 @@ title: OAuthClientListing
|
|
|
20
20
|
| **modified_by** | [**DomainEntityRef**](DomainEntityRef.html) | User that last modified this client | [optional] |
|
|
21
21
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
|
22
22
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
|
23
|
+
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
|
24
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
23
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
24
26
|
{: class="table table-striped"}
|
|
25
27
|
|
data/docs/OAuthClientRequest.md
CHANGED
|
@@ -15,6 +15,8 @@ title: OAuthClientRequest
|
|
|
15
15
|
| **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
|
|
16
16
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
|
17
17
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
|
18
|
+
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
|
19
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
18
20
|
{: class="table table-striped"}
|
|
19
21
|
|
|
20
22
|
|
data/docs/ObservationValue.md
CHANGED
|
@@ -22,7 +22,9 @@ title: ObservationValue
|
|
|
22
22
|
| **address_to** | **String** | The address receiving an action | [optional] |
|
|
23
23
|
| **ani** | **String** | Automatic Number Identification (caller's number) | [optional] |
|
|
24
24
|
| **dnis** | **String** | Dialed number identification service (number dialed by the calling party) | [optional] |
|
|
25
|
-
| **team_id** | **String** | The team
|
|
25
|
+
| **team_id** | **String** | The team id the user is a member of | [optional] |
|
|
26
|
+
| **requested_routings** | **Array<String>** | All routing types for requested/attempted routing methods | [optional] |
|
|
27
|
+
| **used_routing** | **String** | Complete routing method | [optional] |
|
|
26
28
|
| **scored_agents** | [**Array<AnalyticsScoredAgent>**](AnalyticsScoredAgent.html) | | [optional] |
|
|
27
29
|
{: class="table table-striped"}
|
|
28
30
|
|
data/docs/OrgOAuthClient.md
CHANGED
|
@@ -16,6 +16,8 @@ title: OrgOAuthClient
|
|
|
16
16
|
| **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
|
|
17
17
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
|
18
18
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
|
19
|
+
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
|
20
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
19
21
|
| **organization** | [**NamedEntity**](NamedEntity.html) | The oauth client's organization. | [optional] |
|
|
20
22
|
{: class="table table-striped"}
|
|
21
23
|
|
data/docs/OutboundApi.md
CHANGED
|
@@ -20,6 +20,7 @@ Method | Description
|
|
|
20
20
|
[**delete_outbound_contactlistfilter**](OutboundApi.html#delete_outbound_contactlistfilter) | Delete Contact List Filter
|
|
21
21
|
[**delete_outbound_contactlists**](OutboundApi.html#delete_outbound_contactlists) | Delete multiple contact lists.
|
|
22
22
|
[**delete_outbound_dnclist**](OutboundApi.html#delete_outbound_dnclist) | Delete dialer DNC list
|
|
23
|
+
[**delete_outbound_messagingcampaign**](OutboundApi.html#delete_outbound_messagingcampaign) | Delete an Outbound Messaging Campaign
|
|
23
24
|
[**delete_outbound_ruleset**](OutboundApi.html#delete_outbound_ruleset) | Delete a Rule set.
|
|
24
25
|
[**delete_outbound_schedules_campaign**](OutboundApi.html#delete_outbound_schedules_campaign) | Delete a dialer campaign schedule.
|
|
25
26
|
[**delete_outbound_schedules_sequence**](OutboundApi.html#delete_outbound_schedules_sequence) | Delete a dialer sequence schedule.
|
|
@@ -38,6 +39,8 @@ Method | Description
|
|
|
38
39
|
[**get_outbound_campaignrule**](OutboundApi.html#get_outbound_campaignrule) | Get Campaign Rule
|
|
39
40
|
[**get_outbound_campaignrules**](OutboundApi.html#get_outbound_campaignrules) | Query Campaign Rule list
|
|
40
41
|
[**get_outbound_campaigns**](OutboundApi.html#get_outbound_campaigns) | Query a list of dialer campaigns.
|
|
42
|
+
[**get_outbound_campaigns_all**](OutboundApi.html#get_outbound_campaigns_all) | Query across all types of campaigns by division
|
|
43
|
+
[**get_outbound_campaigns_all_divisionviews**](OutboundApi.html#get_outbound_campaigns_all_divisionviews) | Query across all types of campaigns
|
|
41
44
|
[**get_outbound_campaigns_divisionview**](OutboundApi.html#get_outbound_campaigns_divisionview) | Get a basic Campaign information object
|
|
42
45
|
[**get_outbound_campaigns_divisionviews**](OutboundApi.html#get_outbound_campaigns_divisionviews) | Query a list of basic Campaign information objects
|
|
43
46
|
[**get_outbound_contactlist**](OutboundApi.html#get_outbound_contactlist) | Get a dialer contact list.
|
|
@@ -58,6 +61,11 @@ Method | Description
|
|
|
58
61
|
[**get_outbound_dnclists_divisionviews**](OutboundApi.html#get_outbound_dnclists_divisionviews) | Query a list of simplified dnc list objects.
|
|
59
62
|
[**get_outbound_event**](OutboundApi.html#get_outbound_event) | Get Dialer Event
|
|
60
63
|
[**get_outbound_events**](OutboundApi.html#get_outbound_events) | Query Event Logs
|
|
64
|
+
[**get_outbound_messagingcampaign**](OutboundApi.html#get_outbound_messagingcampaign) | Get an Outbound Messaging Campaign
|
|
65
|
+
[**get_outbound_messagingcampaign_progress**](OutboundApi.html#get_outbound_messagingcampaign_progress) | Get messaging campaign's progress
|
|
66
|
+
[**get_outbound_messagingcampaigns**](OutboundApi.html#get_outbound_messagingcampaigns) | Query a list of Messaging Campaigns
|
|
67
|
+
[**get_outbound_messagingcampaigns_divisionview**](OutboundApi.html#get_outbound_messagingcampaigns_divisionview) | Get a basic Messaging Campaign information object
|
|
68
|
+
[**get_outbound_messagingcampaigns_divisionviews**](OutboundApi.html#get_outbound_messagingcampaigns_divisionviews) | Query a list of basic Messaging Campaign information objects
|
|
61
69
|
[**get_outbound_ruleset**](OutboundApi.html#get_outbound_ruleset) | Get a Rule Set by ID.
|
|
62
70
|
[**get_outbound_rulesets**](OutboundApi.html#get_outbound_rulesets) | Query a list of Rule Sets.
|
|
63
71
|
[**get_outbound_schedules_campaign**](OutboundApi.html#get_outbound_schedules_campaign) | Get a dialer campaign schedule.
|
|
@@ -88,6 +96,8 @@ Method | Description
|
|
|
88
96
|
[**post_outbound_dnclist_export**](OutboundApi.html#post_outbound_dnclist_export) | Initiate the export of a dnc list.
|
|
89
97
|
[**post_outbound_dnclist_phonenumbers**](OutboundApi.html#post_outbound_dnclist_phonenumbers) | Add phone numbers to a Dialer DNC list.
|
|
90
98
|
[**post_outbound_dnclists**](OutboundApi.html#post_outbound_dnclists) | Create dialer DNC list
|
|
99
|
+
[**post_outbound_messagingcampaigns**](OutboundApi.html#post_outbound_messagingcampaigns) | Create a Messaging Campaign
|
|
100
|
+
[**post_outbound_messagingcampaigns_progress**](OutboundApi.html#post_outbound_messagingcampaigns_progress) | Get progress for a list of messaging campaigns
|
|
91
101
|
[**post_outbound_rulesets**](OutboundApi.html#post_outbound_rulesets) | Create a Dialer Call Analysis Response Set.
|
|
92
102
|
[**post_outbound_sequences**](OutboundApi.html#post_outbound_sequences) | Create a new campaign sequence.
|
|
93
103
|
[**put_outbound_attemptlimit**](OutboundApi.html#put_outbound_attemptlimit) | Update attempt limits
|
|
@@ -100,6 +110,7 @@ Method | Description
|
|
|
100
110
|
[**put_outbound_contactlist_contact**](OutboundApi.html#put_outbound_contactlist_contact) | Update a contact.
|
|
101
111
|
[**put_outbound_contactlistfilter**](OutboundApi.html#put_outbound_contactlistfilter) | Update Contact List Filter
|
|
102
112
|
[**put_outbound_dnclist**](OutboundApi.html#put_outbound_dnclist) | Update dialer DNC list
|
|
113
|
+
[**put_outbound_messagingcampaign**](OutboundApi.html#put_outbound_messagingcampaign) | Update an Outbound Messaging Campaign
|
|
103
114
|
[**put_outbound_ruleset**](OutboundApi.html#put_outbound_ruleset) | Update a RuleSet.
|
|
104
115
|
[**put_outbound_schedules_campaign**](OutboundApi.html#put_outbound_schedules_campaign) | Update a new campaign schedule.
|
|
105
116
|
[**put_outbound_schedules_sequence**](OutboundApi.html#put_outbound_schedules_sequence) | Update a new sequence schedule.
|
|
@@ -882,6 +893,71 @@ nil (empty response body)
|
|
|
882
893
|
|
|
883
894
|
|
|
884
895
|
|
|
896
|
+
<a name="delete_outbound_messagingcampaign"></a>
|
|
897
|
+
|
|
898
|
+
## [**MessagingCampaign**](MessagingCampaign.html) delete_outbound_messagingcampaign(messaging_campaign_id)
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
Delete an Outbound Messaging Campaign
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
Wraps DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}
|
|
907
|
+
|
|
908
|
+
Requires ANY permissions:
|
|
909
|
+
|
|
910
|
+
* outbound:campaign:delete
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
### Example
|
|
914
|
+
```{"language":"ruby"}
|
|
915
|
+
# load the gem
|
|
916
|
+
require 'purecloudplatformclientv2'
|
|
917
|
+
# setup authorization
|
|
918
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
919
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
920
|
+
environment = "mypurecloud.com"
|
|
921
|
+
|
|
922
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
923
|
+
|
|
924
|
+
PureCloud.configure do |config|
|
|
925
|
+
config.access_token = @authToken
|
|
926
|
+
end
|
|
927
|
+
|
|
928
|
+
api_instance = PureCloud::OutboundApi.new
|
|
929
|
+
|
|
930
|
+
messaging_campaign_id = "messaging_campaign_id_example" # String | The Messaging Campaign ID
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
begin
|
|
934
|
+
#Delete an Outbound Messaging Campaign
|
|
935
|
+
result = api_instance.delete_outbound_messagingcampaign(messaging_campaign_id)
|
|
936
|
+
p result
|
|
937
|
+
rescue PureCloud::ApiError => e
|
|
938
|
+
puts "Exception when calling OutboundApi->delete_outbound_messagingcampaign: #{e}"
|
|
939
|
+
end
|
|
940
|
+
```
|
|
941
|
+
|
|
942
|
+
### Parameters
|
|
943
|
+
|
|
944
|
+
Name | Type | Description | Notes
|
|
945
|
+
------------- | ------------- | ------------- | -------------
|
|
946
|
+
**messaging_campaign_id** | **String**| The Messaging Campaign ID | |
|
|
947
|
+
{: class="table table-striped"}
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
### Return type
|
|
951
|
+
|
|
952
|
+
[**MessagingCampaign**](MessagingCampaign.html)
|
|
953
|
+
|
|
954
|
+
### HTTP request headers
|
|
955
|
+
|
|
956
|
+
- **Content-Type**: application/json
|
|
957
|
+
- **Accept**: application/json
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
885
961
|
<a name="delete_outbound_ruleset"></a>
|
|
886
962
|
|
|
887
963
|
## delete_outbound_ruleset(rule_set_id)
|
|
@@ -1240,6 +1316,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
1240
1316
|
opts = {
|
|
1241
1317
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
1242
1318
|
page_number: 1, # Integer | Page number
|
|
1319
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
1243
1320
|
filter_type: "Prefix", # String | Filter type
|
|
1244
1321
|
name: "name_example", # String | Name
|
|
1245
1322
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -1261,6 +1338,7 @@ Name | Type | Description | Notes
|
|
|
1261
1338
|
------------- | ------------- | ------------- | -------------
|
|
1262
1339
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
1263
1340
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1341
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
1264
1342
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
1265
1343
|
**name** | **String**| Name | [optional] |
|
|
1266
1344
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -1381,6 +1459,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
1381
1459
|
opts = {
|
|
1382
1460
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
1383
1461
|
page_number: 1, # Integer | Page number
|
|
1462
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
1384
1463
|
filter_type: "Prefix", # String | Filter type
|
|
1385
1464
|
name: "name_example", # String | Name
|
|
1386
1465
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -1402,6 +1481,7 @@ Name | Type | Description | Notes
|
|
|
1402
1481
|
------------- | ------------- | ------------- | -------------
|
|
1403
1482
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
1404
1483
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1484
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
1405
1485
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
1406
1486
|
**name** | **String**| Name | [optional] |
|
|
1407
1487
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -1522,6 +1602,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
1522
1602
|
opts = {
|
|
1523
1603
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
1524
1604
|
page_number: 1, # Integer | Page number
|
|
1605
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
1525
1606
|
filter_type: "Prefix", # String | Filter type
|
|
1526
1607
|
name: "name_example", # String | Name
|
|
1527
1608
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -1543,6 +1624,7 @@ Name | Type | Description | Notes
|
|
|
1543
1624
|
------------- | ------------- | ------------- | -------------
|
|
1544
1625
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
1545
1626
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1627
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
1546
1628
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
1547
1629
|
**name** | **String**| Name | [optional] |
|
|
1548
1630
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -1988,6 +2070,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
1988
2070
|
opts = {
|
|
1989
2071
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
1990
2072
|
page_number: 1, # Integer | Page number
|
|
2073
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
1991
2074
|
filter_type: "Prefix", # String | Filter type
|
|
1992
2075
|
name: "name_example", # String | Name
|
|
1993
2076
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -2009,6 +2092,7 @@ Name | Type | Description | Notes
|
|
|
2009
2092
|
------------- | ------------- | ------------- | -------------
|
|
2010
2093
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
2011
2094
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2095
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
2012
2096
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
2013
2097
|
**name** | **String**| Name | [optional] |
|
|
2014
2098
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -2117,6 +2201,164 @@ Name | Type | Description | Notes
|
|
|
2117
2201
|
|
|
2118
2202
|
|
|
2119
2203
|
|
|
2204
|
+
<a name="get_outbound_campaigns_all"></a>
|
|
2205
|
+
|
|
2206
|
+
## [**CommonCampaignEntityListing**](CommonCampaignEntityListing.html) get_outbound_campaigns_all(opts)
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
Query across all types of campaigns by division
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
Wraps GET /api/v2/outbound/campaigns/all
|
|
2215
|
+
|
|
2216
|
+
Requires ANY permissions:
|
|
2217
|
+
|
|
2218
|
+
* outbound:campaign:view
|
|
2219
|
+
* outbound:messagingCampaign:view
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
### Example
|
|
2223
|
+
```{"language":"ruby"}
|
|
2224
|
+
# load the gem
|
|
2225
|
+
require 'purecloudplatformclientv2'
|
|
2226
|
+
# setup authorization
|
|
2227
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2228
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2229
|
+
environment = "mypurecloud.com"
|
|
2230
|
+
|
|
2231
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2232
|
+
|
|
2233
|
+
PureCloud.configure do |config|
|
|
2234
|
+
config.access_token = @authToken
|
|
2235
|
+
end
|
|
2236
|
+
|
|
2237
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2238
|
+
|
|
2239
|
+
opts = {
|
|
2240
|
+
page_size: 25, # Integer | Page size
|
|
2241
|
+
page_number: 1, # Integer | Page number
|
|
2242
|
+
id: ["id_example"], # Array<String> | Campaign ID(s)
|
|
2243
|
+
name: "name_example", # String | Campaign name(s)
|
|
2244
|
+
division_id: ["division_id_example"], # Array<String> | Division ID(s)
|
|
2245
|
+
media_type: ["media_type_example"], # Array<String> | Media type(s)
|
|
2246
|
+
sort_order: "a" # String | Sort order
|
|
2247
|
+
}
|
|
2248
|
+
|
|
2249
|
+
begin
|
|
2250
|
+
#Query across all types of campaigns by division
|
|
2251
|
+
result = api_instance.get_outbound_campaigns_all(opts)
|
|
2252
|
+
p result
|
|
2253
|
+
rescue PureCloud::ApiError => e
|
|
2254
|
+
puts "Exception when calling OutboundApi->get_outbound_campaigns_all: #{e}"
|
|
2255
|
+
end
|
|
2256
|
+
```
|
|
2257
|
+
|
|
2258
|
+
### Parameters
|
|
2259
|
+
|
|
2260
|
+
Name | Type | Description | Notes
|
|
2261
|
+
------------- | ------------- | ------------- | -------------
|
|
2262
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2263
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2264
|
+
**id** | [**Array<String>**](String.html)| Campaign ID(s) | [optional] |
|
|
2265
|
+
**name** | **String**| Campaign name(s) | [optional] |
|
|
2266
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
|
2267
|
+
**media_type** | [**Array<String>**](String.html)| Media type(s) | [optional] <br />**Values**: sms, voice |
|
|
2268
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
2269
|
+
{: class="table table-striped"}
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
### Return type
|
|
2273
|
+
|
|
2274
|
+
[**CommonCampaignEntityListing**](CommonCampaignEntityListing.html)
|
|
2275
|
+
|
|
2276
|
+
### HTTP request headers
|
|
2277
|
+
|
|
2278
|
+
- **Content-Type**: application/json
|
|
2279
|
+
- **Accept**: application/json
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
<a name="get_outbound_campaigns_all_divisionviews"></a>
|
|
2284
|
+
|
|
2285
|
+
## [**CommonCampaignDivisionViewEntityListing**](CommonCampaignDivisionViewEntityListing.html) get_outbound_campaigns_all_divisionviews(opts)
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
Query across all types of campaigns
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
|
|
2293
|
+
Wraps GET /api/v2/outbound/campaigns/all/divisionviews
|
|
2294
|
+
|
|
2295
|
+
Requires ANY permissions:
|
|
2296
|
+
|
|
2297
|
+
* outbound:campaign:search
|
|
2298
|
+
* outbound:messagingCampaign:search
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
### Example
|
|
2302
|
+
```{"language":"ruby"}
|
|
2303
|
+
# load the gem
|
|
2304
|
+
require 'purecloudplatformclientv2'
|
|
2305
|
+
# setup authorization
|
|
2306
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2307
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2308
|
+
environment = "mypurecloud.com"
|
|
2309
|
+
|
|
2310
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2311
|
+
|
|
2312
|
+
PureCloud.configure do |config|
|
|
2313
|
+
config.access_token = @authToken
|
|
2314
|
+
end
|
|
2315
|
+
|
|
2316
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2317
|
+
|
|
2318
|
+
opts = {
|
|
2319
|
+
page_size: 25, # Integer | Page size
|
|
2320
|
+
page_number: 1, # Integer | Page number
|
|
2321
|
+
id: ["id_example"], # Array<String> | Campaign ID(s)
|
|
2322
|
+
name: "name_example", # String | Campaign name(s)
|
|
2323
|
+
division_id: ["division_id_example"], # Array<String> | Division ID(s)
|
|
2324
|
+
media_type: ["media_type_example"], # Array<String> | Media type(s)
|
|
2325
|
+
sort_order: "a" # String | Sort order
|
|
2326
|
+
}
|
|
2327
|
+
|
|
2328
|
+
begin
|
|
2329
|
+
#Query across all types of campaigns
|
|
2330
|
+
result = api_instance.get_outbound_campaigns_all_divisionviews(opts)
|
|
2331
|
+
p result
|
|
2332
|
+
rescue PureCloud::ApiError => e
|
|
2333
|
+
puts "Exception when calling OutboundApi->get_outbound_campaigns_all_divisionviews: #{e}"
|
|
2334
|
+
end
|
|
2335
|
+
```
|
|
2336
|
+
|
|
2337
|
+
### Parameters
|
|
2338
|
+
|
|
2339
|
+
Name | Type | Description | Notes
|
|
2340
|
+
------------- | ------------- | ------------- | -------------
|
|
2341
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2342
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2343
|
+
**id** | [**Array<String>**](String.html)| Campaign ID(s) | [optional] |
|
|
2344
|
+
**name** | **String**| Campaign name(s) | [optional] |
|
|
2345
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
|
2346
|
+
**media_type** | [**Array<String>**](String.html)| Media type(s) | [optional] <br />**Values**: sms, voice |
|
|
2347
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
2348
|
+
{: class="table table-striped"}
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
### Return type
|
|
2352
|
+
|
|
2353
|
+
[**CommonCampaignDivisionViewEntityListing**](CommonCampaignDivisionViewEntityListing.html)
|
|
2354
|
+
|
|
2355
|
+
### HTTP request headers
|
|
2356
|
+
|
|
2357
|
+
- **Content-Type**: application/json
|
|
2358
|
+
- **Accept**: application/json
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
|
|
2120
2362
|
<a name="get_outbound_campaigns_divisionview"></a>
|
|
2121
2363
|
|
|
2122
2364
|
## [**CampaignDivisionView**](CampaignDivisionView.html) get_outbound_campaigns_divisionview(campaign_id)
|
|
@@ -2701,6 +2943,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
2701
2943
|
opts = {
|
|
2702
2944
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
2703
2945
|
page_number: 1, # Integer | Page number
|
|
2946
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
2704
2947
|
filter_type: "Prefix", # String | Filter type
|
|
2705
2948
|
name: "name_example", # String | Name
|
|
2706
2949
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -2723,6 +2966,7 @@ Name | Type | Description | Notes
|
|
|
2723
2966
|
------------- | ------------- | ------------- | -------------
|
|
2724
2967
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
2725
2968
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2969
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
2726
2970
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
2727
2971
|
**name** | **String**| Name | [optional] |
|
|
2728
2972
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -2781,6 +3025,7 @@ opts = {
|
|
|
2781
3025
|
include_size: false, # BOOLEAN | Include size
|
|
2782
3026
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
2783
3027
|
page_number: 1, # Integer | Page number
|
|
3028
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
2784
3029
|
filter_type: "Prefix", # String | Filter type
|
|
2785
3030
|
name: "name_example", # String | Name
|
|
2786
3031
|
id: ["id_example"], # Array<String> | id
|
|
@@ -2806,6 +3051,7 @@ Name | Type | Description | Notes
|
|
|
2806
3051
|
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
2807
3052
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
2808
3053
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3054
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
2809
3055
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
2810
3056
|
**name** | **String**| Name | [optional] |
|
|
2811
3057
|
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
@@ -3224,6 +3470,7 @@ opts = {
|
|
|
3224
3470
|
include_size: false, # BOOLEAN | Include size
|
|
3225
3471
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3226
3472
|
page_number: 1, # Integer | Page number
|
|
3473
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
3227
3474
|
filter_type: "Prefix", # String | Filter type
|
|
3228
3475
|
name: "name_example", # String | Name
|
|
3229
3476
|
dnc_source_type: "dnc_source_type_example", # String | DncSourceType
|
|
@@ -3249,6 +3496,7 @@ Name | Type | Description | Notes
|
|
|
3249
3496
|
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3250
3497
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3251
3498
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3499
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
3252
3500
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3253
3501
|
**name** | **String**| Name | [optional] |
|
|
3254
3502
|
**dnc_source_type** | **String**| DncSourceType | [optional] <br />**Values**: rds, dnc.com, gryphon |
|
|
@@ -3275,15 +3523,376 @@ Name | Type | Description | Notes
|
|
|
3275
3523
|
|
|
3276
3524
|
|
|
3277
3525
|
|
|
3278
|
-
Get a basic DncList information object
|
|
3526
|
+
Get a basic DncList information object
|
|
3527
|
+
|
|
3528
|
+
This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
|
|
3529
|
+
|
|
3530
|
+
Wraps GET /api/v2/outbound/dnclists/divisionviews/{dncListId}
|
|
3531
|
+
|
|
3532
|
+
Requires ALL permissions:
|
|
3533
|
+
|
|
3534
|
+
* outbound:dncList:search
|
|
3535
|
+
|
|
3536
|
+
|
|
3537
|
+
### Example
|
|
3538
|
+
```{"language":"ruby"}
|
|
3539
|
+
# load the gem
|
|
3540
|
+
require 'purecloudplatformclientv2'
|
|
3541
|
+
# setup authorization
|
|
3542
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3543
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3544
|
+
environment = "mypurecloud.com"
|
|
3545
|
+
|
|
3546
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3547
|
+
|
|
3548
|
+
PureCloud.configure do |config|
|
|
3549
|
+
config.access_token = @authToken
|
|
3550
|
+
end
|
|
3551
|
+
|
|
3552
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3553
|
+
|
|
3554
|
+
dnc_list_id = "dnc_list_id_example" # String | Dnclist ID
|
|
3555
|
+
|
|
3556
|
+
opts = {
|
|
3557
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
3558
|
+
include_size: false # BOOLEAN | Include size
|
|
3559
|
+
}
|
|
3560
|
+
|
|
3561
|
+
begin
|
|
3562
|
+
#Get a basic DncList information object
|
|
3563
|
+
result = api_instance.get_outbound_dnclists_divisionview(dnc_list_id, opts)
|
|
3564
|
+
p result
|
|
3565
|
+
rescue PureCloud::ApiError => e
|
|
3566
|
+
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionview: #{e}"
|
|
3567
|
+
end
|
|
3568
|
+
```
|
|
3569
|
+
|
|
3570
|
+
### Parameters
|
|
3571
|
+
|
|
3572
|
+
Name | Type | Description | Notes
|
|
3573
|
+
------------- | ------------- | ------------- | -------------
|
|
3574
|
+
**dnc_list_id** | **String**| Dnclist ID | |
|
|
3575
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3576
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3577
|
+
{: class="table table-striped"}
|
|
3578
|
+
|
|
3579
|
+
|
|
3580
|
+
### Return type
|
|
3581
|
+
|
|
3582
|
+
[**DncListDivisionView**](DncListDivisionView.html)
|
|
3583
|
+
|
|
3584
|
+
### HTTP request headers
|
|
3585
|
+
|
|
3586
|
+
- **Content-Type**: application/json
|
|
3587
|
+
- **Accept**: application/json
|
|
3588
|
+
|
|
3589
|
+
|
|
3590
|
+
|
|
3591
|
+
<a name="get_outbound_dnclists_divisionviews"></a>
|
|
3592
|
+
|
|
3593
|
+
## [**DncListDivisionViewListing**](DncListDivisionViewListing.html) get_outbound_dnclists_divisionviews(opts)
|
|
3594
|
+
|
|
3595
|
+
|
|
3596
|
+
|
|
3597
|
+
Query a list of simplified dnc list objects.
|
|
3598
|
+
|
|
3599
|
+
This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
|
|
3600
|
+
|
|
3601
|
+
Wraps GET /api/v2/outbound/dnclists/divisionviews
|
|
3602
|
+
|
|
3603
|
+
Requires ALL permissions:
|
|
3604
|
+
|
|
3605
|
+
* outbound:dncList:search
|
|
3606
|
+
|
|
3607
|
+
|
|
3608
|
+
### Example
|
|
3609
|
+
```{"language":"ruby"}
|
|
3610
|
+
# load the gem
|
|
3611
|
+
require 'purecloudplatformclientv2'
|
|
3612
|
+
# setup authorization
|
|
3613
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3614
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3615
|
+
environment = "mypurecloud.com"
|
|
3616
|
+
|
|
3617
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3618
|
+
|
|
3619
|
+
PureCloud.configure do |config|
|
|
3620
|
+
config.access_token = @authToken
|
|
3621
|
+
end
|
|
3622
|
+
|
|
3623
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3624
|
+
|
|
3625
|
+
opts = {
|
|
3626
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
3627
|
+
include_size: false, # BOOLEAN | Include size
|
|
3628
|
+
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3629
|
+
page_number: 1, # Integer | Page number
|
|
3630
|
+
filter_type: "Prefix", # String | Filter type
|
|
3631
|
+
name: "name_example", # String | Name
|
|
3632
|
+
id: ["id_example"], # Array<String> | id
|
|
3633
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
3634
|
+
sort_order: "a" # String | Sort order
|
|
3635
|
+
}
|
|
3636
|
+
|
|
3637
|
+
begin
|
|
3638
|
+
#Query a list of simplified dnc list objects.
|
|
3639
|
+
result = api_instance.get_outbound_dnclists_divisionviews(opts)
|
|
3640
|
+
p result
|
|
3641
|
+
rescue PureCloud::ApiError => e
|
|
3642
|
+
puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: #{e}"
|
|
3643
|
+
end
|
|
3644
|
+
```
|
|
3645
|
+
|
|
3646
|
+
### Parameters
|
|
3647
|
+
|
|
3648
|
+
Name | Type | Description | Notes
|
|
3649
|
+
------------- | ------------- | ------------- | -------------
|
|
3650
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3651
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3652
|
+
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3653
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3654
|
+
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3655
|
+
**name** | **String**| Name | [optional] |
|
|
3656
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
3657
|
+
**sort_by** | **String**| Sort by | [optional] |
|
|
3658
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
3659
|
+
{: class="table table-striped"}
|
|
3660
|
+
|
|
3661
|
+
|
|
3662
|
+
### Return type
|
|
3663
|
+
|
|
3664
|
+
[**DncListDivisionViewListing**](DncListDivisionViewListing.html)
|
|
3665
|
+
|
|
3666
|
+
### HTTP request headers
|
|
3667
|
+
|
|
3668
|
+
- **Content-Type**: application/json
|
|
3669
|
+
- **Accept**: application/json
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
|
|
3673
|
+
<a name="get_outbound_event"></a>
|
|
3674
|
+
|
|
3675
|
+
## [**EventLog**](EventLog.html) get_outbound_event(event_id)
|
|
3676
|
+
|
|
3677
|
+
|
|
3678
|
+
|
|
3679
|
+
Get Dialer Event
|
|
3680
|
+
|
|
3681
|
+
|
|
3682
|
+
|
|
3683
|
+
Wraps GET /api/v2/outbound/events/{eventId}
|
|
3684
|
+
|
|
3685
|
+
Requires ANY permissions:
|
|
3686
|
+
|
|
3687
|
+
* outbound:eventLog:view
|
|
3688
|
+
|
|
3689
|
+
|
|
3690
|
+
### Example
|
|
3691
|
+
```{"language":"ruby"}
|
|
3692
|
+
# load the gem
|
|
3693
|
+
require 'purecloudplatformclientv2'
|
|
3694
|
+
# setup authorization
|
|
3695
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3696
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3697
|
+
environment = "mypurecloud.com"
|
|
3698
|
+
|
|
3699
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3700
|
+
|
|
3701
|
+
PureCloud.configure do |config|
|
|
3702
|
+
config.access_token = @authToken
|
|
3703
|
+
end
|
|
3704
|
+
|
|
3705
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3706
|
+
|
|
3707
|
+
event_id = "event_id_example" # String | Event Log ID
|
|
3708
|
+
|
|
3709
|
+
|
|
3710
|
+
begin
|
|
3711
|
+
#Get Dialer Event
|
|
3712
|
+
result = api_instance.get_outbound_event(event_id)
|
|
3713
|
+
p result
|
|
3714
|
+
rescue PureCloud::ApiError => e
|
|
3715
|
+
puts "Exception when calling OutboundApi->get_outbound_event: #{e}"
|
|
3716
|
+
end
|
|
3717
|
+
```
|
|
3718
|
+
|
|
3719
|
+
### Parameters
|
|
3720
|
+
|
|
3721
|
+
Name | Type | Description | Notes
|
|
3722
|
+
------------- | ------------- | ------------- | -------------
|
|
3723
|
+
**event_id** | **String**| Event Log ID | |
|
|
3724
|
+
{: class="table table-striped"}
|
|
3725
|
+
|
|
3726
|
+
|
|
3727
|
+
### Return type
|
|
3728
|
+
|
|
3729
|
+
[**EventLog**](EventLog.html)
|
|
3730
|
+
|
|
3731
|
+
### HTTP request headers
|
|
3732
|
+
|
|
3733
|
+
- **Content-Type**: application/json
|
|
3734
|
+
- **Accept**: application/json
|
|
3735
|
+
|
|
3736
|
+
|
|
3737
|
+
|
|
3738
|
+
<a name="get_outbound_events"></a>
|
|
3739
|
+
|
|
3740
|
+
## [**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts)
|
|
3741
|
+
|
|
3742
|
+
|
|
3743
|
+
|
|
3744
|
+
Query Event Logs
|
|
3745
|
+
|
|
3746
|
+
|
|
3747
|
+
|
|
3748
|
+
Wraps GET /api/v2/outbound/events
|
|
3749
|
+
|
|
3750
|
+
Requires ANY permissions:
|
|
3751
|
+
|
|
3752
|
+
* outbound:eventLog:view
|
|
3753
|
+
|
|
3754
|
+
|
|
3755
|
+
### Example
|
|
3756
|
+
```{"language":"ruby"}
|
|
3757
|
+
# load the gem
|
|
3758
|
+
require 'purecloudplatformclientv2'
|
|
3759
|
+
# setup authorization
|
|
3760
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3761
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3762
|
+
environment = "mypurecloud.com"
|
|
3763
|
+
|
|
3764
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3765
|
+
|
|
3766
|
+
PureCloud.configure do |config|
|
|
3767
|
+
config.access_token = @authToken
|
|
3768
|
+
end
|
|
3769
|
+
|
|
3770
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3771
|
+
|
|
3772
|
+
opts = {
|
|
3773
|
+
page_size: 25, # Integer | Page size
|
|
3774
|
+
page_number: 1, # Integer | Page number
|
|
3775
|
+
filter_type: "Prefix", # String | Filter type
|
|
3776
|
+
category: "category_example", # String | Category
|
|
3777
|
+
level: "level_example", # String | Level
|
|
3778
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
3779
|
+
sort_order: "a" # String | Sort order
|
|
3780
|
+
}
|
|
3781
|
+
|
|
3782
|
+
begin
|
|
3783
|
+
#Query Event Logs
|
|
3784
|
+
result = api_instance.get_outbound_events(opts)
|
|
3785
|
+
p result
|
|
3786
|
+
rescue PureCloud::ApiError => e
|
|
3787
|
+
puts "Exception when calling OutboundApi->get_outbound_events: #{e}"
|
|
3788
|
+
end
|
|
3789
|
+
```
|
|
3790
|
+
|
|
3791
|
+
### Parameters
|
|
3792
|
+
|
|
3793
|
+
Name | Type | Description | Notes
|
|
3794
|
+
------------- | ------------- | ------------- | -------------
|
|
3795
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3796
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3797
|
+
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3798
|
+
**category** | **String**| Category | [optional] |
|
|
3799
|
+
**level** | **String**| Level | [optional] |
|
|
3800
|
+
**sort_by** | **String**| Sort by | [optional] |
|
|
3801
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
3802
|
+
{: class="table table-striped"}
|
|
3803
|
+
|
|
3804
|
+
|
|
3805
|
+
### Return type
|
|
3806
|
+
|
|
3807
|
+
[**DialerEventEntityListing**](DialerEventEntityListing.html)
|
|
3808
|
+
|
|
3809
|
+
### HTTP request headers
|
|
3810
|
+
|
|
3811
|
+
- **Content-Type**: application/json
|
|
3812
|
+
- **Accept**: application/json
|
|
3813
|
+
|
|
3814
|
+
|
|
3815
|
+
|
|
3816
|
+
<a name="get_outbound_messagingcampaign"></a>
|
|
3817
|
+
|
|
3818
|
+
## [**MessagingCampaign**](MessagingCampaign.html) get_outbound_messagingcampaign(messaging_campaign_id)
|
|
3819
|
+
|
|
3820
|
+
|
|
3821
|
+
|
|
3822
|
+
Get an Outbound Messaging Campaign
|
|
3823
|
+
|
|
3824
|
+
|
|
3825
|
+
|
|
3826
|
+
Wraps GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}
|
|
3827
|
+
|
|
3828
|
+
Requires ANY permissions:
|
|
3829
|
+
|
|
3830
|
+
* outbound:messagingCampaign:view
|
|
3831
|
+
|
|
3832
|
+
|
|
3833
|
+
### Example
|
|
3834
|
+
```{"language":"ruby"}
|
|
3835
|
+
# load the gem
|
|
3836
|
+
require 'purecloudplatformclientv2'
|
|
3837
|
+
# setup authorization
|
|
3838
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3839
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3840
|
+
environment = "mypurecloud.com"
|
|
3841
|
+
|
|
3842
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3843
|
+
|
|
3844
|
+
PureCloud.configure do |config|
|
|
3845
|
+
config.access_token = @authToken
|
|
3846
|
+
end
|
|
3847
|
+
|
|
3848
|
+
api_instance = PureCloud::OutboundApi.new
|
|
3849
|
+
|
|
3850
|
+
messaging_campaign_id = "messaging_campaign_id_example" # String | The Messaging Campaign ID
|
|
3851
|
+
|
|
3852
|
+
|
|
3853
|
+
begin
|
|
3854
|
+
#Get an Outbound Messaging Campaign
|
|
3855
|
+
result = api_instance.get_outbound_messagingcampaign(messaging_campaign_id)
|
|
3856
|
+
p result
|
|
3857
|
+
rescue PureCloud::ApiError => e
|
|
3858
|
+
puts "Exception when calling OutboundApi->get_outbound_messagingcampaign: #{e}"
|
|
3859
|
+
end
|
|
3860
|
+
```
|
|
3861
|
+
|
|
3862
|
+
### Parameters
|
|
3863
|
+
|
|
3864
|
+
Name | Type | Description | Notes
|
|
3865
|
+
------------- | ------------- | ------------- | -------------
|
|
3866
|
+
**messaging_campaign_id** | **String**| The Messaging Campaign ID | |
|
|
3867
|
+
{: class="table table-striped"}
|
|
3868
|
+
|
|
3869
|
+
|
|
3870
|
+
### Return type
|
|
3871
|
+
|
|
3872
|
+
[**MessagingCampaign**](MessagingCampaign.html)
|
|
3873
|
+
|
|
3874
|
+
### HTTP request headers
|
|
3875
|
+
|
|
3876
|
+
- **Content-Type**: application/json
|
|
3877
|
+
- **Accept**: application/json
|
|
3878
|
+
|
|
3879
|
+
|
|
3880
|
+
|
|
3881
|
+
<a name="get_outbound_messagingcampaign_progress"></a>
|
|
3882
|
+
|
|
3883
|
+
## [**CampaignProgress**](CampaignProgress.html) get_outbound_messagingcampaign_progress(messaging_campaign_id)
|
|
3884
|
+
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
Get messaging campaign's progress
|
|
3888
|
+
|
|
3279
3889
|
|
|
3280
|
-
This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
|
|
3281
3890
|
|
|
3282
|
-
Wraps GET /api/v2/outbound/
|
|
3891
|
+
Wraps GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress
|
|
3283
3892
|
|
|
3284
|
-
Requires
|
|
3893
|
+
Requires ANY permissions:
|
|
3285
3894
|
|
|
3286
|
-
* outbound:
|
|
3895
|
+
* outbound:messagingCampaign:view
|
|
3287
3896
|
|
|
3288
3897
|
|
|
3289
3898
|
### Example
|
|
@@ -3303,19 +3912,15 @@ end
|
|
|
3303
3912
|
|
|
3304
3913
|
api_instance = PureCloud::OutboundApi.new
|
|
3305
3914
|
|
|
3306
|
-
|
|
3915
|
+
messaging_campaign_id = "messaging_campaign_id_example" # String | The Messaging Campaign ID
|
|
3307
3916
|
|
|
3308
|
-
opts = {
|
|
3309
|
-
include_import_status: false, # BOOLEAN | Include import status
|
|
3310
|
-
include_size: false # BOOLEAN | Include size
|
|
3311
|
-
}
|
|
3312
3917
|
|
|
3313
3918
|
begin
|
|
3314
|
-
#Get
|
|
3315
|
-
result = api_instance.
|
|
3919
|
+
#Get messaging campaign's progress
|
|
3920
|
+
result = api_instance.get_outbound_messagingcampaign_progress(messaging_campaign_id)
|
|
3316
3921
|
p result
|
|
3317
3922
|
rescue PureCloud::ApiError => e
|
|
3318
|
-
puts "Exception when calling OutboundApi->
|
|
3923
|
+
puts "Exception when calling OutboundApi->get_outbound_messagingcampaign_progress: #{e}"
|
|
3319
3924
|
end
|
|
3320
3925
|
```
|
|
3321
3926
|
|
|
@@ -3323,15 +3928,13 @@ end
|
|
|
3323
3928
|
|
|
3324
3929
|
Name | Type | Description | Notes
|
|
3325
3930
|
------------- | ------------- | ------------- | -------------
|
|
3326
|
-
**
|
|
3327
|
-
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3328
|
-
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3931
|
+
**messaging_campaign_id** | **String**| The Messaging Campaign ID | |
|
|
3329
3932
|
{: class="table table-striped"}
|
|
3330
3933
|
|
|
3331
3934
|
|
|
3332
3935
|
### Return type
|
|
3333
3936
|
|
|
3334
|
-
[**
|
|
3937
|
+
[**CampaignProgress**](CampaignProgress.html)
|
|
3335
3938
|
|
|
3336
3939
|
### HTTP request headers
|
|
3337
3940
|
|
|
@@ -3340,21 +3943,21 @@ Name | Type | Description | Notes
|
|
|
3340
3943
|
|
|
3341
3944
|
|
|
3342
3945
|
|
|
3343
|
-
<a name="
|
|
3946
|
+
<a name="get_outbound_messagingcampaigns"></a>
|
|
3344
3947
|
|
|
3345
|
-
## [**
|
|
3948
|
+
## [**MessagingCampaignEntityListing**](MessagingCampaignEntityListing.html) get_outbound_messagingcampaigns(opts)
|
|
3346
3949
|
|
|
3347
3950
|
|
|
3348
3951
|
|
|
3349
|
-
Query a list of
|
|
3952
|
+
Query a list of Messaging Campaigns
|
|
3350
3953
|
|
|
3351
|
-
This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
|
|
3352
3954
|
|
|
3353
|
-
Wraps GET /api/v2/outbound/dnclists/divisionviews
|
|
3354
3955
|
|
|
3355
|
-
|
|
3956
|
+
Wraps GET /api/v2/outbound/messagingcampaigns
|
|
3356
3957
|
|
|
3357
|
-
|
|
3958
|
+
Requires ANY permissions:
|
|
3959
|
+
|
|
3960
|
+
* outbound:messagingCampaign:view
|
|
3358
3961
|
|
|
3359
3962
|
|
|
3360
3963
|
### Example
|
|
@@ -3375,23 +3978,24 @@ end
|
|
|
3375
3978
|
api_instance = PureCloud::OutboundApi.new
|
|
3376
3979
|
|
|
3377
3980
|
opts = {
|
|
3378
|
-
include_import_status: false, # BOOLEAN | Include import status
|
|
3379
|
-
include_size: false, # BOOLEAN | Include size
|
|
3380
3981
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3381
3982
|
page_number: 1, # Integer | Page number
|
|
3382
|
-
|
|
3983
|
+
sort_by: "name", # String | The field to sort by
|
|
3984
|
+
sort_order: "ascending", # String | The direction to sort
|
|
3383
3985
|
name: "name_example", # String | Name
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3986
|
+
contact_list_id: "contact_list_id_example", # String | Contact List ID
|
|
3987
|
+
division_id: ["division_id_example"], # Array<String> | Division ID(s)
|
|
3988
|
+
type: "type_example", # String | Campaign Type
|
|
3989
|
+
sender_sms_phone_number: "sender_sms_phone_number_example", # String | Sender SMS Phone Number
|
|
3990
|
+
id: ["id_example"] # Array<String> | A list of messaging campaign ids to bulk fetch
|
|
3387
3991
|
}
|
|
3388
3992
|
|
|
3389
3993
|
begin
|
|
3390
|
-
#Query a list of
|
|
3391
|
-
result = api_instance.
|
|
3994
|
+
#Query a list of Messaging Campaigns
|
|
3995
|
+
result = api_instance.get_outbound_messagingcampaigns(opts)
|
|
3392
3996
|
p result
|
|
3393
3997
|
rescue PureCloud::ApiError => e
|
|
3394
|
-
puts "Exception when calling OutboundApi->
|
|
3998
|
+
puts "Exception when calling OutboundApi->get_outbound_messagingcampaigns: #{e}"
|
|
3395
3999
|
end
|
|
3396
4000
|
```
|
|
3397
4001
|
|
|
@@ -3399,21 +4003,22 @@ end
|
|
|
3399
4003
|
|
|
3400
4004
|
Name | Type | Description | Notes
|
|
3401
4005
|
------------- | ------------- | ------------- | -------------
|
|
3402
|
-
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
3403
|
-
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
3404
4006
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3405
4007
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3406
|
-
**
|
|
4008
|
+
**sort_by** | **String**| The field to sort by | [optional] [default to name]<br />**Values**: campaignStatus, name, type |
|
|
4009
|
+
**sort_order** | **String**| The direction to sort | [optional] [default to ascending]<br />**Values**: ascending, descending |
|
|
3407
4010
|
**name** | **String**| Name | [optional] |
|
|
3408
|
-
**
|
|
3409
|
-
**
|
|
3410
|
-
**
|
|
4011
|
+
**contact_list_id** | **String**| Contact List ID | [optional] |
|
|
4012
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
|
4013
|
+
**type** | **String**| Campaign Type | [optional] <br />**Values**: SMS |
|
|
4014
|
+
**sender_sms_phone_number** | **String**| Sender SMS Phone Number | [optional] |
|
|
4015
|
+
**id** | [**Array<String>**](String.html)| A list of messaging campaign ids to bulk fetch | [optional] |
|
|
3411
4016
|
{: class="table table-striped"}
|
|
3412
4017
|
|
|
3413
4018
|
|
|
3414
4019
|
### Return type
|
|
3415
4020
|
|
|
3416
|
-
[**
|
|
4021
|
+
[**MessagingCampaignEntityListing**](MessagingCampaignEntityListing.html)
|
|
3417
4022
|
|
|
3418
4023
|
### HTTP request headers
|
|
3419
4024
|
|
|
@@ -3422,21 +4027,21 @@ Name | Type | Description | Notes
|
|
|
3422
4027
|
|
|
3423
4028
|
|
|
3424
4029
|
|
|
3425
|
-
<a name="
|
|
3426
|
-
|
|
3427
|
-
## [**EventLog**](EventLog.html) get_outbound_event(event_id)
|
|
4030
|
+
<a name="get_outbound_messagingcampaigns_divisionview"></a>
|
|
3428
4031
|
|
|
4032
|
+
## [**MessagingCampaignDivisionView**](MessagingCampaignDivisionView.html) get_outbound_messagingcampaigns_divisionview(messaging_campaign_id)
|
|
3429
4033
|
|
|
3430
4034
|
|
|
3431
|
-
Get Dialer Event
|
|
3432
4035
|
|
|
4036
|
+
Get a basic Messaging Campaign information object
|
|
3433
4037
|
|
|
4038
|
+
This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.
|
|
3434
4039
|
|
|
3435
|
-
Wraps GET /api/v2/outbound/
|
|
4040
|
+
Wraps GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}
|
|
3436
4041
|
|
|
3437
|
-
Requires
|
|
4042
|
+
Requires ALL permissions:
|
|
3438
4043
|
|
|
3439
|
-
* outbound:
|
|
4044
|
+
* outbound:messagingCampaign:search
|
|
3440
4045
|
|
|
3441
4046
|
|
|
3442
4047
|
### Example
|
|
@@ -3456,15 +4061,15 @@ end
|
|
|
3456
4061
|
|
|
3457
4062
|
api_instance = PureCloud::OutboundApi.new
|
|
3458
4063
|
|
|
3459
|
-
|
|
4064
|
+
messaging_campaign_id = "messaging_campaign_id_example" # String | The Messaging Campaign ID
|
|
3460
4065
|
|
|
3461
4066
|
|
|
3462
4067
|
begin
|
|
3463
|
-
#Get
|
|
3464
|
-
result = api_instance.
|
|
4068
|
+
#Get a basic Messaging Campaign information object
|
|
4069
|
+
result = api_instance.get_outbound_messagingcampaigns_divisionview(messaging_campaign_id)
|
|
3465
4070
|
p result
|
|
3466
4071
|
rescue PureCloud::ApiError => e
|
|
3467
|
-
puts "Exception when calling OutboundApi->
|
|
4072
|
+
puts "Exception when calling OutboundApi->get_outbound_messagingcampaigns_divisionview: #{e}"
|
|
3468
4073
|
end
|
|
3469
4074
|
```
|
|
3470
4075
|
|
|
@@ -3472,13 +4077,13 @@ end
|
|
|
3472
4077
|
|
|
3473
4078
|
Name | Type | Description | Notes
|
|
3474
4079
|
------------- | ------------- | ------------- | -------------
|
|
3475
|
-
**
|
|
4080
|
+
**messaging_campaign_id** | **String**| The Messaging Campaign ID | |
|
|
3476
4081
|
{: class="table table-striped"}
|
|
3477
4082
|
|
|
3478
4083
|
|
|
3479
4084
|
### Return type
|
|
3480
4085
|
|
|
3481
|
-
[**
|
|
4086
|
+
[**MessagingCampaignDivisionView**](MessagingCampaignDivisionView.html)
|
|
3482
4087
|
|
|
3483
4088
|
### HTTP request headers
|
|
3484
4089
|
|
|
@@ -3487,21 +4092,21 @@ Name | Type | Description | Notes
|
|
|
3487
4092
|
|
|
3488
4093
|
|
|
3489
4094
|
|
|
3490
|
-
<a name="
|
|
3491
|
-
|
|
3492
|
-
## [**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts)
|
|
4095
|
+
<a name="get_outbound_messagingcampaigns_divisionviews"></a>
|
|
3493
4096
|
|
|
4097
|
+
## [**MessagingCampaignDivisionViewEntityListing**](MessagingCampaignDivisionViewEntityListing.html) get_outbound_messagingcampaigns_divisionviews(opts)
|
|
3494
4098
|
|
|
3495
4099
|
|
|
3496
|
-
Query Event Logs
|
|
3497
4100
|
|
|
4101
|
+
Query a list of basic Messaging Campaign information objects
|
|
3498
4102
|
|
|
4103
|
+
This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.
|
|
3499
4104
|
|
|
3500
|
-
Wraps GET /api/v2/outbound/
|
|
4105
|
+
Wraps GET /api/v2/outbound/messagingcampaigns/divisionviews
|
|
3501
4106
|
|
|
3502
|
-
Requires
|
|
4107
|
+
Requires ALL permissions:
|
|
3503
4108
|
|
|
3504
|
-
* outbound:
|
|
4109
|
+
* outbound:messagingCampaign:search
|
|
3505
4110
|
|
|
3506
4111
|
|
|
3507
4112
|
### Example
|
|
@@ -3522,21 +4127,20 @@ end
|
|
|
3522
4127
|
api_instance = PureCloud::OutboundApi.new
|
|
3523
4128
|
|
|
3524
4129
|
opts = {
|
|
3525
|
-
page_size: 25, # Integer | Page size
|
|
4130
|
+
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3526
4131
|
page_number: 1, # Integer | Page number
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
sort_order: "a" # String | Sort order
|
|
4132
|
+
sort_order: "a", # String | The direction to sort
|
|
4133
|
+
name: "name_example", # String | Name
|
|
4134
|
+
id: ["id_example"], # Array<String> | id
|
|
4135
|
+
sender_sms_phone_number: "sender_sms_phone_number_example" # String | Sender SMS Phone Number
|
|
3532
4136
|
}
|
|
3533
4137
|
|
|
3534
4138
|
begin
|
|
3535
|
-
#Query
|
|
3536
|
-
result = api_instance.
|
|
4139
|
+
#Query a list of basic Messaging Campaign information objects
|
|
4140
|
+
result = api_instance.get_outbound_messagingcampaigns_divisionviews(opts)
|
|
3537
4141
|
p result
|
|
3538
4142
|
rescue PureCloud::ApiError => e
|
|
3539
|
-
puts "Exception when calling OutboundApi->
|
|
4143
|
+
puts "Exception when calling OutboundApi->get_outbound_messagingcampaigns_divisionviews: #{e}"
|
|
3540
4144
|
end
|
|
3541
4145
|
```
|
|
3542
4146
|
|
|
@@ -3544,19 +4148,18 @@ end
|
|
|
3544
4148
|
|
|
3545
4149
|
Name | Type | Description | Notes
|
|
3546
4150
|
------------- | ------------- | ------------- | -------------
|
|
3547
|
-
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
4151
|
+
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3548
4152
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3549
|
-
**
|
|
3550
|
-
**
|
|
3551
|
-
**
|
|
3552
|
-
**
|
|
3553
|
-
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
4153
|
+
**sort_order** | **String**| The direction to sort | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
4154
|
+
**name** | **String**| Name | [optional] |
|
|
4155
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
4156
|
+
**sender_sms_phone_number** | **String**| Sender SMS Phone Number | [optional] |
|
|
3554
4157
|
{: class="table table-striped"}
|
|
3555
4158
|
|
|
3556
4159
|
|
|
3557
4160
|
### Return type
|
|
3558
4161
|
|
|
3559
|
-
[**
|
|
4162
|
+
[**MessagingCampaignDivisionViewEntityListing**](MessagingCampaignDivisionViewEntityListing.html)
|
|
3560
4163
|
|
|
3561
4164
|
### HTTP request headers
|
|
3562
4165
|
|
|
@@ -3667,6 +4270,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
3667
4270
|
opts = {
|
|
3668
4271
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
3669
4272
|
page_number: 1, # Integer | Page number
|
|
4273
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
3670
4274
|
filter_type: "Prefix", # String | Filter type
|
|
3671
4275
|
name: "name_example", # String | Name
|
|
3672
4276
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -3688,6 +4292,7 @@ Name | Type | Description | Notes
|
|
|
3688
4292
|
------------- | ------------- | ------------- | -------------
|
|
3689
4293
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
3690
4294
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
4295
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
3691
4296
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3692
4297
|
**name** | **String**| Name | [optional] |
|
|
3693
4298
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -4056,6 +4661,7 @@ api_instance = PureCloud::OutboundApi.new
|
|
|
4056
4661
|
opts = {
|
|
4057
4662
|
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
4058
4663
|
page_number: 1, # Integer | Page number
|
|
4664
|
+
allow_empty_result: false, # BOOLEAN | Whether to return an empty page when there are no results for that page
|
|
4059
4665
|
filter_type: "Prefix", # String | Filter type
|
|
4060
4666
|
name: "name_example", # String | Name
|
|
4061
4667
|
sort_by: "sort_by_example", # String | Sort by
|
|
@@ -4077,6 +4683,7 @@ Name | Type | Description | Notes
|
|
|
4077
4683
|
------------- | ------------- | ------------- | -------------
|
|
4078
4684
|
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
4079
4685
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
4686
|
+
**allow_empty_result** | **BOOLEAN**| Whether to return an empty page when there are no results for that page | [optional] [default to false] |
|
|
4080
4687
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
4081
4688
|
**name** | **String**| Name | [optional] |
|
|
4082
4689
|
**sort_by** | **String**| Sort by | [optional] |
|
|
@@ -5542,6 +6149,136 @@ Name | Type | Description | Notes
|
|
|
5542
6149
|
|
|
5543
6150
|
|
|
5544
6151
|
|
|
6152
|
+
<a name="post_outbound_messagingcampaigns"></a>
|
|
6153
|
+
|
|
6154
|
+
## [**MessagingCampaign**](MessagingCampaign.html) post_outbound_messagingcampaigns(body)
|
|
6155
|
+
|
|
6156
|
+
|
|
6157
|
+
|
|
6158
|
+
Create a Messaging Campaign
|
|
6159
|
+
|
|
6160
|
+
|
|
6161
|
+
|
|
6162
|
+
Wraps POST /api/v2/outbound/messagingcampaigns
|
|
6163
|
+
|
|
6164
|
+
Requires ANY permissions:
|
|
6165
|
+
|
|
6166
|
+
* outbound:messagingCampaign:add
|
|
6167
|
+
|
|
6168
|
+
|
|
6169
|
+
### Example
|
|
6170
|
+
```{"language":"ruby"}
|
|
6171
|
+
# load the gem
|
|
6172
|
+
require 'purecloudplatformclientv2'
|
|
6173
|
+
# setup authorization
|
|
6174
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6175
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6176
|
+
environment = "mypurecloud.com"
|
|
6177
|
+
|
|
6178
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6179
|
+
|
|
6180
|
+
PureCloud.configure do |config|
|
|
6181
|
+
config.access_token = @authToken
|
|
6182
|
+
end
|
|
6183
|
+
|
|
6184
|
+
api_instance = PureCloud::OutboundApi.new
|
|
6185
|
+
|
|
6186
|
+
body = PureCloud::MessagingCampaign.new # MessagingCampaign | Messaging Campaign
|
|
6187
|
+
|
|
6188
|
+
|
|
6189
|
+
begin
|
|
6190
|
+
#Create a Messaging Campaign
|
|
6191
|
+
result = api_instance.post_outbound_messagingcampaigns(body)
|
|
6192
|
+
p result
|
|
6193
|
+
rescue PureCloud::ApiError => e
|
|
6194
|
+
puts "Exception when calling OutboundApi->post_outbound_messagingcampaigns: #{e}"
|
|
6195
|
+
end
|
|
6196
|
+
```
|
|
6197
|
+
|
|
6198
|
+
### Parameters
|
|
6199
|
+
|
|
6200
|
+
Name | Type | Description | Notes
|
|
6201
|
+
------------- | ------------- | ------------- | -------------
|
|
6202
|
+
**body** | [**MessagingCampaign**](MessagingCampaign.html)| Messaging Campaign | |
|
|
6203
|
+
{: class="table table-striped"}
|
|
6204
|
+
|
|
6205
|
+
|
|
6206
|
+
### Return type
|
|
6207
|
+
|
|
6208
|
+
[**MessagingCampaign**](MessagingCampaign.html)
|
|
6209
|
+
|
|
6210
|
+
### HTTP request headers
|
|
6211
|
+
|
|
6212
|
+
- **Content-Type**: application/json
|
|
6213
|
+
- **Accept**: application/json
|
|
6214
|
+
|
|
6215
|
+
|
|
6216
|
+
|
|
6217
|
+
<a name="post_outbound_messagingcampaigns_progress"></a>
|
|
6218
|
+
|
|
6219
|
+
## [**Array<CampaignProgress>**](CampaignProgress.html) post_outbound_messagingcampaigns_progress(body)
|
|
6220
|
+
|
|
6221
|
+
|
|
6222
|
+
|
|
6223
|
+
Get progress for a list of messaging campaigns
|
|
6224
|
+
|
|
6225
|
+
|
|
6226
|
+
|
|
6227
|
+
Wraps POST /api/v2/outbound/messagingcampaigns/progress
|
|
6228
|
+
|
|
6229
|
+
Requires ANY permissions:
|
|
6230
|
+
|
|
6231
|
+
* outbound:messagingCampaign:view
|
|
6232
|
+
|
|
6233
|
+
|
|
6234
|
+
### Example
|
|
6235
|
+
```{"language":"ruby"}
|
|
6236
|
+
# load the gem
|
|
6237
|
+
require 'purecloudplatformclientv2'
|
|
6238
|
+
# setup authorization
|
|
6239
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6240
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6241
|
+
environment = "mypurecloud.com"
|
|
6242
|
+
|
|
6243
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6244
|
+
|
|
6245
|
+
PureCloud.configure do |config|
|
|
6246
|
+
config.access_token = @authToken
|
|
6247
|
+
end
|
|
6248
|
+
|
|
6249
|
+
api_instance = PureCloud::OutboundApi.new
|
|
6250
|
+
|
|
6251
|
+
body = [PureCloud::Array<String>.new] # Array<String> | Messaging Campaign IDs
|
|
6252
|
+
|
|
6253
|
+
|
|
6254
|
+
begin
|
|
6255
|
+
#Get progress for a list of messaging campaigns
|
|
6256
|
+
result = api_instance.post_outbound_messagingcampaigns_progress(body)
|
|
6257
|
+
p result
|
|
6258
|
+
rescue PureCloud::ApiError => e
|
|
6259
|
+
puts "Exception when calling OutboundApi->post_outbound_messagingcampaigns_progress: #{e}"
|
|
6260
|
+
end
|
|
6261
|
+
```
|
|
6262
|
+
|
|
6263
|
+
### Parameters
|
|
6264
|
+
|
|
6265
|
+
Name | Type | Description | Notes
|
|
6266
|
+
------------- | ------------- | ------------- | -------------
|
|
6267
|
+
**body** | **Array<String>**| Messaging Campaign IDs | |
|
|
6268
|
+
{: class="table table-striped"}
|
|
6269
|
+
|
|
6270
|
+
|
|
6271
|
+
### Return type
|
|
6272
|
+
|
|
6273
|
+
[**Array<CampaignProgress>**](CampaignProgress.html)
|
|
6274
|
+
|
|
6275
|
+
### HTTP request headers
|
|
6276
|
+
|
|
6277
|
+
- **Content-Type**: application/json
|
|
6278
|
+
- **Accept**: application/json
|
|
6279
|
+
|
|
6280
|
+
|
|
6281
|
+
|
|
5545
6282
|
<a name="post_outbound_rulesets"></a>
|
|
5546
6283
|
|
|
5547
6284
|
## [**RuleSet**](RuleSet.html) post_outbound_rulesets(body)
|
|
@@ -6357,6 +7094,74 @@ Name | Type | Description | Notes
|
|
|
6357
7094
|
|
|
6358
7095
|
|
|
6359
7096
|
|
|
7097
|
+
<a name="put_outbound_messagingcampaign"></a>
|
|
7098
|
+
|
|
7099
|
+
## [**MessagingCampaign**](MessagingCampaign.html) put_outbound_messagingcampaign(messaging_campaign_id, body)
|
|
7100
|
+
|
|
7101
|
+
|
|
7102
|
+
|
|
7103
|
+
Update an Outbound Messaging Campaign
|
|
7104
|
+
|
|
7105
|
+
|
|
7106
|
+
|
|
7107
|
+
Wraps PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId}
|
|
7108
|
+
|
|
7109
|
+
Requires ANY permissions:
|
|
7110
|
+
|
|
7111
|
+
* outbound:messagingCampaign:edit
|
|
7112
|
+
|
|
7113
|
+
|
|
7114
|
+
### Example
|
|
7115
|
+
```{"language":"ruby"}
|
|
7116
|
+
# load the gem
|
|
7117
|
+
require 'purecloudplatformclientv2'
|
|
7118
|
+
# setup authorization
|
|
7119
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
7120
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
7121
|
+
environment = "mypurecloud.com"
|
|
7122
|
+
|
|
7123
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
7124
|
+
|
|
7125
|
+
PureCloud.configure do |config|
|
|
7126
|
+
config.access_token = @authToken
|
|
7127
|
+
end
|
|
7128
|
+
|
|
7129
|
+
api_instance = PureCloud::OutboundApi.new
|
|
7130
|
+
|
|
7131
|
+
messaging_campaign_id = "messaging_campaign_id_example" # String | The Messaging Campaign ID
|
|
7132
|
+
|
|
7133
|
+
body = PureCloud::MessagingCampaign.new # MessagingCampaign | MessagingCampaign
|
|
7134
|
+
|
|
7135
|
+
|
|
7136
|
+
begin
|
|
7137
|
+
#Update an Outbound Messaging Campaign
|
|
7138
|
+
result = api_instance.put_outbound_messagingcampaign(messaging_campaign_id, body)
|
|
7139
|
+
p result
|
|
7140
|
+
rescue PureCloud::ApiError => e
|
|
7141
|
+
puts "Exception when calling OutboundApi->put_outbound_messagingcampaign: #{e}"
|
|
7142
|
+
end
|
|
7143
|
+
```
|
|
7144
|
+
|
|
7145
|
+
### Parameters
|
|
7146
|
+
|
|
7147
|
+
Name | Type | Description | Notes
|
|
7148
|
+
------------- | ------------- | ------------- | -------------
|
|
7149
|
+
**messaging_campaign_id** | **String**| The Messaging Campaign ID | |
|
|
7150
|
+
**body** | [**MessagingCampaign**](MessagingCampaign.html)| MessagingCampaign | |
|
|
7151
|
+
{: class="table table-striped"}
|
|
7152
|
+
|
|
7153
|
+
|
|
7154
|
+
### Return type
|
|
7155
|
+
|
|
7156
|
+
[**MessagingCampaign**](MessagingCampaign.html)
|
|
7157
|
+
|
|
7158
|
+
### HTTP request headers
|
|
7159
|
+
|
|
7160
|
+
- **Content-Type**: application/json
|
|
7161
|
+
- **Accept**: application/json
|
|
7162
|
+
|
|
7163
|
+
|
|
7164
|
+
|
|
6360
7165
|
<a name="put_outbound_ruleset"></a>
|
|
6361
7166
|
|
|
6362
7167
|
## [**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body)
|