purecloudplatformclientv2 34.0.0 → 35.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
@@ -13,9 +13,9 @@ title: OrganizationPresenceEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: OrganizationRoleEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: OrphanRecordingListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/OutboundApi.md
CHANGED
@@ -38,6 +38,7 @@ Method | Description
|
|
38
38
|
[**get_outbound_campaignrule**](OutboundApi.html#get_outbound_campaignrule) | Get Campaign Rule
|
39
39
|
[**get_outbound_campaignrules**](OutboundApi.html#get_outbound_campaignrules) | Query Campaign Rule list
|
40
40
|
[**get_outbound_campaigns**](OutboundApi.html#get_outbound_campaigns) | Query a list of dialer campaigns.
|
41
|
+
[**get_outbound_campaigns_divisionviews**](OutboundApi.html#get_outbound_campaigns_divisionviews) | Query a list of basic Campaign information objects
|
41
42
|
[**get_outbound_contactlist**](OutboundApi.html#get_outbound_contactlist) | Get a dialer contact list.
|
42
43
|
[**get_outbound_contactlist_contact**](OutboundApi.html#get_outbound_contactlist_contact) | Get a contact.
|
43
44
|
[**get_outbound_contactlist_export**](OutboundApi.html#get_outbound_contactlist_export) | Get the URI of a contact list export.
|
@@ -103,12 +104,18 @@ Method | Description
|
|
103
104
|
|
104
105
|
## - delete_outbound_attemptlimit(attempt_limits_id)
|
105
106
|
|
107
|
+
|
108
|
+
|
106
109
|
Delete attempt limits
|
107
110
|
|
108
111
|
|
109
112
|
|
110
113
|
Wraps DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId}
|
111
114
|
|
115
|
+
Requires ANY permissions:
|
116
|
+
|
117
|
+
* outbound:attemptLimits:delete
|
118
|
+
|
112
119
|
|
113
120
|
### Example
|
114
121
|
~~~ruby
|
@@ -161,12 +168,18 @@ nil (empty response body)
|
|
161
168
|
|
162
169
|
## - delete_outbound_callabletimeset(callable_time_set_id)
|
163
170
|
|
171
|
+
|
172
|
+
|
164
173
|
Delete callable time set
|
165
174
|
|
166
175
|
|
167
176
|
|
168
177
|
Wraps DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId}
|
169
178
|
|
179
|
+
Requires ANY permissions:
|
180
|
+
|
181
|
+
* outbound:callableTimeSet:delete
|
182
|
+
|
170
183
|
|
171
184
|
### Example
|
172
185
|
~~~ruby
|
@@ -219,12 +232,18 @@ nil (empty response body)
|
|
219
232
|
|
220
233
|
## - delete_outbound_callanalysisresponseset(call_analysis_set_id)
|
221
234
|
|
235
|
+
|
236
|
+
|
222
237
|
Delete a dialer call analysis response set.
|
223
238
|
|
224
239
|
|
225
240
|
|
226
241
|
Wraps DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
|
227
242
|
|
243
|
+
Requires ANY permissions:
|
244
|
+
|
245
|
+
* outbound:responseSet:delete
|
246
|
+
|
228
247
|
|
229
248
|
### Example
|
230
249
|
~~~ruby
|
@@ -277,12 +296,18 @@ nil (empty response body)
|
|
277
296
|
|
278
297
|
## -[**Campaign**](Campaign.html) delete_outbound_campaign(campaign_id)
|
279
298
|
|
299
|
+
|
300
|
+
|
280
301
|
Delete a campaign.
|
281
302
|
|
282
303
|
|
283
304
|
|
284
305
|
Wraps DELETE /api/v2/outbound/campaigns/{campaignId}
|
285
306
|
|
307
|
+
Requires ANY permissions:
|
308
|
+
|
309
|
+
* outbound:campaign:delete
|
310
|
+
|
286
311
|
|
287
312
|
### Example
|
288
313
|
~~~ruby
|
@@ -336,12 +361,18 @@ Name | Type | Description | Notes
|
|
336
361
|
|
337
362
|
## - delete_outbound_campaign_progress(campaign_id)
|
338
363
|
|
364
|
+
|
365
|
+
|
339
366
|
Reset campaign progress and recycle the campaign
|
340
367
|
|
341
368
|
|
342
369
|
|
343
370
|
Wraps DELETE /api/v2/outbound/campaigns/{campaignId}/progress
|
344
371
|
|
372
|
+
Requires ANY permissions:
|
373
|
+
|
374
|
+
* outbound:campaign:edit
|
375
|
+
|
345
376
|
|
346
377
|
### Example
|
347
378
|
~~~ruby
|
@@ -394,12 +425,18 @@ nil (empty response body)
|
|
394
425
|
|
395
426
|
## - delete_outbound_campaignrule(campaign_rule_id)
|
396
427
|
|
428
|
+
|
429
|
+
|
397
430
|
Delete Campaign Rule
|
398
431
|
|
399
432
|
|
400
433
|
|
401
434
|
Wraps DELETE /api/v2/outbound/campaignrules/{campaignRuleId}
|
402
435
|
|
436
|
+
Requires ANY permissions:
|
437
|
+
|
438
|
+
* outbound:campaignRule:delete
|
439
|
+
|
403
440
|
|
404
441
|
### Example
|
405
442
|
~~~ruby
|
@@ -452,12 +489,18 @@ nil (empty response body)
|
|
452
489
|
|
453
490
|
## - delete_outbound_contactlist(contact_list_id)
|
454
491
|
|
492
|
+
|
493
|
+
|
455
494
|
Delete a contact list.
|
456
495
|
|
457
496
|
|
458
497
|
|
459
498
|
Wraps DELETE /api/v2/outbound/contactlists/{contactListId}
|
460
499
|
|
500
|
+
Requires ANY permissions:
|
501
|
+
|
502
|
+
* outbound:contactList:delete
|
503
|
+
|
461
504
|
|
462
505
|
### Example
|
463
506
|
~~~ruby
|
@@ -510,12 +553,18 @@ nil (empty response body)
|
|
510
553
|
|
511
554
|
## - delete_outbound_contactlist_contact(contact_list_id, contact_id)
|
512
555
|
|
556
|
+
|
557
|
+
|
513
558
|
Delete a contact.
|
514
559
|
|
515
560
|
|
516
561
|
|
517
562
|
Wraps DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
|
518
563
|
|
564
|
+
Requires ANY permissions:
|
565
|
+
|
566
|
+
* outbound:contact:delete
|
567
|
+
|
519
568
|
|
520
569
|
### Example
|
521
570
|
~~~ruby
|
@@ -571,12 +620,18 @@ nil (empty response body)
|
|
571
620
|
|
572
621
|
## - delete_outbound_contactlist_contacts(contact_list_id, contact_ids)
|
573
622
|
|
623
|
+
|
624
|
+
|
574
625
|
Delete contacts from a contact list.
|
575
626
|
|
576
627
|
|
577
628
|
|
578
629
|
Wraps DELETE /api/v2/outbound/contactlists/{contactListId}/contacts
|
579
630
|
|
631
|
+
Requires ANY permissions:
|
632
|
+
|
633
|
+
* outbound:contact:delete
|
634
|
+
|
580
635
|
|
581
636
|
### Example
|
582
637
|
~~~ruby
|
@@ -632,12 +687,18 @@ nil (empty response body)
|
|
632
687
|
|
633
688
|
## - delete_outbound_contactlistfilter(contact_list_filter_id)
|
634
689
|
|
690
|
+
|
691
|
+
|
635
692
|
Delete Contact List Filter
|
636
693
|
|
637
694
|
|
638
695
|
|
639
696
|
Wraps DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId}
|
640
697
|
|
698
|
+
Requires ANY permissions:
|
699
|
+
|
700
|
+
* outbound:contactListFilter:delete
|
701
|
+
|
641
702
|
|
642
703
|
### Example
|
643
704
|
~~~ruby
|
@@ -690,12 +751,18 @@ nil (empty response body)
|
|
690
751
|
|
691
752
|
## - delete_outbound_contactlists(id)
|
692
753
|
|
754
|
+
|
755
|
+
|
693
756
|
Delete multiple contact lists.
|
694
757
|
|
695
758
|
|
696
759
|
|
697
760
|
Wraps DELETE /api/v2/outbound/contactlists
|
698
761
|
|
762
|
+
Requires ANY permissions:
|
763
|
+
|
764
|
+
* outbound:contactList:delete
|
765
|
+
|
699
766
|
|
700
767
|
### Example
|
701
768
|
~~~ruby
|
@@ -748,12 +815,18 @@ nil (empty response body)
|
|
748
815
|
|
749
816
|
## - delete_outbound_dnclist(dnc_list_id)
|
750
817
|
|
818
|
+
|
819
|
+
|
751
820
|
Delete dialer DNC list
|
752
821
|
|
753
822
|
|
754
823
|
|
755
824
|
Wraps DELETE /api/v2/outbound/dnclists/{dncListId}
|
756
825
|
|
826
|
+
Requires ANY permissions:
|
827
|
+
|
828
|
+
* outbound:dncList:delete
|
829
|
+
|
757
830
|
|
758
831
|
### Example
|
759
832
|
~~~ruby
|
@@ -806,12 +879,18 @@ nil (empty response body)
|
|
806
879
|
|
807
880
|
## - delete_outbound_ruleset(rule_set_id)
|
808
881
|
|
882
|
+
|
883
|
+
|
809
884
|
Delete a Rule set.
|
810
885
|
|
811
886
|
|
812
887
|
|
813
888
|
Wraps DELETE /api/v2/outbound/rulesets/{ruleSetId}
|
814
889
|
|
890
|
+
Requires ANY permissions:
|
891
|
+
|
892
|
+
* outbound:ruleSet:delete
|
893
|
+
|
815
894
|
|
816
895
|
### Example
|
817
896
|
~~~ruby
|
@@ -864,12 +943,18 @@ nil (empty response body)
|
|
864
943
|
|
865
944
|
## - delete_outbound_schedules_campaign(campaign_id)
|
866
945
|
|
946
|
+
|
947
|
+
|
867
948
|
Delete a dialer campaign schedule.
|
868
949
|
|
869
950
|
|
870
951
|
|
871
952
|
Wraps DELETE /api/v2/outbound/schedules/campaigns/{campaignId}
|
872
953
|
|
954
|
+
Requires ANY permissions:
|
955
|
+
|
956
|
+
* outbound:schedule:delete
|
957
|
+
|
873
958
|
|
874
959
|
### Example
|
875
960
|
~~~ruby
|
@@ -922,12 +1007,18 @@ nil (empty response body)
|
|
922
1007
|
|
923
1008
|
## - delete_outbound_schedules_sequence(sequence_id)
|
924
1009
|
|
1010
|
+
|
1011
|
+
|
925
1012
|
Delete a dialer sequence schedule.
|
926
1013
|
|
927
1014
|
|
928
1015
|
|
929
1016
|
Wraps DELETE /api/v2/outbound/schedules/sequences/{sequenceId}
|
930
1017
|
|
1018
|
+
Requires ANY permissions:
|
1019
|
+
|
1020
|
+
* outbound:schedule:delete
|
1021
|
+
|
931
1022
|
|
932
1023
|
### Example
|
933
1024
|
~~~ruby
|
@@ -980,12 +1071,18 @@ nil (empty response body)
|
|
980
1071
|
|
981
1072
|
## - delete_outbound_sequence(sequence_id)
|
982
1073
|
|
1074
|
+
|
1075
|
+
|
983
1076
|
Delete a dialer campaign sequence.
|
984
1077
|
|
985
1078
|
|
986
1079
|
|
987
1080
|
Wraps DELETE /api/v2/outbound/sequences/{sequenceId}
|
988
1081
|
|
1082
|
+
Requires ANY permissions:
|
1083
|
+
|
1084
|
+
* outbound:campaignSequence:delete
|
1085
|
+
|
989
1086
|
|
990
1087
|
### Example
|
991
1088
|
~~~ruby
|
@@ -1038,12 +1135,18 @@ nil (empty response body)
|
|
1038
1135
|
|
1039
1136
|
## -[**AttemptLimits**](AttemptLimits.html) get_outbound_attemptlimit(attempt_limits_id)
|
1040
1137
|
|
1138
|
+
|
1139
|
+
|
1041
1140
|
Get attempt limits
|
1042
1141
|
|
1043
1142
|
|
1044
1143
|
|
1045
1144
|
Wraps GET /api/v2/outbound/attemptlimits/{attemptLimitsId}
|
1046
1145
|
|
1146
|
+
Requires ANY permissions:
|
1147
|
+
|
1148
|
+
* outbound:attemptLimits:view
|
1149
|
+
|
1047
1150
|
|
1048
1151
|
### Example
|
1049
1152
|
~~~ruby
|
@@ -1097,12 +1200,18 @@ Name | Type | Description | Notes
|
|
1097
1200
|
|
1098
1201
|
## -[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_outbound_attemptlimits(opts)
|
1099
1202
|
|
1203
|
+
|
1204
|
+
|
1100
1205
|
Query attempt limits list
|
1101
1206
|
|
1102
1207
|
|
1103
1208
|
|
1104
1209
|
Wraps GET /api/v2/outbound/attemptlimits
|
1105
1210
|
|
1211
|
+
Requires ANY permissions:
|
1212
|
+
|
1213
|
+
* outbound:attemptLimits:view
|
1214
|
+
|
1106
1215
|
|
1107
1216
|
### Example
|
1108
1217
|
~~~ruby
|
@@ -1167,12 +1276,18 @@ Name | Type | Description | Notes
|
|
1167
1276
|
|
1168
1277
|
## -[**CallableTimeSet**](CallableTimeSet.html) get_outbound_callabletimeset(callable_time_set_id)
|
1169
1278
|
|
1279
|
+
|
1280
|
+
|
1170
1281
|
Get callable time set
|
1171
1282
|
|
1172
1283
|
|
1173
1284
|
|
1174
1285
|
Wraps GET /api/v2/outbound/callabletimesets/{callableTimeSetId}
|
1175
1286
|
|
1287
|
+
Requires ANY permissions:
|
1288
|
+
|
1289
|
+
* outbound:callableTimeSet:view
|
1290
|
+
|
1176
1291
|
|
1177
1292
|
### Example
|
1178
1293
|
~~~ruby
|
@@ -1226,12 +1341,18 @@ Name | Type | Description | Notes
|
|
1226
1341
|
|
1227
1342
|
## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_outbound_callabletimesets(opts)
|
1228
1343
|
|
1344
|
+
|
1345
|
+
|
1229
1346
|
Query callable time set list
|
1230
1347
|
|
1231
1348
|
|
1232
1349
|
|
1233
1350
|
Wraps GET /api/v2/outbound/callabletimesets
|
1234
1351
|
|
1352
|
+
Requires ANY permissions:
|
1353
|
+
|
1354
|
+
* outbound:callableTimeSet:view
|
1355
|
+
|
1235
1356
|
|
1236
1357
|
### Example
|
1237
1358
|
~~~ruby
|
@@ -1296,12 +1417,18 @@ Name | Type | Description | Notes
|
|
1296
1417
|
|
1297
1418
|
## -[**ResponseSet**](ResponseSet.html) get_outbound_callanalysisresponseset(call_analysis_set_id)
|
1298
1419
|
|
1420
|
+
|
1421
|
+
|
1299
1422
|
Get a dialer call analysis response set.
|
1300
1423
|
|
1301
1424
|
|
1302
1425
|
|
1303
1426
|
Wraps GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
|
1304
1427
|
|
1428
|
+
Requires ANY permissions:
|
1429
|
+
|
1430
|
+
* outbound:responseSet:view
|
1431
|
+
|
1305
1432
|
|
1306
1433
|
### Example
|
1307
1434
|
~~~ruby
|
@@ -1355,12 +1482,18 @@ Name | Type | Description | Notes
|
|
1355
1482
|
|
1356
1483
|
## -[**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_outbound_callanalysisresponsesets(opts)
|
1357
1484
|
|
1485
|
+
|
1486
|
+
|
1358
1487
|
Query a list of dialer call analysis response sets.
|
1359
1488
|
|
1360
1489
|
|
1361
1490
|
|
1362
1491
|
Wraps GET /api/v2/outbound/callanalysisresponsesets
|
1363
1492
|
|
1493
|
+
Requires ANY permissions:
|
1494
|
+
|
1495
|
+
* outbound:responseSet:view
|
1496
|
+
|
1364
1497
|
|
1365
1498
|
### Example
|
1366
1499
|
~~~ruby
|
@@ -1425,12 +1558,18 @@ Name | Type | Description | Notes
|
|
1425
1558
|
|
1426
1559
|
## -[**Campaign**](Campaign.html) get_outbound_campaign(campaign_id)
|
1427
1560
|
|
1561
|
+
|
1562
|
+
|
1428
1563
|
Get dialer campaign.
|
1429
1564
|
|
1430
1565
|
|
1431
1566
|
|
1432
1567
|
Wraps GET /api/v2/outbound/campaigns/{campaignId}
|
1433
1568
|
|
1569
|
+
Requires ANY permissions:
|
1570
|
+
|
1571
|
+
* outbound:campaign:view
|
1572
|
+
|
1434
1573
|
|
1435
1574
|
### Example
|
1436
1575
|
~~~ruby
|
@@ -1484,12 +1623,18 @@ Name | Type | Description | Notes
|
|
1484
1623
|
|
1485
1624
|
## -[**CampaignDiagnostics**](CampaignDiagnostics.html) get_outbound_campaign_diagnostics(campaign_id)
|
1486
1625
|
|
1626
|
+
|
1627
|
+
|
1487
1628
|
Get campaign diagnostics
|
1488
1629
|
|
1489
1630
|
|
1490
1631
|
|
1491
1632
|
Wraps GET /api/v2/outbound/campaigns/{campaignId}/diagnostics
|
1492
1633
|
|
1634
|
+
Requires ANY permissions:
|
1635
|
+
|
1636
|
+
* outbound:campaign:view
|
1637
|
+
|
1493
1638
|
|
1494
1639
|
### Example
|
1495
1640
|
~~~ruby
|
@@ -1543,12 +1688,18 @@ Name | Type | Description | Notes
|
|
1543
1688
|
|
1544
1689
|
## -[**CampaignInteractions**](CampaignInteractions.html) get_outbound_campaign_interactions(campaign_id)
|
1545
1690
|
|
1691
|
+
|
1692
|
+
|
1546
1693
|
Get dialer campaign interactions.
|
1547
1694
|
|
1548
1695
|
|
1549
1696
|
|
1550
1697
|
Wraps GET /api/v2/outbound/campaigns/{campaignId}/interactions
|
1551
1698
|
|
1699
|
+
Requires ANY permissions:
|
1700
|
+
|
1701
|
+
* outbound:campaign:view
|
1702
|
+
|
1552
1703
|
|
1553
1704
|
### Example
|
1554
1705
|
~~~ruby
|
@@ -1602,12 +1753,18 @@ Name | Type | Description | Notes
|
|
1602
1753
|
|
1603
1754
|
## -[**CampaignProgress**](CampaignProgress.html) get_outbound_campaign_progress(campaign_id)
|
1604
1755
|
|
1756
|
+
|
1757
|
+
|
1605
1758
|
Get campaign progress
|
1606
1759
|
|
1607
1760
|
|
1608
1761
|
|
1609
1762
|
Wraps GET /api/v2/outbound/campaigns/{campaignId}/progress
|
1610
1763
|
|
1764
|
+
Requires ANY permissions:
|
1765
|
+
|
1766
|
+
* outbound:campaign:view
|
1767
|
+
|
1611
1768
|
|
1612
1769
|
### Example
|
1613
1770
|
~~~ruby
|
@@ -1661,12 +1818,18 @@ Name | Type | Description | Notes
|
|
1661
1818
|
|
1662
1819
|
## -[**CampaignStats**](CampaignStats.html) get_outbound_campaign_stats(campaign_id)
|
1663
1820
|
|
1821
|
+
|
1822
|
+
|
1664
1823
|
Get statistics about a Dialer Campaign
|
1665
1824
|
|
1666
1825
|
|
1667
1826
|
|
1668
1827
|
Wraps GET /api/v2/outbound/campaigns/{campaignId}/stats
|
1669
1828
|
|
1829
|
+
Requires ANY permissions:
|
1830
|
+
|
1831
|
+
* outbound:campaign:view
|
1832
|
+
|
1670
1833
|
|
1671
1834
|
### Example
|
1672
1835
|
~~~ruby
|
@@ -1720,12 +1883,18 @@ Name | Type | Description | Notes
|
|
1720
1883
|
|
1721
1884
|
## -[**CampaignRule**](CampaignRule.html) get_outbound_campaignrule(campaign_rule_id)
|
1722
1885
|
|
1886
|
+
|
1887
|
+
|
1723
1888
|
Get Campaign Rule
|
1724
1889
|
|
1725
1890
|
|
1726
1891
|
|
1727
1892
|
Wraps GET /api/v2/outbound/campaignrules/{campaignRuleId}
|
1728
1893
|
|
1894
|
+
Requires ANY permissions:
|
1895
|
+
|
1896
|
+
* outbound:campaignRule:view
|
1897
|
+
|
1729
1898
|
|
1730
1899
|
### Example
|
1731
1900
|
~~~ruby
|
@@ -1779,12 +1948,18 @@ Name | Type | Description | Notes
|
|
1779
1948
|
|
1780
1949
|
## -[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_outbound_campaignrules(opts)
|
1781
1950
|
|
1951
|
+
|
1952
|
+
|
1782
1953
|
Query Campaign Rule list
|
1783
1954
|
|
1784
1955
|
|
1785
1956
|
|
1786
1957
|
Wraps GET /api/v2/outbound/campaignrules
|
1787
1958
|
|
1959
|
+
Requires ANY permissions:
|
1960
|
+
|
1961
|
+
* outbound:campaignRule:view
|
1962
|
+
|
1788
1963
|
|
1789
1964
|
### Example
|
1790
1965
|
~~~ruby
|
@@ -1849,12 +2024,18 @@ Name | Type | Description | Notes
|
|
1849
2024
|
|
1850
2025
|
## -[**CampaignEntityListing**](CampaignEntityListing.html) get_outbound_campaigns(opts)
|
1851
2026
|
|
2027
|
+
|
2028
|
+
|
1852
2029
|
Query a list of dialer campaigns.
|
1853
2030
|
|
1854
2031
|
|
1855
2032
|
|
1856
2033
|
Wraps GET /api/v2/outbound/campaigns
|
1857
2034
|
|
2035
|
+
Requires ANY permissions:
|
2036
|
+
|
2037
|
+
* outbound:campaign:view
|
2038
|
+
|
1858
2039
|
|
1859
2040
|
### Example
|
1860
2041
|
~~~ruby
|
@@ -1927,16 +2108,98 @@ Name | Type | Description | Notes
|
|
1927
2108
|
|
1928
2109
|
|
1929
2110
|
|
2111
|
+
<a name="get_outbound_campaigns_divisionviews"></a>
|
2112
|
+
|
2113
|
+
## -[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts)
|
2114
|
+
|
2115
|
+
|
2116
|
+
|
2117
|
+
Query a list of basic Campaign information objects
|
2118
|
+
|
2119
|
+
This returns a simplified version of a Campaign, consisting of name and division.
|
2120
|
+
|
2121
|
+
Wraps GET /api/v2/outbound/campaigns/divisionviews
|
2122
|
+
|
2123
|
+
Requires ANY permissions:
|
2124
|
+
|
2125
|
+
* outbound:campaign:search
|
2126
|
+
|
2127
|
+
|
2128
|
+
### Example
|
2129
|
+
~~~ruby
|
2130
|
+
# load the gem
|
2131
|
+
require 'purecloudplatformclientv2'
|
2132
|
+
# setup authorization
|
2133
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2134
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2135
|
+
environment = "mypurecloud.com"
|
2136
|
+
|
2137
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2138
|
+
|
2139
|
+
PureCloud.configure do |config|
|
2140
|
+
config.access_token = @authToken
|
2141
|
+
end
|
2142
|
+
|
2143
|
+
api_instance = PureCloud::OutboundApi.new
|
2144
|
+
|
2145
|
+
opts = {
|
2146
|
+
page_size: 25, # Integer | Page size
|
2147
|
+
page_number: 1, # Integer | Page number
|
2148
|
+
filter_type: "Prefix", # String | Filter type
|
2149
|
+
name: "name_example", # String | Name
|
2150
|
+
sort_by: "sort_by_example", # String | Sort by
|
2151
|
+
sort_order: "a" # String | Sort order
|
2152
|
+
}
|
2153
|
+
|
2154
|
+
begin
|
2155
|
+
#Query a list of basic Campaign information objects
|
2156
|
+
result = api_instance.get_outbound_campaigns_divisionviews(opts)
|
2157
|
+
p result
|
2158
|
+
rescue PureCloud::ApiError => e
|
2159
|
+
puts "Exception when calling OutboundApi->get_outbound_campaigns_divisionviews: #{e}"
|
2160
|
+
end
|
2161
|
+
~~~
|
2162
|
+
|
2163
|
+
### Parameters
|
2164
|
+
|
2165
|
+
Name | Type | Description | Notes
|
2166
|
+
------------- | ------------- | ------------- | -------------
|
2167
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
2168
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
2169
|
+
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
2170
|
+
**name** | **String**| Name | [optional] |
|
2171
|
+
**sort_by** | **String**| Sort by | [optional] |
|
2172
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
2173
|
+
{: class="table table-striped"}
|
2174
|
+
|
2175
|
+
|
2176
|
+
### Return type
|
2177
|
+
|
2178
|
+
[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html)
|
2179
|
+
|
2180
|
+
### HTTP request headers
|
2181
|
+
|
2182
|
+
- **Content-Type**: application/json
|
2183
|
+
- **Accept**: application/json
|
2184
|
+
|
2185
|
+
|
2186
|
+
|
1930
2187
|
<a name="get_outbound_contactlist"></a>
|
1931
2188
|
|
1932
2189
|
## -[**ContactList**](ContactList.html) get_outbound_contactlist(contact_list_id, opts)
|
1933
2190
|
|
2191
|
+
|
2192
|
+
|
1934
2193
|
Get a dialer contact list.
|
1935
2194
|
|
1936
2195
|
|
1937
2196
|
|
1938
2197
|
Wraps GET /api/v2/outbound/contactlists/{contactListId}
|
1939
2198
|
|
2199
|
+
Requires ANY permissions:
|
2200
|
+
|
2201
|
+
* outbound:contactList:view
|
2202
|
+
|
1940
2203
|
|
1941
2204
|
### Example
|
1942
2205
|
~~~ruby
|
@@ -1996,12 +2259,18 @@ Name | Type | Description | Notes
|
|
1996
2259
|
|
1997
2260
|
## -[**DialerContact**](DialerContact.html) get_outbound_contactlist_contact(contact_list_id, contact_id)
|
1998
2261
|
|
2262
|
+
|
2263
|
+
|
1999
2264
|
Get a contact.
|
2000
2265
|
|
2001
2266
|
|
2002
2267
|
|
2003
2268
|
Wraps GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
|
2004
2269
|
|
2270
|
+
Requires ANY permissions:
|
2271
|
+
|
2272
|
+
* outbound:contact:view
|
2273
|
+
|
2005
2274
|
|
2006
2275
|
### Example
|
2007
2276
|
~~~ruby
|
@@ -2058,12 +2327,18 @@ Name | Type | Description | Notes
|
|
2058
2327
|
|
2059
2328
|
## -[**ExportUri**](ExportUri.html) get_outbound_contactlist_export(contact_list_id, opts)
|
2060
2329
|
|
2330
|
+
|
2331
|
+
|
2061
2332
|
Get the URI of a contact list export.
|
2062
2333
|
|
2063
2334
|
|
2064
2335
|
|
2065
2336
|
Wraps GET /api/v2/outbound/contactlists/{contactListId}/export
|
2066
2337
|
|
2338
|
+
Requires ALL permissions:
|
2339
|
+
|
2340
|
+
* outbound:contact:view* outbound:contactList:view
|
2341
|
+
|
2067
2342
|
|
2068
2343
|
### Example
|
2069
2344
|
~~~ruby
|
@@ -2121,12 +2396,18 @@ Name | Type | Description | Notes
|
|
2121
2396
|
|
2122
2397
|
## -[**ImportStatus**](ImportStatus.html) get_outbound_contactlist_importstatus(contact_list_id)
|
2123
2398
|
|
2399
|
+
|
2400
|
+
|
2124
2401
|
Get dialer contactList import status.
|
2125
2402
|
|
2126
2403
|
|
2127
2404
|
|
2128
2405
|
Wraps GET /api/v2/outbound/contactlists/{contactListId}/importstatus
|
2129
2406
|
|
2407
|
+
Requires ANY permissions:
|
2408
|
+
|
2409
|
+
* outbound:contactList:view
|
2410
|
+
|
2130
2411
|
|
2131
2412
|
### Example
|
2132
2413
|
~~~ruby
|
@@ -2180,12 +2461,18 @@ Name | Type | Description | Notes
|
|
2180
2461
|
|
2181
2462
|
## -[**ContactListFilter**](ContactListFilter.html) get_outbound_contactlistfilter(contact_list_filter_id)
|
2182
2463
|
|
2464
|
+
|
2465
|
+
|
2183
2466
|
Get Contact list filter
|
2184
2467
|
|
2185
2468
|
|
2186
2469
|
|
2187
2470
|
Wraps GET /api/v2/outbound/contactlistfilters/{contactListFilterId}
|
2188
2471
|
|
2472
|
+
Requires ANY permissions:
|
2473
|
+
|
2474
|
+
* outbound:contactListFilter:view
|
2475
|
+
|
2189
2476
|
|
2190
2477
|
### Example
|
2191
2478
|
~~~ruby
|
@@ -2239,12 +2526,18 @@ Name | Type | Description | Notes
|
|
2239
2526
|
|
2240
2527
|
## -[**ContactListFilterEntityListing**](ContactListFilterEntityListing.html) get_outbound_contactlistfilters(opts)
|
2241
2528
|
|
2529
|
+
|
2530
|
+
|
2242
2531
|
Query Contact list filters
|
2243
2532
|
|
2244
2533
|
|
2245
2534
|
|
2246
2535
|
Wraps GET /api/v2/outbound/contactlistfilters
|
2247
2536
|
|
2537
|
+
Requires ANY permissions:
|
2538
|
+
|
2539
|
+
* outbound:contactListFilter:view
|
2540
|
+
|
2248
2541
|
|
2249
2542
|
### Example
|
2250
2543
|
~~~ruby
|
@@ -2311,12 +2604,18 @@ Name | Type | Description | Notes
|
|
2311
2604
|
|
2312
2605
|
## -[**ContactListEntityListing**](ContactListEntityListing.html) get_outbound_contactlists(opts)
|
2313
2606
|
|
2607
|
+
|
2608
|
+
|
2314
2609
|
Query a list of contact lists.
|
2315
2610
|
|
2316
2611
|
|
2317
2612
|
|
2318
2613
|
Wraps GET /api/v2/outbound/contactlists
|
2319
2614
|
|
2615
|
+
Requires ANY permissions:
|
2616
|
+
|
2617
|
+
* outbound:contactList:view
|
2618
|
+
|
2320
2619
|
|
2321
2620
|
### Example
|
2322
2621
|
~~~ruby
|
@@ -2387,12 +2686,18 @@ Name | Type | Description | Notes
|
|
2387
2686
|
|
2388
2687
|
## -[**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts)
|
2389
2688
|
|
2689
|
+
|
2690
|
+
|
2390
2691
|
Get dialer DNC list
|
2391
2692
|
|
2392
2693
|
|
2393
2694
|
|
2394
2695
|
Wraps GET /api/v2/outbound/dnclists/{dncListId}
|
2395
2696
|
|
2697
|
+
Requires ANY permissions:
|
2698
|
+
|
2699
|
+
* outbound:dncList:view
|
2700
|
+
|
2396
2701
|
|
2397
2702
|
### Example
|
2398
2703
|
~~~ruby
|
@@ -2452,12 +2757,18 @@ Name | Type | Description | Notes
|
|
2452
2757
|
|
2453
2758
|
## -[**ExportUri**](ExportUri.html) get_outbound_dnclist_export(dnc_list_id, opts)
|
2454
2759
|
|
2760
|
+
|
2761
|
+
|
2455
2762
|
Get the URI of a DNC list export.
|
2456
2763
|
|
2457
2764
|
|
2458
2765
|
|
2459
2766
|
Wraps GET /api/v2/outbound/dnclists/{dncListId}/export
|
2460
2767
|
|
2768
|
+
Requires ALL permissions:
|
2769
|
+
|
2770
|
+
* outbound:dnc:view* outbound:dncList:view
|
2771
|
+
|
2461
2772
|
|
2462
2773
|
### Example
|
2463
2774
|
~~~ruby
|
@@ -2515,12 +2826,18 @@ Name | Type | Description | Notes
|
|
2515
2826
|
|
2516
2827
|
## -[**ImportStatus**](ImportStatus.html) get_outbound_dnclist_importstatus(dnc_list_id)
|
2517
2828
|
|
2829
|
+
|
2830
|
+
|
2518
2831
|
Get dialer dncList import status.
|
2519
2832
|
|
2520
2833
|
|
2521
2834
|
|
2522
2835
|
Wraps GET /api/v2/outbound/dnclists/{dncListId}/importstatus
|
2523
2836
|
|
2837
|
+
Requires ANY permissions:
|
2838
|
+
|
2839
|
+
* outbound:dncList:view
|
2840
|
+
|
2524
2841
|
|
2525
2842
|
### Example
|
2526
2843
|
~~~ruby
|
@@ -2574,12 +2891,18 @@ Name | Type | Description | Notes
|
|
2574
2891
|
|
2575
2892
|
## -[**DncListEntityListing**](DncListEntityListing.html) get_outbound_dnclists(opts)
|
2576
2893
|
|
2894
|
+
|
2895
|
+
|
2577
2896
|
Query dialer DNC lists
|
2578
2897
|
|
2579
2898
|
|
2580
2899
|
|
2581
2900
|
Wraps GET /api/v2/outbound/dnclists
|
2582
2901
|
|
2902
|
+
Requires ANY permissions:
|
2903
|
+
|
2904
|
+
* outbound:dncList:view
|
2905
|
+
|
2583
2906
|
|
2584
2907
|
### Example
|
2585
2908
|
~~~ruby
|
@@ -2648,12 +2971,18 @@ Name | Type | Description | Notes
|
|
2648
2971
|
|
2649
2972
|
## -[**EventLog**](EventLog.html) get_outbound_event(event_id)
|
2650
2973
|
|
2974
|
+
|
2975
|
+
|
2651
2976
|
Get Dialer Event
|
2652
2977
|
|
2653
2978
|
|
2654
2979
|
|
2655
2980
|
Wraps GET /api/v2/outbound/events/{eventId}
|
2656
2981
|
|
2982
|
+
Requires ANY permissions:
|
2983
|
+
|
2984
|
+
* outbound:eventLog:view
|
2985
|
+
|
2657
2986
|
|
2658
2987
|
### Example
|
2659
2988
|
~~~ruby
|
@@ -2707,12 +3036,18 @@ Name | Type | Description | Notes
|
|
2707
3036
|
|
2708
3037
|
## -[**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts)
|
2709
3038
|
|
3039
|
+
|
3040
|
+
|
2710
3041
|
Query Event Logs
|
2711
3042
|
|
2712
3043
|
|
2713
3044
|
|
2714
3045
|
Wraps GET /api/v2/outbound/events
|
2715
3046
|
|
3047
|
+
Requires ANY permissions:
|
3048
|
+
|
3049
|
+
* outbound:eventLog:view
|
3050
|
+
|
2716
3051
|
|
2717
3052
|
### Example
|
2718
3053
|
~~~ruby
|
@@ -2779,12 +3114,18 @@ Name | Type | Description | Notes
|
|
2779
3114
|
|
2780
3115
|
## -[**RuleSet**](RuleSet.html) get_outbound_ruleset(rule_set_id)
|
2781
3116
|
|
3117
|
+
|
3118
|
+
|
2782
3119
|
Get a Rule Set by ID.
|
2783
3120
|
|
2784
3121
|
|
2785
3122
|
|
2786
3123
|
Wraps GET /api/v2/outbound/rulesets/{ruleSetId}
|
2787
3124
|
|
3125
|
+
Requires ANY permissions:
|
3126
|
+
|
3127
|
+
* outbound:ruleSet:view
|
3128
|
+
|
2788
3129
|
|
2789
3130
|
### Example
|
2790
3131
|
~~~ruby
|
@@ -2838,12 +3179,18 @@ Name | Type | Description | Notes
|
|
2838
3179
|
|
2839
3180
|
## -[**RuleSetEntityListing**](RuleSetEntityListing.html) get_outbound_rulesets(opts)
|
2840
3181
|
|
3182
|
+
|
3183
|
+
|
2841
3184
|
Query a list of Rule Sets.
|
2842
3185
|
|
2843
3186
|
|
2844
3187
|
|
2845
3188
|
Wraps GET /api/v2/outbound/rulesets
|
2846
3189
|
|
3190
|
+
Requires ANY permissions:
|
3191
|
+
|
3192
|
+
* outbound:ruleSet:view
|
3193
|
+
|
2847
3194
|
|
2848
3195
|
### Example
|
2849
3196
|
~~~ruby
|
@@ -2908,12 +3255,18 @@ Name | Type | Description | Notes
|
|
2908
3255
|
|
2909
3256
|
## -[**CampaignSchedule**](CampaignSchedule.html) get_outbound_schedules_campaign(campaign_id)
|
2910
3257
|
|
3258
|
+
|
3259
|
+
|
2911
3260
|
Get a dialer campaign schedule.
|
2912
3261
|
|
2913
3262
|
|
2914
3263
|
|
2915
3264
|
Wraps GET /api/v2/outbound/schedules/campaigns/{campaignId}
|
2916
3265
|
|
3266
|
+
Requires ANY permissions:
|
3267
|
+
|
3268
|
+
* outbound:schedule:view
|
3269
|
+
|
2917
3270
|
|
2918
3271
|
### Example
|
2919
3272
|
~~~ruby
|
@@ -2967,12 +3320,18 @@ Name | Type | Description | Notes
|
|
2967
3320
|
|
2968
3321
|
## -[**Array<CampaignSchedule>**](CampaignSchedule.html) get_outbound_schedules_campaigns
|
2969
3322
|
|
3323
|
+
|
3324
|
+
|
2970
3325
|
Query for a list of dialer campaign schedules.
|
2971
3326
|
|
2972
3327
|
|
2973
3328
|
|
2974
3329
|
Wraps GET /api/v2/outbound/schedules/campaigns
|
2975
3330
|
|
3331
|
+
Requires ANY permissions:
|
3332
|
+
|
3333
|
+
* outbound:schedule:view
|
3334
|
+
|
2976
3335
|
|
2977
3336
|
### Example
|
2978
3337
|
~~~ruby
|
@@ -3020,12 +3379,18 @@ This endpoint does not need any parameter.
|
|
3020
3379
|
|
3021
3380
|
## -[**SequenceSchedule**](SequenceSchedule.html) get_outbound_schedules_sequence(sequence_id)
|
3022
3381
|
|
3382
|
+
|
3383
|
+
|
3023
3384
|
Get a dialer sequence schedule.
|
3024
3385
|
|
3025
3386
|
|
3026
3387
|
|
3027
3388
|
Wraps GET /api/v2/outbound/schedules/sequences/{sequenceId}
|
3028
3389
|
|
3390
|
+
Requires ANY permissions:
|
3391
|
+
|
3392
|
+
* outbound:schedule:view
|
3393
|
+
|
3029
3394
|
|
3030
3395
|
### Example
|
3031
3396
|
~~~ruby
|
@@ -3079,12 +3444,18 @@ Name | Type | Description | Notes
|
|
3079
3444
|
|
3080
3445
|
## -[**Array<SequenceSchedule>**](SequenceSchedule.html) get_outbound_schedules_sequences
|
3081
3446
|
|
3447
|
+
|
3448
|
+
|
3082
3449
|
Query for a list of dialer sequence schedules.
|
3083
3450
|
|
3084
3451
|
|
3085
3452
|
|
3086
3453
|
Wraps GET /api/v2/outbound/schedules/sequences
|
3087
3454
|
|
3455
|
+
Requires ANY permissions:
|
3456
|
+
|
3457
|
+
* outbound:schedule:view
|
3458
|
+
|
3088
3459
|
|
3089
3460
|
### Example
|
3090
3461
|
~~~ruby
|
@@ -3132,12 +3503,18 @@ This endpoint does not need any parameter.
|
|
3132
3503
|
|
3133
3504
|
## -[**CampaignSequence**](CampaignSequence.html) get_outbound_sequence(sequence_id)
|
3134
3505
|
|
3506
|
+
|
3507
|
+
|
3135
3508
|
Get a dialer campaign sequence.
|
3136
3509
|
|
3137
3510
|
|
3138
3511
|
|
3139
3512
|
Wraps GET /api/v2/outbound/sequences/{sequenceId}
|
3140
3513
|
|
3514
|
+
Requires ANY permissions:
|
3515
|
+
|
3516
|
+
* outbound:campaignSequence:view
|
3517
|
+
|
3141
3518
|
|
3142
3519
|
### Example
|
3143
3520
|
~~~ruby
|
@@ -3191,12 +3568,18 @@ Name | Type | Description | Notes
|
|
3191
3568
|
|
3192
3569
|
## -[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_outbound_sequences(opts)
|
3193
3570
|
|
3571
|
+
|
3572
|
+
|
3194
3573
|
Query a list of dialer campaign sequences.
|
3195
3574
|
|
3196
3575
|
|
3197
3576
|
|
3198
3577
|
Wraps GET /api/v2/outbound/sequences
|
3199
3578
|
|
3579
|
+
Requires ANY permissions:
|
3580
|
+
|
3581
|
+
* outbound:campaignSequence:view
|
3582
|
+
|
3200
3583
|
|
3201
3584
|
### Example
|
3202
3585
|
~~~ruby
|
@@ -3261,12 +3644,18 @@ Name | Type | Description | Notes
|
|
3261
3644
|
|
3262
3645
|
## -[**OutboundSettings**](OutboundSettings.html) get_outbound_settings
|
3263
3646
|
|
3647
|
+
|
3648
|
+
|
3264
3649
|
Get the outbound settings for this organization
|
3265
3650
|
|
3266
3651
|
|
3267
3652
|
|
3268
3653
|
Wraps GET /api/v2/outbound/settings
|
3269
3654
|
|
3655
|
+
Requires ANY permissions:
|
3656
|
+
|
3657
|
+
* outbound:settings:view
|
3658
|
+
|
3270
3659
|
|
3271
3660
|
### Example
|
3272
3661
|
~~~ruby
|
@@ -3314,12 +3703,18 @@ This endpoint does not need any parameter.
|
|
3314
3703
|
|
3315
3704
|
## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings
|
3316
3705
|
|
3706
|
+
|
3707
|
+
|
3317
3708
|
Get the Dialer wrap up code mapping.
|
3318
3709
|
|
3319
3710
|
|
3320
3711
|
|
3321
3712
|
Wraps GET /api/v2/outbound/wrapupcodemappings
|
3322
3713
|
|
3714
|
+
Requires ANY permissions:
|
3715
|
+
|
3716
|
+
* outbound:wrapUpCodeMapping:view
|
3717
|
+
|
3323
3718
|
|
3324
3719
|
### Example
|
3325
3720
|
~~~ruby
|
@@ -3367,12 +3762,18 @@ This endpoint does not need any parameter.
|
|
3367
3762
|
|
3368
3763
|
## - patch_outbound_settings(body)
|
3369
3764
|
|
3765
|
+
|
3766
|
+
|
3370
3767
|
Update the outbound settings for this organization
|
3371
3768
|
|
3372
3769
|
|
3373
3770
|
|
3374
3771
|
Wraps PATCH /api/v2/outbound/settings
|
3375
3772
|
|
3773
|
+
Requires ANY permissions:
|
3774
|
+
|
3775
|
+
* outbound:settings:edit
|
3776
|
+
|
3376
3777
|
|
3377
3778
|
### Example
|
3378
3779
|
~~~ruby
|
@@ -3425,12 +3826,18 @@ nil (empty response body)
|
|
3425
3826
|
|
3426
3827
|
## -[**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body)
|
3427
3828
|
|
3829
|
+
|
3830
|
+
|
3428
3831
|
Create attempt limits
|
3429
3832
|
|
3430
3833
|
|
3431
3834
|
|
3432
3835
|
Wraps POST /api/v2/outbound/attemptlimits
|
3433
3836
|
|
3837
|
+
Requires ANY permissions:
|
3838
|
+
|
3839
|
+
* outbound:attemptLimits:add
|
3840
|
+
|
3434
3841
|
|
3435
3842
|
### Example
|
3436
3843
|
~~~ruby
|
@@ -3484,12 +3891,18 @@ Name | Type | Description | Notes
|
|
3484
3891
|
|
3485
3892
|
## -[**AuditSearchResult**](AuditSearchResult.html) post_outbound_audits(body, opts)
|
3486
3893
|
|
3894
|
+
|
3895
|
+
|
3487
3896
|
Retrieves audits for dialer.
|
3488
3897
|
|
3489
3898
|
|
3490
3899
|
|
3491
3900
|
Wraps POST /api/v2/outbound/audits
|
3492
3901
|
|
3902
|
+
Requires ANY permissions:
|
3903
|
+
|
3904
|
+
* outbound:audit:view
|
3905
|
+
|
3493
3906
|
|
3494
3907
|
### Example
|
3495
3908
|
~~~ruby
|
@@ -3555,12 +3968,18 @@ Name | Type | Description | Notes
|
|
3555
3968
|
|
3556
3969
|
## -[**CallableTimeSet**](CallableTimeSet.html) post_outbound_callabletimesets(body)
|
3557
3970
|
|
3971
|
+
|
3972
|
+
|
3558
3973
|
Create callable time set
|
3559
3974
|
|
3560
3975
|
|
3561
3976
|
|
3562
3977
|
Wraps POST /api/v2/outbound/callabletimesets
|
3563
3978
|
|
3979
|
+
Requires ANY permissions:
|
3980
|
+
|
3981
|
+
* outbound:callableTimeSet:add
|
3982
|
+
|
3564
3983
|
|
3565
3984
|
### Example
|
3566
3985
|
~~~ruby
|
@@ -3614,12 +4033,18 @@ Name | Type | Description | Notes
|
|
3614
4033
|
|
3615
4034
|
## -[**ResponseSet**](ResponseSet.html) post_outbound_callanalysisresponsesets(body)
|
3616
4035
|
|
4036
|
+
|
4037
|
+
|
3617
4038
|
Create a dialer call analysis response set.
|
3618
4039
|
|
3619
4040
|
|
3620
4041
|
|
3621
4042
|
Wraps POST /api/v2/outbound/callanalysisresponsesets
|
3622
4043
|
|
4044
|
+
Requires ANY permissions:
|
4045
|
+
|
4046
|
+
* outbound:responseSet:add
|
4047
|
+
|
3623
4048
|
|
3624
4049
|
### Example
|
3625
4050
|
~~~ruby
|
@@ -3673,12 +4098,18 @@ Name | Type | Description | Notes
|
|
3673
4098
|
|
3674
4099
|
## -[**ContactCallbackRequest**](ContactCallbackRequest.html) post_outbound_campaign_callback_schedule(campaign_id, body)
|
3675
4100
|
|
4101
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
4102
|
+
|
3676
4103
|
Schedule a Callback for a Dialer Campaign (Deprecated)
|
3677
4104
|
|
3678
4105
|
This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"
|
3679
4106
|
|
3680
4107
|
Wraps POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule
|
3681
4108
|
|
4109
|
+
Requires NO permissions:
|
4110
|
+
|
4111
|
+
|
4112
|
+
|
3682
4113
|
|
3683
4114
|
### Example
|
3684
4115
|
~~~ruby
|
@@ -3735,12 +4166,18 @@ Name | Type | Description | Notes
|
|
3735
4166
|
|
3736
4167
|
## -[**CampaignRule**](CampaignRule.html) post_outbound_campaignrules(body)
|
3737
4168
|
|
4169
|
+
|
4170
|
+
|
3738
4171
|
Create Campaign Rule
|
3739
4172
|
|
3740
4173
|
|
3741
4174
|
|
3742
4175
|
Wraps POST /api/v2/outbound/campaignrules
|
3743
4176
|
|
4177
|
+
Requires ANY permissions:
|
4178
|
+
|
4179
|
+
* outbound:campaignRule:add
|
4180
|
+
|
3744
4181
|
|
3745
4182
|
### Example
|
3746
4183
|
~~~ruby
|
@@ -3794,12 +4231,18 @@ Name | Type | Description | Notes
|
|
3794
4231
|
|
3795
4232
|
## -[**Campaign**](Campaign.html) post_outbound_campaigns(body)
|
3796
4233
|
|
4234
|
+
|
4235
|
+
|
3797
4236
|
Create a campaign.
|
3798
4237
|
|
3799
4238
|
|
3800
4239
|
|
3801
4240
|
Wraps POST /api/v2/outbound/campaigns
|
3802
4241
|
|
4242
|
+
Requires ANY permissions:
|
4243
|
+
|
4244
|
+
* outbound:campaign:add
|
4245
|
+
|
3803
4246
|
|
3804
4247
|
### Example
|
3805
4248
|
~~~ruby
|
@@ -3853,12 +4296,18 @@ Name | Type | Description | Notes
|
|
3853
4296
|
|
3854
4297
|
## -[**Array<CampaignProgress>**](CampaignProgress.html) post_outbound_campaigns_progress(body)
|
3855
4298
|
|
4299
|
+
|
4300
|
+
|
3856
4301
|
Get progress for a list of campaigns
|
3857
4302
|
|
3858
4303
|
|
3859
4304
|
|
3860
4305
|
Wraps POST /api/v2/outbound/campaigns/progress
|
3861
4306
|
|
4307
|
+
Requires ANY permissions:
|
4308
|
+
|
4309
|
+
* outbound:campaign:view
|
4310
|
+
|
3862
4311
|
|
3863
4312
|
### Example
|
3864
4313
|
~~~ruby
|
@@ -3912,12 +4361,18 @@ Name | Type | Description | Notes
|
|
3912
4361
|
|
3913
4362
|
## -[**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts)
|
3914
4363
|
|
4364
|
+
|
4365
|
+
|
3915
4366
|
Add contacts to a contact list.
|
3916
4367
|
|
3917
4368
|
|
3918
4369
|
|
3919
4370
|
Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts
|
3920
4371
|
|
4372
|
+
Requires ANY permissions:
|
4373
|
+
|
4374
|
+
* outbound:contact:add
|
4375
|
+
|
3921
4376
|
|
3922
4377
|
### Example
|
3923
4378
|
~~~ruby
|
@@ -3982,12 +4437,18 @@ Name | Type | Description | Notes
|
|
3982
4437
|
|
3983
4438
|
## -[**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body)
|
3984
4439
|
|
4440
|
+
|
4441
|
+
|
3985
4442
|
Get contacts from a contact list.
|
3986
4443
|
|
3987
4444
|
|
3988
4445
|
|
3989
4446
|
Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk
|
3990
4447
|
|
4448
|
+
Requires ANY permissions:
|
4449
|
+
|
4450
|
+
* outbound:contact:view
|
4451
|
+
|
3991
4452
|
|
3992
4453
|
### Example
|
3993
4454
|
~~~ruby
|
@@ -4044,12 +4505,18 @@ Name | Type | Description | Notes
|
|
4044
4505
|
|
4045
4506
|
## -[**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id)
|
4046
4507
|
|
4508
|
+
|
4509
|
+
|
4047
4510
|
Initiate the export of a contact list.
|
4048
4511
|
|
4049
4512
|
Returns 200 if received OK.
|
4050
4513
|
|
4051
4514
|
Wraps POST /api/v2/outbound/contactlists/{contactListId}/export
|
4052
4515
|
|
4516
|
+
Requires ALL permissions:
|
4517
|
+
|
4518
|
+
* outbound:contact:view* outbound:contactList:view
|
4519
|
+
|
4053
4520
|
|
4054
4521
|
### Example
|
4055
4522
|
~~~ruby
|
@@ -4103,12 +4570,18 @@ Name | Type | Description | Notes
|
|
4103
4570
|
|
4104
4571
|
## -[**ContactListFilter**](ContactListFilter.html) post_outbound_contactlistfilters(body)
|
4105
4572
|
|
4573
|
+
|
4574
|
+
|
4106
4575
|
Create Contact List Filter
|
4107
4576
|
|
4108
4577
|
|
4109
4578
|
|
4110
4579
|
Wraps POST /api/v2/outbound/contactlistfilters
|
4111
4580
|
|
4581
|
+
Requires ANY permissions:
|
4582
|
+
|
4583
|
+
* outbound:contactListFilter:add
|
4584
|
+
|
4112
4585
|
|
4113
4586
|
### Example
|
4114
4587
|
~~~ruby
|
@@ -4162,12 +4635,18 @@ Name | Type | Description | Notes
|
|
4162
4635
|
|
4163
4636
|
## -[**FilterPreviewResponse**](FilterPreviewResponse.html) post_outbound_contactlistfilters_preview(body)
|
4164
4637
|
|
4638
|
+
|
4639
|
+
|
4165
4640
|
Get a preview of the output of a contact list filter
|
4166
4641
|
|
4167
4642
|
|
4168
4643
|
|
4169
4644
|
Wraps POST /api/v2/outbound/contactlistfilters/preview
|
4170
4645
|
|
4646
|
+
Requires ANY permissions:
|
4647
|
+
|
4648
|
+
* outbound:contact:view
|
4649
|
+
|
4171
4650
|
|
4172
4651
|
### Example
|
4173
4652
|
~~~ruby
|
@@ -4221,12 +4700,18 @@ Name | Type | Description | Notes
|
|
4221
4700
|
|
4222
4701
|
## -[**ContactList**](ContactList.html) post_outbound_contactlists(body)
|
4223
4702
|
|
4703
|
+
|
4704
|
+
|
4224
4705
|
Create a contact List.
|
4225
4706
|
|
4226
4707
|
|
4227
4708
|
|
4228
4709
|
Wraps POST /api/v2/outbound/contactlists
|
4229
4710
|
|
4711
|
+
Requires ANY permissions:
|
4712
|
+
|
4713
|
+
* outbound:contactList:add
|
4714
|
+
|
4230
4715
|
|
4231
4716
|
### Example
|
4232
4717
|
~~~ruby
|
@@ -4280,12 +4765,18 @@ Name | Type | Description | Notes
|
|
4280
4765
|
|
4281
4766
|
## - post_outbound_conversation_dnc(conversation_id)
|
4282
4767
|
|
4768
|
+
|
4769
|
+
|
4283
4770
|
Add phone numbers to a Dialer DNC list.
|
4284
4771
|
|
4285
4772
|
|
4286
4773
|
|
4287
4774
|
Wraps POST /api/v2/outbound/conversations/{conversationId}/dnc
|
4288
4775
|
|
4776
|
+
Requires ANY permissions:
|
4777
|
+
|
4778
|
+
* outbound:dnc:add
|
4779
|
+
|
4289
4780
|
|
4290
4781
|
### Example
|
4291
4782
|
~~~ruby
|
@@ -4338,12 +4829,18 @@ nil (empty response body)
|
|
4338
4829
|
|
4339
4830
|
## -[**UriReference**](UriReference.html) post_outbound_dnclist_export(dnc_list_id)
|
4340
4831
|
|
4832
|
+
|
4833
|
+
|
4341
4834
|
Initiate the export of a dnc list.
|
4342
4835
|
|
4343
4836
|
Returns 200 if received OK.
|
4344
4837
|
|
4345
4838
|
Wraps POST /api/v2/outbound/dnclists/{dncListId}/export
|
4346
4839
|
|
4840
|
+
Requires ALL permissions:
|
4841
|
+
|
4842
|
+
* outbound:dnc:view* outbound:dncList:view
|
4843
|
+
|
4347
4844
|
|
4348
4845
|
### Example
|
4349
4846
|
~~~ruby
|
@@ -4397,12 +4894,18 @@ Name | Type | Description | Notes
|
|
4397
4894
|
|
4398
4895
|
## - post_outbound_dnclist_phonenumbers(dnc_list_id, body)
|
4399
4896
|
|
4897
|
+
|
4898
|
+
|
4400
4899
|
Add phone numbers to a Dialer DNC list.
|
4401
4900
|
|
4402
4901
|
Only Internal DNC lists may be appended to
|
4403
4902
|
|
4404
4903
|
Wraps POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers
|
4405
4904
|
|
4905
|
+
Requires ANY permissions:
|
4906
|
+
|
4907
|
+
* outbound:dnc:add
|
4908
|
+
|
4406
4909
|
|
4407
4910
|
### Example
|
4408
4911
|
~~~ruby
|
@@ -4458,12 +4961,18 @@ nil (empty response body)
|
|
4458
4961
|
|
4459
4962
|
## -[**DncList**](DncList.html) post_outbound_dnclists(body)
|
4460
4963
|
|
4964
|
+
|
4965
|
+
|
4461
4966
|
Create dialer DNC list
|
4462
4967
|
|
4463
4968
|
|
4464
4969
|
|
4465
4970
|
Wraps POST /api/v2/outbound/dnclists
|
4466
4971
|
|
4972
|
+
Requires ANY permissions:
|
4973
|
+
|
4974
|
+
* outbound:dncList:add
|
4975
|
+
|
4467
4976
|
|
4468
4977
|
### Example
|
4469
4978
|
~~~ruby
|
@@ -4517,12 +5026,18 @@ Name | Type | Description | Notes
|
|
4517
5026
|
|
4518
5027
|
## -[**RuleSet**](RuleSet.html) post_outbound_rulesets(body)
|
4519
5028
|
|
5029
|
+
|
5030
|
+
|
4520
5031
|
Create a Dialer Call Analysis Response Set.
|
4521
5032
|
|
4522
5033
|
|
4523
5034
|
|
4524
5035
|
Wraps POST /api/v2/outbound/rulesets
|
4525
5036
|
|
5037
|
+
Requires ANY permissions:
|
5038
|
+
|
5039
|
+
* outbound:ruleSet:add
|
5040
|
+
|
4526
5041
|
|
4527
5042
|
### Example
|
4528
5043
|
~~~ruby
|
@@ -4576,12 +5091,18 @@ Name | Type | Description | Notes
|
|
4576
5091
|
|
4577
5092
|
## -[**CampaignSequence**](CampaignSequence.html) post_outbound_sequences(body)
|
4578
5093
|
|
5094
|
+
|
5095
|
+
|
4579
5096
|
Create a new campaign sequence.
|
4580
5097
|
|
4581
5098
|
|
4582
5099
|
|
4583
5100
|
Wraps POST /api/v2/outbound/sequences
|
4584
5101
|
|
5102
|
+
Requires ANY permissions:
|
5103
|
+
|
5104
|
+
* outbound:campaignSequence:add
|
5105
|
+
|
4585
5106
|
|
4586
5107
|
### Example
|
4587
5108
|
~~~ruby
|
@@ -4635,12 +5156,18 @@ Name | Type | Description | Notes
|
|
4635
5156
|
|
4636
5157
|
## -[**AttemptLimits**](AttemptLimits.html) put_outbound_attemptlimit(attempt_limits_id, body)
|
4637
5158
|
|
5159
|
+
|
5160
|
+
|
4638
5161
|
Update attempt limits
|
4639
5162
|
|
4640
5163
|
|
4641
5164
|
|
4642
5165
|
Wraps PUT /api/v2/outbound/attemptlimits/{attemptLimitsId}
|
4643
5166
|
|
5167
|
+
Requires ANY permissions:
|
5168
|
+
|
5169
|
+
* outbound:attemptLimits:edit
|
5170
|
+
|
4644
5171
|
|
4645
5172
|
### Example
|
4646
5173
|
~~~ruby
|
@@ -4697,12 +5224,18 @@ Name | Type | Description | Notes
|
|
4697
5224
|
|
4698
5225
|
## -[**CallableTimeSet**](CallableTimeSet.html) put_outbound_callabletimeset(callable_time_set_id, body)
|
4699
5226
|
|
5227
|
+
|
5228
|
+
|
4700
5229
|
Update callable time set
|
4701
5230
|
|
4702
5231
|
|
4703
5232
|
|
4704
5233
|
Wraps PUT /api/v2/outbound/callabletimesets/{callableTimeSetId}
|
4705
5234
|
|
5235
|
+
Requires ANY permissions:
|
5236
|
+
|
5237
|
+
* outbound:callableTimeSet:edit
|
5238
|
+
|
4706
5239
|
|
4707
5240
|
### Example
|
4708
5241
|
~~~ruby
|
@@ -4759,12 +5292,18 @@ Name | Type | Description | Notes
|
|
4759
5292
|
|
4760
5293
|
## -[**ResponseSet**](ResponseSet.html) put_outbound_callanalysisresponseset(call_analysis_set_id, body)
|
4761
5294
|
|
5295
|
+
|
5296
|
+
|
4762
5297
|
Update a dialer call analysis response set.
|
4763
5298
|
|
4764
5299
|
|
4765
5300
|
|
4766
5301
|
Wraps PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}
|
4767
5302
|
|
5303
|
+
Requires ANY permissions:
|
5304
|
+
|
5305
|
+
* outbound:responseSet:edit
|
5306
|
+
|
4768
5307
|
|
4769
5308
|
### Example
|
4770
5309
|
~~~ruby
|
@@ -4821,12 +5360,18 @@ Name | Type | Description | Notes
|
|
4821
5360
|
|
4822
5361
|
## -[**Campaign**](Campaign.html) put_outbound_campaign(campaign_id, body)
|
4823
5362
|
|
5363
|
+
|
5364
|
+
|
4824
5365
|
Update a campaign.
|
4825
5366
|
|
4826
5367
|
|
4827
5368
|
|
4828
5369
|
Wraps PUT /api/v2/outbound/campaigns/{campaignId}
|
4829
5370
|
|
5371
|
+
Requires ANY permissions:
|
5372
|
+
|
5373
|
+
* outbound:campaign:edit
|
5374
|
+
|
4830
5375
|
|
4831
5376
|
### Example
|
4832
5377
|
~~~ruby
|
@@ -4883,12 +5428,18 @@ Name | Type | Description | Notes
|
|
4883
5428
|
|
4884
5429
|
## -String** put_outbound_campaign_agent(campaign_id, user_id, body)
|
4885
5430
|
|
5431
|
+
|
5432
|
+
|
4886
5433
|
Send notification that an agent's state changed
|
4887
5434
|
|
4888
5435
|
New agent state.
|
4889
5436
|
|
4890
5437
|
Wraps PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId}
|
4891
5438
|
|
5439
|
+
Requires NO permissions:
|
5440
|
+
|
5441
|
+
|
5442
|
+
|
4892
5443
|
|
4893
5444
|
### Example
|
4894
5445
|
~~~ruby
|
@@ -4948,12 +5499,18 @@ Name | Type | Description | Notes
|
|
4948
5499
|
|
4949
5500
|
## -[**CampaignRule**](CampaignRule.html) put_outbound_campaignrule(campaign_rule_id, body)
|
4950
5501
|
|
5502
|
+
|
5503
|
+
|
4951
5504
|
Update Campaign Rule
|
4952
5505
|
|
4953
5506
|
|
4954
5507
|
|
4955
5508
|
Wraps PUT /api/v2/outbound/campaignrules/{campaignRuleId}
|
4956
5509
|
|
5510
|
+
Requires ANY permissions:
|
5511
|
+
|
5512
|
+
* outbound:campaignRule:edit
|
5513
|
+
|
4957
5514
|
|
4958
5515
|
### Example
|
4959
5516
|
~~~ruby
|
@@ -5010,12 +5567,18 @@ Name | Type | Description | Notes
|
|
5010
5567
|
|
5011
5568
|
## -[**ContactList**](ContactList.html) put_outbound_contactlist(contact_list_id, body)
|
5012
5569
|
|
5570
|
+
|
5571
|
+
|
5013
5572
|
Update a contact list.
|
5014
5573
|
|
5015
5574
|
|
5016
5575
|
|
5017
5576
|
Wraps PUT /api/v2/outbound/contactlists/{contactListId}
|
5018
5577
|
|
5578
|
+
Requires ANY permissions:
|
5579
|
+
|
5580
|
+
* outbound:contactList:edit
|
5581
|
+
|
5019
5582
|
|
5020
5583
|
### Example
|
5021
5584
|
~~~ruby
|
@@ -5072,12 +5635,18 @@ Name | Type | Description | Notes
|
|
5072
5635
|
|
5073
5636
|
## -[**DialerContact**](DialerContact.html) put_outbound_contactlist_contact(contact_list_id, contact_id, body)
|
5074
5637
|
|
5638
|
+
|
5639
|
+
|
5075
5640
|
Update a contact.
|
5076
5641
|
|
5077
5642
|
|
5078
5643
|
|
5079
5644
|
Wraps PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}
|
5080
5645
|
|
5646
|
+
Requires ANY permissions:
|
5647
|
+
|
5648
|
+
* outbound:contact:edit
|
5649
|
+
|
5081
5650
|
|
5082
5651
|
### Example
|
5083
5652
|
~~~ruby
|
@@ -5137,12 +5706,18 @@ Name | Type | Description | Notes
|
|
5137
5706
|
|
5138
5707
|
## -[**ContactListFilter**](ContactListFilter.html) put_outbound_contactlistfilter(contact_list_filter_id, body)
|
5139
5708
|
|
5709
|
+
|
5710
|
+
|
5140
5711
|
Update Contact List Filter
|
5141
5712
|
|
5142
5713
|
|
5143
5714
|
|
5144
5715
|
Wraps PUT /api/v2/outbound/contactlistfilters/{contactListFilterId}
|
5145
5716
|
|
5717
|
+
Requires ANY permissions:
|
5718
|
+
|
5719
|
+
* outbound:contactListFilter:edit
|
5720
|
+
|
5146
5721
|
|
5147
5722
|
### Example
|
5148
5723
|
~~~ruby
|
@@ -5199,12 +5774,18 @@ Name | Type | Description | Notes
|
|
5199
5774
|
|
5200
5775
|
## -[**DncList**](DncList.html) put_outbound_dnclist(dnc_list_id, body)
|
5201
5776
|
|
5777
|
+
|
5778
|
+
|
5202
5779
|
Update dialer DNC list
|
5203
5780
|
|
5204
5781
|
|
5205
5782
|
|
5206
5783
|
Wraps PUT /api/v2/outbound/dnclists/{dncListId}
|
5207
5784
|
|
5785
|
+
Requires ANY permissions:
|
5786
|
+
|
5787
|
+
* outbound:dncList:edit
|
5788
|
+
|
5208
5789
|
|
5209
5790
|
### Example
|
5210
5791
|
~~~ruby
|
@@ -5261,12 +5842,18 @@ Name | Type | Description | Notes
|
|
5261
5842
|
|
5262
5843
|
## -[**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body)
|
5263
5844
|
|
5845
|
+
|
5846
|
+
|
5264
5847
|
Update a RuleSet.
|
5265
5848
|
|
5266
5849
|
|
5267
5850
|
|
5268
5851
|
Wraps PUT /api/v2/outbound/rulesets/{ruleSetId}
|
5269
5852
|
|
5853
|
+
Requires ANY permissions:
|
5854
|
+
|
5855
|
+
* outbound:ruleSet:edit
|
5856
|
+
|
5270
5857
|
|
5271
5858
|
### Example
|
5272
5859
|
~~~ruby
|
@@ -5323,12 +5910,18 @@ Name | Type | Description | Notes
|
|
5323
5910
|
|
5324
5911
|
## -[**CampaignSchedule**](CampaignSchedule.html) put_outbound_schedules_campaign(campaign_id, body)
|
5325
5912
|
|
5913
|
+
|
5914
|
+
|
5326
5915
|
Update a new campaign schedule.
|
5327
5916
|
|
5328
5917
|
|
5329
5918
|
|
5330
5919
|
Wraps PUT /api/v2/outbound/schedules/campaigns/{campaignId}
|
5331
5920
|
|
5921
|
+
Requires ANY permissions:
|
5922
|
+
|
5923
|
+
* outbound:schedule:edit
|
5924
|
+
|
5332
5925
|
|
5333
5926
|
### Example
|
5334
5927
|
~~~ruby
|
@@ -5385,12 +5978,18 @@ Name | Type | Description | Notes
|
|
5385
5978
|
|
5386
5979
|
## -[**SequenceSchedule**](SequenceSchedule.html) put_outbound_schedules_sequence(sequence_id, body)
|
5387
5980
|
|
5981
|
+
|
5982
|
+
|
5388
5983
|
Update a new sequence schedule.
|
5389
5984
|
|
5390
5985
|
|
5391
5986
|
|
5392
5987
|
Wraps PUT /api/v2/outbound/schedules/sequences/{sequenceId}
|
5393
5988
|
|
5989
|
+
Requires ANY permissions:
|
5990
|
+
|
5991
|
+
* outbound:schedule:edit
|
5992
|
+
|
5394
5993
|
|
5395
5994
|
### Example
|
5396
5995
|
~~~ruby
|
@@ -5447,12 +6046,18 @@ Name | Type | Description | Notes
|
|
5447
6046
|
|
5448
6047
|
## -[**CampaignSequence**](CampaignSequence.html) put_outbound_sequence(sequence_id, body)
|
5449
6048
|
|
6049
|
+
|
6050
|
+
|
5450
6051
|
Update a new campaign sequence.
|
5451
6052
|
|
5452
6053
|
|
5453
6054
|
|
5454
6055
|
Wraps PUT /api/v2/outbound/sequences/{sequenceId}
|
5455
6056
|
|
6057
|
+
Requires ANY permissions:
|
6058
|
+
|
6059
|
+
* outbound:campaignSequence:edit
|
6060
|
+
|
5456
6061
|
|
5457
6062
|
### Example
|
5458
6063
|
~~~ruby
|
@@ -5509,12 +6114,18 @@ Name | Type | Description | Notes
|
|
5509
6114
|
|
5510
6115
|
## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_outbound_wrapupcodemappings(body)
|
5511
6116
|
|
6117
|
+
|
6118
|
+
|
5512
6119
|
Update the Dialer wrap up code mapping.
|
5513
6120
|
|
5514
6121
|
|
5515
6122
|
|
5516
6123
|
Wraps PUT /api/v2/outbound/wrapupcodemappings
|
5517
6124
|
|
6125
|
+
Requires ANY permissions:
|
6126
|
+
|
6127
|
+
* outbound:wrapUpCodeMapping:edit
|
6128
|
+
|
5518
6129
|
|
5519
6130
|
### Example
|
5520
6131
|
~~~ruby
|