### Initialize and Run Premium App Wizard Locally

Source: https://developer.genesys.cloud/appfoundry/premium-app-wizard

Commands to install project dependencies and start the local development server for the Premium Application Install Wizard.

```bash
npm i
node index
```

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

### Enable Custom Setup Page Before Install

Source: https://developer.genesys.cloud/appfoundry/premium-app-wizard/6-wizard-config-parameters.md

Controls the visibility of the optional 'Step 2' in the provisioning process. If set to false, the custom setup page and its step in the wizard will not be displayed.

```javascript
enableCustomSetupPageBeforeInstall: true
```

```javascript
enableCustomSetupPageBeforeInstall: false
```

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

### Run Project Locally

Source: https://developer.genesys.cloud/api/tutorials/agent-chat-assistant?language=javascript&step=1

Commands to install project dependencies and start the local server for development and testing.

```bash
npm install
```

```bash
node run-local.js
```

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

### Post Custom Setup Installed Data Structure

Source: https://developer.genesys.cloud/appfoundry/premium-app-wizard/7-custom-setup.md

An example of the structure for installedData passed to the post-custom-setup module. It contains arrays of provisioned Genesys Cloud entities categorized by module keys.

```javascript
{
  role: [{...}, {...}],
  group: [{...}],
  ...
}
```

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

### Basic WebRTC SDK Media Utility Usage

Source: https://developer.genesys.cloud/devapps/webrtcsdk/media.md

This example demonstrates initializing the SDK, managing media state synchronization, requesting audio permissions, starting an audio stream, and accepting a session. It assumes an initialized SDK instance is available. Ensure proper error handling for permission denials.

```typescript
import { ISdkMediaState, SdkMediaStateWithType } from 'genesys-cloud-webrtc-sdk';

/* async function for demonstration */
async function run () {

  /* fetch the beginning media state sync synchronously, then update it in the `on('state')` listener */
  let mediaState: ISdkMediaState = sdk.media.getState();

  sdk.media.on('state', (state: SdkMediaStateWithType) => {
    // emits every time devices or permissions change
    // this value can always be synchronously attained
    // using `sdk.media.getState()`
    mediaState = state;
  });

  /* request permissions for the desired media types */
  try {
    await sdkMedia.requestMediaPermissions('audio');
  } catch (e) {
    // error getting permissions. this usually means the user denied permissions
    // to verify, you can check the error type or check the mediaState (preferred)
    const { hasMicPermissions } = sdk.media.getState(); // get the current media state

    if (!hasMicPermissions) {
      // decide what to do. the sdk cannot function
      // without media permissions. generally it is best
      // to kick the user out of the app and explain how they
      // can grant permissions for their specific browser
    }
  }

  /* if we get here, that means we have `audio` permissions and devices have been enumerated */
  const devices = mediaState.devices;
  const audioDevices = mediaState.audioDevices; // or just grab microphones

  /* you can request media through the sdk. if there are permissions issues, the state will be updated */
  const micId = audioDevices[0].deviceId;
  const audioStream = await sdk.media.startMedia({ audio: micId });

  /* this is a mock session object. the real session would be attained through  the `sdk.on('sessionStarted', evt)` listener */
  const sessionToAccept = { conversationId: 'some-hash-id', ...restOfSessionObject };

  /* you can even accept a pending session with media you already have */
  sdk.acceptSession({
    conversationId: sessionToAccept.conversationid,
    mediaStream: audioStream
  });

  /* OR you can even accept a pending session with a deviceId and the sdk will create the media */
  sdk.acceptSession({
    conversationId: sessionToAccept.conversationid,
    audioDeviceId: micId,
  });
}

run();

```

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

### Example HTTPS GET Request Headers

Source: https://developer.genesys.cloud/devapps/audiohook/session-walkthrough

This example shows the structure of an HTTPS GET request with the necessary headers for establishing an AudioHook session. Ensure all required headers are present and correctly formatted.

```http
GET /api/v1/voicebiometrics/ws HTTP/1.1

Host: audiohook.example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Protocol: "json"
Sec-WebSocket-Version: 13
Audiohook-Organization-Id: 12345678-1234-1234-1234-123456789012
Audiohook-Correlation-Id: 87654321-8765-8765-8765-123456789012
Audiohook-Session-Id: 11223344-1122-1122-1122-112233445566
Audiohook-Retry-Attempt: 0
X-API-KEY: SGVsbG8sIEkgYW0gdGhlIEFQSSBrZXkh

```

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

### Post Purchase Installation Instructions for Premium Client Applications

Source: https://developer.genesys.cloud/appfoundry/free-trials

These instructions guide users on how to grant access and activate a Premium Client Application after purchase. It involves assigning permissions to user roles and saving the application configuration.

```Markdown
##Access to {Vendor Client App}
Now that {Vendor Client App} is enabled for your org:

1. Click 'Next' then click the installation icon for {Vendor Client App}
2. Add the {Vendor Client App Name} permission to **any** user role you'd like to have access to {Vendor Client App Name}: integration > {Permission} > view
* Suggested role: {Insert Role}
3. **Activate** the {Vendor Client App Name} and click **Save**
4.  Navigate to Apps Menu -> {Vendor Client App Name} to complete the setup post installation
```

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

### initialize()

Source: https://developer.genesys.cloud/devapps/webrtcsdk

Sets up the SDK for use and authenticates the user. Requires an `accessToken` for agents or a `securityCode` for guests.

```APIDOC
## initialize()

### Description
Setup the SDK for use and authenticate the user
  * agents must have an accessToken passed into the constructor options
  * guests need a securityCode (or the data received from an already redeemed securityCode).

If the customerData is not passed in this will redeem the code for the data, else it will use the data passed in.

### Method
```typescript
initialize(opts?: {
    securityCode: string;
} | ICustomerData): Promise<void>;
```

### Parameters
* `opts` = `{ securityCode: 'shortCode received from agent to share screen' }`
* _or_ if the customer data has already been redeemed using

the securityCode (this is an advanced usage)

```typescript
interface ICustomerData {
  conversation: {
    id: string;
  };
  sourceCommunicationId: string;
  jwt: string;
}
```

### Returns
A Promise that is fulfilled once the web socket is connected and other necessary async tasks are complete.
```

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

### Playback Started Message Example

Source: https://developer.genesys.cloud/devapps/audiohook/protocol-reference

Example of a 'playback_started' message sent by the client to the AudioHook server.

```json
{
  "version": "2",
  "type": "playback_started",
  "seq": 12,
  "serverseq": 11,
  "id": "e160e428-53e2-487c-977d-96989bf5c99d",
  "parameters": {}
}
```

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

### Make a Request to Get Current User Information

Source: https://developer.genesys.cloud/platform/api/quickstart

This example demonstrates how to make a GET request to the /api/v2/users/me endpoint to retrieve the current user's information. It shows examples using both curl and jQuery.

```APIDOC
## GET /api/v2/users/me

### Description
Retrieves the currently authenticated user's information.

### Method
GET

### Endpoint
/api/v2/users/me

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Format: "bearer <ACCESS_TOKEN>"
- **Content-Type** (string) - Required - Set to "application/json"

### Request Example (curl)
```bash
curl -X GET -H "Content-Type: application/json" -H "Authorization: bearer <INSERT AUTH TOKEN>" "https://api.mypurecloud.com/api/v2/users/me"
```

### Request Example (jQuery)
```javascript
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.mypurecloud.com/api/v2/users/me",
  "method": "GET",
  "headers": {
    "content-type": "application/json",
    "authorization": "bearer <INSERT AUTH TOKEN>"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
```

### Response
#### Success Response (200 OK)
- **id** (string) - The unique identifier for the user.
- **name** (string) - The name of the user.
- **email** (string) - The email address of the user.
(Other user-related fields may be included)

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "//": "... other user properties ..."
}
```
```

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

### Example Terraform Genesys Cloud Guide Version Update

Source: https://developer.genesys.cloud/blog/2026-03-10-deploy-ai-guides-terraform-blueprint

This example demonstrates how a Terraform 'genesyscloud_guide_version' resource is updated. It shows a specific change in the 'instruction' attribute, highlighting how modifications to your guide's logic are managed.

```hcl
# genesyscloud_guide_version.account_balance_v1 will be updated in-place
  ~ resource "genesyscloud_guide_version" "account_balance_v1" {
        id          = "ghi789-version-id"
      ~ instruction = <<-EOT
          - ## Step 1: Greeting
          - Say "Hello! I can help you check your account balance."
          + ## Step 1: Welcome
          + Say "Welcome! I'm here to help you check your account balance."
        EOT
        # (3 unchanged attributes hidden)
    }
```

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

### POST /wizard/scripts/modules/post-custom-setup.js

Source: https://developer.genesys.cloud/appfoundry/premium-app-wizard/7-custom-setup.md

Defines the interface for the post-install custom setup module, which executes logic after provisioning is complete.

```APIDOC
## POST /wizard/scripts/modules/post-custom-setup.js

### Description
This endpoint represents the entry point for post-installation logic. The `configure` function is triggered after all objects have been provisioned, allowing developers to sync data or perform external API calls.

### Method
POST

### Parameters
#### Request Body
- **logFunc** (Function) - Required - A function that accepts a string to display progress messages in the UI.
- **installedData** (Object) - Required - Contains all provisioned Genesys Cloud entities organized by module key.
- **userMe** (Object) - Required - The Genesys Cloud user object for the current user.
- **gcClient** (Object) - Required - The initialized Genesys Cloud SDK API client.

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the post-install process completed successfully.
- **cause** (string) - Optional - Provides details if the status is false.

### Response Example
{
  "status": true,
  "cause": ""
}
```

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

### Basic Archy Installation Steps

Source: https://developer.genesys.cloud/devapps/archy/install.html

The fundamental steps for installing Archy involve creating a directory, downloading the appropriate zip file, extracting it, and optionally adding the directory to your environment's path.

```text
Create a directory where you want to install Archy.
Download the Archy zip file appropriate for your operating system.
Extract it to the directory you created above.
( highly recommended ) Add the directory you created above to your environment's path so you can run the archy script / batch file from any directory.
```

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

### Example Request for Export Details

Source: https://developer.genesys.cloud/commdigital/externalcontacts/export

An example GET request to fetch the details of an export identified by its ID.

```http
GET /api/v2/externalcontacts/contacts/exports/b91b0c1a-9470-4952-99e1-8bae85ba5a23
```

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

### GET /api/v2/routing/email/setup

Source: https://developer.genesys.cloud/routing/routing

Retrieves the email setup configuration.

```APIDOC
## GET /api/v2/routing/email/setup

### Description
Get email setup.

### Method
GET

### Endpoint
/api/v2/routing/email/setup
```

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

### Instantiating Messaging Client and Fetching Deployment Config (1.X)

Source: https://developer.genesys.cloud/commdigital/digital/webmessaging/mobile-messaging/messenger-transport-mobile-sdk/migration-guide

Example of how to create a messaging client and fetch deployment configuration using the singleton MobileMessenger object in version 1.X.

```kotlin
val messagingClient = MobileMessenger.createMessagingClient(context, configuration)
val deploymentConfig = MobileMessenger.fetchDeploymentConfig(domain, deploymentId)
```

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

### Initialize SDK

Source: https://developer.genesys.cloud/devapps/webrtcsdk/index.md

Sets up the SDK for use and authenticates the user. Requires an `accessToken` for agents or a `securityCode` for guests.

```APIDOC
## Initialize SDK

### Description
Setup the SDK for use and authenticate the user
  * agents must have an accessToken passed into the constructor options
  * guests need a securityCode (or the data received from an already redeemed securityCode).

If the customerData is not passed in this will redeem the code for the data, else it will use the data passed in.

### Method
```typescript
initialize(opts?: {
    securityCode: string;
} | ICustomerData): Promise<void>;
```

### Parameters
* `opts` = `{ securityCode: 'shortCode received from agent to share screen' }`
* _or_ if the customer data has already been redeemed using

the securityCode (this is an advanced usage)

### ICustomerData Interface
```typescript
interface ICustomerData {
  conversation: {
    id: string;
  };
  sourceCommunicationId: string;
  jwt: string;
}
```

### Returns
A Promise that is fulfilled once the web socket is connected and other necessary async tasks are complete.
```

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

### Example API Endpoint - Architect Schedules

Source: https://developer.genesys.cloud/announcements/cef6f1e0-5532-4a28-81a9-84762ab38392

This example shows a GET endpoint for retrieving schedules from the Architect API, which will be impacted by the Joda-Time dependency removal.

```http
GET api/v2/architect/schedules/{scheduleId}
```

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

### POST /initialize

Source: https://developer.genesys.cloud/api/webrtcsdk/index.html

Sets up the SDK and authenticates the user. This method must be called before other SDK operations.

```APIDOC
## POST /initialize

### Description
Setup the SDK for use and authenticate the user. Agents must have an `accessToken` passed into the constructor options. Guests need a `securityCode` (or the data received from an already redeemed `securityCode`). If `customerData` is not passed in, this will redeem the code for the data; else, it will use the data passed in.

### Method
POST

### Endpoint
`/initialize`

### Parameters
#### Request Body
- **opts** (object) - Optional - Options for initialization.
  - **securityCode** (string) - Required (if `customerData` is not provided) - The short code received from an agent to share a screen.
  - **customerData** (object) - Optional - Pre-redeemed customer data.
    - **conversation** (object) - Required - Conversation details.
      - **id** (string) - Required - The conversation ID.
    - **sourceCommunicationId** (string) - Required - The ID of the source communication.
    - **jwt** (string) - Required - The JSON Web Token.

### Request Example
```json
{
  "securityCode": "shortCode received from agent to share screen"
}
```
_or_
```json
{
  "customerData": {
    "conversation": {
      "id": "conversationId"
    },
    "sourceCommunicationId": "sourceCommunicationId",
    "jwt": "jwt"
  }
}
```

### Response
#### Success Response (200)
- **void** - A Promise that is fulfilled once the web socket is connected and other necessary async tasks are complete.

#### Response Example
(No specific response body example provided, as it returns a Promise that resolves to void upon successful completion.)
```

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

### Unzip Archy Installation File

Source: https://developer.genesys.cloud/devapps/archy/install.html

Extract the Archy installation zip file to your created Archy directory. This example assumes the zip file is in your Downloads folder.

```bash
# Assuming the archy-macos.zip file is in your `~/Downloads` directory
$> unzip ~/Downloads/archy-macos.zip -d ~/archy

```

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

### Navigate to Project Directory

Source: https://developer.genesys.cloud/blueprints/angular-app-with-genesys-cloud-sdk

Command to change the current directory to the cloned sample project.

```bash
cd genesys-cloud-sample
```

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

### Build for Production

Source: https://developer.genesys.cloud/blueprints/analytics-detail-record-metrics-blueprint

Execute this command to create a production-ready build of the application.

```bash
npm run build
```

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

### Install Pods and Update SDK

Source: https://developer.genesys.cloud/commdigital/digital/webmessaging/mobile-messaging/messenger-mobile-sdk/ios/index

Run this command in your project's root directory to install dependencies. Use `pod update GenesysCloud` to get the latest version.

```bash
pod install
# pod update GenesysCloud (use this if you want to get the newly released version).
```

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

### Start Chat Widget with a Button

Source: https://developer.genesys.cloud/api/webchat/widget-version2.html

Invoke the 'WebChat.open' command to start the chat widget. This example shows how to trigger it using an HTML button's onclick event.

```html
<button type="button" id="chat-button-simple" onclick="customPlugin.command('WebChat.open');">Start Chat (simple)</button>
```

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

### JSON Configuration Example

Source: https://developer.genesys.cloud/devapps/sdk/java

Example of SDK configuration parameters in JSON format, covering logging, retry, reauthentication, and general settings.

```json
{
    "logging": {
        "log_level": "trace",
        "log_format": "text",
        "log_to_console": false,
        "log_file_path": "/var/log/javasdk.log",
        "log_response_body": false,
        "log_request_body": false
    },
    "retry": {
        "retry_wait_min": 3,
        "retry_wait_max": 10,
        "retry_max": 5
    },
    "reauthentication": {
        "refresh_access_token": true,
        "refresh_token_wait_max": 10
    },
    "general": {
        "live_reload_config": true,
        "host": "https://api.mypurecloud.com"
    }
}
```

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

### Enable Dynamic Install Summary

Source: https://developer.genesys.cloud/appfoundry/premium-app-wizard/6-wizard-config-parameters.md

Enables the dynamic generation of the Install Summary to reflect items in 'provisioningInfo'. This eliminates the need for manual updates to the '_INSTALLATION DETAILS PAGE_' section in 'index.html'.

```javascript
enableDynamicInstallSummary: true
```

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

### Example API Endpoint - Telephony Providers Edges

Source: https://developer.genesys.cloud/announcements/cef6f1e0-5532-4a28-81a9-84762ab38392

This example shows a GET endpoint for retrieving sites from the Telephony Providers Edge API, which will be impacted by the Joda-Time dependency removal.

```http
GET /api/v2/telephony/providers/edges/sites/{siteId}
```

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

### Conversation Interval Filtering Example

Source: https://developer.genesys.cloud/analyticsdatamanagement/analytics/detail/index

Demonstrates how conversation start and end times interact with query intervals to determine inclusion. The index for the conversation's start day is searched.

```text
start: 2018-02-19T23:55:05.520Z
end: 2018-02-20T07:25:00.692Z
interval: 2018-02-19T23:55:05.519Z/2018-02-20T07:30:00.000Z will include the conversation.
interval: 2018-02-20T07:20:00.000Z/2018-02-20T07:30:00.000Z will NOT include the conversation, even if there was activity at 2018-02-20T07:20:01.000Z. The index for 2018-02-19 was not searched.
interval: 2018-02-19T07:55:05.521Z/2018-02-20T07:30:00.000Z will include the conversation, because the interval touches the day of the conversation start, even though the start is not in the interval.
```

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

### Example SpeechStarted Event Message

Source: https://developer.genesys.cloud/devapps/audiohook/protocol-reference

An example JSON message representing a SpeechStarted event. This event is used to signal the start of speech detection for the Bot Transcription Connector feature.

```json
{
  "version": "2",
  "type": "event",
  "seq": 12,
  "clientseq": 11,
  "id": "e160e428-53e2-487c-977d-96989bf5c99d",
  "parameters": {
    "entities": [
      {
        "type": "speech_started",
        "data": {
        }
      }
    ]
  }
}
```

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

### Install PureCloudPlatformClientV2 SDK

Source: https://developer.genesys.cloud/api/rest/client-libraries/python

Install the Python SDK using pip. Ensure to remove the maximum path length limitation on Windows before installation.

```bash
pip install PureCloudPlatformClientV2
```

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

### Fetch and Build CLI from Source (Go)

Source: https://developer.genesys.cloud/api/rest/command-line-interface

Fetches and builds the CLI from source using Go. The binary will be in your $GOPATH/bin directory.

```bash
env GO111MODULE=on go get github.com/mypurecloud/platform-client-sdk-cli/build/gc
```

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

### GET Request to Scan Contacts with Cursor

Source: https://developer.genesys.cloud/api/rest/v2/externalcontacts/scan.html

This example shows how to make a GET request to scan external contacts, including a cursor for pagination. Omit the cursor parameter for the initial request.

```HTTP
GET https://api.mypurecloud.com/api/v2/externalcontacts/scan/contacts?limit=42&cursor=eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..ZVjllAOz7AfeXOk1.HyDYmtq-elBEO8EsdUyMzC7ho0KWg3WQF0HZ9xcK9a0Ua_j3lDR2JQBFxitLK9cRODvL4AsikksO7zsAS1b-ywFOjfgaAkmNWbTL6yDdjDB1wZRDGAcxKEsqeVRL3M41pC0.-t2FIHF69FTDu54xSaf0ow
```

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

### Install Platform API Client SDK - Go

Source: https://developer.genesys.cloud/devapps/sdk/go?tab=versions

Use 'go get' to retrieve the SDK package from GitHub. Ensure your Go version is 1.15 or newer to avoid potential build errors.

```bash
go get github.com/mypurecloud/platform-client-sdk-go/platformclientv2

```

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

### Pre Purchase Installation Instructions for Genesys Cloud Embeddable Framework Applications

Source: https://developer.genesys.cloud/appfoundry/free-trials

These instructions outline the prerequisites for installing a Genesys Cloud Embeddable Framework (GEF) application, including external dependencies and package installations that must be completed before starting a Free Trial.

```Markdown
##Prerequisites: {Vendor GEF App Name} for Genesys Cloud

{Vendor GEF App Name} for Genesys Cloud has a an external dependancies within {External CRM}.  Click 'Next' for items required before begining your Free Trial of this integration with Genesys Cloud.
 
###Pre-Purchase Instructions (external link) 
 
## Install the {Vendor GEF App Name} Package 
 
Install the {Vendor GEF App Name} Package from the {Package Location Name}. This package **must** be fully installed before you start your **Free Trial**. 
 
Note: You may need to contact your {CRM Administrator} to install the package.
External URL Link: {Insert}
```

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

### Setup Key Configurations

Source: https://developer.genesys.cloud/api/rest/v2/conversations

Sets up configurations for encryption key creation.

```APIDOC
## POST /api/v2/conversations/keyconfigurations

### Description
Sets up configurations for encryption key creation.

### Method
POST

### Endpoint
/api/v2/conversations/keyconfigurations

### Parameters
#### Request Body
- **keyConfiguration** (object) - Required - The details for the key configuration.
```

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

### Current Query Trades Response

Source: https://developer.genesys.cloud/workforcemanagement/flexibility/shift-trading-api-migration

Example response from the current GET shift trades endpoint.

```json
{
  "entities": [
    {
      "trade": {
        "id": "trade-123",
        "weekDate": "2026-04-07",
        "schedule": { "id": "sched-1" },
        "state": "Unmatched",
        "initiatingUser": { "id": "user-a" },
        "initiatingShiftId": "shift-1",
        "initiatingShiftStart": "2026-04-08T08:00:00Z",
        "initiatingShiftEnd": "2026-04-08T16:00:00Z",
        "metadata": { "version": 1 }
      },
      "matchReview": null
    }
  ]
}
```

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

### Basic SDK Initialization

Source: https://developer.genesys.cloud/devapps/webrtcsdk/index.md

Demonstrates the basic setup and initialization of the Genesys Cloud WebRTC SDK for an authenticated user.

```APIDOC
## Basic SDK Initialization

### Description
This example shows how to initialize the Genesys Cloud WebRTC SDK with an access token for an authenticated user. It also includes setting up basic event listeners for common SDK events.

### Method
Instantiation and Initialization

### Endpoint
N/A (Client-side SDK)

### Parameters
#### Request Body
- **accessToken** (string) - Required - Access token received from authentication. Required for authenticated users (aka agents).

### Request Example
```javascript
import { GenesysCloudWebrtcSdk } from 'genesys-cloud-webrtc-sdk';

const sdk = new GenesysCloudWebrtcSdk({
  accessToken: 'your-access-token'
});

// Optionally set up some SDK event listeners (not an exhaustive list)
sdk.on('sdkError', (event) => { /* do stuff with the error */ });
sdk.on('pendingSession', (event) => { /* pending session incoming */ });
sdk.on('sessionStarted', (event) => { /* a session just started */ });

sdk.initialize().then(() => {
  // the web socket has connected and the SDK is ready to use
});
```

### Response
#### Success Response (200)
SDK initialization is asynchronous. The `initialize()` method returns a Promise that resolves when the SDK is ready.

#### Response Example
N/A (Promise resolution indicates readiness)
```

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

### Basic SDK Initialization

Source: https://developer.genesys.cloud/devapps/webrtcsdk

Demonstrates the basic setup and initialization of the Genesys Cloud WebRTC SDK for an authenticated user.

```APIDOC
## Basic SDK Initialization

### Description
This example shows how to initialize the Genesys Cloud WebRTC SDK with an access token for an authenticated user. It also includes setting up basic event listeners for common SDK events.

### Method
Instantiation and Initialization

### Endpoint
N/A (Client-side SDK)

### Parameters
#### Request Body (for constructor)
- **accessToken** (string) - Required - Access token received from authentication. Required for authenticated users (aka agents).

### Request Example
```javascript
import { GenesysCloudWebrtcSdk } from 'genesys-cloud-webrtc-sdk';

const sdk = new GenesysCloudWebrtcSdk({
  accessToken: 'your-access-token'
});

// Optionally set up some SDK event listeners (not an exhaustive list)
sdk.on('sdkError', (event) => { /* do stuff with the error */ });
sdk.on('pendingSession', (event) => { /* pending session incoming */ });
sdk.on('sessionStarted', (event) => { /* a session just started */ });

sdk.initialize().then(() => {
  // the web socket has connected and the SDK is ready to use
});
```

### Response
N/A (Initialization is asynchronous and returns a Promise)

#### Success Response (Promise Resolution)
Indicates that the SDK has successfully connected and is ready for use.

#### Response Example
```javascript
// The .then() block of sdk.initialize() will execute upon successful connection.
console.log('SDK initialized and connected.');
```
```

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

### Get Message Media

Source: https://developer.genesys.cloud/commdigital/third-party-object-routing/open-messaging

Retrieves message media. Refer to the provided link for example usage.

```APIDOC
## GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}

### Description
Get media. See https://developer.genesys.cloud.com/commdigital/digital/messagemediaupload/ for example usage.

### Method
GET

### Endpoint
/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}
```

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

### Get Media

Source: https://developer.genesys.cloud/commdigital/digital/openmessaging/openmessaging-apis

Retrieves media associated with a message. Refer to the provided link for example usage.

```APIDOC
## GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}

### Description
Get media. See https://developer.genesys.cloud.com/commdigital/digital/messagemediaupload/ for example usage.

### Method
GET

### Endpoint
/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId}

### Parameters
#### Path Parameters
- **conversationId** (string) - Required - The ID of the conversation.
- **communicationId** (string) - Required - The ID of the communication.
- **mediaId** (string) - Required - The ID of the media item.
```

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

### Install CLI (Go 1.16+)

Source: https://developer.genesys.cloud/api/rest/command-line-interface

Installs the latest version of the CLI using Go. Ensure Go version is 1.16 or higher.

```bash
env GO111MODULE=on go install github.com/mypurecloud/platform-client-sdk-cli/build/gc@latest
```

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

### GET Request to Scan External Contact Notes

Source: https://developer.genesys.cloud/api/rest/v2/externalcontacts/scan.html

This example shows how to make a GET request to scan for external contact notes. Include a cursor for subsequent pages; omit it for the initial request.

```HTTP
GET https://api.mypurecloud.com/api/v2/externalcontacts/scan/notes?limit=42&cursor=eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..kkVoxgCuJSQ12W9I.BARTsoSGbCQp7Luh5W6z-eY9-XX0znIxUPcKvNrZMBPFnGB60I8LaJobPnu5X3sPkb_b-8LBnL-vfA_ZpSVNop-FzUVqTWGm0K5P445HXVpB6pvU-rW_kv0I.dFDbZTe9yKLrQaSStLmkLg
```

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

### Example Flow YAML for Reference Question

Source: https://developer.genesys.cloud/devapps/archy/flowAuthoring/quiz.html

This YAML snippet is used in a quiz question to assess understanding of flow references and the `startUpRef` property.

```yaml
inboundCall:
  name: Archy Demo
  startUpRef: /./menus/menu[mainMenu]
  menus:
    - menu:  
        name: Main Menu
        refId: mainMenu   
```

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

### JSON Configuration File Example

Source: https://developer.genesys.cloud/api/rest/client-libraries/javascript

Example of a configuration file in JSON format. This format mirrors the INI structure for logging, reauthentication, and general SDK settings.

```json
{
    "logging": {
        "log_level": "trace",
        "log_format": "text",
        "log_to_console": false,
        "log_file_path": "/var/log/javascriptsdk.log",
        "log_response_body": false,
        "log_request_body": false
    },
    "reauthentication": {
        "refresh_access_token": true,
        "refresh_token_wait_max": 10
    },
    "general": {
        "live_reload_config": true,
        "host": "https://api.mypurecloud.com"
    }
}
```