CustomerCardService | nice-cxone-acd-agent-apps

Class to handle Customer Card API calls

Hierarchy

CustomerCardService

Constructors

constructor

new CustomerCardService(): CustomerCardService

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:87
example
Returns CustomerCardService

Properties

Private DELETE_CUSTOMER_CUSTOM_FIELD

DELETE_CUSTOMER_CUSTOM_FIELD: string = '/dfo/3.0/customers/{customerId}/custom-fields/{customFieldIdent}'

Private EXECUTE_WORKFLOW_URI

EXECUTE_WORKFLOW_URI: string = '/InContactAPI/services/v27.0/agent-integration/configuration/{configurationId}/workflow/{workflowId}'

Private GET_CRM_DATA_FOR_TRANSFERED_CONTACT

GET_CRM_DATA_FOR_TRANSFERED_CONTACT: string = '/InContactAPI/services/v30.0/agent-integration/workflow-execution/interaction/{cacheKey}'

Private auth

auth: CXoneAuth

Private customerSearchScrollToken

customerSearchScrollToken: string = ''

Private isAbortDelayDigitalApiEnabled

isAbortDelayDigitalApiEnabled: boolean = ...

logger

logger: Logger = ...

Private Readonly requestManager

requestManager: RequestManager = ...

Private searchText

searchText: string = ''

Private urlUtilsService

urlUtilsService: UrlUtilsService = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

createNewCustomerNote

createNewCustomerNote(customerId: string, note: string): Promise<CXoneSdkError | CustomerCardNote>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:766
Method to create a Customer note in customer card
example
Parameters
- customerId: string
- note: string
Returns Promise<CXoneSdkError | CustomerCardNote>
- API Returns Response JSON with created note object

deleteCustomField

deleteCustomField(customFields: CXoneDeleteCustomField): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:267
Method to delete linked custom field on customer card
example
```
deleteCustomField({ ident: 'city', customerId: 'email_bharath@gmail.com' });
```
Parameters
- customFields: CXoneDeleteCustomField
  
  ident & customerId to delete identValue
Returns Promise<HttpResponse>
- API Returns Response code with success or failure

deleteCustomerNoteByNoteId

deleteCustomerNoteByNoteId(customerId: string, noteId: string): Promise<HttpResponse | CXoneSdkError>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:791
Method to delete a Customer note in customer card
example
Parameters
- customerId: string
- noteId: string
Returns Promise<HttpResponse | CXoneSdkError>
- API Returns Response JSON with deleted empty note object

editCustomerNoteByNoteId

editCustomerNoteByNoteId(customerId: string, noteId: string, note: string): Promise<CXoneSdkError | CustomerCardNote>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:816
Method to edit a Customer note in customer card
example
Parameters
- customerId: string
- noteId: string
- note: string
Returns Promise<CXoneSdkError | CustomerCardNote>
- API Returns Response JSON with updated note object

executeCreateWorkFlow

executeCreateWorkFlow(crmRequest: CXoneWorkflowCreateRequest): Promise<AgentWorkflowResponseEvent>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:642
Method to create a new record in CRM in Tray
example
- createRecord({action: 'search', interactionId: '1234', workflowInput: 'test'})
Parameters
- crmRequest: CXoneWorkflowCreateRequest
  
  type of CXoneWorkflowCreateRequest
Returns Promise<AgentWorkflowResponseEvent>
- API Returns Response JSON with created record and status

executeWorkFlow

executeWorkFlow(crmRequest: CXoneWorkflowRequest): Promise<AgentWorkflowResponseEvent>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:532
Method to get in CRM workflow response
example
- CRM data from workflow.
Parameters
- crmRequest: CXoneWorkflowRequest
Returns Promise<AgentWorkflowResponseEvent>
- API Returns CRM data for payload

Private generatePayloadForExecuteWorkFlow

generatePayloadForExecuteWorkFlow(request: CXoneWorkflowRequest): { action: string; cacheKey: string; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: string; entity: undefined; entityId: undefined; integration: undefined; interactionID: string; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: CXoneDigitalContactData | CXoneVoiceContactData; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: RelatesToEntity[]; interactionID: undefined; relatedObject: undefined; workflowInput: undefined } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: CXoneDigitalContactData | CXoneVoiceContactData; dataMappingId: string; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: RelatesToEntity[]; interactionID: string; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: string; entityId: string; integration: undefined; interactionID: undefined; relatedObject: { entityType?: string; name: string; value: string }; workflowInput: undefined } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: undefined; interactionID: undefined; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: undefined; cacheKey: undefined; contactID: undefined; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: undefined; interactionID: undefined; relatedObject: undefined; workflowInput: undefined }

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:472
Parameters
- request: CXoneWorkflowRequest
Returns { action: string; cacheKey: string; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: string; entity: undefined; entityId: undefined; integration: undefined; interactionID: string; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: CXoneDigitalContactData | CXoneVoiceContactData; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: RelatesToEntity[]; interactionID: undefined; relatedObject: undefined; workflowInput: undefined } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: CXoneDigitalContactData | CXoneVoiceContactData; dataMappingId: string; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: RelatesToEntity[]; interactionID: string; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: string; entityId: string; integration: undefined; interactionID: undefined; relatedObject: { entityType?: string; name: string; value: string }; workflowInput: undefined } | { action: string; cacheKey: undefined; contactID: string; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: undefined; interactionID: undefined; relatedObject: undefined; workflowInput: { action?: string; email?: string; entites?: CXoneIntegrationEntity[]; id?: string; phoneNumber?: string; recipientId?: string; type?: string } } | { action: undefined; cacheKey: undefined; contactID: undefined; cxoneContact: undefined; dataMappingId: undefined; dynamicDataMappingId: undefined; entity: undefined; entityId: undefined; integration: undefined; interactionID: undefined; relatedObject: undefined; workflowInput: undefined }

getAgentDigitalContactHistory

getAgentDigitalContactHistory(ownerAssignee: string): Promise<AssertsShape<{ authorEndUserIdentity: any; channelId: default<string, AnyObject, string>; channelName: default<string, AnyObject, string>; contactId: default<string, AnyObject, string>; createdAt: RequiredStringSchema<string, AnyObject>; customFields: default<default<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>, AssertsShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>[], AssertsShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>[]>; direction: RequiredStringSchema<string, AnyObject>; endUser: any; endUserRecipients: any; id: RequiredStringSchema<string, AnyObject>; inboundCount: default<number, AnyObject, number>; inboxAssignee: default<number, AnyObject, number>; inboxAssigneeLastAssignedAt: default<Date, AnyObject, Date>; inboxAssigneeUser: any; interactionId: default<string, AnyObject, string>; isDraft: default<boolean, AnyObject, boolean>; outboundCount: default<number, AnyObject, number>; ownerAssigneeUser: any; recipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[]>; routingQueueId: default<string, AnyObject, string>; skillId: default<number, AnyObject, number>; skillName: default<string, AnyObject, string>; status: RequiredStringSchema<string, AnyObject>; statusUpdatedAt: default<Date, AnyObject, Date>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: RequiredStringSchema<string, AnyObject> }>[]>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:297
Method to fetch Agent Digital Contact History
example
- Pass 1 parameter ownerAssignee
Parameters
- ownerAssignee: string
Returns Promise<AssertsShape<{ authorEndUserIdentity: any; channelId: default<string, AnyObject, string>; channelName: default<string, AnyObject, string>; contactId: default<string, AnyObject, string>; createdAt: RequiredStringSchema<string, AnyObject>; customFields: default<default<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>, AssertsShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>[], AssertsShape<Assign<ObjectShape, { ident: default<string, AnyObject, string>; isEditable: default<boolean, AnyObject, boolean>; isRequired: default<boolean, AnyObject, boolean>; isVisibleInCustomerCard: default<boolean, AnyObject, boolean>; isVisibleInRightPanel: default<boolean, AnyObject, boolean>; label: default<string, AnyObject, string>; selectedValue: default<string, AnyObject, string>; type: default<string, AnyObject, string>; value: default<string, AnyObject, string>; values: OptionalArraySchema<AnySchema<any, any, any>, any, any[]> }>>[]>; direction: RequiredStringSchema<string, AnyObject>; endUser: any; endUserRecipients: any; id: RequiredStringSchema<string, AnyObject>; inboundCount: default<number, AnyObject, number>; inboxAssignee: default<number, AnyObject, number>; inboxAssigneeLastAssignedAt: default<Date, AnyObject, Date>; inboxAssigneeUser: any; interactionId: default<string, AnyObject, string>; isDraft: default<boolean, AnyObject, boolean>; outboundCount: default<number, AnyObject, number>; ownerAssigneeUser: any; recipients: default<default<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrimary: RequiredBooleanSchema<boolean, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; name: RequiredStringSchema<string, AnyObject> }>>[]>; routingQueueId: default<string, AnyObject, string>; skillId: default<number, AnyObject, number>; skillName: default<string, AnyObject, string>; status: RequiredStringSchema<string, AnyObject>; statusUpdatedAt: default<Date, AnyObject, Date>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: RequiredStringSchema<string, AnyObject> }>[]>
- API Returns Digital contact History details for the Agent

getAgentVoiceContactHistory

getAgentVoiceContactHistory(contactHistoryRequest: CXoneAgentVoiceContactHistoryRequest): Promise<AssertsShape<{ agentId: default<string, AnyObject, string>; contactId: default<string, AnyObject, string>; contactStart: default<string, AnyObject, string>; dispositionNotes: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; fromAddr: default<string, AnyObject, string>; isOutbound: default<boolean, AnyObject, boolean>; lastName: default<string, AnyObject, string>; lastUpdateTime: default<string, AnyObject, string>; mediaType: default<string, AnyObject, string>; primaryDispositionId: default<number, AnyObject, number>; skillId: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; tags: any; teamId: default<string, AnyObject, string>; toAddr: default<string, AnyObject, string>; totalDurationSeconds: default<number, AnyObject, number> }>[]>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:348
Method to fetch Agent Contact History
example
- Pass 2 parameter inboxAssignee & updatedSinceHours for fetching contact history for particular days span.
Parameters
- contactHistoryRequest: CXoneAgentVoiceContactHistoryRequest
Returns Promise<AssertsShape<{ agentId: default<string, AnyObject, string>; contactId: default<string, AnyObject, string>; contactStart: default<string, AnyObject, string>; dispositionNotes: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; fromAddr: default<string, AnyObject, string>; isOutbound: default<boolean, AnyObject, boolean>; lastName: default<string, AnyObject, string>; lastUpdateTime: default<string, AnyObject, string>; mediaType: default<string, AnyObject, string>; primaryDispositionId: default<number, AnyObject, number>; skillId: default<string, AnyObject, string>; skillName: default<string, AnyObject, string>; tags: any; teamId: default<string, AnyObject, string>; toAddr: default<string, AnyObject, string>; totalDurationSeconds: default<number, AnyObject, number> }>[]>
- API Returns contact History details for the Agent

getCRMDataForTransferedContact

getCRMDataForTransferedContact(crmInteractionId: string): Promise<unknown>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:848
Method to get the CRM data for transfered contact

example
Parameters
- crmInteractionId: string
  
  CRM record interaction id
Returns Promise<unknown>
- API Returns Response JSON with CRM data for transfered contact

getCRMDataForTransferedContactFromPolling

getCRMDataForTransferedContactFromPolling(crmInteractionId: string): Promise<unknown>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:879
Method to keep alive cacheKey

example
getCRMDataForTransferedContactFromPolling(crmInteractionId)

Parameters
- crmInteractionId: string
  
  CRM record interaction id
Returns Promise<unknown>

getCustomFieldsDefinitions

getCustomFieldsDefinitions(contactId?: string): Promise<CXoneCustomerCardCustomFields>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:97
Method to fetch custom field definition
example
Parameters
- contactId: string = ''
  
  Contact Id used as unique key for request deduplication when feature toggle is enabled
Returns Promise<CXoneCustomerCardCustomFields>
- API Returns Response JSON of Custom field definition

getCustomerDetails

getCustomerDetails(customerinfo: CustomerRequest): Promise<AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[]>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:152
Method to fetch Customer details by Full Name
example
Parameters
- customerinfo: CustomerRequest
Returns Promise<AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[]>
- API Returns Response JSON with specific Customer Details

getCustomerDetailsById

getCustomerDetailsById(customerId: string): Promise<AssertsShape<{ customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:199
Method to fetch Customer details by Id
example
Parameters
- customerId: string
Returns Promise<AssertsShape<{ customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>
- API Returns Response JSON with specific Customer Details

getCustomerNotesById

getCustomerNotesById(Id: { currentPageIndex: number; customerId: string }): Promise<CustomerCardNoteResponse>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:744
Method to fetch Customer details by Id
example
Parameters
- Id: { currentPageIndex: number; customerId: string }
  
  Customer Id of the Customer
  - currentPageIndex: number
  - customerId: string
Returns Promise<CustomerCardNoteResponse>
- API Returns Response JSON with list of Customer Notes

invokeECCService

invokeECCService(ECCPayload: ECCRequest): Promise<CreateInteractionResponse | UpdateInteractionResponse>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:912
Method to fetch livevox uuid for enhanced customer card
example
Parameters
- ECCPayload: ECCRequest
Returns Promise<CreateInteractionResponse | UpdateInteractionResponse>
- API Returns Response JSON with UUID as string value

Private isNewSearchRequest

isNewSearchRequest(newSearchText?: string): boolean

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:720
Used to check if the current request is a new search request or the already searched request

Parameters
- Optional newSearchText: string
  
  search string
Returns boolean
boolean stating if true that means its a new search request

mergeCustomerCard

mergeCustomerCard(cxoneMergeCustomerCardArguments: CXoneMergeCustomerCardArguments): Promise<HttpResponse | CXoneSdkError>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:693
Wrapper method used to call mergeCustomerCard() method
example
- mergeCustomerCard({currentCustomerId: 'asdafaf', customerIdToMerge: 'chat_dasfasf'})
Parameters
- cxoneMergeCustomerCardArguments: CXoneMergeCustomerCardArguments
Returns Promise<HttpResponse | CXoneSdkError>

Private normalizeVoiceContactHistoryResponse

normalizeVoiceContactHistoryResponse(completedContacts: unknown, isTenantSegmentationEnabled: boolean): Record<string, unknown>[]

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:437
Normalizes ACD voice contact history records so both V23 and V33 payload keys are supported.
example
```
this.normalizeVoiceContactHistoryResponse(response?.data?.completedContacts, true)
```
Parameters
- completedContacts: unknown
  
  Raw completed contacts collection from API response.
- isTenantSegmentationEnabled: boolean
  
  True when V33 endpoint is enabled.
Returns Record<string, unknown>[]
Normalized contacts with legacy-compatible keys.

searchCustomer

searchCustomer(searchedText: string, externalIds: string[], scrollToken?: string): Promise<AssertsShape<{ data: default<default<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[]>; scrollToken: default<string, AnyObject, string> }>>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:730
Method to search customers by Full Name
example
- searchCustomer(John Doe)
Parameters
- searchedText: string
  
  search field text to search details of the customer
- externalIds: string[]
- Optional scrollToken: string
Returns Promise<AssertsShape<{ data: default<default<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>[]>; scrollToken: default<string, AnyObject, string> }>>
- API Returns Response JSON with searched customer list

updateCustomFields

updateCustomFields(customFields: CustomerCardCustomFieldDetails): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/customer-card/service/customer-card-service.ts:232
Method to update all custom fields
example
Parameters
- customFields: CustomerCardCustomFieldDetails
Returns Promise<HttpResponse>
- API Returns Response code with success or failure

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CustomerCardService

Properties

Private DELETE_CUSTOMER_CUSTOM_FIELD

Private EXECUTE_WORKFLOW_URI

Private GET_CRM_DATA_FOR_TRANSFERED_CONTACT

Private auth

Private customerSearchScrollToken

Private isAbortDelayDigitalApiEnabled

logger

Private Readonly requestManager

Private searchText

Private urlUtilsService

Protected utilService

Methods

createNewCustomerNote

Parameters

customerId: string

note: string

Returns Promise<CXoneSdkError | CustomerCardNote>

deleteCustomField

Parameters

customFields: CXoneDeleteCustomField

Returns Promise<HttpResponse>

deleteCustomerNoteByNoteId

Parameters

customerId: string

noteId: string

Returns Promise<HttpResponse | CXoneSdkError>

editCustomerNoteByNoteId

Parameters

customerId: string

noteId: string

note: string

Returns Promise<CXoneSdkError | CustomerCardNote>

executeCreateWorkFlow

Parameters

crmRequest: CXoneWorkflowCreateRequest

Returns Promise<AgentWorkflowResponseEvent>

executeWorkFlow

Parameters

crmRequest: CXoneWorkflowRequest

Returns Promise<AgentWorkflowResponseEvent>

Private generatePayloadForExecuteWorkFlow

Parameters

request: CXoneWorkflowRequest

getAgentDigitalContactHistory

Parameters

ownerAssignee: string

getAgentVoiceContactHistory

Parameters

contactHistoryRequest: CXoneAgentVoiceContactHistoryRequest

getCRMDataForTransferedContact

Parameters

crmInteractionId: string

Returns Promise<unknown>

getCRMDataForTransferedContactFromPolling

Parameters

crmInteractionId: string

Returns Promise<unknown>

getCustomFieldsDefinitions

Parameters

contactId: string = ''

Returns Promise<CXoneCustomerCardCustomFields>

getCustomerDetails

Parameters

customerinfo: CustomerRequest

getCustomerDetailsById

Parameters

customerId: string

Returns Promise<AssertsShape<{ customFields: any; firstName: default<string, AnyObject, string>; fullName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; identities: any; image: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>

getCustomerNotesById

Parameters

Id: { currentPageIndex: number; customerId: string }