CxEngage Javascript SDK Documentation 1.0.0
Auto-generated Documentation for the various modules contained in the SDK.
Namespaces
cxengage-javascript-sdk.domain.errors
Public variables and functions:
- active-interactions-err
- args-failed-spec-err
- bad-sdk-init-opts-err
- failed-cognito-auth-err
- failed-to-accept-interaction-err
- failed-to-acknowledge-flow-action-err
- failed-to-add-outbound-identifier-list-member-err
- failed-to-assign-blank-salesforce-classic-item-err
- failed-to-assign-blank-salesforce-lightning-item-err
- failed-to-assign-contact-to-interaction-err
- failed-to-assign-salesforce-classic-item-no-interaction-err
- failed-to-assign-salesforce-classic-item-to-interaction-err
- failed-to-assign-salesforce-lightning-item-no-interaction-err
- failed-to-assign-salesforce-lightning-item-to-interaction-err
- failed-to-associate-err
- failed-to-cancel-extension-transfer-err
- failed-to-cancel-outbound-dial-err
- failed-to-cancel-queue-transfer-err
- failed-to-cancel-resource-transfer-err
- failed-to-change-state-err
- failed-to-change-twilio-active-output-ringtone-devices-err
- failed-to-change-twilio-active-output-speaker-devices-err
- failed-to-connect-to-mqtt-err
- failed-to-create-api-key-err
- failed-to-create-business-hour-err
- failed-to-create-contact-err
- failed-to-create-data-access-report-err
- failed-to-create-dispatch-mapping-err
- failed-to-create-disposition-err
- failed-to-create-disposition-list-err
- failed-to-create-email-reply-artifact-err
- failed-to-create-email-template-err
- failed-to-create-err
- failed-to-create-exception-err
- failed-to-create-flow-draft-err
- failed-to-create-flow-err
- failed-to-create-group-err
- failed-to-create-integration-err
- failed-to-create-integration-listener-err
- failed-to-create-interaction-note-err
- failed-to-create-list-err
- failed-to-create-list-item-err
- failed-to-create-message-template-err
- failed-to-create-outbound-email-interaction-err
- failed-to-create-outbound-identifier-err
- failed-to-create-outbound-identifier-list-err
- failed-to-create-outbound-sms-interaction-err
- failed-to-create-reason-err
- failed-to-create-reason-list-err
- failed-to-create-role-err
- failed-to-create-skill-err
- failed-to-create-sla-err
- failed-to-create-sla-version-err
- failed-to-create-tenant-err
- failed-to-create-transfer-list-err
- failed-to-create-user-err
- failed-to-delete-api-key-err
- failed-to-delete-contact-err
- failed-to-delete-email-template-err
- failed-to-delete-err
- failed-to-delete-exception-err
- failed-to-delete-list-item-err
- failed-to-delete-outbound-identifier-err
- failed-to-delete-sqs-message
- failed-to-deselect-disposition-err
- failed-to-disable-wrapup-err
- failed-to-dissociate-err
- failed-to-download-list-err
- failed-to-enable-wrapup-err
- failed-to-end-interaction-err
- failed-to-end-wrapup-err
- failed-to-find-twilio-connection-object
- failed-to-focus-interaction-err
- failed-to-focus-salesforce-classic-interaction-err
- failed-to-focus-salesforce-lightning-interaction-err
- failed-to-focus-zendesk-interaction-err
- failed-to-get-api-keys-err
- failed-to-get-artifact-err
- failed-to-get-artifacts-err
- failed-to-get-attachment-url-err
- failed-to-get-auth-info-err
- failed-to-get-available-stats-err
- failed-to-get-business-hour-err
- failed-to-get-business-hours-err
- failed-to-get-capacity-err
- failed-to-get-capacity-rules-err
- failed-to-get-contact-err
- failed-to-get-contact-interaction-history-err
- failed-to-get-crm-interactions-err
- failed-to-get-current-salesforce-classic-org-id-err
- failed-to-get-current-salesforce-classic-user-id-err
- failed-to-get-current-salesforce-lightning-org-id-err
- failed-to-get-current-salesforce-lightning-user-id-err
- failed-to-get-dashboards-list-err
- failed-to-get-data-access-member-err
- failed-to-get-data-access-report-err
- failed-to-get-data-access-reports-err
- failed-to-get-dispatch-mapping-err
- failed-to-get-dispatch-mappings-err
- failed-to-get-disposition-err
- failed-to-get-dispositions-err
- failed-to-get-email-templates-err
- failed-to-get-email-transcripts-err
- failed-to-get-email-types-err
- failed-to-get-entity-err
- failed-to-get-flow-err
- failed-to-get-flows-err
- failed-to-get-group-err
- failed-to-get-groups-err
- failed-to-get-historical-report-folders-err
- failed-to-get-identity-providers-err
- failed-to-get-integration-err
- failed-to-get-integration-listener-err
- failed-to-get-integration-listeners-err
- failed-to-get-integrations-err
- failed-to-get-interaction-note-err
- failed-to-get-interaction-reporting-err
- failed-to-get-list-err
- failed-to-get-list-item-err
- failed-to-get-list-types-err
- failed-to-get-lists-err
- failed-to-get-message-template-err
- failed-to-get-message-templates-err
- failed-to-get-messaging-transcripts-err
- failed-to-get-outbound-identifier-list-err
- failed-to-get-outbound-identifier-lists-err
- failed-to-get-outbound-identifiers-err
- failed-to-get-permissions-err
- failed-to-get-platform-roles-err
- failed-to-get-platform-user-email-err
- failed-to-get-platform-user-err
- failed-to-get-queue-err
- failed-to-get-queue-list-err
- failed-to-get-reason-err
- failed-to-get-reason-list-err
- failed-to-get-reason-lists-err
- failed-to-get-reasons-err
- failed-to-get-recordings-err
- failed-to-get-region-err
- failed-to-get-regions-err
- failed-to-get-role-err
- failed-to-get-roles-err
- failed-to-get-running-session-state
- failed-to-get-session-config-err
- failed-to-get-skill-err
- failed-to-get-skills-err
- failed-to-get-sla-err
- failed-to-get-slas-err
- failed-to-get-specific-messaging-transcript-err
- failed-to-get-tenant-branding-err
- failed-to-get-tenant-data-err
- failed-to-get-tenant-details-err
- failed-to-get-tenant-err
- failed-to-get-tenant-protected-branding-err
- failed-to-get-tenants-err
- failed-to-get-timezones-err
- failed-to-get-transfer-list-err
- failed-to-get-transfer-lists-err
- failed-to-get-user-config-err
- failed-to-get-user-err
- failed-to-get-user-extensions-err
- failed-to-get-user-outbound-identifier-lists-err
- failed-to-get-users-err
- failed-to-init-cognito-sdk-err
- failed-to-init-twilio-err
- failed-to-init-zendesk-client-err
- failed-to-invite-user-err
- failed-to-list-all-contacts-err
- failed-to-list-contact-attributes-err
- failed-to-list-interaction-notes-err
- failed-to-merge-contacts-err
- failed-to-mute-target-resource-err
- failed-to-perform-bulk-stat-query-err
- failed-to-perform-outbound-dial-err
- failed-to-perform-stat-query-err
- failed-to-place-customer-on-hold-err
- failed-to-place-resource-on-hold-err
- failed-to-process-sqs-message
- failed-to-read-err
- failed-to-receive-sqs-message
- failed-to-refresh-sqs-integration-err
- failed-to-refresh-twilio-integration-err
- failed-to-remove-flow-draft-err
- failed-to-remove-outbound-identifier-list-member-err
- failed-to-remove-resource-err
- failed-to-resume-all-err
- failed-to-resume-customer-err
- failed-to-resume-resource-err
- failed-to-retrieve-contact-layout-err
- failed-to-retrieve-contact-layouts-list-err
- failed-to-retrieve-email-artifact-err
- failed-to-retrieve-messaging-history-err
- failed-to-retrieve-messaging-metadata-err
- failed-to-retrieve-smooch-messaging-history-err
- failed-to-save-logs-err
- failed-to-search-contacts-err
- failed-to-select-disposition-err
- failed-to-send-agent-cancel-reply-err
- failed-to-send-agent-no-reply-err
- failed-to-send-agent-reply-started-err
- failed-to-send-custom-interrupt-err
- failed-to-send-digits-invalid-interaction-err
- failed-to-send-email-reply-err
- failed-to-send-email-reply-no-artifact-err
- failed-to-send-interaction-script-response-err
- failed-to-send-outbound-sms-err
- failed-to-send-salesforce-classic-assign-err
- failed-to-send-salesforce-classic-unassign-err
- failed-to-send-salesforce-lightning-assign-err
- failed-to-send-salesforce-lightning-unassign-err
- failed-to-send-smooch-attachment
- failed-to-send-smooch-conversation-read
- failed-to-send-smooch-message
- failed-to-send-smooch-typing
- failed-to-send-twilio-digits-err
- failed-to-send-zendesk-assign-err
- failed-to-set-direction-err
- failed-to-set-presence-state-err
- failed-to-set-zendesk-dimensions-err
- failed-to-set-zendesk-visibility-err
- failed-to-start-agent-session-err
- failed-to-start-recording-err
- failed-to-start-silent-monitoring
- failed-to-start-silent-monitoring-no-extension
- failed-to-stop-recording-err
- failed-to-transfer-to-extension-err
- failed-to-transfer-to-queue-err
- failed-to-transfer-to-resource-err
- failed-to-unassign-contact-from-interaction-err
- failed-to-unassign-salesforce-classic-item-from-interaction-err
- failed-to-unassign-salesforce-lightning-item-from-interaction-err
- failed-to-unfocus-interaction-err
- failed-to-unmute-target-resource-err
- failed-to-update-api-key-err
- failed-to-update-business-hour-err
- failed-to-update-contact-err
- failed-to-update-data-access-report-err
- failed-to-update-default-tenant-err
- failed-to-update-dispatch-mapping-err
- failed-to-update-disposition-err
- failed-to-update-disposition-list-err
- failed-to-update-email-template-err
- failed-to-update-err
- failed-to-update-extension-err
- failed-to-update-flow-err
- failed-to-update-group-err
- failed-to-update-integration-err
- failed-to-update-integration-listener-err
- failed-to-update-interaction-note-err
- failed-to-update-list-err
- failed-to-update-list-item-err
- failed-to-update-message-template-err
- failed-to-update-outbound-identifier-err
- failed-to-update-outbound-identifier-list-err
- failed-to-update-platform-user-err
- failed-to-update-reason-err
- failed-to-update-reason-list-err
- failed-to-update-role-err
- failed-to-update-salesforce-classic-interaction-tab-id-err
- failed-to-update-salesforce-lightning-interaction-tab-id-err
- failed-to-update-skill-err
- failed-to-update-sla-err
- failed-to-update-tenant-branding-err
- failed-to-update-tenant-err
- failed-to-update-transfer-list-err
- failed-to-update-user-err
- failed-to-update-user-skill-member-err
- failed-to-update-users-capacity-rule-err
- failed-to-upload-branding-image-err
- failed-to-upload-list-err
- force-killed-twilio-connection-err
- insufficient-permissions-err
- invalid-disposition-provided-err
- invalid-extension-provided-err
- invalid-reason-info-err
- login-failed-login-request-err
- login-failed-token-request-err
- logout-failed-err
- mqtt-connection-lost-err
- no-microphone-access-err
- no-twilio-integration-err
- reporting-batch-request-failed-err
- required-module-failed-to-start-err
- session-heartbeats-failed-err
- sqs-loop-ended
- sqs-uncaught-exception
- unable-to-find-script-err
- unknown-agent-notification-type-err
- work-offer-expired-err
- wrong-number-of-sdk-fn-args-err
- wrong-number-sdk-opts-err
cxengage-javascript-sdk.modules.entities
Public variables and functions:
- add-outbound-identifier-list-member
- associate
- create-api-key
- create-business-hour
- create-data-access-report
- create-dispatch-mapping
- create-disposition
- create-disposition-list
- create-email-template
- create-exception
- create-flow
- create-flow-draft
- create-group
- create-integration
- create-integration-listener
- create-list
- create-list-item
- create-message-template
- create-outbound-identifier
- create-outbound-identifier-list
- create-reason
- create-reason-list
- create-role
- create-skill
- create-sla
- create-sla-version
- create-tenant
- create-transfer-list
- create-user
- delete-api-key
- delete-email-template
- delete-exception
- delete-list-item
- delete-outbound-identifier
- dissociate
- download-list
- get-api-keys
- get-artifact
- get-artifacts
- get-branding
- get-business-hour
- get-business-hours
- get-capacity-rules
- get-dashboards
- get-data-access-member
- get-data-access-report
- get-data-access-reports
- get-dispatch-mapping
- get-dispatch-mappings
- get-disposition
- get-dispositions
- get-email-templates
- get-email-types
- get-entity
- get-flow
- get-flows
- get-group
- get-groups
- get-historical-report-folders
- get-identity-providers
- get-integration
- get-integration-listener
- get-integration-listeners
- get-integrations
- get-list
- get-list-item
- get-list-types
- get-lists
- get-message-template
- get-message-templates
- get-outbound-identifier-list
- get-outbound-identifier-lists
- get-outbound-identifiers
- get-permissions
- get-platform-roles
- get-platform-user
- get-platform-user-email
- get-protected-branding
- get-queue
- get-queues
- get-reason
- get-reason-list
- get-reason-lists
- get-reasons
- get-recordings
- get-regions
- get-role
- get-roles
- get-skill
- get-skills
- get-sla
- get-slas
- get-tenant
- get-tenants
- get-timezones
- get-transfer-list
- get-transfer-lists
- get-user
- get-user-outbound-identifier-lists
- get-users
- invite-user
- remove-flow-draft
- remove-outbound-identifier-list-member
- update-api-key
- update-branding
- update-business-hour
- update-data-access-report
- update-dispatch-mapping
- update-disposition
- update-disposition-list
- update-email-template
- update-flow
- update-group
- update-integration
- update-integration-listener
- update-list
- update-list-item
- update-message-template
- update-outbound-identifier
- update-outbound-identifier-list
- update-platform-user
- update-reason
- update-reason-list
- update-role
- update-skill
- update-sla
- update-tenant
- update-transfer-list
- update-user
- update-user-skill-member
- update-users-capacity-rule
- upload-branding-image
- upload-list
cxengage-javascript-sdk.modules.interaction
Public variables and functions:
- accept
- assign
- cancel-extension-transfer
- cancel-queue-transfer
- cancel-resource-transfer
- create-note
- custom-interrupt
- deselect-disposition
- disable-wrapup
- enable-wrapup
- end
- end-wrapup
- focus
- get-all-notes
- get-note
- select-disposition
- send-script
- transfer-to-extension
- transfer-to-queue
- transfer-to-resource
- unassign
- unfocus
- update-note
cxengage-javascript-sdk.modules.session
Public variables and functions:
- clear-monitored-interaction
- get-active-tenant-id
- get-active-user-id
- get-default-extension
- get-extensions
- get-monitored-interaction
- get-running-session-state
- get-sso-token
- get-tenant-details
- get-token
- get-user-config
- go-not-ready
- go-ready
- set-active-tenant
- set-direction
- set-locale
- set-presence-state
- set-token
- set-user-identity