@or-sdk/hitl

Installation:

$ npm i @or-sdk/hitl

Usage

To start using HitL API methods through this SDK it has to be Initialized first. To do that a OneReach JWT authorization token and a HitL or Discovery service URL have to be passed to the constructor. After initializing the HitL SDK, its methods can be used to make requests to HitL APIs.

Available HitL APIs are:

• agents - Manage HitL agents (retrieve, search, manage permissions, status and meta information) (see AgentsApi class for the documentation)
• cannedMessages - Manage predefined message templates for quick responses (see CannedMessagesApi class for the documentation)
• commands - Send and manage commands within HitL sessions (see CommandsApi class for the documentation)
• conferences - Manage voice conference participants and member states (see ConferencesApi class for the documentation)
• contactRuleGroups - Manage contact rule groups (search, create, update, delete) (see ContactRuleGroupsApi class for the documentation)
• contacts - Search contacts with filtering based on agent's contact rule groups (see ContactsApi class for the documentation)
• contactsMeta - Retrieve metadata information about contacts (timestamps, etc.) (see ContactsMetaApi class for the documentation)
• eventTemplates - Manage event templates (retrieve, create, update, delete) (see EventTemplatesApi class for the documentation)
• filters - Manage conversation view filters with bulk operations support (see FiltersApi class for the documentation)
• helpers - Provide helper utilities for system maintenance (like cleaning duplicates) (see HelpersApi class for the documentation)
• listeners - Manage HitL event listeners (WebSocket connections, callbacks, notifications) (see ListenersApi class for the documentation)
• migrations - Manage database migrations and default records (see MigrationsApi class for the documentation)
• ruleGroups - Manage rule groups (search, create, update, delete) (see RuleGroupsApi class for the documentation)
• sessionEvents - Manage events for HitL sessions (retrieve, track read status, bulk operations) (see SessionEventsApi class for the documentation)
• sessionRelations - Manage relationships between HitL sessions (see SessionRelationsApi class for the documentation)
• sessions - Manage HitL session lifecycle (create, update, close, transfer, search) (see SessionsApi class for the documentation)
• settings - Manage system settings and configuration (see SettingsApi class for the documentation)
• tasks - Manage asynchronous task execution (event sending, broadcasting, etc.) (see TasksApi class for the documentation)
• versions - Manage UI version information and compatibility (see VersionsApi class for the documentation)

Examples

In a flow

const HitlApi = require('@or-sdk/hitl').HITL;

// with direct api url
const hitlApi = new HitlApi({
  token: `FLOW ${this.config.flowToken}`,
  hitlUrl: this.config.env.HITL_API_URL
});

// with service discovery(slower)
const hitlApi = new HitlApi({
  token: `FLOW ${this.config.flowToken}`,
  discoveryUrl: this.config.env.SERVICE_DISCOVERY_API_URL,
});

const ruleGroupsList = await hitlApi.ruleGroups.searchRuleGroups();

Outside a flow

const HitlApi = require('@or-sdk/hitl').HITL;

const CLIENT_DOMAIN_PREFIX = ''; // A PDE client-environment domain prefix, e.g. "staging"

// Either "discoveryUrl" or "hitlUrl" should be specified, "hitlUrl" takes precedence if both are present
const { agents, cannedMessages, ruleGroups } = new HitlApi({
  token: 'AUTH TOKEN HERE', // FLOW, SERVICE or USER JWT OneReach authorization token
  discoveryUrl: `https://discovery.${CLIENT_DOMAIN_PREFIX}.api.onereach.ai`, // A service discovery URL, e.g. "https://discovery.staging.api.onereach.ai"
  hitlUrl: `https://hitl.${CLIENT_DOMAIN_PREFIX}.api.onereach.ai`, // A HitL API URL, e.g. "https://hitl.staging.api.onereach.ai"
});

const agentsList = await agents.getAgents();
const cannedMessages = await cannedMessages.getCannedMessages({ id: 'MESSAGE ID HERE' });
const ruleGroupsList = await hitlApi.ruleGroups.searchRuleGroups();