integrations/contact-center/nice-cxone/dist¶
Interfaces¶
ConfiguredHandoffInput¶
Properties¶
idempotencyKey?¶
payload?¶
query?¶
NiceCxoneClient¶
Properties¶
providerClient¶
Methods¶
createHandoff()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
ConfiguredHandoffInput |
Returns¶
Promise\<ProviderJsonObject>
endContact()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
readiness()¶
Returns¶
Promise\<ProviderJsonObject>
request()¶
Parameters¶
| Parameter | Type |
|---|---|
input |
ProviderExtensionRequestInput |
Returns¶
Promise\<ProviderJsonObject>
scheduleCallback()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
startContact()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
NiceCxoneClientOptions¶
Extended by¶
Properties¶
accessToken?¶
apiBaseUrl?¶
apiKey?¶
apiKeyHeaderName?¶
authorizationHeader?¶
baseUrl?¶
defaultHandoffPath?¶
fetch?¶
Call Signature¶
Parameters¶
| Parameter | Type |
|---|---|
input |
URL | RequestInfo |
init? |
RequestInit |
Returns¶
Promise\<Response>
Call Signature¶
Parameters¶
| Parameter | Type |
|---|---|
input |
string | Request | URL |
init? |
RequestInit |
Returns¶
Promise\<Response>
providerClient?¶
readinessPath?¶
retry?¶
signal?¶
timeoutMs?¶
NiceCxoneIntegrationOptions¶
Extends¶
Properties¶
accessToken?¶
Inherited from¶
NiceCxoneClientOptions.accessToken
apiBaseUrl?¶
Inherited from¶
NiceCxoneClientOptions.apiBaseUrl
apiKey?¶
Inherited from¶
apiKeyHeaderName?¶
Inherited from¶
NiceCxoneClientOptions.apiKeyHeaderName
authorizationHeader?¶
Inherited from¶
NiceCxoneClientOptions.authorizationHeader
baseUrl?¶
Inherited from¶
NiceCxoneClientOptions.baseUrl
defaultHandoffPath?¶
Inherited from¶
NiceCxoneClientOptions.defaultHandoffPath
fetch?¶
Call Signature¶
Parameters¶
| Parameter | Type |
|---|---|
input |
URL | RequestInfo |
init? |
RequestInit |
Returns¶
Promise\<Response>
Call Signature¶
Parameters¶
| Parameter | Type |
|---|---|
input |
string | Request | URL |
init? |
RequestInit |
Returns¶
Promise\<Response>
Inherited from¶
niceCxoneClient?¶
providerClient?¶
Inherited from¶
NiceCxoneClientOptions.providerClient
readinessPath?¶
Inherited from¶
NiceCxoneClientOptions.readinessPath
retry?¶
Inherited from¶
signal?¶
Inherited from¶
timeoutMs?¶
Inherited from¶
NiceCxoneClientOptions.timeoutMs
NiceCxoneOperationInput¶
Extended by¶
Properties¶
body?¶
headers?¶
idempotencyKey?¶
pathParams?¶
query?¶
NiceCxoneProviderClient¶
Methods¶
createHandoff()¶
Parameters¶
| Parameter | Type |
|---|---|
input |
ConfiguredHandoffInput |
Returns¶
Promise\<ProviderJsonObject>
endContact()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
readiness()?¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneReadinessInput |
Returns¶
Promise\<ProviderJsonObject>
request()¶
Parameters¶
| Parameter | Type |
|---|---|
input |
ProviderExtensionRequestInput |
Returns¶
Promise\<ProviderJsonObject>
scheduleCallback()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
startContact()¶
Parameters¶
| Parameter | Type |
|---|---|
input? |
NiceCxoneOperationInput |
Returns¶
Promise\<ProviderJsonObject>
NiceCxoneReadinessInput¶
Properties¶
path?¶
ProviderExtensionRequestInput¶
Extends¶
Properties¶
allowMutation?¶
body?¶
Inherited from¶
classification?¶
headers?¶
Inherited from¶
NiceCxoneOperationInput.headers
idempotencyKey?¶
Inherited from¶
NiceCxoneOperationInput.idempotencyKey
method?¶
operationId?¶
path?¶
pathParams?¶
Inherited from¶
NiceCxoneOperationInput.pathParams
query?¶
Inherited from¶
ProviderRestRetryOptions¶
Properties¶
attempts?¶
baseDelayMs?¶
maxDelayMs?¶
statusCodes?¶
Type Aliases¶
NiceCxoneProviderMethod¶
NiceCxoneQueryValue¶
ProviderJsonObject¶
Functions¶
createNiceCxoneClient()¶
Parameters¶
| Parameter | Type |
|---|---|
options? |
NiceCxoneClientOptions |
Returns¶
createNiceCxoneIntegration()¶
function createNiceCxoneIntegration(options?): DefinedIntegration<{
capabilities: readonly [{
capability: "handoff";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contactTransfer";
label: "contactTransfer";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "schedule";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "callback";
label: "callback";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "send";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "update-provider-object";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: false;
}];
category: "contact-center";
channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: readonly [{
label: "NICE CXone REST APIs";
url: "https://developer.niceincontact.com/API";
}, {
label: "NICE CXone ACD SDK package";
url: "https://www.npmjs.com/package/@nice-devone/acd-sdk";
}, {
label: "NICE CXone Agent SDK repository";
url: "https://github.com/nice-devone/nice-cxone-agent-sdk";
}];
notes: readonly ["Maintained NICE @nice-devone SDK packages exist, but the closest ACD runtime package is UNLICENSED and documented for CXone Agent/app-bundler use.", "Runtime calls use a fail-closed built-in REST adapter when baseUrl/API credentials are supplied, with NiceCxoneProviderClient available as a typed host override."];
scope: "support-workflow-subset";
};
credentialRequirements: readonly [{
id: "nice-cxone-api-base";
label: "NICE CXone API base URL";
required: true;
}, {
id: "nice-cxone-api-access";
label: "NICE CXone API access";
required: true;
}, {
id: "nice-cxone-routing";
label: "NICE CXone skill/queue routing configuration";
required: false;
}];
directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
id: "contact-center.nice-cxone";
maintainers: readonly [{
name: "Cognidesk";
type: "official";
}];
metadata: {
implementation: {
adapterKind: "no-official-sdk-rest-adapter";
allowedOperations: readonly [{
alias: "contact-center.handoff.request";
checksum: "not-applicable-host-configured";
id: "configuredHandoff";
method: "POST";
path: "host-configured";
source: "provider-rest-adapter";
}, {
alias: "contact-center.callback.schedule";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "scheduleACallback";
method: "POST";
path: "/promise";
source: "https://developer.niceincontact.com/content/apis/patron/patron-callback-api-docs";
}, {
alias: "contact-center.contact.start";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "startChatSession";
method: "POST";
path: "/contacts/chats";
source: "https://developer.niceincontact.com/content/apis/patron/patron-chatrequests-api-docs";
}, {
alias: "contact-center.contact.end";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "endChat";
method: "DELETE";
path: "/contacts/chats/{chatSession}";
source: "https://developer.niceincontact.com/content/apis/patron/patron-chatrequests-api-docs";
}, {
alias: "nice-cxone.request";
checksum: "not-applicable-host-configured";
id: "providerExtensionRequest";
method: "GET";
path: "host-configured";
source: "provider-rest-adapter";
}];
implementationStrategy: "provider-rest-adapter";
providerSdkDecision: {
checkedAt: "2026-06-25";
checkedPackages: readonly [{
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "Closest ACD package is unlicensed and documented for CXone Agent/app-bundler use rather than a redistributable server-side REST client.";
result: "official-sdk-not-redistributable-server-rest-client";
}, {
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/agent-sdk";
reason: "Agent SDK is unlicensed and coupled to CXone Agent/browser app runtime.";
result: "agent-app-sdk-not-server-rest-client";
}, {
checkedVersion: "3.3.0";
license: "UNLICENSED";
package: "@nice-devone/nice-cxone-chat-web-sdk";
reason: "Web SDK targets browser DFO chat rather than package-owned Contact Center server operations.";
result: "browser-dfo-chat-sdk-not-contact-center-server-client";
}];
defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
result: "no-redistributable-server-side-cxone-sdk";
typedClientOverride: "NiceCxoneProviderClient";
};
sdkDecision: "Maintained NICE @nice-devone SDK packages exist, but the closest ACD runtime package is UNLICENSED and designed for CXone Agent/app-bundler use rather than a redistributable server-side REST client; this package provides a fail-closed built-in REST adapter with providerClient override.";
verifiedAt: "2026-06-25";
};
manifestOnlySafe: true;
providerRestAdapter: {
adapterKind: "no-official-sdk-rest-adapter";
failureMode: "fail-closed";
hostClientEscapeHatch: "NiceCxoneClient.providerClient";
hostClientOverride: true;
packageOwnedRestClient: true;
providerClientOverride: "NiceCxoneProviderClient";
reviewedOperationAllowlist: true;
strategy: "provider-rest-adapter";
};
providerSdkDecision: {
checkedAt: "2026-06-25";
checkedPackages: readonly [{
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "Closest ACD package is unlicensed and documented for CXone Agent/app-bundler use rather than a redistributable server-side REST client.";
result: "official-sdk-not-redistributable-server-rest-client";
}, {
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/agent-sdk";
reason: "Agent SDK is unlicensed and coupled to CXone Agent/browser app runtime.";
result: "agent-app-sdk-not-server-rest-client";
}, {
checkedVersion: "3.3.0";
license: "UNLICENSED";
package: "@nice-devone/nice-cxone-chat-web-sdk";
reason: "Web SDK targets browser DFO chat rather than package-owned Contact Center server operations.";
result: "browser-dfo-chat-sdk-not-contact-center-server-client";
}];
defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
result: "no-redistributable-server-side-cxone-sdk";
typedClientOverride: "NiceCxoneProviderClient";
};
sdkDecision: {
checkedAt: "2026-06-25";
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "@nice-devone/acd-sdk is the closest NICE CXone ACD npm package, but it is published as UNLICENSED and documented for CXone Agent/app-bundler use with browser and agent SDK dependencies.";
result: "official-sdk-not-redistributable-server-rest-client";
};
};
name: "NICE CXone";
operations: readonly [{
alias: "contact-center.handoff.request";
capability: "handoff";
providerObject: "contactTransfer";
}, {
alias: "contact-center.callback.schedule";
capability: "schedule";
providerObject: "callback";
}, {
alias: "contact-center.contact.start";
capability: "send";
providerObject: "contact";
}, {
alias: "contact-center.contact.end";
capability: "update-provider-object";
providerObject: "contact";
}, {
alias: "nice-cxone.request";
capability: "read-provider-object";
extension: true;
providerObject: "contact";
}];
packageName: "@cognidesk/integration-contact-center-nice-cxone";
provider: "nice-cxone";
trustLevel: "official";
}, unknown, {
contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
contact-center.contact.end: (input) => Promise<ProviderJsonObject>;
contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
nice-cxone.request: (input) => Promise<ProviderJsonObject>;
}>;
Parameters¶
| Parameter | Type |
|---|---|
options? |
NiceCxoneIntegrationOptions |
Returns¶
DefinedIntegration\<{
capabilities: readonly [{
capability: "handoff";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contactTransfer";
label: "contactTransfer";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "schedule";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "callback";
label: "callback";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "send";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "update-provider-object";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: true;
}, {
capability: "read-provider-object";
exposesSensitiveData: true;
providerObjects: readonly [{
kind: "contact";
label: "contact";
}];
requiresCredential: true;
sideEffect: false;
}];
category: "contact-center";
channelAudiences: readonly ["customer-facing", "internal-support", "mixed"];
coverage: {
evidence: readonly [{
label: "NICE CXone REST APIs";
url: "https://developer.niceincontact.com/API";
}, {
label: "NICE CXone ACD SDK package";
url: "https://www.npmjs.com/package/@nice-devone/acd-sdk";
}, {
label: "NICE CXone Agent SDK repository";
url: "https://github.com/nice-devone/nice-cxone-agent-sdk";
}];
notes: readonly ["Maintained NICE @nice-devone SDK packages exist, but the closest ACD runtime package is UNLICENSED and documented for CXone Agent/app-bundler use.", "Runtime calls use a fail-closed built-in REST adapter when baseUrl/API credentials are supplied, with NiceCxoneProviderClient available as a typed host override."];
scope: "support-workflow-subset";
};
credentialRequirements: readonly [{
id: "nice-cxone-api-base";
label: "NICE CXone API base URL";
required: true;
}, {
id: "nice-cxone-api-access";
label: "NICE CXone API access";
required: true;
}, {
id: "nice-cxone-routing";
label: "NICE CXone skill/queue routing configuration";
required: false;
}];
directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
id: "contact-center.nice-cxone";
maintainers: readonly [{
name: "Cognidesk";
type: "official";
}];
metadata: {
implementation: {
adapterKind: "no-official-sdk-rest-adapter";
allowedOperations: readonly [{
alias: "contact-center.handoff.request";
checksum: "not-applicable-host-configured";
id: "configuredHandoff";
method: "POST";
path: "host-configured";
source: "provider-rest-adapter";
}, {
alias: "contact-center.callback.schedule";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "scheduleACallback";
method: "POST";
path: "/promise";
source: "https://developer.niceincontact.com/content/apis/patron/patron-callback-api-docs";
}, {
alias: "contact-center.contact.start";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "startChatSession";
method: "POST";
path: "/contacts/chats";
source: "https://developer.niceincontact.com/content/apis/patron/patron-chatrequests-api-docs";
}, {
alias: "contact-center.contact.end";
checksum: "sha256:076fb5602cd1e76f13d38bb2172547e9d2f91877447c3088ff14e849bac2099a-local-generated-operation-catalog";
id: "endChat";
method: "DELETE";
path: "/contacts/chats/{chatSession}";
source: "https://developer.niceincontact.com/content/apis/patron/patron-chatrequests-api-docs";
}, {
alias: "nice-cxone.request";
checksum: "not-applicable-host-configured";
id: "providerExtensionRequest";
method: "GET";
path: "host-configured";
source: "provider-rest-adapter";
}];
implementationStrategy: "provider-rest-adapter";
providerSdkDecision: {
checkedAt: "2026-06-25";
checkedPackages: readonly [{
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "Closest ACD package is unlicensed and documented for CXone Agent/app-bundler use rather than a redistributable server-side REST client.";
result: "official-sdk-not-redistributable-server-rest-client";
}, {
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/agent-sdk";
reason: "Agent SDK is unlicensed and coupled to CXone Agent/browser app runtime.";
result: "agent-app-sdk-not-server-rest-client";
}, {
checkedVersion: "3.3.0";
license: "UNLICENSED";
package: "@nice-devone/nice-cxone-chat-web-sdk";
reason: "Web SDK targets browser DFO chat rather than package-owned Contact Center server operations.";
result: "browser-dfo-chat-sdk-not-contact-center-server-client";
}];
defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
result: "no-redistributable-server-side-cxone-sdk";
typedClientOverride: "NiceCxoneProviderClient";
};
sdkDecision: "Maintained NICE @nice-devone SDK packages exist, but the closest ACD runtime package is UNLICENSED and designed for CXone Agent/app-bundler use rather than a redistributable server-side REST client; this package provides a fail-closed built-in REST adapter with providerClient override.";
verifiedAt: "2026-06-25";
};
manifestOnlySafe: true;
providerRestAdapter: {
adapterKind: "no-official-sdk-rest-adapter";
failureMode: "fail-closed";
hostClientEscapeHatch: "NiceCxoneClient.providerClient";
hostClientOverride: true;
packageOwnedRestClient: true;
providerClientOverride: "NiceCxoneProviderClient";
reviewedOperationAllowlist: true;
strategy: "provider-rest-adapter";
};
providerSdkDecision: {
checkedAt: "2026-06-25";
checkedPackages: readonly [{
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "Closest ACD package is unlicensed and documented for CXone Agent/app-bundler use rather than a redistributable server-side REST client.";
result: "official-sdk-not-redistributable-server-rest-client";
}, {
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/agent-sdk";
reason: "Agent SDK is unlicensed and coupled to CXone Agent/browser app runtime.";
result: "agent-app-sdk-not-server-rest-client";
}, {
checkedVersion: "3.3.0";
license: "UNLICENSED";
package: "@nice-devone/nice-cxone-chat-web-sdk";
reason: "Web SDK targets browser DFO chat rather than package-owned Contact Center server operations.";
result: "browser-dfo-chat-sdk-not-contact-center-server-client";
}];
defaultRestPolicy: "fail-closed-provider-rest-adapter-with-typed-provider-client-override";
result: "no-redistributable-server-side-cxone-sdk";
typedClientOverride: "NiceCxoneProviderClient";
};
sdkDecision: {
checkedAt: "2026-06-25";
checkedVersion: "26.2.1";
license: "UNLICENSED";
package: "@nice-devone/acd-sdk";
reason: "@nice-devone/acd-sdk is the closest NICE CXone ACD npm package, but it is published as UNLICENSED and documented for CXone Agent/app-bundler use with browser and agent SDK dependencies.";
result: "official-sdk-not-redistributable-server-rest-client";
};
};
name: "NICE CXone";
operations: readonly [{
alias: "contact-center.handoff.request";
capability: "handoff";
providerObject: "contactTransfer";
}, {
alias: "contact-center.callback.schedule";
capability: "schedule";
providerObject: "callback";
}, {
alias: "contact-center.contact.start";
capability: "send";
providerObject: "contact";
}, {
alias: "contact-center.contact.end";
capability: "update-provider-object";
providerObject: "contact";
}, {
alias: "nice-cxone.request";
capability: "read-provider-object";
extension: true;
providerObject: "contact";
}];
packageName: "@cognidesk/integration-contact-center-nice-cxone";
provider: "nice-cxone";
trustLevel: "official";
}, unknown, {
contact-center.callback.schedule: (input) => Promise\<ProviderJsonObject>;
contact-center.contact.end: (input) => Promise\<ProviderJsonObject>;
contact-center.contact.start: (input) => Promise\<ProviderJsonObject>;
contact-center.handoff.request: (input) => Promise\<ProviderJsonObject>;
nice-cxone.request: (input) => Promise\<ProviderJsonObject>;
}>
createNiceCxoneIntegrationOperationHandlers()¶
function createNiceCxoneIntegrationOperationHandlers(options?): {
contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
contact-center.contact.end: (input) => Promise<ProviderJsonObject>;
contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
nice-cxone.request: (input) => Promise<ProviderJsonObject>;
};
Parameters¶
| Parameter | Type |
|---|---|
options? |
NiceCxoneIntegrationOptions |
Returns¶
{
contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
contact-center.contact.end: (input) => Promise<ProviderJsonObject>;
contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
nice-cxone.request: (input) => Promise<ProviderJsonObject>;
}
| Name | Type |
|---|---|
contact-center.callback.schedule() |
(input) => Promise\<ProviderJsonObject> |
contact-center.contact.end() |
(input) => Promise\<ProviderJsonObject> |
contact-center.contact.start() |
(input) => Promise\<ProviderJsonObject> |
contact-center.handoff.request() |
(input) => Promise\<ProviderJsonObject> |
nice-cxone.request() |
(input) => Promise\<ProviderJsonObject> |
References¶
niceCxoneProviderManifest¶
Re-exports niceCxoneProviderManifest
niceCxoneProviderManifestInput¶
Re-exports niceCxoneProviderManifestInput
niceCxoneRestSupportSlice¶
Re-exports niceCxoneRestSupportSlice
niceCxoneSupportSlice¶
Re-exports niceCxoneSupportSlice