NICE CXone

https://developer.niceincontact.com
Admin
NICE CXone is a comprehensive cloud-based contact center and customer experience platform providing...
Tokens:1,053,377
Snippets:11,280
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### getConfigurations example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action configuration. Requires a token string.

```typescript
getConfigurations()
```

--------------------------------

### startNewCall() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Starts a new call. Returns a Promise that resolves when the call is started.

```typescript
startNewCall();
```

--------------------------------

### getConfigurationWorkflows example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action workflow data. Requires a configId string.

```typescript
getConfigurationWorkflows('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### getDataMappings example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action data mappings data. Requires a configId string.

```typescript
getDataMappings('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### startConnection example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/UIQueueWsProvider.html

Starts a connection with the provided user information. Accepts a UserInfo object representing the current logged-in user.

```typescript
startConnection(userInfo)
```

--------------------------------

### startPolling example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneSkillAgentsProvider.html

Starts polling for agents assigned to the given skill. Any currently running poll (and its worker) is stopped first. Page size starts at DEFAULT_PAGE_SIZE and only grows when loadMore() is called. The example uses a polling interval of 5000 ms.

```typescript
startPolling(skillId, 5000)
```

--------------------------------

### Start WEM WebSocket

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneNotificationManager.html

Method to start websocket. The example passes locale, timezone, and request data with retry settings.

```typescript
startWemWebsocket('en-US', 'Asia/Calcutta',{maxRetryAttempts:5, retryInterval: 2000})
```

--------------------------------

### runHeartbeat example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WSProvider.html

Starts heartbeat comment for websocket.

```typescript
this.runHeartbeat();
```

--------------------------------

### initializeDigital example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/DigitalContactManager.html

Example call to initialize digital methods like starting websocket and user slot connection.

```typescript
initializeDigital
```

--------------------------------

### startWemWebSocket(requestData) example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WemNotificationProvider.html

This method to start websocket. Returns void or CXoneSdkError.

```typescript
startWebsocket({'en-US', 'Asia/Calcutta',{maxRetryAttempts:5, retryInterval: 2000}});
```

--------------------------------

### Start signal script

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneIndicatorManager.html

Example from the signalScript method documentation showing how to call the method.

```typescript
openSignalScript();
```

--------------------------------

### getDynamicDataMappings example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action dynamic data mappings data. Requires a configId string.

```typescript
getDynamicDataMappings('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### startHeartbeatMonitorFor example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotNotificationClient.html

Example usage of the private startHeartbeatMonitorFor method, which starts a heartbeat monitor for the given state object.

```typescript
startHeartbeatMonitorFor(this.heartbeatState, HEARTBEAT_INTERVAL, 'Heartbeat', this.onClosed())
```

--------------------------------

### Start session example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneSession.html

Starts an agent session with a StartSessionRequest object containing stationId and stationPhoneNumber. Returns a Promise of HttpResponse or CXoneSdkError.

```typescript
@example
const startSessionObj: StartSessionRequest = {
stationId: stationId?.current?.value || '',
stationPhoneNumber: stationPhoneNo?.current?.value || '',
};
const startSession = this.startSession(startSessionObj);
```

--------------------------------

### startVoiceRecordingStatusPolling() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CxOneVoiceRecordingStatusProvider.html

Starts voice recording status polling.

```typescript
this.startVoiceRecordingStatusPolling();
```

--------------------------------

### get example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/HttpClient.html

Performs a GET request to the specified URL with the provided request object. Optionally enables latency measurement via the includeForMeasuringLatency parameter.

```typescript
@example
get('https://nice.dev.cxone.com/getUsers', {body: 'api_request_body'}, true)
```

--------------------------------

### POST API request with Correlation ID and JSON body

Source: https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted

Example of a POST request to the tags endpoint, including a JSON body built with PowerShell. Uses the same Correlation ID as the GET example. The response is not shown.

```powershell
$headers =  @{}
$headers["Authorization"] = "bearer  eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1c2VyOjExZWNiNGQ3LTVjMGUtNDQ5MC1hMTZjLTAyNDJhYzExMDAwMiIsInJvbGUiOnsibGVnYWN5SWQiOiJBZG1pbmlzdHJhdG9yIiwic2Vjb25kYXJ5Um9sZXMiOltdLCJpZCI6IjExZWJjODJkLWM1ZTItYTJlMC04MTk0LTAyNDJhYzExMDAwMiIsImxhc3RVcGRhdGVUaW1lIjoxNjY0Nzk5MTA0MjQ2fSwiaWNBZ2VudElkIjoiMjQyMTEiLCJpc3MiOiJodHRwczpcL1wvYXV0aC5kZXYubmljZS1pbmNvbnRhY3QuY29tIiwiZ2l2ZW5fbmFtZSI6IkltZGFkdWwiLCJhdWQiOiJpbnRlcm5hbEBpbmNvbnRhY3QgaW5jLiIsImljU1BJZCI6IjI3IiwiaWNCVUlkIjo0NjY5LCJuYW1lIjoiaW1kYWR1bC5zaGFyaWZAZG83Mi5jb20iLCJ0ZW5hbnRJZCI6IjExZWJjODJkLWJmZTgtNTUxMC05MGNkLTAyNDJhYzExMDAwMiIsImV4cCI6MTY2NDg2NjAzNywiaWF0IjoxNjY0ODYyNDM3LCJmYW1pbHlfbmFtZSI6IlNoYXJpZiIsInRlbmFudCI6InBlcm1fcHVuZV9hcGlfZG83MjQyMTkyMTMzIiwidmlld3MiOnt9LCJpY0NsdXN0ZXJJZCI6IkRPNzIifQ.YSFyyCc3aZ6u1IgOBQUdB7bR3ueSS2FlbGw9WDrXGgCyQrOP9Q1ZaHCJj-QVP9_A93NAz_aMiOfwYlwJzA6yiq6VmiWAEnLuxAoopz-8RCnVYG50QyjkmERwdgmx58ueZSQ_nUQS2qmGkk3O1JIKftxwqORXQWg8QxkWjQBTjsI"
$headers["x-Correlation-ID"] = "29d7c6fc-5535-4cb4-83e5-90d9e0aa6d61"
$headers["content-type"] = "application/json"
$headers["Accept"] = "application/json"


$postParams = @{
                "tagName" = "testTag"  
                "notes" = "testing"
                } | ConvertTo-Json


curl -v -Uri https://api-do72.dev.nice-incontact.com/InContactAPI/services/v7.0/tags -Headers $headers -Body $postParams -Method Post
```

--------------------------------

### initialize example using AdminService.instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Example call for the initialize method, which initializes user details (cxoneConfig, userInfo, accessToken).

```typescript
const agentSession = AdminService.instance.initialize(accessToken, config, userInfo);
```

--------------------------------

### GET API request with Correlation ID

Source: https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted

Example of a GET request to the agents endpoint with a real authorization token and a specific Correlation ID. The response includes the X-Correlation-ID header echoing the provided ID.

```powershell
$headers =  @{}
$headers["Authorization"] = "bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1c2VyOjExZWNiNGQ3LTVjMGUtNDQ5MC1hMTZjLTAyNDJhYzExMDAwMiIsInJvbGUiOnsibGVnYWN5SWQiOiJBZG1pbmlzdHJhdG9yIiwic2Vjb25kYXJ5Um9sZXMiOltdLCJpZCI6IjExZWJjODJkLWM1ZTItYTJlMC04MTk0LTAyNDJhYzExMDAwMiIsImxhc3RVcGRhdGVUaW1lIjoxNjY0Nzk5MTA0MjQ2fSwiaWNBZ2VudElkIjoiMjQyMTEiLCJpc3MiOiJodHRwczpcL1wvYXV0aC5kZXYubmljZS1pbmNvbnRhY3QuY29tIiwiZ2l2ZW5fbmFtZSI6IkltZGFkdWwiLCJhdWQiOiJpbnRlcm5hbEBpbmNvbnRhY3QgaW5jLiIsImljU1BJZCI6IjI3IiwiaWNCVUlkIjo0NjY5LCJuYW1lIjoiaW1kYWR1bC5zaGFyaWZAZG83Mi5jb20iLCJ0ZW5hbnRJZCI6IjExZWJjODJkLWJmZTgtNTUxMC05MGNkLTAyNDJhYzExMDAwMiIsImV4cCI6MTY2NDg2NjAzNywiaWF0IjoxNjY0ODYyNDM3LCJmYW1pbHlfbmFtZSI6IlNoYXJpZiIsInRlbmFudCI6InBlcm1fcHVuZV9hcGlfZG83MjQyMTkyMTMzIiwidmlld3MiOnt9LCJpY0NsdXN0ZXJJZCI6IkRPNzIifQ.YSFyyCc3aZ6u1IgOBQUdB7bR3ueSS2FlbGw9WDrXGgCyQrOP9Q1ZaHCJj-QVP9_A93NAz_aMiOfwYlwJzA6yiq6VmiWAEnLuxAoopz-8RCnVYG50QyjkmERwdgmx58ueZSQ_nUQS2qmGkk3O1JIKftxwqORXQWg8QxkWjQBTjsI"
$headers["x-Correlation-ID"] = "29d7c6fc-5535-4cb4-83e5-90d9e0aa6d61"
$headers["content-type"] = "application/json"
$headers["Accept"] = "application/json"

curl -V -Uri https://api-do72.dev.nice-incontact.com/InContactAPI/services/v24.0/agents/24211 -Headers $headers -Method Get 
```

--------------------------------

### init(authSettings) example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAuth.html

Initializes the auth settings. Example shows passing a hostname and clientId.

```typescript
init({'cxoneHostname': 'https://cxone.dev.niceincontact.com', 'clientId': 'Salesforce Agent Console@inContact Inc.'})
```

--------------------------------

### Get CXoneEventMessenger singleton instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneEventMessenger.html

Example of accessing the static instance accessor to get the singleton object of the class. Note: the example uses CXoneAcdClient.instance() but the accessor is for CXoneEventMessenger.

```typescript
@example
const cxoneAcdClient = CXoneAcdClient.instance();
```

--------------------------------

### setUpDeviceSync() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Sets up device sync. Returns a Promise that resolves when device sync is set up.

```typescript
setUpDeviceSync();
```

--------------------------------

### setSelectedTabs example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDynamicDirectory.html

Example for setSelectedTabs method, used to get the selected tab.

```typescript
this.setSelectedTabs();
```

--------------------------------

### initialize(accessToken, config, userInfo)

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Method to initialize the user details (i.e) cxoneConfig, userInfo and accessToken.

```APIDOC
## initialize(accessToken, config, userInfo)

### Description
Method to initialize the user details (i.e) cxoneConfig, userInfo and accessToken.

### Method
initialize

### Signature
`initialize(accessToken: string, config: CXoneConfiguration, userInfo: UserInfo): void`

### Parameters
- **accessToken** (string) - Required - Access token
- **config** (CXoneConfiguration) - Required - cxoneConfig object
- **userInfo** (UserInfo) - Required - user info object

### Returns
void

### Request Example
```typescript
const agentSession = AdminService.instance.initialize(accessToken, config, userInfo);
```
```

--------------------------------

### POST /scripts/start

Source: https://developer.niceincontact.com/API/AdminAPI#/General/post-start-script

Starts a Script. This method will start a script that is identified by scriptId. Currently this only supports channel related scripts such as Email, Phone, Chat etc. You cannot start Generic or API scripts using this method. We plan to provide this additional functionality in a later release. This method also requires a Skill identified by skillId through which the script can be run. In order for the skill to be valid the media type of the script must match the media type of the skill. You can also send up to 20 separate values into the script using the parameters parameter separated by the | symbol. These will be assigned to ascending parameters named P1, P2, P3... for access in Studio.

```APIDOC
## [POST] /scripts/start

### Description
Starts a Script. This method will start a script that is identified by scriptId. Currently this only supports channel related scripts such as Email, Phone, Chat etc. You cannot start Generic or API scripts using this method. We plan to provide this additional functionality in a later release. This method also requires a Skill identified by skillId through which the script can be run. In order for the skill to be valid the media type of the script must match the media type of the skill. You can also send up to 20 separate values into the script using the parameters parameter separated by the | symbol. These will be assigned to ascending parameters named P1, P2, P3... for access in Studio.

### Method
POST

### Endpoint
/scripts/start

### Parameters
#### Query Parameters
- **skillId** (integer) - Required - ACD skill ID
- **scriptId** (string) - Required - Script ID
- **scriptPath** (string) - Required - Script Path
- **Parameters** (string) - Optional - A string of | delimited values i.e. "value1|value2|..."
- **startDate** (string) - Optional - ISO 8601 time for script to start in the future
```

--------------------------------

### getScriptByName example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Method to call the script to get the skill Id. Note: the example uses getScriptData, which may be a typo.

```typescript
getScriptData('scriptName');
```

--------------------------------

### Constructor Example: new DirectoryBase()

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDirectory.html

Creates an instance of the directory session and initializes it. The example shows the constructor call without arguments.

```typescript
new DirectoryBase();
```

--------------------------------

### initJabraSdk() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Initializes the Jabra SDK and sets up the EasyCallControlFactory. Returns a Promise.

```typescript
new JabraSdkService()
```

--------------------------------

### startGetNextEvents example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACDSessionManager.html

Starts the get-next events process. The example assigns the method reference to a variable.

```typescript
const startGetNextEvents = agentSession.startGetNextEvents
```

--------------------------------

### getEWEWorkflowsTestResult example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action Test Summary data. Note: the example uses 'getTestSearchWorkflows' instead of the method name.

```typescript
getTestSearchWorkflows('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### launchCXoneAgent() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAuth.html

Launches the CXoneAgent application from the SDK. Takes a target div id, app URL, and style parameters.

```typescript
launchCXoneAgent('divId','https://cxagent.nicecxone-dev.com?src=UH',{width:'400px', height:'500px'});
```

--------------------------------

### getTagsOnContactEvent example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ContactManager.html

Example call to get tags for CallContactEvents and VoiceMailContactEvents. Requires skillId and contactId parameters.

```typescript
getTagsOnContactEvent(1234, 4321)
```

--------------------------------

### Create WSService instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WSService.html

Constructor example for creating a new WSService instance.

```typescript
new WSService();
```

--------------------------------

### getWorkflowsEntitiesFields example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action workflow data. Requires a configId string.

```typescript
getWorkflowsEntitiesFields('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### Run unit tests

Source: https://developer.niceincontact.com/Content/sdk-docs/index.html

Run all unit tests using npm.

```bash
npm run test
```

--------------------------------

### getWorkflowsEntities example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentIntegrationConfigurationService.html

Example call to get studio action workflow data. Requires a configId string.

```typescript
getWorkflowsEntities('01899438-147f-433b-945b-f1fde6d91877')
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAgentSetting.html

Creates a new instance of CXoneAgentSetting and initializes the adminService.

```APIDOC
## constructor

### Description
Creates a new instance of CXoneAgentSetting and initializes the adminService.

### Method
constructor

### Signature
`new CXoneAgentSetting(): CXoneAgentSetting`

### Request Example
```
const cxoneAgentSetting = new CXoneAgentSetting();
```

### Returns
CXoneAgentSetting
```

--------------------------------

### init

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACWebRtcService.html

Initializes the service with the provided options. This method sets up the service with the given connection options.

```APIDOC
## init

### Description
Initializes the service with the provided options.

### Method
init

### Parameters
- **options** (CXoneVoiceConnectionOptions) - Required - The connection options.

### Returns
void
```

--------------------------------

### init

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAuth.html

Initializes the authentication settings for the SDK.

```APIDOC
## init

### Description
Initializes the authentication settings for the SDK.

### Method
init

### Signature
init(authSettings: AuthSettings): void

### Parameters
- **authSettings** (AuthSettings) - Required - The authentication settings to initialize.

### Returns
void

### Request Example
```
init({'cxoneHostname': 'https://cxone.dev.niceincontact.com', 'clientId': 'Salesforce Agent Console@inContact Inc.'})
```
```

--------------------------------

### getSmartReachDispositionsOnContactEvent example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ContactManager.html

Example call to get Smartreach dispositions for CallContactEvents. Requires skillId, contactId, and mediaType parameters.

```typescript
getSmartReachDispositionsOnContactEvent(1234, 4321, MediaType.VOICE)
```

--------------------------------

### startWebSocket(): void

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDigitalWebsocket.html

Opens the webSocket data.

```APIDOC
## startWebSocket(): void

### Description
Used to open the webSocket data.

### Returns
void

### Example
```
startWebSocket();
@param heartBeatIntervalMilliSec - time in milliseconds(Default = 5000 miliseconds)
```
```

--------------------------------

### Create CXonePermission instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAgentPermission.html

Example from the constructor section showing how to instantiate CXonePermission, which is used to get an instance for CXonePermission and adminService.

```typescript
const cxonePermission = new CXonePermission();
```

--------------------------------

### POST /skills/{skillId}/start

Source: https://developer.niceincontact.com/API/AdminAPI#/Skills

Start a Personal Connection Skill.

```APIDOC
## [POST] /skills/{skillId}/start

### Description
Start a Personal Connection Skill.

### Method
POST

### Endpoint
/skills/{skillId}/start

### Parameters
#### Path Parameters
- **skillId** (string) - Required - The ID of the skill.
```

--------------------------------

### stringifyLogLevel: Get log level value

Source: https://developer.niceincontact.com/Content/sdk-docs/modules.html

Gets the log level value as a string. The example shows that passing 2 returns 'INFO'.

```typescript
// Gets value as INFO
stringifyLogLevel(2) 
```

--------------------------------

### Create AgentStateService instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentStateService.html

Constructor example showing how to instantiate the AgentStateService class.

```typescript
const agentState = new AgentStateService();
```

--------------------------------

### getPresenceSyncWSUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the Presence sync WS URL. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
getPresenceSyncWSUri('na1','staging.niceincontact.com');
```

--------------------------------

### GET /points-of-contact

Source: https://developer.niceincontact.com/API/AdminAPI#/General/getPointsOfContact

Returns a list of points of contact. A point of contact is essentially an "address" where patrons can request an interaction with an agent. For example, a point of contact for the phone channel would be a phone number that someone can dial. A point of contact for the email channel would be an email address to which they can send emails. A point of contact for a work item or chat channel is a GUID for each channel, which applications can use to get chat requests or work items into queue.

```APIDOC
## [GET] /points-of-contact

### Description
Returns a list of points of contact. A point of contact is essentially an "address" where patrons can request an interaction with an agent. For example, a point of contact for the phone channel would be a phone number that someone can dial. A point of contact for the email channel would be an email address to which they can send emails. A point of contact for a work item or chat channel is a GUID for each channel, which applications can use to get chat requests or work items into queue.

### Method
GET

### Endpoint
/points-of-contact

### Parameters
#### Query Parameters
- **mediaTypeId** (integer) - Optional - ID of Media Type to filter by. Allowable values can be retrieved using **GET /media-types** API. The pick list here is for ease of use in the Portal. Available values: 1, 3, 4, 5, 6
- **skip** (integer) - Optional - Number of records to skip in the results
- **top** (integer) - Optional - Number of records to return in the results

### Response
#### Success Response (200)
- **businessUnitId** (integer) - The business unit ID.
- **lastPollTime** (string) - The last poll time.
- **pointsOfContact** (array) - List of points of contact.
  - **businessUnitId** (integer) - The business unit ID.
  - **contactAddress** (string) - The contact address.
  - **contactCode** (integer) - The contact code.
  - **contactDescription** (string) - The contact description.
  - **defaultSkillId** (integer) - The default skill ID.
  - **isActive** (boolean) - Whether the point of contact is active.
  - **mediaTypeId** (integer) - The media type ID.
  - **subType** (string) - The sub type.
  - **mediaTypeName** (string) - The media type name.
  - **notes** (string) - Notes.
  - **outboundSkill** (boolean) - Whether it is an outbound skill.
  - **scriptName** (string) - The script name.

#### Response Example
```json
{
  "businessUnitId": 0,
  "lastPollTime": "2026-11-10T19:30:50.410Z",
  "pointsOfContact": [
    {
      "businessUnitId": 0,
      "contactAddress": "string",
      "contactCode": 0,
      "contactDescription": "string",
      "defaultSkillId": 0,
      "isActive": true,
      "mediaTypeId": 0,
      "subType": "string",
      "mediaTypeName": "string",
      "notes": "string",
      "outboundSkill": true,
      "scriptName": "string"
    }
  ]
}
```
```

--------------------------------

### grafanaInit - Initialize Grafana Faro

Source: https://developer.niceincontact.com/Content/sdk-docs/modules.html

Initializes Grafana Faro for log collection. Requires agentSettings and userInfo from backend, an optional appName (default 'cxa'), grafanaFaroUri, and an optional grafanaFaroKey. Returns void.

```typescript
grafanaInit(agentSettings, userInfo, appName, grafanaFaroUri);
```

--------------------------------

### loadMore example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneSkillAgentsProvider.html

Expands the visible page by DEFAULT_PAGE_SIZE, reading the next slice from IDB. The example shows startPolling first to display the first 25, then loadMore to display the first 50.

```typescript
startPolling(skillId);  // shows first 25
loadMore();             // shows first 50
```

--------------------------------

### Get agent message notification

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneNotificationManager.html

Method to get agent message notification. The example shows calling the method with no arguments.

```typescript
this.getAgentMessageNotification();
```

--------------------------------

### Create TeamService instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/TeamService.html

Constructor example showing how to instantiate the TeamService class.

```typescript
const TeamService = new TeamService();
```

--------------------------------

### Response of GET API with X-Correlation-ID

Source: https://developer.niceincontact.com/Documentation/CorrelationIdGettingStarted

HTTP response headers from the GET request, showing the echoed X-Correlation-ID header and other server details. Useful for verifying that the Correlation ID is returned in the response.

```http
HTTP/1.1 200 Success
Date: Tue, 04 Oct 2022 05:54:42 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 2832
Connection: keep-alive
Set-Cookie: AWSALB=QPdTfDlGPznsXMYThl3dUJoFXs51RkncnbJHcq1caUGMfV8YEgXi51Nnj71CB1jJGCblp9GXU1a/SmtP3H8lTgc2qD+U7bSqVO3W3/kow1f6PD7NHj/fbovvGKUL; Expires=Tue, 11 Oct 2022 05:54:41 GMT; Path=/
Set-Cookie: AWSALBCORS=QPdTfDlGPznsXMYThl3dUJoFXs51RkncnbJHcq1caUGMfV8YEgXi51Nnj71CB1jJGCblp9GXU1a/SmtP3H8lTgc2qD+U7bSqVO3W3/kow1f6PD7NHj/fbovvGKUL; Expires=Tue, 11 Oct 2022 05:54:41 GMT; Path=/; SameSite=None; Secure
Cache-Control: private, no-store, s-maxage=0
Pragma: no-cache
Server: Microsoft-IIS/8.5
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS
Access-Control-Expose-Headers: Content-Encoding,icServerTime,Date,icBranchValue,icServerName,icStatusDescription
X-Correlation-ID: 29d7c6fc-5535-4cb4-83e5-90d9e0aa6d61
icServerTime: 2022-10-04T05:54:42.041Z
icServerName: DOA-C72API01
icBranchValue: 1
icStatusDescription: Success
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Strict-Transport-Security: max-age=31536000; includeSubDomains
```

--------------------------------

### getPresenceSyncUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the Presence sync URL. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
getPresenceSyncUri('na1','staging.niceincontact.com');
```

--------------------------------

### connectSocket example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDynamicDirectory.html

Example for mergeSearchResults and socketMessageHandler methods, showing how to connect the WebSocket.

```typescript
this.connectSocket();
```

--------------------------------

### Create a new CXoneDigitalClient instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDigitalClient.html

Use the constructor to get an instance for agent auth and session. This example shows how to instantiate the client.

```typescript
const cxoneDigitalClient = new CXoneDigitalClient();
```

--------------------------------

### getAaiTranscriptWsUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the agent assist transcript WS URI. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
getAaiTranscriptWsUri('na1','staging.niceincontact.com');
```

--------------------------------

### getWorker method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/LoadWorker.html

Use to get worker after initializing based on worker name. The example shows calling getWorker with workerScriptName and workerName parameters.

```typescript
this.getWorker(workerScriptName,workerName);
```

--------------------------------

### init(acdAgentId: string, options: CXoneVoiceConnectionOptions, audioElement: HTMLAudioElement, appName: string): void

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACWebRtcService.html

Method to init and connect to audio code server.

```APIDOC
## init(acdAgentId: string, options: CXoneVoiceConnectionOptions, audioElement: HTMLAudioElement, appName: string): void

### Description
Method to init and connect to audio code server.

### Parameters
- **acdAgentId** (string) - Required - The ACD agent ID.
- **options** (CXoneVoiceConnectionOptions) - Required - The voice connection options.
- **audioElement** (HTMLAudioElement) - Required - The audio element.
- **appName** (string) - Required - The application name.

### Returns
void

### Request Example
```typescript
webRtcService.init("12345", options, audioElement);
```
```

--------------------------------

### Get agent state

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentStateService.html

Method call example for getAgentState().

```typescript
getAgentState()
```

--------------------------------

### Install dependencies with yarn

Source: https://developer.niceincontact.com/Content/sdk-docs/index.html

Run `yarn install` to install dependencies. If you encounter the error "Couldn't find package", it may be caused by npm private repository; temporarily comment out the `.npmrc` line `registry=https://nice-devops-369498121101.d.codeartifact.us-west-2.amazonaws.com/npm/cxone-npm/`.

```bash
yarn install
```

--------------------------------

### Constructor example: new ACWebRtcService()

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACWebRtcService.html

Shows how to instantiate the ACWebRtcService class. The constructor initializes the service for Integrated Softphone tasks.

```typescript
const webRtcService = new ACWebRtcService();
```

--------------------------------

### getANI example

Source: https://developer.niceincontact.com/Content/sdk-docs/modules.html

Gets the ANI (Automatic Number Identification) from a voice contact object.

```typescript
getANI(voiceContact)
```

--------------------------------

### connectNewGenSocket example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WSProvider.html

Connects the WebSocket - NewGen.

```typescript
this.connectNewGenSocket();
```

--------------------------------

### getAllSkillsList example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/SkillService.html

Returns agent skills with optional filters. The example passes mediaTypeId 4, startIndex 1, recordsToLoad 5, searchText 'call', and forceFetch false.

```typescript
getAllSkillsList(4,1,5,'call',false)
```

--------------------------------

### getCXoneConfiguration example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAuth.html

Call to retrieve CXone configuration for authentication. Requires hostname and tenantId; isUserHub is optional in the example.

```typescript
getCXoneConfiguration('https://cxone.dev.niceincontact.com','11e85da0-f32c-7e10-898c-0242ac110003');
```

--------------------------------

### Get digital user details

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDigitalClient.html

Get digital logged in user details like UserId to call other digital APIs. This example shows how to call getDigitalUserDetails.

```typescript
getDigitalUserDetails();
```

--------------------------------

### promiseKeeper example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CommitmentService.html

Gets PromiseKeeper event. Requires a CommitmentEvent object.

```typescript
@example
this.promiseKeeper(callDetails);
```

--------------------------------

### init('12345', options, audioElement)

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACWebRtcService.html

Initializes and connects to the audio code server. Takes acdAgentId, options, audioElement, and appName parameters.

```typescript
webRtcService.init("12345", options, audioElement);
```

--------------------------------

### getAPIFacadeBaseUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the API facade base URI. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
@example
getAPIFacadeBaseUri('na1','staging.niceincontact.com');
```

--------------------------------

### Get agent state details

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentStateService.html

Method call example for getAgentStateDetails().

```typescript
getAgentStateDetails();
```

--------------------------------

### startPolling example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneSkillActivityProvider.html

Initiates polling for skill activity data. Creates a new CXoneSkillActivityProvider instance and calls startPolling.

```typescript
const skillActivityProvider = new CXoneSkillActivityProvider();
this.skillActivityProvider.startPolling();
```

--------------------------------

### startRequestTrackerCleanup() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/RequestManager.html

Starts periodic cleanup of expired request trackers.

```typescript
this.startRequestTrackerCleanup()
```

--------------------------------

### requestDirectoryData example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDirectoryProvider.html

Initiates polling for directory data. Creates a CXoneDirectoryProvider instance and starts polling.

```typescript
const directoryProvider = new CXoneDirectoryProvider();
this.directoryProvider.startPolling();
```

--------------------------------

### HttpResponse toString method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/HttpResponse.html

Returns a string response from a method call. The example shows calling the string() method to get the stringified values for an http response.

```typescript
@example
const responseString = this.string();
```

--------------------------------

### getDirectories example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDynamicDirectory.html

Retrieves directories for a given agent with pagination. The example shows calling with agentId 1234, startIndex 0, and totalRecords 25, which gets directories from 0 to 25.

```typescript
@example
getDirectories(1234,0,25)
This will get directories from 0 to 25 for agent id 1234
```

--------------------------------

### Create a new DigitalService instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/DigitalService.html

Use the constructor to instantiate a DigitalService object. The example shows the basic usage without any arguments.

```typescript
const digitalSvc = new DigitalService();
```

--------------------------------

### Get appenders with getAppenders

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/LoggerConfig.html

Example of the getAppenders method. Returns the array of appenders.

```typescript
getAppenders();
```

--------------------------------

### Get team unavailable codes

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentStateService.html

Method call example for getTeamUnavailableCodes(updateCache).

```typescript
getTeamUnavailableCodes(updateCache);
```

--------------------------------

### Serve cxone-agent-host with NX

Source: https://developer.niceincontact.com/Content/sdk-docs/index.html

Use NX Console to serve the `cxone-agent-host` project, or execute this command in a separate terminal window.

```bash
yarn nx serve cxone-agent-host
```

--------------------------------

### registerAgentAssistGetNextSubject example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentAssistWSService.html

Registers a subscription to the agentAssistGetNextEventSubject for getting the AgentAssist getnext event.

```typescript
this.registerAgentAssistGetNextSubject();
```

--------------------------------

### getAllAgentAssistGetNextFromIndexDb example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentAssistProcessorService.html

Gets GetNext event data from indexdb. Returns a Promise<AgentAssistWSRequest[]>.

```typescript
agentAssistProcessorService.getAllAgentAssistGetNextFromIndexDb();
```

--------------------------------

### getTimeStampOffset example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Method to get time stamp offset. Returns a promise resolving to a number or CXoneSdkError.

```typescript
getTimeStampOffset()
```

--------------------------------

### Create Groups Response Example

Source: https://developer.niceincontact.com/API/AdminAPI#/Groups/postgroups

Example response for POST /groups. Shows success and error fields for each group result.

```json
{
  "errorCount": 0,
  "groupResults": [
    {
      "success": true,
      "groupId": 0,
      "error": "string"
    }
  ]
}
```

--------------------------------

### getAgentSettings example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Method to return agent settings. Returns a promise resolving to AgentSettings.

```typescript
getAgentSettings()
```

--------------------------------

### getDirectoryMetadata example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDynamicDirectory.html

Retrieves directory metadata for a given directory and agent. The example shows calling with directoryId 5678 and agentId 1234, which gets metadata for agent 1234 and directory 5678.

```typescript
getDirectoryMetadata(5678, 1234);
```

--------------------------------

### spawnScript example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AdminService.html

Example call for the spawnScript method, which calls spawn script.

```typescript
spawnScript();
```

--------------------------------

### formWssUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns a wss connection URL with query parameters. Parameters: userHubArea (UserHub region), domain (root domain), wsQueryParams (object containing tenant & user id).

```typescript
formWssUri(userHubArea, domain, wsQueryParams);
```

--------------------------------

### getWebHidConsent() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Gets webHID consent. Returns a Promise that resolves when consent is obtained.

```typescript
getWebHidConsent();
```

--------------------------------

### getAahNotificationWssUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the agent assist notification WS URL. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
getAahNotificationWssUri('na1','staging.niceincontact.com');
```

--------------------------------

### getAgentFirstName example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotService.html

Calls getAgentFirstName to get the first name of the logged-in agent. Returns any.

```typescript
copilotService.getAgentFirstName();
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CxoneHeadsetClient.html

Initializes the CxoneHeadsetClient instance, setting up the session manager and Jabra SDK service.

```APIDOC
## constructor

### Description
Initializes the CxoneHeadsetClient instance, setting up the session manager and Jabra SDK service.

### Method
constructor

### Signature
`new CxoneHeadsetClient(): CxoneHeadsetClient`

### Example
```typescript
new CxoneHeadsetClient()
```

#### Returns
CxoneHeadsetClient
```

--------------------------------

### getCommitments example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CommitmentService.html

Gets all commitments for a given agent. Requires a unique agentId number.

```typescript
getCommitments(1464319);
```

--------------------------------

### connect(websocketUrl: string, wsWorker?: any): void

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneDigitalWebsocket.html

Makes a connection with the websocket server.

```APIDOC
## connect(websocketUrl: string, wsWorker?: any): void

### Description
This function used to make connection with websocket server.

### Parameters
- **websocketUrl** (string) - Required
- **wsWorker** (any) - Optional

### Returns
void

### Example
```
connect('ws://localhost:8089');
```
```

--------------------------------

### Get access token by code (getAccessTokenByCode)

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAuth.html

Generates an access token and calls getCXoneConfiguration to get the API endpoint URL. The example shows passing a request object with client ID and generated code.

```typescript
getAccessTokenByCode({'Salesforce Agent Cons..', 'eyJ0eXAiOiJKV1Qi...'})
```

--------------------------------

### Create AddressBookService instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AddressBookService.html

Example showing how to instantiate the AddressBookService class. The constructor returns a new AddressBookService object.

```typescript
@example
const adminService = new AdminService();
```

--------------------------------

### getConnectionMessage method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WSService.html

Calls getConnectionMessage('heartbeat') to get a connection message with the specified type.

```typescript
this.getConnectionMessage('heartbeat');
```

--------------------------------

### getDfoAppBaseUri example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneConfiguration.html

Returns the DFO APP base URI version 2.0, to be replaced by latest 3.0 API once available. Example uses 'na1' and 'staging.niceincontact.com'.

```typescript
@example
getDfoAppBaseUri('na1','staging.niceincontact.com');
```

--------------------------------

### getWemNotificationPollingConfig() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WemNotificationProvider.html

Use to get polling request parameters for leader election. Returns WemNotificationRequestData.

```typescript
this.getWemNotificationPollingConfig();
```

--------------------------------

### Serve cxone-agent with NX

Source: https://developer.niceincontact.com/Content/sdk-docs/index.html

Use NX Console to serve the `cxone-agent` project, or execute this command in a separate terminal window.

```bash
yarn nx serve cxone-agent
```

--------------------------------

### init method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/FeatureToggleService.html

Initialize the feature toggle service with an access token and base URL. Required before using other methods.

```typescript
init('accessToken', 'baseUrl');
```

--------------------------------

### getDigitalAvailableLanguagesForTranslation example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/DigitalService.html

Calls getDigitalAvailableLanguagesForTranslation to get available languages for translation. Returns a Promise<CXoneDigitalTranslationLanguages>.

```typescript
getDigitalAvailableLanguagesForTranslation();
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneEventHubProvider.html

Creates a new instance of the CXoneEventHubProvider class.

```APIDOC
## constructor

### Description
Creates a new instance of the CXoneEventHubProvider class.

### Method
constructor

### Returns
CXoneEventHubProvider
```

--------------------------------

### getValidCallId() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Gets a valid call ID. Returns a string representing the call ID.

```typescript
getValidCallId();
```

--------------------------------

### Get log level with getLevel

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/LoggerConfig.html

Example of the getLevel method. Returns the current log level.

```typescript
getLevel();
```

--------------------------------

### getTaskResponse example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotService.html

Calls getTaskResponse with an intent name and contact ID to get a task response.

```javascript
copilotService.getTaskResponse('Task intent name here', '12321');
```

--------------------------------

### Create AgentAssistBaseResponse instance

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/AgentAssistBaseResponse.html

Example from the constructor documentation showing how to instantiate AgentAssistBaseResponse. The constructor takes a command string and response header object, and returns an AgentAssistBaseResponse instance.

```typescript
const AgentAssistBaseResponse = new AgentAssistBaseResponse();
```

--------------------------------

### getTaskAssistFormPreFilledData example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotService.html

Calls getTaskAssistFormPreFilledData with a task intent name to get pre-filled form data.

```javascript
copilotService.getTaskAssistFormPreFilledData('Task intent name here');
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/WSService.html

Creates an instance of the WSService class for WebSocket service.

```APIDOC
## constructor

### Description
Creates an instance of the WSService class for WebSocket service.

### Method
constructor

### Signature
`new WSService(): WSService`

### Returns
- **WSService** - The new WSService instance

### Request Example
```
new WSService();
```
```

--------------------------------

### getLsDataByAgentId example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotService.html

Calls getLsDataByAgentId with no arguments to get local storage data by the agent ID.

```javascript
copilotService.getLsDataByAgentId();
```

--------------------------------

### getAgentAssistConfig example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CopilotService.html

Calls getAgentAssistConfig with contactId and optional isObjectFlag to get AAH config. Returns any.

```typescript
copilotService.getAgentAssistConfig('12321',false);
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAcdClient.html

Creates a new instance of CXoneAcdClient for agent authentication and session management.

```APIDOC
## constructor

### Description
Creates a new instance of CXoneAcdClient for agent authentication and session management.

### Method
constructor

### Signature
`new CXoneAcdClient(): CXoneAcdClient`

### Request Example
```typescript
const cxoneAcdClient = new CXoneAcdClient();
```

### Returns
CXoneAcdClient
```

--------------------------------

### getUserLocation example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneUser.html

Method to get user location. Returns a Promise resolving to CXoneSdkError or UserLocation.

```typescript
getUserLocation();
```

--------------------------------

### constructor

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXonePartnerPresenceSyncRuleMapping.html

Creates a new instance of the CXonePartnerPresenceSyncRuleMapping class.

```APIDOC
## new CXonePartnerPresenceSyncRuleMapping()

### Description
Creates a new instance of the CXonePartnerPresenceSyncRuleMapping class.

### Returns
- **CXonePartnerPresenceSyncRuleMapping** - A new instance of the class.
```

--------------------------------

### getSkillsFromIndexDB example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneSkillActivityProvider.html

Gets skill data from index DB. Returns a Promise that resolves to void.

```typescript
getSkillsFromIndexDB();
```

--------------------------------

### initAll() example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/JabraSdkService.html

Initializes all the methods. Returns a Promise that resolves when initialization is complete.

```typescript
initAll();
```

--------------------------------

### getNextEventHandler method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneEventMessenger.html

Gets the next event received. Takes no parameters and returns void.

```typescript
onGetNextEventReceived();
```

--------------------------------

### loginAudioCodeServer()

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/ACWebRtcService.html

Initiates the Audio Codes server. Private method.

```typescript
this.loginAudioCodeServer();
```

--------------------------------

### startSocketHeartBeat example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/UIQueueWsProvider.html

Sends a heartbeat. Requires agentId and tenantId parameters.

```typescript
startSocketHeartBeat(agentId, tenantId)
```

--------------------------------

### getEventsFromState method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneEventMessenger.html

Gets events from state. Takes a PostMessageEvent subscriber and returns an array of any.

```typescript
getEventsFromState(subscriberObject);
```

--------------------------------

### getNotificationSettings method example

Source: https://developer.niceincontact.com/Content/sdk-docs/classes/CXoneAgentSetting.html

Gets favorite quick replies. Returns a Promise resolving to CXoneAudioVisualNotificationSettings.

```typescript
getNotificationSettings()
```
Tokens:
Raw