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: ConversationEntityListing
|
|
|
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/ConversationsApi.md
CHANGED
|
@@ -110,12 +110,18 @@ Method | Description
|
|
|
110
110
|
|
|
111
111
|
## - delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
|
112
112
|
|
|
113
|
+
|
|
114
|
+
|
|
113
115
|
Delete a code used to add a communication to this participant
|
|
114
116
|
|
|
115
117
|
|
|
116
118
|
|
|
117
119
|
Wraps DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode}
|
|
118
120
|
|
|
121
|
+
Requires NO permissions:
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
119
125
|
|
|
120
126
|
### Example
|
|
121
127
|
~~~ruby
|
|
@@ -174,12 +180,18 @@ nil (empty response body)
|
|
|
174
180
|
|
|
175
181
|
## - delete_conversations_call_participant_consult(conversation_id, participant_id)
|
|
176
182
|
|
|
183
|
+
|
|
184
|
+
|
|
177
185
|
Cancel the transfer
|
|
178
186
|
|
|
179
187
|
|
|
180
188
|
|
|
181
189
|
Wraps DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
182
190
|
|
|
191
|
+
Requires NO permissions:
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
183
195
|
|
|
184
196
|
### Example
|
|
185
197
|
~~~ruby
|
|
@@ -235,12 +247,18 @@ nil (empty response body)
|
|
|
235
247
|
|
|
236
248
|
## - delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id)
|
|
237
249
|
|
|
250
|
+
|
|
251
|
+
|
|
238
252
|
Delete attachment from draft
|
|
239
253
|
|
|
240
254
|
|
|
241
255
|
|
|
242
256
|
Wraps DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId}
|
|
243
257
|
|
|
258
|
+
Requires NO permissions:
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
244
262
|
|
|
245
263
|
### Example
|
|
246
264
|
~~~ruby
|
|
@@ -296,12 +314,18 @@ nil (empty response body)
|
|
|
296
314
|
|
|
297
315
|
## -[**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
|
298
316
|
|
|
317
|
+
|
|
318
|
+
|
|
299
319
|
Get a conversation by id
|
|
300
320
|
|
|
301
321
|
|
|
302
322
|
|
|
303
323
|
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
304
324
|
|
|
325
|
+
Requires ANY permissions:
|
|
326
|
+
|
|
327
|
+
* analytics:conversationDetail:view
|
|
328
|
+
|
|
305
329
|
|
|
306
330
|
### Example
|
|
307
331
|
~~~ruby
|
|
@@ -355,12 +379,18 @@ Name | Type | Description | Notes
|
|
|
355
379
|
|
|
356
380
|
## -[**Conversation**](Conversation.html) get_conversation(conversation_id)
|
|
357
381
|
|
|
382
|
+
|
|
383
|
+
|
|
358
384
|
Get conversation
|
|
359
385
|
|
|
360
386
|
|
|
361
387
|
|
|
362
388
|
Wraps GET /api/v2/conversations/{conversationId}
|
|
363
389
|
|
|
390
|
+
Requires ANY permissions:
|
|
391
|
+
|
|
392
|
+
* conversation:communication:view
|
|
393
|
+
|
|
364
394
|
|
|
365
395
|
### Example
|
|
366
396
|
~~~ruby
|
|
@@ -414,12 +444,18 @@ Name | Type | Description | Notes
|
|
|
414
444
|
|
|
415
445
|
## -[**SecureSession**](SecureSession.html) get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
|
|
416
446
|
|
|
447
|
+
|
|
448
|
+
|
|
417
449
|
Fetch info on a secure session
|
|
418
450
|
|
|
419
451
|
|
|
420
452
|
|
|
421
453
|
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}
|
|
422
454
|
|
|
455
|
+
Requires NO permissions:
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
423
459
|
|
|
424
460
|
### Example
|
|
425
461
|
~~~ruby
|
|
@@ -479,12 +515,18 @@ Name | Type | Description | Notes
|
|
|
479
515
|
|
|
480
516
|
## -[**SecureSessionEntityListing**](SecureSessionEntityListing.html) get_conversation_participant_secureivrsessions(conversation_id, participant_id)
|
|
481
517
|
|
|
518
|
+
|
|
519
|
+
|
|
482
520
|
Get a list of secure sessions for this participant.
|
|
483
521
|
|
|
484
522
|
|
|
485
523
|
|
|
486
524
|
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
|
|
487
525
|
|
|
526
|
+
Requires NO permissions:
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
488
530
|
|
|
489
531
|
### Example
|
|
490
532
|
~~~ruby
|
|
@@ -539,7 +581,9 @@ Name | Type | Description | Notes
|
|
|
539
581
|
|
|
540
582
|
<a name="get_conversation_participant_wrapup"></a>
|
|
541
583
|
|
|
542
|
-
## -[**
|
|
584
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversation_participant_wrapup(conversation_id, participant_id, opts)
|
|
585
|
+
|
|
586
|
+
|
|
543
587
|
|
|
544
588
|
Get the wrap-up for this conversation participant.
|
|
545
589
|
|
|
@@ -547,6 +591,10 @@ Get the wrap-up for this conversation participant.
|
|
|
547
591
|
|
|
548
592
|
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup
|
|
549
593
|
|
|
594
|
+
Requires NO permissions:
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
550
598
|
|
|
551
599
|
### Example
|
|
552
600
|
~~~ruby
|
|
@@ -594,7 +642,7 @@ Name | Type | Description | Notes
|
|
|
594
642
|
|
|
595
643
|
### Return type
|
|
596
644
|
|
|
597
|
-
[**
|
|
645
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
598
646
|
|
|
599
647
|
### HTTP request headers
|
|
600
648
|
|
|
@@ -607,12 +655,18 @@ Name | Type | Description | Notes
|
|
|
607
655
|
|
|
608
656
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversation_participant_wrapupcodes(conversation_id, participant_id)
|
|
609
657
|
|
|
658
|
+
|
|
659
|
+
|
|
610
660
|
Get list of wrapup codes for this conversation participant
|
|
611
661
|
|
|
612
662
|
|
|
613
663
|
|
|
614
664
|
Wraps GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes
|
|
615
665
|
|
|
666
|
+
Requires NO permissions:
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
616
670
|
|
|
617
671
|
### Example
|
|
618
672
|
~~~ruby
|
|
@@ -669,12 +723,18 @@ Name | Type | Description | Notes
|
|
|
669
723
|
|
|
670
724
|
## -[**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
|
671
725
|
|
|
726
|
+
|
|
727
|
+
|
|
672
728
|
Get active conversations for the logged in user
|
|
673
729
|
|
|
674
730
|
|
|
675
731
|
|
|
676
732
|
Wraps GET /api/v2/conversations
|
|
677
733
|
|
|
734
|
+
Requires NO permissions:
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
678
738
|
|
|
679
739
|
### Example
|
|
680
740
|
~~~ruby
|
|
@@ -729,12 +789,18 @@ Name | Type | Description | Notes
|
|
|
729
789
|
|
|
730
790
|
## -[**CallConversation**](CallConversation.html) get_conversations_call(conversation_id)
|
|
731
791
|
|
|
792
|
+
|
|
793
|
+
|
|
732
794
|
Get call conversation
|
|
733
795
|
|
|
734
796
|
|
|
735
797
|
|
|
736
798
|
Wraps GET /api/v2/conversations/calls/{conversationId}
|
|
737
799
|
|
|
800
|
+
Requires NO permissions:
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
738
804
|
|
|
739
805
|
### Example
|
|
740
806
|
~~~ruby
|
|
@@ -786,7 +852,9 @@ Name | Type | Description | Notes
|
|
|
786
852
|
|
|
787
853
|
<a name="get_conversations_call_participant_wrapup"></a>
|
|
788
854
|
|
|
789
|
-
## -[**
|
|
855
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_call_participant_wrapup(conversation_id, participant_id, opts)
|
|
856
|
+
|
|
857
|
+
|
|
790
858
|
|
|
791
859
|
Get the wrap-up for this conversation participant.
|
|
792
860
|
|
|
@@ -794,6 +862,10 @@ Get the wrap-up for this conversation participant.
|
|
|
794
862
|
|
|
795
863
|
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup
|
|
796
864
|
|
|
865
|
+
Requires NO permissions:
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
797
869
|
|
|
798
870
|
### Example
|
|
799
871
|
~~~ruby
|
|
@@ -841,7 +913,7 @@ Name | Type | Description | Notes
|
|
|
841
913
|
|
|
842
914
|
### Return type
|
|
843
915
|
|
|
844
|
-
[**
|
|
916
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
845
917
|
|
|
846
918
|
### HTTP request headers
|
|
847
919
|
|
|
@@ -854,12 +926,18 @@ Name | Type | Description | Notes
|
|
|
854
926
|
|
|
855
927
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_call_participant_wrapupcodes(conversation_id, participant_id)
|
|
856
928
|
|
|
929
|
+
|
|
930
|
+
|
|
857
931
|
Get list of wrapup codes for this conversation participant
|
|
858
932
|
|
|
859
933
|
|
|
860
934
|
|
|
861
935
|
Wraps GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes
|
|
862
936
|
|
|
937
|
+
Requires NO permissions:
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
863
941
|
|
|
864
942
|
### Example
|
|
865
943
|
~~~ruby
|
|
@@ -916,12 +994,18 @@ Name | Type | Description | Notes
|
|
|
916
994
|
|
|
917
995
|
## -[**CallbackConversation**](CallbackConversation.html) get_conversations_callback(conversation_id)
|
|
918
996
|
|
|
997
|
+
|
|
998
|
+
|
|
919
999
|
Get callback conversation
|
|
920
1000
|
|
|
921
1001
|
|
|
922
1002
|
|
|
923
1003
|
Wraps GET /api/v2/conversations/callbacks/{conversationId}
|
|
924
1004
|
|
|
1005
|
+
Requires NO permissions:
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
925
1009
|
|
|
926
1010
|
### Example
|
|
927
1011
|
~~~ruby
|
|
@@ -973,7 +1057,9 @@ Name | Type | Description | Notes
|
|
|
973
1057
|
|
|
974
1058
|
<a name="get_conversations_callback_participant_wrapup"></a>
|
|
975
1059
|
|
|
976
|
-
## -[**
|
|
1060
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_callback_participant_wrapup(conversation_id, participant_id, opts)
|
|
1061
|
+
|
|
1062
|
+
|
|
977
1063
|
|
|
978
1064
|
Get the wrap-up for this conversation participant.
|
|
979
1065
|
|
|
@@ -981,6 +1067,10 @@ Get the wrap-up for this conversation participant.
|
|
|
981
1067
|
|
|
982
1068
|
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup
|
|
983
1069
|
|
|
1070
|
+
Requires NO permissions:
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
984
1074
|
|
|
985
1075
|
### Example
|
|
986
1076
|
~~~ruby
|
|
@@ -1028,7 +1118,7 @@ Name | Type | Description | Notes
|
|
|
1028
1118
|
|
|
1029
1119
|
### Return type
|
|
1030
1120
|
|
|
1031
|
-
[**
|
|
1121
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1032
1122
|
|
|
1033
1123
|
### HTTP request headers
|
|
1034
1124
|
|
|
@@ -1041,12 +1131,18 @@ Name | Type | Description | Notes
|
|
|
1041
1131
|
|
|
1042
1132
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
|
|
1043
1133
|
|
|
1134
|
+
|
|
1135
|
+
|
|
1044
1136
|
Get list of wrapup codes for this conversation participant
|
|
1045
1137
|
|
|
1046
1138
|
|
|
1047
1139
|
|
|
1048
1140
|
Wraps GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1049
1141
|
|
|
1142
|
+
Requires NO permissions:
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1050
1146
|
|
|
1051
1147
|
### Example
|
|
1052
1148
|
~~~ruby
|
|
@@ -1103,12 +1199,18 @@ Name | Type | Description | Notes
|
|
|
1103
1199
|
|
|
1104
1200
|
## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_conversations_callbacks
|
|
1105
1201
|
|
|
1202
|
+
|
|
1203
|
+
|
|
1106
1204
|
Get active callback conversations for the logged in user
|
|
1107
1205
|
|
|
1108
1206
|
|
|
1109
1207
|
|
|
1110
1208
|
Wraps GET /api/v2/conversations/callbacks
|
|
1111
1209
|
|
|
1210
|
+
Requires NO permissions:
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1112
1214
|
|
|
1113
1215
|
### Example
|
|
1114
1216
|
~~~ruby
|
|
@@ -1156,12 +1258,18 @@ This endpoint does not need any parameter.
|
|
|
1156
1258
|
|
|
1157
1259
|
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls
|
|
1158
1260
|
|
|
1261
|
+
|
|
1262
|
+
|
|
1159
1263
|
Get active call conversations for the logged in user
|
|
1160
1264
|
|
|
1161
1265
|
|
|
1162
1266
|
|
|
1163
1267
|
Wraps GET /api/v2/conversations/calls
|
|
1164
1268
|
|
|
1269
|
+
Requires NO permissions:
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1165
1273
|
|
|
1166
1274
|
### Example
|
|
1167
1275
|
~~~ruby
|
|
@@ -1209,12 +1317,18 @@ This endpoint does not need any parameter.
|
|
|
1209
1317
|
|
|
1210
1318
|
## -[**CallHistoryConversationEntityListing**](CallHistoryConversationEntityListing.html) get_conversations_calls_history(opts)
|
|
1211
1319
|
|
|
1320
|
+
|
|
1321
|
+
|
|
1212
1322
|
Get call history
|
|
1213
1323
|
|
|
1214
1324
|
|
|
1215
1325
|
|
|
1216
1326
|
Wraps GET /api/v2/conversations/calls/history
|
|
1217
1327
|
|
|
1328
|
+
Requires NO permissions:
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1218
1332
|
|
|
1219
1333
|
### Example
|
|
1220
1334
|
~~~ruby
|
|
@@ -1275,12 +1389,18 @@ Name | Type | Description | Notes
|
|
|
1275
1389
|
|
|
1276
1390
|
## -[**MaxParticipants**](MaxParticipants.html) get_conversations_calls_maximumconferenceparties
|
|
1277
1391
|
|
|
1392
|
+
|
|
1393
|
+
|
|
1278
1394
|
Get the maximum number of participants that this user can have on a conference
|
|
1279
1395
|
|
|
1280
1396
|
|
|
1281
1397
|
|
|
1282
1398
|
Wraps GET /api/v2/conversations/calls/maximumconferenceparties
|
|
1283
1399
|
|
|
1400
|
+
Requires NO permissions:
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1284
1404
|
|
|
1285
1405
|
### Example
|
|
1286
1406
|
~~~ruby
|
|
@@ -1328,12 +1448,18 @@ This endpoint does not need any parameter.
|
|
|
1328
1448
|
|
|
1329
1449
|
## -[**ChatConversation**](ChatConversation.html) get_conversations_chat(conversation_id)
|
|
1330
1450
|
|
|
1451
|
+
|
|
1452
|
+
|
|
1331
1453
|
Get chat conversation
|
|
1332
1454
|
|
|
1333
1455
|
|
|
1334
1456
|
|
|
1335
1457
|
Wraps GET /api/v2/conversations/chats/{conversationId}
|
|
1336
1458
|
|
|
1459
|
+
Requires NO permissions:
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
|
|
1337
1463
|
|
|
1338
1464
|
### Example
|
|
1339
1465
|
~~~ruby
|
|
@@ -1385,7 +1511,9 @@ Name | Type | Description | Notes
|
|
|
1385
1511
|
|
|
1386
1512
|
<a name="get_conversations_chat_participant_wrapup"></a>
|
|
1387
1513
|
|
|
1388
|
-
## -[**
|
|
1514
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_chat_participant_wrapup(conversation_id, participant_id, opts)
|
|
1515
|
+
|
|
1516
|
+
|
|
1389
1517
|
|
|
1390
1518
|
Get the wrap-up for this conversation participant.
|
|
1391
1519
|
|
|
@@ -1393,6 +1521,10 @@ Get the wrap-up for this conversation participant.
|
|
|
1393
1521
|
|
|
1394
1522
|
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup
|
|
1395
1523
|
|
|
1524
|
+
Requires NO permissions:
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1396
1528
|
|
|
1397
1529
|
### Example
|
|
1398
1530
|
~~~ruby
|
|
@@ -1440,7 +1572,7 @@ Name | Type | Description | Notes
|
|
|
1440
1572
|
|
|
1441
1573
|
### Return type
|
|
1442
1574
|
|
|
1443
|
-
[**
|
|
1575
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1444
1576
|
|
|
1445
1577
|
### HTTP request headers
|
|
1446
1578
|
|
|
@@ -1453,12 +1585,18 @@ Name | Type | Description | Notes
|
|
|
1453
1585
|
|
|
1454
1586
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id)
|
|
1455
1587
|
|
|
1588
|
+
|
|
1589
|
+
|
|
1456
1590
|
Get list of wrapup codes for this conversation participant
|
|
1457
1591
|
|
|
1458
1592
|
|
|
1459
1593
|
|
|
1460
1594
|
Wraps GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1461
1595
|
|
|
1596
|
+
Requires NO permissions:
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1462
1600
|
|
|
1463
1601
|
### Example
|
|
1464
1602
|
~~~ruby
|
|
@@ -1515,12 +1653,18 @@ Name | Type | Description | Notes
|
|
|
1515
1653
|
|
|
1516
1654
|
## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_conversations_chats
|
|
1517
1655
|
|
|
1656
|
+
|
|
1657
|
+
|
|
1518
1658
|
Get active chat conversations for the logged in user
|
|
1519
1659
|
|
|
1520
1660
|
|
|
1521
1661
|
|
|
1522
1662
|
Wraps GET /api/v2/conversations/chats
|
|
1523
1663
|
|
|
1664
|
+
Requires NO permissions:
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1524
1668
|
|
|
1525
1669
|
### Example
|
|
1526
1670
|
~~~ruby
|
|
@@ -1568,12 +1712,18 @@ This endpoint does not need any parameter.
|
|
|
1568
1712
|
|
|
1569
1713
|
## -[**CobrowseConversation**](CobrowseConversation.html) get_conversations_cobrowsesession(conversation_id)
|
|
1570
1714
|
|
|
1715
|
+
|
|
1716
|
+
|
|
1571
1717
|
Get cobrowse conversation
|
|
1572
1718
|
|
|
1573
1719
|
|
|
1574
1720
|
|
|
1575
1721
|
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
1576
1722
|
|
|
1723
|
+
Requires NO permissions:
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1577
1727
|
|
|
1578
1728
|
### Example
|
|
1579
1729
|
~~~ruby
|
|
@@ -1625,7 +1775,9 @@ Name | Type | Description | Notes
|
|
|
1625
1775
|
|
|
1626
1776
|
<a name="get_conversations_cobrowsesession_participant_wrapup"></a>
|
|
1627
1777
|
|
|
1628
|
-
## -[**
|
|
1778
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_cobrowsesession_participant_wrapup(conversation_id, participant_id, opts)
|
|
1779
|
+
|
|
1780
|
+
|
|
1629
1781
|
|
|
1630
1782
|
Get the wrap-up for this conversation participant.
|
|
1631
1783
|
|
|
@@ -1633,6 +1785,10 @@ Get the wrap-up for this conversation participant.
|
|
|
1633
1785
|
|
|
1634
1786
|
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapup
|
|
1635
1787
|
|
|
1788
|
+
Requires NO permissions:
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1636
1792
|
|
|
1637
1793
|
### Example
|
|
1638
1794
|
~~~ruby
|
|
@@ -1680,7 +1836,7 @@ Name | Type | Description | Notes
|
|
|
1680
1836
|
|
|
1681
1837
|
### Return type
|
|
1682
1838
|
|
|
1683
|
-
[**
|
|
1839
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
1684
1840
|
|
|
1685
1841
|
### HTTP request headers
|
|
1686
1842
|
|
|
@@ -1693,12 +1849,18 @@ Name | Type | Description | Notes
|
|
|
1693
1849
|
|
|
1694
1850
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_cobrowsesession_participant_wrapupcodes(conversation_id, participant_id)
|
|
1695
1851
|
|
|
1852
|
+
|
|
1853
|
+
|
|
1696
1854
|
Get list of wrapup codes for this conversation participant
|
|
1697
1855
|
|
|
1698
1856
|
|
|
1699
1857
|
|
|
1700
1858
|
Wraps GET /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/wrapupcodes
|
|
1701
1859
|
|
|
1860
|
+
Requires NO permissions:
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
|
|
1702
1864
|
|
|
1703
1865
|
### Example
|
|
1704
1866
|
~~~ruby
|
|
@@ -1755,12 +1917,18 @@ Name | Type | Description | Notes
|
|
|
1755
1917
|
|
|
1756
1918
|
## -[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_conversations_cobrowsesessions
|
|
1757
1919
|
|
|
1920
|
+
|
|
1921
|
+
|
|
1758
1922
|
Get active cobrowse conversations for the logged in user
|
|
1759
1923
|
|
|
1760
1924
|
|
|
1761
1925
|
|
|
1762
1926
|
Wraps GET /api/v2/conversations/cobrowsesessions
|
|
1763
1927
|
|
|
1928
|
+
Requires NO permissions:
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
|
|
1764
1932
|
|
|
1765
1933
|
### Example
|
|
1766
1934
|
~~~ruby
|
|
@@ -1808,12 +1976,18 @@ This endpoint does not need any parameter.
|
|
|
1808
1976
|
|
|
1809
1977
|
## -[**EmailConversation**](EmailConversation.html) get_conversations_email(conversation_id)
|
|
1810
1978
|
|
|
1979
|
+
|
|
1980
|
+
|
|
1811
1981
|
Get email conversation
|
|
1812
1982
|
|
|
1813
1983
|
|
|
1814
1984
|
|
|
1815
1985
|
Wraps GET /api/v2/conversations/emails/{conversationId}
|
|
1816
1986
|
|
|
1987
|
+
Requires NO permissions:
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1817
1991
|
|
|
1818
1992
|
### Example
|
|
1819
1993
|
~~~ruby
|
|
@@ -1867,12 +2041,18 @@ Name | Type | Description | Notes
|
|
|
1867
2041
|
|
|
1868
2042
|
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_message(conversation_id, message_id)
|
|
1869
2043
|
|
|
2044
|
+
|
|
2045
|
+
|
|
1870
2046
|
Get conversation message
|
|
1871
2047
|
|
|
1872
2048
|
|
|
1873
2049
|
|
|
1874
2050
|
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/{messageId}
|
|
1875
2051
|
|
|
2052
|
+
Requires NO permissions:
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
1876
2056
|
|
|
1877
2057
|
### Example
|
|
1878
2058
|
~~~ruby
|
|
@@ -1929,12 +2109,18 @@ Name | Type | Description | Notes
|
|
|
1929
2109
|
|
|
1930
2110
|
## -[**EmailMessageListing**](EmailMessageListing.html) get_conversations_email_messages(conversation_id)
|
|
1931
2111
|
|
|
2112
|
+
|
|
2113
|
+
|
|
1932
2114
|
Get conversation messages
|
|
1933
2115
|
|
|
1934
2116
|
|
|
1935
2117
|
|
|
1936
2118
|
Wraps GET /api/v2/conversations/emails/{conversationId}/messages
|
|
1937
2119
|
|
|
2120
|
+
Requires NO permissions:
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
1938
2124
|
|
|
1939
2125
|
### Example
|
|
1940
2126
|
~~~ruby
|
|
@@ -1988,12 +2174,18 @@ Name | Type | Description | Notes
|
|
|
1988
2174
|
|
|
1989
2175
|
## -[**EmailMessage**](EmailMessage.html) get_conversations_email_messages_draft(conversation_id)
|
|
1990
2176
|
|
|
2177
|
+
|
|
2178
|
+
|
|
1991
2179
|
Get conversation draft reply
|
|
1992
2180
|
|
|
1993
2181
|
|
|
1994
2182
|
|
|
1995
2183
|
Wraps GET /api/v2/conversations/emails/{conversationId}/messages/draft
|
|
1996
2184
|
|
|
2185
|
+
Requires NO permissions:
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
1997
2189
|
|
|
1998
2190
|
### Example
|
|
1999
2191
|
~~~ruby
|
|
@@ -2045,7 +2237,9 @@ Name | Type | Description | Notes
|
|
|
2045
2237
|
|
|
2046
2238
|
<a name="get_conversations_email_participant_wrapup"></a>
|
|
2047
2239
|
|
|
2048
|
-
## -[**
|
|
2240
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_email_participant_wrapup(conversation_id, participant_id, opts)
|
|
2241
|
+
|
|
2242
|
+
|
|
2049
2243
|
|
|
2050
2244
|
Get the wrap-up for this conversation participant.
|
|
2051
2245
|
|
|
@@ -2053,6 +2247,10 @@ Get the wrap-up for this conversation participant.
|
|
|
2053
2247
|
|
|
2054
2248
|
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup
|
|
2055
2249
|
|
|
2250
|
+
Requires NO permissions:
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
|
|
2056
2254
|
|
|
2057
2255
|
### Example
|
|
2058
2256
|
~~~ruby
|
|
@@ -2100,7 +2298,7 @@ Name | Type | Description | Notes
|
|
|
2100
2298
|
|
|
2101
2299
|
### Return type
|
|
2102
2300
|
|
|
2103
|
-
[**
|
|
2301
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
2104
2302
|
|
|
2105
2303
|
### HTTP request headers
|
|
2106
2304
|
|
|
@@ -2113,12 +2311,18 @@ Name | Type | Description | Notes
|
|
|
2113
2311
|
|
|
2114
2312
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_email_participant_wrapupcodes(conversation_id, participant_id)
|
|
2115
2313
|
|
|
2314
|
+
|
|
2315
|
+
|
|
2116
2316
|
Get list of wrapup codes for this conversation participant
|
|
2117
2317
|
|
|
2118
2318
|
|
|
2119
2319
|
|
|
2120
2320
|
Wraps GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes
|
|
2121
2321
|
|
|
2322
|
+
Requires NO permissions:
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2122
2326
|
|
|
2123
2327
|
### Example
|
|
2124
2328
|
~~~ruby
|
|
@@ -2175,12 +2379,18 @@ Name | Type | Description | Notes
|
|
|
2175
2379
|
|
|
2176
2380
|
## -[**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_conversations_emails
|
|
2177
2381
|
|
|
2382
|
+
|
|
2383
|
+
|
|
2178
2384
|
Get active email conversations for the logged in user
|
|
2179
2385
|
|
|
2180
2386
|
|
|
2181
2387
|
|
|
2182
2388
|
Wraps GET /api/v2/conversations/emails
|
|
2183
2389
|
|
|
2390
|
+
Requires NO permissions:
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2184
2394
|
|
|
2185
2395
|
### Example
|
|
2186
2396
|
~~~ruby
|
|
@@ -2228,12 +2438,18 @@ This endpoint does not need any parameter.
|
|
|
2228
2438
|
|
|
2229
2439
|
## -[**MessageConversation**](MessageConversation.html) get_conversations_message(conversation_id)
|
|
2230
2440
|
|
|
2441
|
+
|
|
2442
|
+
|
|
2231
2443
|
Get message conversation
|
|
2232
2444
|
|
|
2233
2445
|
|
|
2234
2446
|
|
|
2235
2447
|
Wraps GET /api/v2/conversations/messages/{conversationId}
|
|
2236
2448
|
|
|
2449
|
+
Requires NO permissions:
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2237
2453
|
|
|
2238
2454
|
### Example
|
|
2239
2455
|
~~~ruby
|
|
@@ -2287,12 +2503,18 @@ Name | Type | Description | Notes
|
|
|
2287
2503
|
|
|
2288
2504
|
## -[**MessageData**](MessageData.html) get_conversations_message_message(conversation_id, message_id)
|
|
2289
2505
|
|
|
2506
|
+
|
|
2507
|
+
|
|
2290
2508
|
Get message
|
|
2291
2509
|
|
|
2292
2510
|
|
|
2293
2511
|
|
|
2294
2512
|
Wraps GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
|
|
2295
2513
|
|
|
2514
|
+
Requires ANY permissions:
|
|
2515
|
+
|
|
2516
|
+
* conversation:message:view
|
|
2517
|
+
|
|
2296
2518
|
|
|
2297
2519
|
### Example
|
|
2298
2520
|
~~~ruby
|
|
@@ -2347,7 +2569,9 @@ Name | Type | Description | Notes
|
|
|
2347
2569
|
|
|
2348
2570
|
<a name="get_conversations_message_participant_wrapup"></a>
|
|
2349
2571
|
|
|
2350
|
-
## -[**
|
|
2572
|
+
## -[**AssignedWrapupCode**](AssignedWrapupCode.html) get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
|
2573
|
+
|
|
2574
|
+
|
|
2351
2575
|
|
|
2352
2576
|
Get the wrap-up for this conversation participant.
|
|
2353
2577
|
|
|
@@ -2355,6 +2579,10 @@ Get the wrap-up for this conversation participant.
|
|
|
2355
2579
|
|
|
2356
2580
|
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup
|
|
2357
2581
|
|
|
2582
|
+
Requires NO permissions:
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2358
2586
|
|
|
2359
2587
|
### Example
|
|
2360
2588
|
~~~ruby
|
|
@@ -2402,7 +2630,7 @@ Name | Type | Description | Notes
|
|
|
2402
2630
|
|
|
2403
2631
|
### Return type
|
|
2404
2632
|
|
|
2405
|
-
[**
|
|
2633
|
+
[**AssignedWrapupCode**](AssignedWrapupCode.html)
|
|
2406
2634
|
|
|
2407
2635
|
### HTTP request headers
|
|
2408
2636
|
|
|
@@ -2415,12 +2643,18 @@ Name | Type | Description | Notes
|
|
|
2415
2643
|
|
|
2416
2644
|
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
|
2417
2645
|
|
|
2646
|
+
|
|
2647
|
+
|
|
2418
2648
|
Get list of wrapup codes for this conversation participant
|
|
2419
2649
|
|
|
2420
2650
|
|
|
2421
2651
|
|
|
2422
2652
|
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes
|
|
2423
2653
|
|
|
2654
|
+
Requires NO permissions:
|
|
2655
|
+
|
|
2656
|
+
|
|
2657
|
+
|
|
2424
2658
|
|
|
2425
2659
|
### Example
|
|
2426
2660
|
~~~ruby
|
|
@@ -2477,12 +2711,18 @@ Name | Type | Description | Notes
|
|
|
2477
2711
|
|
|
2478
2712
|
## -[**MessageConversationEntityListing**](MessageConversationEntityListing.html) get_conversations_messages
|
|
2479
2713
|
|
|
2714
|
+
|
|
2715
|
+
|
|
2480
2716
|
Get active message conversations for the logged in user
|
|
2481
2717
|
|
|
2482
2718
|
|
|
2483
2719
|
|
|
2484
2720
|
Wraps GET /api/v2/conversations/messages
|
|
2485
2721
|
|
|
2722
|
+
Requires NO permissions:
|
|
2723
|
+
|
|
2724
|
+
|
|
2725
|
+
|
|
2486
2726
|
|
|
2487
2727
|
### Example
|
|
2488
2728
|
~~~ruby
|
|
@@ -2530,12 +2770,18 @@ This endpoint does not need any parameter.
|
|
|
2530
2770
|
|
|
2531
2771
|
## - patch_conversation_participant(conversation_id, participant_id, body)
|
|
2532
2772
|
|
|
2773
|
+
|
|
2774
|
+
|
|
2533
2775
|
Update a participant.
|
|
2534
2776
|
|
|
2535
2777
|
Update conversation participant.
|
|
2536
2778
|
|
|
2537
2779
|
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}
|
|
2538
2780
|
|
|
2781
|
+
Requires NO permissions:
|
|
2782
|
+
|
|
2783
|
+
|
|
2784
|
+
|
|
2539
2785
|
|
|
2540
2786
|
### Example
|
|
2541
2787
|
~~~ruby
|
|
@@ -2594,12 +2840,18 @@ nil (empty response body)
|
|
|
2594
2840
|
|
|
2595
2841
|
## - patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
|
2596
2842
|
|
|
2843
|
+
|
|
2844
|
+
|
|
2597
2845
|
Update the attributes on a conversation participant.
|
|
2598
2846
|
|
|
2599
2847
|
|
|
2600
2848
|
|
|
2601
2849
|
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes
|
|
2602
2850
|
|
|
2851
|
+
Requires NO permissions:
|
|
2852
|
+
|
|
2853
|
+
|
|
2854
|
+
|
|
2603
2855
|
|
|
2604
2856
|
### Example
|
|
2605
2857
|
~~~ruby
|
|
@@ -2658,12 +2910,18 @@ nil (empty response body)
|
|
|
2658
2910
|
|
|
2659
2911
|
## -[**Conversation**](Conversation.html) patch_conversations_call(conversation_id, body)
|
|
2660
2912
|
|
|
2913
|
+
|
|
2914
|
+
|
|
2661
2915
|
Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2662
2916
|
|
|
2663
2917
|
|
|
2664
2918
|
|
|
2665
2919
|
Wraps PATCH /api/v2/conversations/calls/{conversationId}
|
|
2666
2920
|
|
|
2921
|
+
Requires ANY permissions:
|
|
2922
|
+
|
|
2923
|
+
* conversation:communication:disconnect
|
|
2924
|
+
|
|
2667
2925
|
|
|
2668
2926
|
### Example
|
|
2669
2927
|
~~~ruby
|
|
@@ -2720,12 +2978,18 @@ Name | Type | Description | Notes
|
|
|
2720
2978
|
|
|
2721
2979
|
## - patch_conversations_call_participant(conversation_id, participant_id, body)
|
|
2722
2980
|
|
|
2981
|
+
|
|
2982
|
+
|
|
2723
2983
|
Update conversation participant
|
|
2724
2984
|
|
|
2725
2985
|
|
|
2726
2986
|
|
|
2727
2987
|
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}
|
|
2728
2988
|
|
|
2989
|
+
Requires NO permissions:
|
|
2990
|
+
|
|
2991
|
+
|
|
2992
|
+
|
|
2729
2993
|
|
|
2730
2994
|
### Example
|
|
2731
2995
|
~~~ruby
|
|
@@ -2784,12 +3048,18 @@ nil (empty response body)
|
|
|
2784
3048
|
|
|
2785
3049
|
## - patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
|
2786
3050
|
|
|
3051
|
+
|
|
3052
|
+
|
|
2787
3053
|
Update the attributes on a conversation participant.
|
|
2788
3054
|
|
|
2789
3055
|
|
|
2790
3056
|
|
|
2791
3057
|
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes
|
|
2792
3058
|
|
|
3059
|
+
Requires NO permissions:
|
|
3060
|
+
|
|
3061
|
+
|
|
3062
|
+
|
|
2793
3063
|
|
|
2794
3064
|
### Example
|
|
2795
3065
|
~~~ruby
|
|
@@ -2848,12 +3118,18 @@ nil (empty response body)
|
|
|
2848
3118
|
|
|
2849
3119
|
## -[**Empty**](Empty.html) patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2850
3120
|
|
|
3121
|
+
|
|
3122
|
+
|
|
2851
3123
|
Update conversation participant's communication by disconnecting it.
|
|
2852
3124
|
|
|
2853
3125
|
|
|
2854
3126
|
|
|
2855
3127
|
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2856
3128
|
|
|
3129
|
+
Requires NO permissions:
|
|
3130
|
+
|
|
3131
|
+
|
|
3132
|
+
|
|
2857
3133
|
|
|
2858
3134
|
### Example
|
|
2859
3135
|
~~~ruby
|
|
@@ -2916,12 +3192,18 @@ Name | Type | Description | Notes
|
|
|
2916
3192
|
|
|
2917
3193
|
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
2918
3194
|
|
|
3195
|
+
|
|
3196
|
+
|
|
2919
3197
|
Change who can speak
|
|
2920
3198
|
|
|
2921
3199
|
|
|
2922
3200
|
|
|
2923
3201
|
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
2924
3202
|
|
|
3203
|
+
Requires NO permissions:
|
|
3204
|
+
|
|
3205
|
+
|
|
3206
|
+
|
|
2925
3207
|
|
|
2926
3208
|
### Example
|
|
2927
3209
|
~~~ruby
|
|
@@ -2981,12 +3263,18 @@ Name | Type | Description | Notes
|
|
|
2981
3263
|
|
|
2982
3264
|
## -[**Conversation**](Conversation.html) patch_conversations_callback(conversation_id, body)
|
|
2983
3265
|
|
|
3266
|
+
|
|
3267
|
+
|
|
2984
3268
|
Update a conversation by disconnecting all of the participants
|
|
2985
3269
|
|
|
2986
3270
|
|
|
2987
3271
|
|
|
2988
3272
|
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}
|
|
2989
3273
|
|
|
3274
|
+
Requires ANY permissions:
|
|
3275
|
+
|
|
3276
|
+
* conversation:communication:disconnect
|
|
3277
|
+
|
|
2990
3278
|
|
|
2991
3279
|
### Example
|
|
2992
3280
|
~~~ruby
|
|
@@ -3043,12 +3331,18 @@ Name | Type | Description | Notes
|
|
|
3043
3331
|
|
|
3044
3332
|
## - patch_conversations_callback_participant(conversation_id, participant_id, body)
|
|
3045
3333
|
|
|
3334
|
+
|
|
3335
|
+
|
|
3046
3336
|
Update conversation participant
|
|
3047
3337
|
|
|
3048
3338
|
|
|
3049
3339
|
|
|
3050
3340
|
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}
|
|
3051
3341
|
|
|
3342
|
+
Requires NO permissions:
|
|
3343
|
+
|
|
3344
|
+
|
|
3345
|
+
|
|
3052
3346
|
|
|
3053
3347
|
### Example
|
|
3054
3348
|
~~~ruby
|
|
@@ -3107,12 +3401,18 @@ nil (empty response body)
|
|
|
3107
3401
|
|
|
3108
3402
|
## - patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
|
3109
3403
|
|
|
3404
|
+
|
|
3405
|
+
|
|
3110
3406
|
Update the attributes on a conversation participant.
|
|
3111
3407
|
|
|
3112
3408
|
|
|
3113
3409
|
|
|
3114
3410
|
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes
|
|
3115
3411
|
|
|
3412
|
+
Requires NO permissions:
|
|
3413
|
+
|
|
3414
|
+
|
|
3415
|
+
|
|
3116
3416
|
|
|
3117
3417
|
### Example
|
|
3118
3418
|
~~~ruby
|
|
@@ -3171,12 +3471,18 @@ nil (empty response body)
|
|
|
3171
3471
|
|
|
3172
3472
|
## -[**Empty**](Empty.html) patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3173
3473
|
|
|
3474
|
+
|
|
3475
|
+
|
|
3174
3476
|
Update conversation participant's communication by disconnecting it.
|
|
3175
3477
|
|
|
3176
3478
|
|
|
3177
3479
|
|
|
3178
3480
|
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3179
3481
|
|
|
3482
|
+
Requires NO permissions:
|
|
3483
|
+
|
|
3484
|
+
|
|
3485
|
+
|
|
3180
3486
|
|
|
3181
3487
|
### Example
|
|
3182
3488
|
~~~ruby
|
|
@@ -3239,12 +3545,18 @@ Name | Type | Description | Notes
|
|
|
3239
3545
|
|
|
3240
3546
|
## -[**Conversation**](Conversation.html) patch_conversations_chat(conversation_id, body)
|
|
3241
3547
|
|
|
3548
|
+
|
|
3549
|
+
|
|
3242
3550
|
Update a conversation by disconnecting all of the participants
|
|
3243
3551
|
|
|
3244
3552
|
|
|
3245
3553
|
|
|
3246
3554
|
Wraps PATCH /api/v2/conversations/chats/{conversationId}
|
|
3247
3555
|
|
|
3556
|
+
Requires ANY permissions:
|
|
3557
|
+
|
|
3558
|
+
* conversation:communication:disconnect
|
|
3559
|
+
|
|
3248
3560
|
|
|
3249
3561
|
### Example
|
|
3250
3562
|
~~~ruby
|
|
@@ -3301,12 +3613,18 @@ Name | Type | Description | Notes
|
|
|
3301
3613
|
|
|
3302
3614
|
## - patch_conversations_chat_participant(conversation_id, participant_id, body)
|
|
3303
3615
|
|
|
3616
|
+
|
|
3617
|
+
|
|
3304
3618
|
Update conversation participant
|
|
3305
3619
|
|
|
3306
3620
|
|
|
3307
3621
|
|
|
3308
3622
|
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}
|
|
3309
3623
|
|
|
3624
|
+
Requires NO permissions:
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
|
|
3310
3628
|
|
|
3311
3629
|
### Example
|
|
3312
3630
|
~~~ruby
|
|
@@ -3365,12 +3683,18 @@ nil (empty response body)
|
|
|
3365
3683
|
|
|
3366
3684
|
## - patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
|
3367
3685
|
|
|
3686
|
+
|
|
3687
|
+
|
|
3368
3688
|
Update the attributes on a conversation participant.
|
|
3369
3689
|
|
|
3370
3690
|
|
|
3371
3691
|
|
|
3372
3692
|
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes
|
|
3373
3693
|
|
|
3694
|
+
Requires NO permissions:
|
|
3695
|
+
|
|
3696
|
+
|
|
3697
|
+
|
|
3374
3698
|
|
|
3375
3699
|
### Example
|
|
3376
3700
|
~~~ruby
|
|
@@ -3429,12 +3753,18 @@ nil (empty response body)
|
|
|
3429
3753
|
|
|
3430
3754
|
## -[**Empty**](Empty.html) patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3431
3755
|
|
|
3756
|
+
|
|
3757
|
+
|
|
3432
3758
|
Update conversation participant's communication by disconnecting it.
|
|
3433
3759
|
|
|
3434
3760
|
|
|
3435
3761
|
|
|
3436
3762
|
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3437
3763
|
|
|
3764
|
+
Requires NO permissions:
|
|
3765
|
+
|
|
3766
|
+
|
|
3767
|
+
|
|
3438
3768
|
|
|
3439
3769
|
### Example
|
|
3440
3770
|
~~~ruby
|
|
@@ -3497,12 +3827,18 @@ Name | Type | Description | Notes
|
|
|
3497
3827
|
|
|
3498
3828
|
## -[**Conversation**](Conversation.html) patch_conversations_cobrowsesession(conversation_id, body)
|
|
3499
3829
|
|
|
3830
|
+
|
|
3831
|
+
|
|
3500
3832
|
Update a conversation by disconnecting all of the participants
|
|
3501
3833
|
|
|
3502
3834
|
|
|
3503
3835
|
|
|
3504
3836
|
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
3505
3837
|
|
|
3838
|
+
Requires ANY permissions:
|
|
3839
|
+
|
|
3840
|
+
* conversation:communication:disconnect
|
|
3841
|
+
|
|
3506
3842
|
|
|
3507
3843
|
### Example
|
|
3508
3844
|
~~~ruby
|
|
@@ -3559,12 +3895,18 @@ Name | Type | Description | Notes
|
|
|
3559
3895
|
|
|
3560
3896
|
## - patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
|
3561
3897
|
|
|
3898
|
+
|
|
3899
|
+
|
|
3562
3900
|
Update conversation participant
|
|
3563
3901
|
|
|
3564
3902
|
|
|
3565
3903
|
|
|
3566
3904
|
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}
|
|
3567
3905
|
|
|
3906
|
+
Requires NO permissions:
|
|
3907
|
+
|
|
3908
|
+
|
|
3909
|
+
|
|
3568
3910
|
|
|
3569
3911
|
### Example
|
|
3570
3912
|
~~~ruby
|
|
@@ -3624,12 +3966,18 @@ nil (empty response body)
|
|
|
3624
3966
|
|
|
3625
3967
|
## - patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
|
3626
3968
|
|
|
3969
|
+
|
|
3970
|
+
|
|
3627
3971
|
Update the attributes on a conversation participant.
|
|
3628
3972
|
|
|
3629
3973
|
|
|
3630
3974
|
|
|
3631
3975
|
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes
|
|
3632
3976
|
|
|
3977
|
+
Requires NO permissions:
|
|
3978
|
+
|
|
3979
|
+
|
|
3980
|
+
|
|
3633
3981
|
|
|
3634
3982
|
### Example
|
|
3635
3983
|
~~~ruby
|
|
@@ -3689,12 +4037,18 @@ nil (empty response body)
|
|
|
3689
4037
|
|
|
3690
4038
|
## -[**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3691
4039
|
|
|
4040
|
+
|
|
4041
|
+
|
|
3692
4042
|
Update conversation participant's communication by disconnecting it.
|
|
3693
4043
|
|
|
3694
4044
|
|
|
3695
4045
|
|
|
3696
4046
|
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3697
4047
|
|
|
4048
|
+
Requires NO permissions:
|
|
4049
|
+
|
|
4050
|
+
|
|
4051
|
+
|
|
3698
4052
|
|
|
3699
4053
|
### Example
|
|
3700
4054
|
~~~ruby
|
|
@@ -3757,12 +4111,18 @@ Name | Type | Description | Notes
|
|
|
3757
4111
|
|
|
3758
4112
|
## -[**Conversation**](Conversation.html) patch_conversations_email(conversation_id, body)
|
|
3759
4113
|
|
|
4114
|
+
|
|
4115
|
+
|
|
3760
4116
|
Update a conversation by disconnecting all of the participants
|
|
3761
4117
|
|
|
3762
4118
|
|
|
3763
4119
|
|
|
3764
4120
|
Wraps PATCH /api/v2/conversations/emails/{conversationId}
|
|
3765
4121
|
|
|
4122
|
+
Requires ANY permissions:
|
|
4123
|
+
|
|
4124
|
+
* conversation:communication:disconnect
|
|
4125
|
+
|
|
3766
4126
|
|
|
3767
4127
|
### Example
|
|
3768
4128
|
~~~ruby
|
|
@@ -3819,12 +4179,18 @@ Name | Type | Description | Notes
|
|
|
3819
4179
|
|
|
3820
4180
|
## - patch_conversations_email_participant(conversation_id, participant_id, body)
|
|
3821
4181
|
|
|
4182
|
+
|
|
4183
|
+
|
|
3822
4184
|
Update conversation participant
|
|
3823
4185
|
|
|
3824
4186
|
|
|
3825
4187
|
|
|
3826
4188
|
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}
|
|
3827
4189
|
|
|
4190
|
+
Requires NO permissions:
|
|
4191
|
+
|
|
4192
|
+
|
|
4193
|
+
|
|
3828
4194
|
|
|
3829
4195
|
### Example
|
|
3830
4196
|
~~~ruby
|
|
@@ -3883,12 +4249,18 @@ nil (empty response body)
|
|
|
3883
4249
|
|
|
3884
4250
|
## - patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
|
3885
4251
|
|
|
4252
|
+
|
|
4253
|
+
|
|
3886
4254
|
Update the attributes on a conversation participant.
|
|
3887
4255
|
|
|
3888
4256
|
|
|
3889
4257
|
|
|
3890
4258
|
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes
|
|
3891
4259
|
|
|
4260
|
+
Requires NO permissions:
|
|
4261
|
+
|
|
4262
|
+
|
|
4263
|
+
|
|
3892
4264
|
|
|
3893
4265
|
### Example
|
|
3894
4266
|
~~~ruby
|
|
@@ -3947,12 +4319,18 @@ nil (empty response body)
|
|
|
3947
4319
|
|
|
3948
4320
|
## -[**Empty**](Empty.html) patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3949
4321
|
|
|
4322
|
+
|
|
4323
|
+
|
|
3950
4324
|
Update conversation participant's communication by disconnecting it.
|
|
3951
4325
|
|
|
3952
4326
|
|
|
3953
4327
|
|
|
3954
4328
|
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3955
4329
|
|
|
4330
|
+
Requires NO permissions:
|
|
4331
|
+
|
|
4332
|
+
|
|
4333
|
+
|
|
3956
4334
|
|
|
3957
4335
|
### Example
|
|
3958
4336
|
~~~ruby
|
|
@@ -4015,12 +4393,18 @@ Name | Type | Description | Notes
|
|
|
4015
4393
|
|
|
4016
4394
|
## -[**Conversation**](Conversation.html) patch_conversations_message(conversation_id, body)
|
|
4017
4395
|
|
|
4396
|
+
|
|
4397
|
+
|
|
4018
4398
|
Update a conversation by disconnecting all of the participants
|
|
4019
4399
|
|
|
4020
4400
|
|
|
4021
4401
|
|
|
4022
4402
|
Wraps PATCH /api/v2/conversations/messages/{conversationId}
|
|
4023
4403
|
|
|
4404
|
+
Requires ANY permissions:
|
|
4405
|
+
|
|
4406
|
+
* conversation:communication:disconnect
|
|
4407
|
+
|
|
4024
4408
|
|
|
4025
4409
|
### Example
|
|
4026
4410
|
~~~ruby
|
|
@@ -4077,12 +4461,18 @@ Name | Type | Description | Notes
|
|
|
4077
4461
|
|
|
4078
4462
|
## - patch_conversations_message_participant(conversation_id, participant_id, opts)
|
|
4079
4463
|
|
|
4464
|
+
|
|
4465
|
+
|
|
4080
4466
|
Update conversation participant
|
|
4081
4467
|
|
|
4082
4468
|
|
|
4083
4469
|
|
|
4084
4470
|
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}
|
|
4085
4471
|
|
|
4472
|
+
Requires NO permissions:
|
|
4473
|
+
|
|
4474
|
+
|
|
4475
|
+
|
|
4086
4476
|
|
|
4087
4477
|
### Example
|
|
4088
4478
|
~~~ruby
|
|
@@ -4142,12 +4532,18 @@ nil (empty response body)
|
|
|
4142
4532
|
|
|
4143
4533
|
## - patch_conversations_message_participant_attributes(conversation_id, participant_id, opts)
|
|
4144
4534
|
|
|
4535
|
+
|
|
4536
|
+
|
|
4145
4537
|
Update the attributes on a conversation participant.
|
|
4146
4538
|
|
|
4147
4539
|
|
|
4148
4540
|
|
|
4149
4541
|
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes
|
|
4150
4542
|
|
|
4543
|
+
Requires NO permissions:
|
|
4544
|
+
|
|
4545
|
+
|
|
4546
|
+
|
|
4151
4547
|
|
|
4152
4548
|
### Example
|
|
4153
4549
|
~~~ruby
|
|
@@ -4207,12 +4603,18 @@ nil (empty response body)
|
|
|
4207
4603
|
|
|
4208
4604
|
## -[**Empty**](Empty.html) patch_conversations_message_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
4209
4605
|
|
|
4606
|
+
|
|
4607
|
+
|
|
4210
4608
|
Update conversation participant's communication by disconnecting it.
|
|
4211
4609
|
|
|
4212
4610
|
|
|
4213
4611
|
|
|
4214
4612
|
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
4215
4613
|
|
|
4614
|
+
Requires NO permissions:
|
|
4615
|
+
|
|
4616
|
+
|
|
4617
|
+
|
|
4216
4618
|
|
|
4217
4619
|
### Example
|
|
4218
4620
|
~~~ruby
|
|
@@ -4275,12 +4677,18 @@ Name | Type | Description | Notes
|
|
|
4275
4677
|
|
|
4276
4678
|
## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
|
4277
4679
|
|
|
4680
|
+
|
|
4681
|
+
|
|
4278
4682
|
Index conversation properties
|
|
4279
4683
|
|
|
4280
4684
|
|
|
4281
4685
|
|
|
4282
4686
|
Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
|
|
4283
4687
|
|
|
4688
|
+
Requires ANY permissions:
|
|
4689
|
+
|
|
4690
|
+
* analytics:conversationProperties:index
|
|
4691
|
+
|
|
4284
4692
|
|
|
4285
4693
|
### Example
|
|
4286
4694
|
~~~ruby
|
|
@@ -4337,12 +4745,18 @@ Name | Type | Description | Notes
|
|
|
4337
4745
|
|
|
4338
4746
|
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
|
4339
4747
|
|
|
4748
|
+
|
|
4749
|
+
|
|
4340
4750
|
Query for conversation aggregates
|
|
4341
4751
|
|
|
4342
4752
|
|
|
4343
4753
|
|
|
4344
4754
|
Wraps POST /api/v2/analytics/conversations/aggregates/query
|
|
4345
4755
|
|
|
4756
|
+
Requires ANY permissions:
|
|
4757
|
+
|
|
4758
|
+
* analytics:conversationAggregate:view
|
|
4759
|
+
|
|
4346
4760
|
|
|
4347
4761
|
### Example
|
|
4348
4762
|
~~~ruby
|
|
@@ -4396,12 +4810,18 @@ Name | Type | Description | Notes
|
|
|
4396
4810
|
|
|
4397
4811
|
## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|
|
4398
4812
|
|
|
4813
|
+
|
|
4814
|
+
|
|
4399
4815
|
Query for conversation details
|
|
4400
4816
|
|
|
4401
4817
|
|
|
4402
4818
|
|
|
4403
4819
|
Wraps POST /api/v2/analytics/conversations/details/query
|
|
4404
4820
|
|
|
4821
|
+
Requires ANY permissions:
|
|
4822
|
+
|
|
4823
|
+
* analytics:conversationDetail:view
|
|
4824
|
+
|
|
4405
4825
|
|
|
4406
4826
|
### Example
|
|
4407
4827
|
~~~ruby
|
|
@@ -4455,12 +4875,18 @@ Name | Type | Description | Notes
|
|
|
4455
4875
|
|
|
4456
4876
|
## -String** post_conversation_disconnect(conversation_id)
|
|
4457
4877
|
|
|
4878
|
+
|
|
4879
|
+
|
|
4458
4880
|
Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
4459
4881
|
|
|
4460
4882
|
|
|
4461
4883
|
|
|
4462
4884
|
Wraps POST /api/v2/conversations/{conversationId}/disconnect
|
|
4463
4885
|
|
|
4886
|
+
Requires ANY permissions:
|
|
4887
|
+
|
|
4888
|
+
* conversation:communication:disconnect
|
|
4889
|
+
|
|
4464
4890
|
|
|
4465
4891
|
### Example
|
|
4466
4892
|
~~~ruby
|
|
@@ -4514,12 +4940,18 @@ Name | Type | Description | Notes
|
|
|
4514
4940
|
|
|
4515
4941
|
## - post_conversation_participant_callbacks(conversation_id, participant_id, opts)
|
|
4516
4942
|
|
|
4943
|
+
|
|
4944
|
+
|
|
4517
4945
|
Create a new callback for the specified participant on the conversation.
|
|
4518
4946
|
|
|
4519
4947
|
|
|
4520
4948
|
|
|
4521
4949
|
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks
|
|
4522
4950
|
|
|
4951
|
+
Requires ANY permissions:
|
|
4952
|
+
|
|
4953
|
+
* conversation:callback:create
|
|
4954
|
+
|
|
4523
4955
|
|
|
4524
4956
|
### Example
|
|
4525
4957
|
~~~ruby
|
|
@@ -4579,12 +5011,18 @@ nil (empty response body)
|
|
|
4579
5011
|
|
|
4580
5012
|
## - post_conversation_participant_digits(conversation_id, participant_id, opts)
|
|
4581
5013
|
|
|
5014
|
+
|
|
5015
|
+
|
|
4582
5016
|
Sends DTMF to the participant
|
|
4583
5017
|
|
|
4584
5018
|
|
|
4585
5019
|
|
|
4586
5020
|
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits
|
|
4587
5021
|
|
|
5022
|
+
Requires NO permissions:
|
|
5023
|
+
|
|
5024
|
+
|
|
5025
|
+
|
|
4588
5026
|
|
|
4589
5027
|
### Example
|
|
4590
5028
|
~~~ruby
|
|
@@ -4644,12 +5082,18 @@ nil (empty response body)
|
|
|
4644
5082
|
|
|
4645
5083
|
## - post_conversation_participant_replace(conversation_id, participant_id, body)
|
|
4646
5084
|
|
|
5085
|
+
|
|
5086
|
+
|
|
4647
5087
|
Replace this participant with the specified user and/or address
|
|
4648
5088
|
|
|
4649
5089
|
|
|
4650
5090
|
|
|
4651
5091
|
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace
|
|
4652
5092
|
|
|
5093
|
+
Requires NO permissions:
|
|
5094
|
+
|
|
5095
|
+
|
|
5096
|
+
|
|
4653
5097
|
|
|
4654
5098
|
### Example
|
|
4655
5099
|
~~~ruby
|
|
@@ -4708,12 +5152,18 @@ nil (empty response body)
|
|
|
4708
5152
|
|
|
4709
5153
|
## -[**SecureSession**](SecureSession.html) post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts)
|
|
4710
5154
|
|
|
5155
|
+
|
|
5156
|
+
|
|
4711
5157
|
Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
4712
5158
|
|
|
4713
5159
|
|
|
4714
5160
|
|
|
4715
5161
|
Wraps POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions
|
|
4716
5162
|
|
|
5163
|
+
Requires NO permissions:
|
|
5164
|
+
|
|
5165
|
+
|
|
5166
|
+
|
|
4717
5167
|
|
|
4718
5168
|
### Example
|
|
4719
5169
|
~~~ruby
|
|
@@ -4774,12 +5224,18 @@ Name | Type | Description | Notes
|
|
|
4774
5224
|
|
|
4775
5225
|
## -[**Conversation**](Conversation.html) post_conversations_call(conversation_id, body)
|
|
4776
5226
|
|
|
5227
|
+
|
|
5228
|
+
|
|
4777
5229
|
Place a new call as part of a callback conversation.
|
|
4778
5230
|
|
|
4779
5231
|
|
|
4780
5232
|
|
|
4781
5233
|
Wraps POST /api/v2/conversations/calls/{conversationId}
|
|
4782
5234
|
|
|
5235
|
+
Requires NO permissions:
|
|
5236
|
+
|
|
5237
|
+
|
|
5238
|
+
|
|
4783
5239
|
|
|
4784
5240
|
### Example
|
|
4785
5241
|
~~~ruby
|
|
@@ -4836,12 +5292,18 @@ Name | Type | Description | Notes
|
|
|
4836
5292
|
|
|
4837
5293
|
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) post_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
4838
5294
|
|
|
5295
|
+
|
|
5296
|
+
|
|
4839
5297
|
Initiate and update consult transfer
|
|
4840
5298
|
|
|
4841
5299
|
|
|
4842
5300
|
|
|
4843
5301
|
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
4844
5302
|
|
|
5303
|
+
Requires NO permissions:
|
|
5304
|
+
|
|
5305
|
+
|
|
5306
|
+
|
|
4845
5307
|
|
|
4846
5308
|
### Example
|
|
4847
5309
|
~~~ruby
|
|
@@ -4901,12 +5363,18 @@ Name | Type | Description | Notes
|
|
|
4901
5363
|
|
|
4902
5364
|
## - post_conversations_call_participant_monitor(conversation_id, participant_id)
|
|
4903
5365
|
|
|
5366
|
+
|
|
5367
|
+
|
|
4904
5368
|
Listen in on the conversation from the point of view of a given participant.
|
|
4905
5369
|
|
|
4906
5370
|
|
|
4907
5371
|
|
|
4908
5372
|
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor
|
|
4909
5373
|
|
|
5374
|
+
Requires ANY permissions:
|
|
5375
|
+
|
|
5376
|
+
* conversation:call:monitor
|
|
5377
|
+
|
|
4910
5378
|
|
|
4911
5379
|
### Example
|
|
4912
5380
|
~~~ruby
|
|
@@ -4962,12 +5430,18 @@ nil (empty response body)
|
|
|
4962
5430
|
|
|
4963
5431
|
## - post_conversations_call_participant_replace(conversation_id, participant_id, body)
|
|
4964
5432
|
|
|
5433
|
+
|
|
5434
|
+
|
|
4965
5435
|
Replace this participant with the specified user and/or address
|
|
4966
5436
|
|
|
4967
5437
|
|
|
4968
5438
|
|
|
4969
5439
|
Wraps POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace
|
|
4970
5440
|
|
|
5441
|
+
Requires NO permissions:
|
|
5442
|
+
|
|
5443
|
+
|
|
5444
|
+
|
|
4971
5445
|
|
|
4972
5446
|
### Example
|
|
4973
5447
|
~~~ruby
|
|
@@ -5026,12 +5500,18 @@ nil (empty response body)
|
|
|
5026
5500
|
|
|
5027
5501
|
## -[**Conversation**](Conversation.html) post_conversations_call_participants(conversation_id, body)
|
|
5028
5502
|
|
|
5503
|
+
|
|
5504
|
+
|
|
5029
5505
|
Add participants to a conversation
|
|
5030
5506
|
|
|
5031
5507
|
|
|
5032
5508
|
|
|
5033
5509
|
Wraps POST /api/v2/conversations/calls/{conversationId}/participants
|
|
5034
5510
|
|
|
5511
|
+
Requires NO permissions:
|
|
5512
|
+
|
|
5513
|
+
|
|
5514
|
+
|
|
5035
5515
|
|
|
5036
5516
|
### Example
|
|
5037
5517
|
~~~ruby
|
|
@@ -5088,12 +5568,18 @@ Name | Type | Description | Notes
|
|
|
5088
5568
|
|
|
5089
5569
|
## - post_conversations_callback_participant_replace(conversation_id, participant_id, body)
|
|
5090
5570
|
|
|
5571
|
+
|
|
5572
|
+
|
|
5091
5573
|
Replace this participant with the specified user and/or address
|
|
5092
5574
|
|
|
5093
5575
|
|
|
5094
5576
|
|
|
5095
5577
|
Wraps POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace
|
|
5096
5578
|
|
|
5579
|
+
Requires NO permissions:
|
|
5580
|
+
|
|
5581
|
+
|
|
5582
|
+
|
|
5097
5583
|
|
|
5098
5584
|
### Example
|
|
5099
5585
|
~~~ruby
|
|
@@ -5152,12 +5638,18 @@ nil (empty response body)
|
|
|
5152
5638
|
|
|
5153
5639
|
## -[**CreateCallbackResponse**](CreateCallbackResponse.html) post_conversations_callbacks(body)
|
|
5154
5640
|
|
|
5641
|
+
|
|
5642
|
+
|
|
5155
5643
|
Create a Callback
|
|
5156
5644
|
|
|
5157
5645
|
|
|
5158
5646
|
|
|
5159
5647
|
Wraps POST /api/v2/conversations/callbacks
|
|
5160
5648
|
|
|
5649
|
+
Requires ANY permissions:
|
|
5650
|
+
|
|
5651
|
+
* conversation:callback:create
|
|
5652
|
+
|
|
5161
5653
|
|
|
5162
5654
|
### Example
|
|
5163
5655
|
~~~ruby
|
|
@@ -5211,12 +5703,18 @@ Name | Type | Description | Notes
|
|
|
5211
5703
|
|
|
5212
5704
|
## -[**CreateCallResponse**](CreateCallResponse.html) post_conversations_calls(body)
|
|
5213
5705
|
|
|
5706
|
+
|
|
5707
|
+
|
|
5214
5708
|
Create a call conversation
|
|
5215
5709
|
|
|
5216
5710
|
|
|
5217
5711
|
|
|
5218
5712
|
Wraps POST /api/v2/conversations/calls
|
|
5219
5713
|
|
|
5714
|
+
Requires ANY permissions:
|
|
5715
|
+
|
|
5716
|
+
* conversation:conference:add
|
|
5717
|
+
|
|
5220
5718
|
|
|
5221
5719
|
### Example
|
|
5222
5720
|
~~~ruby
|
|
@@ -5270,12 +5768,18 @@ Name | Type | Description | Notes
|
|
|
5270
5768
|
|
|
5271
5769
|
## - post_conversations_chat_participant_replace(conversation_id, participant_id, body)
|
|
5272
5770
|
|
|
5771
|
+
|
|
5772
|
+
|
|
5273
5773
|
Replace this participant with the specified user and/or address
|
|
5274
5774
|
|
|
5275
5775
|
|
|
5276
5776
|
|
|
5277
5777
|
Wraps POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace
|
|
5278
5778
|
|
|
5779
|
+
Requires NO permissions:
|
|
5780
|
+
|
|
5781
|
+
|
|
5782
|
+
|
|
5279
5783
|
|
|
5280
5784
|
### Example
|
|
5281
5785
|
~~~ruby
|
|
@@ -5334,12 +5838,18 @@ nil (empty response body)
|
|
|
5334
5838
|
|
|
5335
5839
|
## -[**ChatConversation**](ChatConversation.html) post_conversations_chats(body)
|
|
5336
5840
|
|
|
5841
|
+
|
|
5842
|
+
|
|
5337
5843
|
Create a web chat conversation
|
|
5338
5844
|
|
|
5339
5845
|
|
|
5340
5846
|
|
|
5341
5847
|
Wraps POST /api/v2/conversations/chats
|
|
5342
5848
|
|
|
5849
|
+
Requires ANY permissions:
|
|
5850
|
+
|
|
5851
|
+
* conversation:webchat:create
|
|
5852
|
+
|
|
5343
5853
|
|
|
5344
5854
|
### Example
|
|
5345
5855
|
~~~ruby
|
|
@@ -5393,12 +5903,18 @@ Name | Type | Description | Notes
|
|
|
5393
5903
|
|
|
5394
5904
|
## - post_conversations_cobrowsesession_participant_replace(conversation_id, participant_id, opts)
|
|
5395
5905
|
|
|
5906
|
+
|
|
5907
|
+
|
|
5396
5908
|
Replace this participant with the specified user and/or address
|
|
5397
5909
|
|
|
5398
5910
|
|
|
5399
5911
|
|
|
5400
5912
|
Wraps POST /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/replace
|
|
5401
5913
|
|
|
5914
|
+
Requires NO permissions:
|
|
5915
|
+
|
|
5916
|
+
|
|
5917
|
+
|
|
5402
5918
|
|
|
5403
5919
|
### Example
|
|
5404
5920
|
~~~ruby
|
|
@@ -5458,12 +5974,18 @@ nil (empty response body)
|
|
|
5458
5974
|
|
|
5459
5975
|
## -[**EmailConversation**](EmailConversation.html) post_conversations_email_inboundmessages(conversation_id, body)
|
|
5460
5976
|
|
|
5977
|
+
|
|
5978
|
+
|
|
5461
5979
|
Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
|
|
5462
5980
|
|
|
5463
5981
|
|
|
5464
5982
|
|
|
5465
5983
|
Wraps POST /api/v2/conversations/emails/{conversationId}/inboundmessages
|
|
5466
5984
|
|
|
5985
|
+
Requires NO permissions:
|
|
5986
|
+
|
|
5987
|
+
|
|
5988
|
+
|
|
5467
5989
|
|
|
5468
5990
|
### Example
|
|
5469
5991
|
~~~ruby
|
|
@@ -5520,12 +6042,18 @@ Name | Type | Description | Notes
|
|
|
5520
6042
|
|
|
5521
6043
|
## -[**EmailMessage**](EmailMessage.html) post_conversations_email_messages(conversation_id, body)
|
|
5522
6044
|
|
|
6045
|
+
|
|
6046
|
+
|
|
5523
6047
|
Send an email reply
|
|
5524
6048
|
|
|
5525
6049
|
|
|
5526
6050
|
|
|
5527
6051
|
Wraps POST /api/v2/conversations/emails/{conversationId}/messages
|
|
5528
6052
|
|
|
6053
|
+
Requires NO permissions:
|
|
6054
|
+
|
|
6055
|
+
|
|
6056
|
+
|
|
5529
6057
|
|
|
5530
6058
|
### Example
|
|
5531
6059
|
~~~ruby
|
|
@@ -5582,12 +6110,18 @@ Name | Type | Description | Notes
|
|
|
5582
6110
|
|
|
5583
6111
|
## - post_conversations_email_participant_replace(conversation_id, participant_id, body)
|
|
5584
6112
|
|
|
6113
|
+
|
|
6114
|
+
|
|
5585
6115
|
Replace this participant with the specified user and/or address
|
|
5586
6116
|
|
|
5587
6117
|
|
|
5588
6118
|
|
|
5589
6119
|
Wraps POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace
|
|
5590
6120
|
|
|
6121
|
+
Requires NO permissions:
|
|
6122
|
+
|
|
6123
|
+
|
|
6124
|
+
|
|
5591
6125
|
|
|
5592
6126
|
### Example
|
|
5593
6127
|
~~~ruby
|
|
@@ -5646,12 +6180,18 @@ nil (empty response body)
|
|
|
5646
6180
|
|
|
5647
6181
|
## -[**EmailConversation**](EmailConversation.html) post_conversations_emails(body)
|
|
5648
6182
|
|
|
6183
|
+
|
|
6184
|
+
|
|
5649
6185
|
Create an email conversation
|
|
5650
6186
|
|
|
5651
6187
|
If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.
|
|
5652
6188
|
|
|
5653
6189
|
Wraps POST /api/v2/conversations/emails
|
|
5654
6190
|
|
|
6191
|
+
Requires ANY permissions:
|
|
6192
|
+
|
|
6193
|
+
* conversation:email:create
|
|
6194
|
+
|
|
5655
6195
|
|
|
5656
6196
|
### Example
|
|
5657
6197
|
~~~ruby
|
|
@@ -5705,12 +6245,18 @@ Name | Type | Description | Notes
|
|
|
5705
6245
|
|
|
5706
6246
|
## -[**FaxSendResponse**](FaxSendResponse.html) post_conversations_faxes(body)
|
|
5707
6247
|
|
|
6248
|
+
|
|
6249
|
+
|
|
5708
6250
|
Create Fax Conversation
|
|
5709
6251
|
|
|
5710
6252
|
|
|
5711
6253
|
|
|
5712
6254
|
Wraps POST /api/v2/conversations/faxes
|
|
5713
6255
|
|
|
6256
|
+
Requires NO permissions:
|
|
6257
|
+
|
|
6258
|
+
|
|
6259
|
+
|
|
5714
6260
|
|
|
5715
6261
|
### Example
|
|
5716
6262
|
~~~ruby
|
|
@@ -5764,12 +6310,18 @@ Name | Type | Description | Notes
|
|
|
5764
6310
|
|
|
5765
6311
|
## -[**MessageData**](MessageData.html) post_conversations_message_communication_messages(conversation_id, communication_id, body)
|
|
5766
6312
|
|
|
6313
|
+
|
|
6314
|
+
|
|
5767
6315
|
Send message
|
|
5768
6316
|
|
|
5769
6317
|
|
|
5770
6318
|
|
|
5771
6319
|
Wraps POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages
|
|
5772
6320
|
|
|
6321
|
+
Requires ANY permissions:
|
|
6322
|
+
|
|
6323
|
+
* conversation:message:create
|
|
6324
|
+
|
|
5773
6325
|
|
|
5774
6326
|
### Example
|
|
5775
6327
|
~~~ruby
|
|
@@ -5829,12 +6381,18 @@ Name | Type | Description | Notes
|
|
|
5829
6381
|
|
|
5830
6382
|
## -[**TextMessageListing**](TextMessageListing.html) post_conversations_message_messages_bulk(conversation_id, opts)
|
|
5831
6383
|
|
|
6384
|
+
|
|
6385
|
+
|
|
5832
6386
|
Get messages in batch
|
|
5833
6387
|
|
|
5834
6388
|
|
|
5835
6389
|
|
|
5836
6390
|
Wraps POST /api/v2/conversations/messages/{conversationId}/messages/bulk
|
|
5837
6391
|
|
|
6392
|
+
Requires ANY permissions:
|
|
6393
|
+
|
|
6394
|
+
* conversation:message:view
|
|
6395
|
+
|
|
5838
6396
|
|
|
5839
6397
|
### Example
|
|
5840
6398
|
~~~ruby
|
|
@@ -5892,12 +6450,18 @@ Name | Type | Description | Notes
|
|
|
5892
6450
|
|
|
5893
6451
|
## - post_conversations_message_participant_replace(conversation_id, participant_id, body)
|
|
5894
6452
|
|
|
6453
|
+
|
|
6454
|
+
|
|
5895
6455
|
Replace this participant with the specified user and/or address
|
|
5896
6456
|
|
|
5897
6457
|
|
|
5898
6458
|
|
|
5899
6459
|
Wraps POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace
|
|
5900
6460
|
|
|
6461
|
+
Requires NO permissions:
|
|
6462
|
+
|
|
6463
|
+
|
|
6464
|
+
|
|
5901
6465
|
|
|
5902
6466
|
### Example
|
|
5903
6467
|
~~~ruby
|
|
@@ -5956,12 +6520,18 @@ nil (empty response body)
|
|
|
5956
6520
|
|
|
5957
6521
|
## -[**Empty**](Empty.html) put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body)
|
|
5958
6522
|
|
|
6523
|
+
|
|
6524
|
+
|
|
5959
6525
|
Set uuiData to be sent on future commands.
|
|
5960
6526
|
|
|
5961
6527
|
|
|
5962
6528
|
|
|
5963
6529
|
Wraps PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata
|
|
5964
6530
|
|
|
6531
|
+
Requires NO permissions:
|
|
6532
|
+
|
|
6533
|
+
|
|
6534
|
+
|
|
5965
6535
|
|
|
5966
6536
|
### Example
|
|
5967
6537
|
~~~ruby
|
|
@@ -6024,12 +6594,18 @@ Name | Type | Description | Notes
|
|
|
6024
6594
|
|
|
6025
6595
|
## -[**EmailMessage**](EmailMessage.html) put_conversations_email_messages_draft(conversation_id, body)
|
|
6026
6596
|
|
|
6597
|
+
|
|
6598
|
+
|
|
6027
6599
|
Update conversation draft reply
|
|
6028
6600
|
|
|
6029
6601
|
|
|
6030
6602
|
|
|
6031
6603
|
Wraps PUT /api/v2/conversations/emails/{conversationId}/messages/draft
|
|
6032
6604
|
|
|
6605
|
+
Requires NO permissions:
|
|
6606
|
+
|
|
6607
|
+
|
|
6608
|
+
|
|
6033
6609
|
|
|
6034
6610
|
### Example
|
|
6035
6611
|
~~~ruby
|