Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SkillService

Class to perform get skills

Hierarchy

  • SkillService

Index

Constructors

Properties

Methods

Constructors

constructor

  • Create instance of CXoneAuth

    @example
    const skillService = new SkillService();

    Returns SkillService

Properties

Private GET_SKILLS_URI

GET_SKILLS_URI: string = '/InContactAPI/services/v27.0/skills'

Private GET_SKILL_NAME_BY_ROUTING_ID

GET_SKILL_NAME_BY_ROUTING_ID: string = '/dfo/3.0/routing-queues?size=500'

Private apiParser

apiParser: SkillApiParser = ...

Private auth

auth: CXoneAuth

Protected logger

logger: Logger = ...

Private urlUtilsService

urlUtilsService: UrlUtilsService = ...

Protected utilService

utilService: HttpUtilService = ...

Private validationUtils

validationUtils: ValidationUtils = ...

Static Private cachedAgentSkills

cachedAgentSkills: AgentSkill[]

Methods

getAgentSkills

  • getAgentSkills(agentId?: string): Promise<AgentSkill[]>

  • Method to return agent skills

    Parameters

    • Optional agentId: string

      Pass the Agent Id

    Returns Promise<AgentSkill[]>

    • return the agent skills details
    @example
    getAgentSkills('4712')

getAllSkillsList

  • getAllSkillsList(mediaTypeId?: number, startIndex?: number, recordsToLoad?: number, searchText?: string, forceFetch?: boolean): Promise<Skills[]>

  • Method to return agent skills

    Parameters

    • Optional mediaTypeId: number

      Pass the media type Id

    • Optional startIndex: number

      Pass the start index

    • Optional recordsToLoad: number

      Pass the number of records to load

    • Optional searchText: string

      Pass the text string to search

    • Optional forceFetch: boolean

      Used to forceful API call

    Returns Promise<Skills[]>

    • return the agent skills details
    @example
    getAllSkillsList(4,1,5,'call',false)

getCachedAgentSkills

  • Method to return cached agent skills

    Parameters

    • Optional agentId: string

      nullable Agent Id

      @example
      getCachedAgentSkills('1001') || getCachedAgentSkills()

    Returns AgentSkill[] | Promise<AgentSkill[]>

    • return the cached agent skills details

getRoutingQueueNames

  • getRoutingQueueNames(): Promise<AssertsShape<{ agentFirstResponseTime: default<number, AnyObject, number>; agentFollowOnResponseTime: default<number, AnyObject, number>; agentResponseEnabled: default<boolean, AnyObject, boolean>; customerIdleTime: default<number, AnyObject, number>; customerResponseEnabled: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; isSubqueue: RequiredStringSchema<string, AnyObject>; name: MixedSchema<any, AnyObject, any>; skillId: default<number, AnyObject, number>; timeExtensionEnabled: default<boolean, AnyObject, boolean> }>[]>

  • Method to get Skill Name from Routing Queue

    example

    Returns Promise<AssertsShape<{ agentFirstResponseTime: default<number, AnyObject, number>; agentFollowOnResponseTime: default<number, AnyObject, number>; agentResponseEnabled: default<boolean, AnyObject, boolean>; customerIdleTime: default<number, AnyObject, number>; customerResponseEnabled: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; isSubqueue: RequiredStringSchema<string, AnyObject>; name: MixedSchema<any, AnyObject, any>; skillId: default<number, AnyObject, number>; timeExtensionEnabled: default<boolean, AnyObject, boolean> }>[]>

    • API Response has routing queue information.

getSkillById

  • getSkillById(skillId: string, fetchFromIndexedDB?: boolean): Promise<Skills>

  • Used to get the skill details based on the skill id

    example
    this.skillService.getSkillById("123456", false);

    Parameters

    • skillId: string

      skill id to fetch the skill details

    • Optional fetchFromIndexedDB: boolean

      fetch data from IndexedDB or not

    Returns Promise<Skills>

getSkillCPAManagementParametersById

  • getSkillCPAManagementParametersById(skillId: number): Promise<AssertsShape<{ abandonMessagePath: RequiredStringSchema<string, AnyObject>; abandonMsgMode: RequiredNumberSchema<number, AnyObject>; abandonTimeout: RequiredNumberSchema<number, AnyObject>; agentNoResponseSeconds: default<number, AnyObject, number>; agentOverrideOptionAnsweringMachine: RequiredBooleanSchema<boolean, AnyObject>; agentOverrideOptionBadNumber: RequiredBooleanSchema<boolean, AnyObject>; agentOverrideOptionFax: RequiredBooleanSchema<boolean, AnyObject>; agentResponseUtteranceMinimumSeconds: default<number, AnyObject, number>; agentVoiceThreshold: default<number, AnyObject, number>; ansMachineDetMode: RequiredNumberSchema<number, AnyObject>; ansMachineMsg: RequiredStringSchema<string, AnyObject>; ansMachineOverrideSeconds: RequiredNumberSchema<number, AnyObject>; customerLiveSilenceSeconds: default<number, AnyObject, number>; customerVoiceThreshold: default<number, AnyObject, number>; enableCPALogging: default<boolean, AnyObject, boolean>; exceptions: RequiredArraySchema<AnySchema<any, any, any>, AnyObject, any[]>; machineEndSilenceSeconds: default<number, AnyObject, number>; machineEndTimeoutSeconds: default<number, AnyObject, number>; machineMinimumWithAgentSeconds: default<number, AnyObject, number>; machineMinimumWithoutAgentSeconds: default<number, AnyObject, number>; preConnectCPAEnabled: RequiredBooleanSchema<boolean, AnyObject>; preConnectCPARecording: default<boolean, AnyObject, boolean>; treatProgressAsRinging: RequiredBooleanSchema<boolean, AnyObject>; utteranceMinimumSeconds: default<number, AnyObject, number> }>>

  • Get the CPA management parameters on the skill

    example
    this.skillService.getSkillCPAManagementParametersById(123456);

    Parameters

    • skillId: number

      skill id

    Returns Promise<AssertsShape<{ abandonMessagePath: RequiredStringSchema<string, AnyObject>; abandonMsgMode: RequiredNumberSchema<number, AnyObject>; abandonTimeout: RequiredNumberSchema<number, AnyObject>; agentNoResponseSeconds: default<number, AnyObject, number>; agentOverrideOptionAnsweringMachine: RequiredBooleanSchema<boolean, AnyObject>; agentOverrideOptionBadNumber: RequiredBooleanSchema<boolean, AnyObject>; agentOverrideOptionFax: RequiredBooleanSchema<boolean, AnyObject>; agentResponseUtteranceMinimumSeconds: default<number, AnyObject, number>; agentVoiceThreshold: default<number, AnyObject, number>; ansMachineDetMode: RequiredNumberSchema<number, AnyObject>; ansMachineMsg: RequiredStringSchema<string, AnyObject>; ansMachineOverrideSeconds: RequiredNumberSchema<number, AnyObject>; customerLiveSilenceSeconds: default<number, AnyObject, number>; customerVoiceThreshold: default<number, AnyObject, number>; enableCPALogging: default<boolean, AnyObject, boolean>; exceptions: RequiredArraySchema<AnySchema<any, any, any>, AnyObject, any[]>; machineEndSilenceSeconds: default<number, AnyObject, number>; machineEndTimeoutSeconds: default<number, AnyObject, number>; machineMinimumWithAgentSeconds: default<number, AnyObject, number>; machineMinimumWithoutAgentSeconds: default<number, AnyObject, number>; preConnectCPAEnabled: RequiredBooleanSchema<boolean, AnyObject>; preConnectCPARecording: default<boolean, AnyObject, boolean>; treatProgressAsRinging: RequiredBooleanSchema<boolean, AnyObject>; utteranceMinimumSeconds: default<number, AnyObject, number> }>>

getSkillDeliveryParametersById

  • getSkillDeliveryParametersById(skillId: number): Promise<AssertsShape<{ complianceRecordsDefaultAccept: default<boolean, AnyObject, boolean>; complianceRecordsDeliveryType: default<number, AnyObject, number>; complianceRecordsDisabled: default<boolean, AnyObject, boolean>; complianceRecordsTimeout: default<number, AnyObject, number>; complianceRecordsTimeoutSubsequent: default<number, AnyObject, number>; confirmationRequiredDefault: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequiredDefaultAccept: default<boolean, AnyObject, boolean>; confirmationRequiredDeliveryType: default<number, AnyObject, number>; confirmationRequiredDisabled: default<boolean, AnyObject, boolean>; confirmationRequiredTimeout: default<number, AnyObject, number>; confirmationRequiredTimeoutSubsequent: default<number, AnyObject, number>; showComplianceButtonDisposition: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonRequeue: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonReschedule: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonSnooze: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonDisposition: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonRequeue: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonReschedule: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonSnooze: RequiredBooleanSchema<boolean, AnyObject> }>>

  • Get the delivery preferences parameters on the skill

    example
    this.skillService.getSkillDeliveryPreferencesById(123456);

    Parameters

    • skillId: number

      skill id

    Returns Promise<AssertsShape<{ complianceRecordsDefaultAccept: default<boolean, AnyObject, boolean>; complianceRecordsDeliveryType: default<number, AnyObject, number>; complianceRecordsDisabled: default<boolean, AnyObject, boolean>; complianceRecordsTimeout: default<number, AnyObject, number>; complianceRecordsTimeoutSubsequent: default<number, AnyObject, number>; confirmationRequiredDefault: RequiredBooleanSchema<boolean, AnyObject>; confirmationRequiredDefaultAccept: default<boolean, AnyObject, boolean>; confirmationRequiredDeliveryType: default<number, AnyObject, number>; confirmationRequiredDisabled: default<boolean, AnyObject, boolean>; confirmationRequiredTimeout: default<number, AnyObject, number>; confirmationRequiredTimeoutSubsequent: default<number, AnyObject, number>; showComplianceButtonDisposition: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonRequeue: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonReschedule: RequiredBooleanSchema<boolean, AnyObject>; showComplianceButtonSnooze: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonDisposition: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonRequeue: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonReschedule: RequiredBooleanSchema<boolean, AnyObject>; showPreviewButtonSnooze: RequiredBooleanSchema<boolean, AnyObject> }>>

Generated using TypeDoc