Skip to content

integrations/contact-center/genesys-engage/dist

Interfaces

ConfiguredHandoffInput

Properties

idempotencyKey?
optional idempotencyKey?: string;
payload?
optional payload?: unknown;
query?
optional query?: Record<string, ProviderQueryValue>;

GenesysEngageClient

Properties

engagementSdkClient?
optional engagementSdkClient?: GenesysEngageEngagementSdkClient;
providerClient
providerClient: GenesysEngageProviderClient;

Methods

createHandoff()
createHandoff(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? ConfiguredHandoffInput
Returns

Promise\<ProviderJsonObject>

readiness()
readiness(): Promise<ProviderJsonObject>;
Returns

Promise\<ProviderJsonObject>

request()
request(input): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input ProviderExtensionRequestInput
Returns

Promise\<ProviderJsonObject>

scheduleCallback()
scheduleCallback(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

sendChatMessage()
sendChatMessage(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

startContact()
startContact(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

GenesysEngageClientOptions

Extended by

Properties

accessToken?
optional accessToken?: string;
apiBaseUrl?
optional apiBaseUrl?: string;
apiKey?
optional apiKey?: string;
apiKeyHeaderName?
optional apiKeyHeaderName?: string;
authorizationHeader?
optional authorizationHeader?: string;
baseUrl?
optional baseUrl?: string;
defaultHandoffPath?
optional defaultHandoffPath?: string;
engagementBaseUrl?
optional engagementBaseUrl?: string;
engagementSdk?
optional engagementSdk?: any;
engagementSdkClient?
optional engagementSdkClient?: GenesysEngageEngagementSdkClient;
fetch?
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};
Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input URL | RequestInfo
init? RequestInit
Returns

Promise\<Response>

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input string | Request | URL
init? RequestInit
Returns

Promise\<Response>

providerClient?
optional providerClient?: GenesysEngageProviderClient;
readinessPath?
optional readinessPath?: string;
retry?
optional retry?: number | ProviderRestRetryOptions;
signal?
optional signal?: AbortSignal;
timeoutMs?
optional timeoutMs?: number;

GenesysEngageEngagementSdkClient

Properties

apiClient
apiClient: any;
callbacksApi
callbacksApi: any;
sdk
sdk: any;

GenesysEngageIntegrationOptions

Extends

Properties

accessToken?
optional accessToken?: string;
Inherited from

GenesysEngageClientOptions.accessToken

apiBaseUrl?
optional apiBaseUrl?: string;
Inherited from

GenesysEngageClientOptions.apiBaseUrl

apiKey?
optional apiKey?: string;
Inherited from

GenesysEngageClientOptions.apiKey

apiKeyHeaderName?
optional apiKeyHeaderName?: string;
Inherited from

GenesysEngageClientOptions.apiKeyHeaderName

authorizationHeader?
optional authorizationHeader?: string;
Inherited from

GenesysEngageClientOptions.authorizationHeader

baseUrl?
optional baseUrl?: string;
Inherited from

GenesysEngageClientOptions.baseUrl

defaultHandoffPath?
optional defaultHandoffPath?: string;
Inherited from

GenesysEngageClientOptions.defaultHandoffPath

engagementBaseUrl?
optional engagementBaseUrl?: string;
Inherited from

GenesysEngageClientOptions.engagementBaseUrl

engagementSdk?
optional engagementSdk?: any;
Inherited from

GenesysEngageClientOptions.engagementSdk

engagementSdkClient?
optional engagementSdkClient?: GenesysEngageEngagementSdkClient;
Inherited from

GenesysEngageClientOptions.engagementSdkClient

fetch?
optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};
Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input URL | RequestInfo
init? RequestInit
Returns

Promise\<Response>

Call Signature
(input, init?): Promise<Response>;

MDN Reference

Parameters
Parameter Type
input string | Request | URL
init? RequestInit
Returns

Promise\<Response>

Inherited from

GenesysEngageClientOptions.fetch

genesysEngageClient?
optional genesysEngageClient?: GenesysEngageClient;
providerClient?
optional providerClient?: GenesysEngageProviderClient;
Inherited from

GenesysEngageClientOptions.providerClient

readinessPath?
optional readinessPath?: string;
Inherited from

GenesysEngageClientOptions.readinessPath

retry?
optional retry?: number | ProviderRestRetryOptions;
Inherited from

GenesysEngageClientOptions.retry

signal?
optional signal?: AbortSignal;
Inherited from

GenesysEngageClientOptions.signal

timeoutMs?
optional timeoutMs?: number;
Inherited from

GenesysEngageClientOptions.timeoutMs

GenesysEngageOperationInput

Extended by

Properties

body?
optional body?: unknown;
headers?
optional headers?: Record<string, string>;
idempotencyKey?
optional idempotencyKey?: string;
pathParams?
optional pathParams?: Record<string, string | number | boolean>;
query?
optional query?: Record<string, ProviderQueryValue>;

GenesysEngageProviderClient

Methods

createHandoff()
createHandoff(input): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input ConfiguredHandoffInput
Returns

Promise\<ProviderJsonObject>

readiness()?
optional readiness(): Promise<ProviderJsonObject>;
Returns

Promise\<ProviderJsonObject>

request()
request(input): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input ProviderExtensionRequestInput
Returns

Promise\<ProviderJsonObject>

scheduleCallback()
scheduleCallback(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

sendChatMessage()
sendChatMessage(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

startContact()
startContact(input?): Promise<ProviderJsonObject>;
Parameters
Parameter Type
input? GenesysEngageOperationInput
Returns

Promise\<ProviderJsonObject>

ProviderExtensionRequestInput

Extends

Properties

allowMutation?
optional allowMutation?: boolean;
body?
optional body?: unknown;
Inherited from

GenesysEngageOperationInput.body

classification?
optional classification?: string;
headers?
optional headers?: Record<string, string>;
Inherited from

GenesysEngageOperationInput.headers

idempotencyKey?
optional idempotencyKey?: string;
Inherited from

GenesysEngageOperationInput.idempotencyKey

method?
optional method?: ProviderHttpMethod;
operationId?
optional operationId?: string;
path?
optional path?: string;
pathParams?
optional pathParams?: Record<string, string | number | boolean>;
Inherited from

GenesysEngageOperationInput.pathParams

query?
optional query?: Record<string, ProviderQueryValue>;
Inherited from

GenesysEngageOperationInput.query

ProviderRestRetryOptions

Properties

attempts?
optional attempts?: number;
baseDelayMs?
optional baseDelayMs?: number;
maxDelayMs?
optional maxDelayMs?: number;
statusCodes?
optional statusCodes?: readonly number[];

Type Aliases

GenesysEngageCallbacksApi

type GenesysEngageCallbacksApi = InstanceType<GenesysEngageEngagementSdk["CallbacksApi"]>;

GenesysEngageEngagementApiClient

type GenesysEngageEngagementApiClient = InstanceType<GenesysEngageEngagementSdk["ApiClient"]>;

GenesysEngageEngagementSdk

type GenesysEngageEngagementSdk = typeof EngagementClientSdk;

ProviderJsonObject

type ProviderJsonObject = Record<string, unknown>;

Functions

createGenesysEngageClient()

function createGenesysEngageClient(options?): GenesysEngageClient;

Parameters

Parameter Type
options? GenesysEngageClientOptions

Returns

GenesysEngageClient

createGenesysEngageEngagementSdkClient()

function createGenesysEngageEngagementSdkClient(options?): GenesysEngageEngagementSdkClient;

Parameters

Parameter Type
options? Pick\<GenesysEngageClientOptions, "apiBaseUrl" | "baseUrl" | "engagementBaseUrl" | "engagementSdk">

Returns

GenesysEngageEngagementSdkClient

createGenesysEngageIntegration()

function createGenesysEngageIntegration(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: "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: "Genesys GMS Callback Services API";
        url: "https://docs.genesys.com/Documentation/GMS/latest/API/CallbackServicesAPI";
      }, {
        label: "Genesys GMS Chat API v2";
        url: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2";
      }, {
        label: "PureEngage engagement-client-js";
        url: "https://www.npmjs.com/package/engagement-client-js";
      }, {
        label: "Genesys Cloud Platform SDK for JavaScript";
        url: "https://github.com/MyPureCloud/platform-client-sdk-javascript";
      }, {
        label: "PureEngage Engagement Client Library";
        url: "https://developer.genesyscloud.com/client-libraries/engagement/js/index.html";
     }];
     notes: readonly ["Runtime callback scheduling uses the official PureEngage engagement-client-js generated SDK through CallbacksApi.bookCallbackExternal.", "No matching maintained backend/runtime SDK was verified for GMS Chat API v2, so chat operations use the reviewed REST adapter.", "GenesysEngageProviderClient remains available as a typed host override for tenant-specific surfaces and handoff routing."];
     scope: "support-workflow-subset";
  };
  credentialRequirements: readonly [{
     id: "genesys-engage-gms-base-url";
     label: "Genesys Mobile Services base URL";
     required: true;
   }, {
     id: "genesys-engage-auth";
     label: "Genesys Engage/GMS authentication";
     required: false;
   }, {
     id: "genesys-engage-routing";
     label: "Genesys Engage callback, chat, and routing configuration";
     required: false;
  }];
  directions: readonly ["inbound-only", "outbound-only", "bidirectional"];
  id: "contact-center.genesys-engage";
  maintainers: readonly [{
     name: "Cognidesk";
     type: "official";
  }];
  metadata: {
     implementation: {
        adapterKind: "official-engagement-sdk-plus-gms-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: "provider-sdk-generated-swagger-client";
           id: "createCallback";
           method: "POST";
           path: "/callback/create";
           sdkMethod: "CallbacksApi.bookCallbackExternal";
           sdkPackage: "engagement-client-js";
           source: "engagement-client-js CallbacksApi.bookCallbackExternal";
         }, {
           alias: "contact-center.contact.start";
           checksum: "not-available-html-doc";
           id: "requestChat";
           method: "POST";
           path: "/genesys/2/chat/{serviceName}";
           source: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2";
         }, {
           alias: "genesys-engage.chat.send";
           checksum: "not-available-html-doc";
           id: "sendChatMessage";
           method: "POST";
           path: "/genesys/2/chat/{serviceName}/{chatId}/send";
           source: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2";
         }, {
           alias: "genesys-engage.gms.request";
           checksum: "not-applicable-host-configured";
           id: "providerExtensionRequest";
           method: "GET";
           path: "host-configured";
           source: "provider-rest-adapter";
        }];
        implementationStrategy: "official-sdk-and-provider-rest-adapter";
        providerSdkDecision: {
           checkedAt: "2026-06-25";
           checkedPackages: readonly [{
              checkedVersion: "9.0.83";
              license: "MIT";
              package: "engagement-client-js";
              reason: "Official PureEngage Engagement client exposes CallbacksApi.bookCallbackExternal, which backs Cognidesk contact-center.callback.schedule. It does not expose GMS Chat API v2, so chat operations stay on the reviewed REST adapter.";
              result: "accepted-callback-runtime-sdk";
            }, {
              checkedVersion: "9.0.95";
              license: "MIT";
              package: "genesys-workspace-client-js";
              reason: "Workspace Web Edition client targets workspace voice/call controls rather than GMS Chat API v2 and GMS callback endpoints.";
              result: "workspace-web-edition-api-not-gms-runtime-client";
            }, {
              checkedVersion: "255.1.0";
              license: "MIT";
              package: "purecloud-platform-client-v2";
              reason: "Maintained SDK targets Genesys Cloud Platform APIs, not Genesys Engage GMS Chat/Callback endpoints.";
              result: "genesys-cloud-sdk-not-genesys-engage-gms";
           }];
           defaultRestPolicy: "official-engagement-client-sdk-for-callbacks-with-fail-closed-gms-chat-rest-adapter-and-typed-provider-client-override";
           result: "official-engagement-sdk-for-callbacks-gms-chat-rest-adapter";
           typedClientOverride: "GenesysEngageProviderClient";
        };
        sdkDecision: "engagement-client-js is used for callback scheduling through CallbacksApi.bookCallbackExternal. GMS Chat API v2 has no matching maintained backend/runtime SDK in the checked packages, so chat operations use the built-in reviewed REST adapter with providerClient override.";
        verifiedAt: "2026-06-25";
     };
     manifestOnlySafe: true;
     providerRestAdapter: {
        adapterKind: "official-engagement-sdk-plus-gms-rest-adapter";
        providerClientOverride: "GenesysEngageProviderClient";
        strategy: "official-sdk-and-provider-rest-adapter";
     };
     providerSdkDecision: {
        checkedAt: "2026-06-25";
        checkedPackages: readonly [{
           checkedVersion: "9.0.83";
           license: "MIT";
           package: "engagement-client-js";
           reason: "Official PureEngage Engagement client exposes CallbacksApi.bookCallbackExternal, which backs Cognidesk contact-center.callback.schedule. It does not expose GMS Chat API v2, so chat operations stay on the reviewed REST adapter.";
           result: "accepted-callback-runtime-sdk";
         }, {
           checkedVersion: "9.0.95";
           license: "MIT";
           package: "genesys-workspace-client-js";
           reason: "Workspace Web Edition client targets workspace voice/call controls rather than GMS Chat API v2 and GMS callback endpoints.";
           result: "workspace-web-edition-api-not-gms-runtime-client";
         }, {
           checkedVersion: "255.1.0";
           license: "MIT";
           package: "purecloud-platform-client-v2";
           reason: "Maintained SDK targets Genesys Cloud Platform APIs, not Genesys Engage GMS Chat/Callback endpoints.";
           result: "genesys-cloud-sdk-not-genesys-engage-gms";
        }];
        defaultRestPolicy: "official-engagement-client-sdk-for-callbacks-with-fail-closed-gms-chat-rest-adapter-and-typed-provider-client-override";
        result: "official-engagement-sdk-for-callbacks-gms-chat-rest-adapter";
        typedClientOverride: "GenesysEngageProviderClient";
     };
  };
  name: "Genesys Engage / GMS";
  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: "genesys-engage.chat.send";
     capability: "send";
     extension: true;
     providerObject: "contact";
   }, {
     alias: "genesys-engage.gms.request";
     capability: "read-provider-object";
     extension: true;
     providerObject: "contact";
  }];
  packageName: "@cognidesk/integration-contact-center-genesys-engage";
  provider: "genesys-engage";
  trustLevel: "official";
}, unknown, {
  contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
  contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-engage.chat.send: (input) => Promise<ProviderJsonObject>;
  genesys-engage.gms.request: (input) => Promise<ProviderJsonObject>;
}>;

Parameters

Parameter Type
options? GenesysEngageIntegrationOptions

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: "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: "Genesys GMS Callback Services API"; url: "https://docs.genesys.com/Documentation/GMS/latest/API/CallbackServicesAPI"; }, { label: "Genesys GMS Chat API v2"; url: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2"; }, { label: "PureEngage engagement-client-js"; url: "https://www.npmjs.com/package/engagement-client-js"; }, { label: "Genesys Cloud Platform SDK for JavaScript"; url: "https://github.com/MyPureCloud/platform-client-sdk-javascript"; }, { label: "PureEngage Engagement Client Library"; url: "https://developer.genesyscloud.com/client-libraries/engagement/js/index.html"; }]; notes: readonly ["Runtime callback scheduling uses the official PureEngage engagement-client-js generated SDK through CallbacksApi.bookCallbackExternal.", "No matching maintained backend/runtime SDK was verified for GMS Chat API v2, so chat operations use the reviewed REST adapter.", "GenesysEngageProviderClient remains available as a typed host override for tenant-specific surfaces and handoff routing."]; scope: "support-workflow-subset"; }; credentialRequirements: readonly [{ id: "genesys-engage-gms-base-url"; label: "Genesys Mobile Services base URL"; required: true; }, { id: "genesys-engage-auth"; label: "Genesys Engage/GMS authentication"; required: false; }, { id: "genesys-engage-routing"; label: "Genesys Engage callback, chat, and routing configuration"; required: false; }]; directions: readonly ["inbound-only", "outbound-only", "bidirectional"]; id: "contact-center.genesys-engage"; maintainers: readonly [{ name: "Cognidesk"; type: "official"; }]; metadata: { implementation: { adapterKind: "official-engagement-sdk-plus-gms-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: "provider-sdk-generated-swagger-client"; id: "createCallback"; method: "POST"; path: "/callback/create"; sdkMethod: "CallbacksApi.bookCallbackExternal"; sdkPackage: "engagement-client-js"; source: "engagement-client-js CallbacksApi.bookCallbackExternal"; }, { alias: "contact-center.contact.start"; checksum: "not-available-html-doc"; id: "requestChat"; method: "POST"; path: "/genesys/2/chat/{serviceName}"; source: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2"; }, { alias: "genesys-engage.chat.send"; checksum: "not-available-html-doc"; id: "sendChatMessage"; method: "POST"; path: "/genesys/2/chat/{serviceName}/{chatId}/send"; source: "https://docs.genesys.com/Documentation/GMS/latest/API/ChatAPIv2"; }, { alias: "genesys-engage.gms.request"; checksum: "not-applicable-host-configured"; id: "providerExtensionRequest"; method: "GET"; path: "host-configured"; source: "provider-rest-adapter"; }]; implementationStrategy: "official-sdk-and-provider-rest-adapter"; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ checkedVersion: "9.0.83"; license: "MIT"; package: "engagement-client-js"; reason: "Official PureEngage Engagement client exposes CallbacksApi.bookCallbackExternal, which backs Cognidesk contact-center.callback.schedule. It does not expose GMS Chat API v2, so chat operations stay on the reviewed REST adapter."; result: "accepted-callback-runtime-sdk"; }, { checkedVersion: "9.0.95"; license: "MIT"; package: "genesys-workspace-client-js"; reason: "Workspace Web Edition client targets workspace voice/call controls rather than GMS Chat API v2 and GMS callback endpoints."; result: "workspace-web-edition-api-not-gms-runtime-client"; }, { checkedVersion: "255.1.0"; license: "MIT"; package: "purecloud-platform-client-v2"; reason: "Maintained SDK targets Genesys Cloud Platform APIs, not Genesys Engage GMS Chat/Callback endpoints."; result: "genesys-cloud-sdk-not-genesys-engage-gms"; }]; defaultRestPolicy: "official-engagement-client-sdk-for-callbacks-with-fail-closed-gms-chat-rest-adapter-and-typed-provider-client-override"; result: "official-engagement-sdk-for-callbacks-gms-chat-rest-adapter"; typedClientOverride: "GenesysEngageProviderClient"; }; sdkDecision: "engagement-client-js is used for callback scheduling through CallbacksApi.bookCallbackExternal. GMS Chat API v2 has no matching maintained backend/runtime SDK in the checked packages, so chat operations use the built-in reviewed REST adapter with providerClient override."; verifiedAt: "2026-06-25"; }; manifestOnlySafe: true; providerRestAdapter: { adapterKind: "official-engagement-sdk-plus-gms-rest-adapter"; providerClientOverride: "GenesysEngageProviderClient"; strategy: "official-sdk-and-provider-rest-adapter"; }; providerSdkDecision: { checkedAt: "2026-06-25"; checkedPackages: readonly [{ checkedVersion: "9.0.83"; license: "MIT"; package: "engagement-client-js"; reason: "Official PureEngage Engagement client exposes CallbacksApi.bookCallbackExternal, which backs Cognidesk contact-center.callback.schedule. It does not expose GMS Chat API v2, so chat operations stay on the reviewed REST adapter."; result: "accepted-callback-runtime-sdk"; }, { checkedVersion: "9.0.95"; license: "MIT"; package: "genesys-workspace-client-js"; reason: "Workspace Web Edition client targets workspace voice/call controls rather than GMS Chat API v2 and GMS callback endpoints."; result: "workspace-web-edition-api-not-gms-runtime-client"; }, { checkedVersion: "255.1.0"; license: "MIT"; package: "purecloud-platform-client-v2"; reason: "Maintained SDK targets Genesys Cloud Platform APIs, not Genesys Engage GMS Chat/Callback endpoints."; result: "genesys-cloud-sdk-not-genesys-engage-gms"; }]; defaultRestPolicy: "official-engagement-client-sdk-for-callbacks-with-fail-closed-gms-chat-rest-adapter-and-typed-provider-client-override"; result: "official-engagement-sdk-for-callbacks-gms-chat-rest-adapter"; typedClientOverride: "GenesysEngageProviderClient"; }; }; name: "Genesys Engage / GMS"; 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: "genesys-engage.chat.send"; capability: "send"; extension: true; providerObject: "contact"; }, { alias: "genesys-engage.gms.request"; capability: "read-provider-object"; extension: true; providerObject: "contact"; }]; packageName: "@cognidesk/integration-contact-center-genesys-engage"; provider: "genesys-engage"; trustLevel: "official"; }, unknown, { contact-center.callback.schedule: (input) => Promise\<ProviderJsonObject>; contact-center.contact.start: (input) => Promise\<ProviderJsonObject>; contact-center.handoff.request: (input) => Promise\<ProviderJsonObject>; genesys-engage.chat.send: (input) => Promise\<ProviderJsonObject>; genesys-engage.gms.request: (input) => Promise\<ProviderJsonObject>; }>

createGenesysEngageIntegrationOperationHandlers()

function createGenesysEngageIntegrationOperationHandlers(options?): {
  contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
  contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-engage.chat.send: (input) => Promise<ProviderJsonObject>;
  genesys-engage.gms.request: (input) => Promise<ProviderJsonObject>;
};

Parameters

Parameter Type
options? GenesysEngageIntegrationOptions

Returns

{
  contact-center.callback.schedule: (input) => Promise<ProviderJsonObject>;
  contact-center.contact.start: (input) => Promise<ProviderJsonObject>;
  contact-center.handoff.request: (input) => Promise<ProviderJsonObject>;
  genesys-engage.chat.send: (input) => Promise<ProviderJsonObject>;
  genesys-engage.gms.request: (input) => Promise<ProviderJsonObject>;
}
Name Type
contact-center.callback.schedule() (input) => Promise\<ProviderJsonObject>
contact-center.contact.start() (input) => Promise\<ProviderJsonObject>
contact-center.handoff.request() (input) => Promise\<ProviderJsonObject>
genesys-engage.chat.send() (input) => Promise\<ProviderJsonObject>
genesys-engage.gms.request() (input) => Promise\<ProviderJsonObject>

References

genesysEngageProviderManifest

Re-exports genesysEngageProviderManifest

genesysEngageProviderManifestInput

Re-exports genesysEngageProviderManifestInput

genesysEngageRestSupportSlice

Re-exports genesysEngageRestSupportSlice

genesysEngageSupportSlice

Re-exports genesysEngageSupportSlice