DigitalContactService | nice-cxone-acd-agent-apps

Class to handle digital contact related API calls

Hierarchy

DigitalContactService

Index

Constructors

constructor

Constructors

constructor

new DigitalContactService(): DigitalContactService

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:72
example
```
const digitalContactSvc = new DigitalContactService();
```
Returns DigitalContactService

Properties

Private APPROVE_DRAFT_MESSAGE

APPROVE_DRAFT_MESSAGE: string = '/dfo/3.0/contacts/{contactId}/message-drafts/{messageDraftId}/approval'

Private CREATE_DRAFT_MESSAGE

CREATE_DRAFT_MESSAGE: string = '/dfo/3.0/contacts/{contactId}/message-drafts'

Private DELETE_DRAFT_MESSAGE

DELETE_DRAFT_MESSAGE: string = '/dfo/3.0/contacts/{contactId}/message-drafts/{messageDraftId}'

Private DELETE_MESSAGE_BY_ID

DELETE_MESSAGE_BY_ID: string = '/dfo/3.0/messages/{messageId}/delete'

Private DIGITAL_DRAFT_CONTACT

DIGITAL_DRAFT_CONTACT: string = '/dfo/3.0/contacts/draft'

Private DIGITAL_QR_REPLACE_VARIABLES

DIGITAL_QR_REPLACE_VARIABLES: string = '/dfo/3.0/quick-responses/{quickResponseId}/replace-variables'

Private DIGITAL_QUICK_REPLIES_OUTBOUND

DIGITAL_QUICK_REPLIES_OUTBOUND: string = '/dfo/3.0/quick-responses'

Private DIGITAL_RECIPIENTS_VALIDATION

DIGITAL_RECIPIENTS_VALIDATION: string = '/dfo/3.0/channels/{channelId}/recipients/validation'

Private FOCUS_DEFOCUS_CONTACT

FOCUS_DEFOCUS_CONTACT: string = '/dfo/3.0/contacts/{contactId}/focus'

Private HIDE_MESSAGE_BY_ID

HIDE_MESSAGE_BY_ID: string = '/dfo/3.0/messages/{messageId}/hide'

Private LOAD_RELATED_CASES

LOAD_RELATED_CASES: string = '/dfo/3.0/contacts/{contactId}/detail/pagination'

Private QUICK_RESPONSE_REPLACE_VARIABLES

QUICK_RESPONSE_REPLACE_VARIABLES: string = '/rich-message-settings/1.0/quick-responses/{quickResponseId}/replace-variables'

Private REJECT_DRAFT_MESSAGE

REJECT_DRAFT_MESSAGE: string = '/dfo/3.0/contacts/{contactId}/message-drafts/{messageDraftId}/refusal'

Private RELATED_MESSAGES

RELATED_MESSAGES: string = '/dfo/3.0/contacts/{contactId}/related-messages'

Private UPDATE_DRAFT_MESSAGE

UPDATE_DRAFT_MESSAGE: string = '/dfo/3.0/contacts/{contactId}/message-drafts/{messageDraftId}'

Private adminService

adminService: AdminService

Private auth

auth: CXoneAuth

Private isAbortDelayDigitalApiEnabled

isAbortDelayDigitalApiEnabled: boolean = ...

logger

logger: CcfLogger = ...

Private Readonly requestManager

requestManager: RequestManager = ...

Private urlUtilsService

urlUtilsService: UrlUtilsService = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

approveDraftMessage

approveDraftMessage(contactId: string, messageDraftId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:839
Method to approveDraftMessage

example
Parameters
- contactId: string
- messageDraftId: string
Returns Promise<HttpResponse>
response from API

changeAssignedUser

changeAssignedUser(contactId: string, cxoneUserId: string): Promise<HttpResponse | CXoneSdkError>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:269
Method to assign customer contact to User
example
```
changeAssignedUser('123332', '645337')
```
Parameters
- contactId: string
  
  Contact Id of the digital contact
- cxoneUserId: string
Returns Promise<HttpResponse | CXoneSdkError>
- HttpResponse | CXoneSdkError

changeCustomerContactStatus

changeCustomerContactStatus(caseId: string, status: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:83
Method to change status of digital contact
example
Parameters
- caseId: string
  
  Case Id of the digital contact
- status: string
  
  Status to be set to the digital contact
Returns Promise<HttpResponse>

changeRoutingQueue

changeRoutingQueue(contactId: string, skillId: string): Promise<HttpResponse | CXoneSdkError>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:216
Method to assign customer contact to routing queue
example
Parameters
- contactId: string
  
  Contact Id of the digital contact
- skillId: string
  
  Id of the skill queue where the contact it to be assigned
Returns Promise<HttpResponse | CXoneSdkError>

createDraftMessage

createDraftMessage(draftMessage: CXoneDigitalCreateDraftRequest, contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:756
Method to createDraftMessage

example
Parameters
- draftMessage: CXoneDigitalCreateDraftRequest
- contactId: string
Returns Promise<HttpResponse>
response from API

createOutboundDraftContact

createOutboundDraftContact(draftContactRequest: CXoneDigitalDraftContactRequest): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:1113
Creates or upsert a draft contact When draftContactId is omitted in the request a new draft is created. When draftContactId is provided the existing draft is updated (upsert).

example
createOutboundDraftContact(draftContactRequest)

Parameters
- draftContactRequest: CXoneDigitalDraftContactRequest
  
  CXoneDigitalDraftContactRequest containing channelId, recipients and optional draftContactId
Returns Promise<HttpResponse>
HttpResponse containing the draftContactId

deFocusContact

deFocusContact(contactIdToDefocus: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:931
Method to de-focus a digital contact
example
- deFocusContact()
Parameters
- contactIdToDefocus: string
Returns Promise<HttpResponse>
response - Focus DEL API

deleteDraftMessage

deleteDraftMessage(contactId: string, messageDraftId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:812
Method to deleteDraftMessage

example
Parameters
- contactId: string
- messageDraftId: string
Returns Promise<HttpResponse>
response from API

deleteMessage

deleteMessage(messageId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:675
Method to delete a message - argument - messageId
example
- deleteMessage(messageId)
Parameters
- messageId: string
  
  message id of the message
Returns Promise<HttpResponse>
response - Delete API

fetchQuickResponseReplaceVariable

fetchQuickResponseReplaceVariable(quickResponseId: string, digitalContactVariableDetails: CXoneQuickReplyReplaceVariableRequest): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:1072
Method to get digital contact's quick response replace variables when hasVariables flag comes as true
example
- fetchQuickResponseReplaceVariable('12ynj23', {contact: {contactNumber: '12345'}, externalVariables: []})
Parameters
- quickResponseId: string
- digitalContactVariableDetails: CXoneQuickReplyReplaceVariableRequest
Returns Promise<HttpResponse>
- return the content of replace variables of quick response

focusContact

focusContact(contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:898
Method to focus a digital contact
example
- focusContact(caseId)
Parameters
- contactId: string
Returns Promise<HttpResponse>
response - Focus POST API

getBulkReplyHistory

getBulkReplyHistory(): Promise<CXoneSdkError | BulkReplyHistoryResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:160
Method to Get the bulk reply history
example
Returns Promise<CXoneSdkError | BulkReplyHistoryResponse>

getCaseHistory

getCaseHistory(contactId: string, pageNumber: number, pageSize: number): Promise<unknown>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:1041
Method to get history data for a case interaction
example
```
getCaseHistory('12345',1,10)
```
Parameters
- contactId: string
  
  Contact Id of the digital contact
- pageNumber: number
  
  page number
- pageSize: number
  
  page Size
Returns Promise<unknown>
- returns the history object with events

getDigitalContactDetails

getDigitalContactDetails(contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:346
Method to get contact details based on user slot API digital contact Id
example
Parameters
- contactId: string
Returns Promise<HttpResponse>

Private getLoggedInUserId

getLoggedInUserId(): string

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:250
Method to get logged in user id from local storage
example
- getLoggedInUserId()
Returns string
- User Id of the logged in user

getMessageById

getMessageById(messageId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:649
Method to get whole message content with html formatting
example
- getMessageById
Parameters
- messageId: string
  
  message id of the message
Returns Promise<HttpResponse>
- detailed message response

getQuickReplies

getQuickReplies(contactId: string, page?: number, size?: string | number, search?: string): Promise<CXoneDigitalQuickReply[]>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:453
Method to get quick replies data
example
```
getQuickReplies('234567', 1, 10, '')
```
Parameters
- contactId: string
  
  Contact Id of the digital contact
- page: number = 1
  
  start index for pagination
- size: string | number = 1000
  
  total records to be fetched
- search: string = ''
  
  This is content or title to be searched
Returns Promise<CXoneDigitalQuickReply[]>
- return the list of Quick replies

getQuickRepliesForOutboundContact

getQuickRepliesForOutboundContact(page?: number, channelId?: string, size?: string | number, search?: string): Promise<CXoneDigitalOutboundQuickReply>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:501
Method to get quick responses for outbound data
example
```
getQuickRepliesForOutboundContact(1, 10, '')
```
Parameters
- page: number = 1
  
  start index for pagination
- Optional channelId: string
- size: string | number = 1000
  
  total records to be fetched
- search: string = ''
  
  This is content or title to be searched
Returns Promise<CXoneDigitalOutboundQuickReply>
- return the list of Quick replies

getRelatedMessages

getRelatedMessages(contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:387
Method to get all related message threads for a public channel digital contact
example
Parameters
- contactId: string
Returns Promise<HttpResponse>

getReplaceQuickResponseVariables

getReplaceQuickResponseVariables(quickReplyId: string): Promise<CXoneDigitalReplaceVariables>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:589
Method to get digital contact quick reply replace variables
example
```
getReplaceQuickResponseVariables(44)
```
Parameters
- quickReplyId: string
  
  Unique identification for quick reply
Returns Promise<CXoneDigitalReplaceVariables>
- return the content of replace variable

getReplaceVariables

getReplaceVariables(contactId: string, quickReplyId: string): Promise<CXoneDigitalReplaceVariables>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:550
Method to get DFO chat replace variables
example
```
getReplaceVariables('234567', 44)
```
Parameters
- contactId: string
  
  Contact Id of the digital contact
- quickReplyId: string
  
  Unique identification for quick reply
Returns Promise<CXoneDigitalReplaceVariables>
- return the content of replace variable

getTraceIdFromResponseHeader

getTraceIdFromResponseHeader(response: HttpResponse): string

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:1100
Method to get traceId from response headers
example
- getTraceIdFromResponseHeader(response)
Parameters
- response: HttpResponse
  
  HttpResponse object
Returns string
- traceId string or empty string if not found

hideUnhideMessage

hideUnhideMessage(messageData: { isHidden: boolean; msgId: string }): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:708
Method to hide/unhide whole message
example
- hideUnhideMessage
Parameters
- messageData: { isHidden: boolean; msgId: string }
  - isHidden: boolean
  - msgId: string
Returns Promise<HttpResponse>
- detailed message response

loadPreviousNextCases

loadPreviousNextCases(contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:994
Method to fetch previous and next related cases of current digital contact
example
- loadPreviousNextCases('2345678')
Parameters
- contactId: string
  
  Contact Id of the digital contact
Returns Promise<HttpResponse>

postOutboundReply

postOutboundReply(sendReplyRequest: CXoneDigitalReplyRequest, channelId: string, xTraceId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:310
Method to send reply

example
postOutboundReply(postOutboundReply, channelId, xTraceId)

Parameters
- sendReplyRequest: CXoneDigitalReplyRequest
  
  message object
- channelId: string
  
  channel Id
- xTraceId: string
  
  xTraceId to trace the message
Returns Promise<HttpResponse>
response from /dfo/3.0/channels/channel_id/outbound API

refuseDraftMessage

refuseDraftMessage(contactId: string, messageDraftId: string, reason?: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:867
Method to refuseDraftMessage

example
Parameters
- contactId: string
  
  contact Id
- messageDraftId: string
  
  draft message id
- Optional reason: string
  
  reason for refusal
Returns Promise<HttpResponse>
response from API

sendBulkReply

sendBulkReply(selectedContactIds: string[], messageContent: string, cxoneUserId: string): Promise<CXoneSdkError | BulkReplyResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:118
Method to send bulk reply
example
- sendBulkReply(['12345'], 'test', '457677')
Parameters
- selectedContactIds: string[]
  
  Selected contact IDs
- messageContent: string
  
  Message content
- cxoneUserId: string
  
  Agent ID of logged in user
Returns Promise<CXoneSdkError | BulkReplyResponse>

subscribeToEventHub

subscribeToEventHub(relationObjectId: string, subscriptionType?: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:413
Method to subscribe to event hub for the event not coming fromm web socket
example
Parameters
- relationObjectId: string
- subscriptionType: string = 'contact'
Returns Promise<HttpResponse>

unassignCustomerContact

unassignCustomerContact(contactId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:186
Method to unassign customer contact
example
Parameters
- contactId: string
Returns Promise<HttpResponse>

updateDraftMessage

updateDraftMessage(draftMessage: CXoneDigitalUpdateDraftRequest, contactId: string, messageDraftId: string): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:784
Method to updateDraftMessage

example
Parameters
- draftMessage: CXoneDigitalUpdateDraftRequest
- contactId: string
- messageDraftId: string
Returns Promise<HttpResponse>
response from API

updateMessageReadStatus

updateMessageReadStatus(messageId: string): Promise<unknown>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:965
Method to mark a digital case as read when it is focused
example
- markMessageAsRead(messageId)
Parameters
- messageId: string
Returns Promise<unknown>
response - whether the isRead field was successfully updated or not

uploadAttachment

uploadAttachment(uploadDetails: CXoneFileUploadRequest): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:619
Method to upload attachment to s3 bucket for digital contact
example
Parameters
- uploadDetails: CXoneFileUploadRequest
Returns Promise<HttpResponse>

validateRecipients

validateRecipients(channelId: string, recipientsValidationRequest: CXoneDigitalRecipientsValidationRequest): Promise<HttpResponse>

- Defined in digital-sdk/src/lib/digital/service/digital-contact-service.ts:1144
Validates recipients for an outbound contact Should only be called when the channel flag canPredictThreadIdOnExternalPlatform is true.

example
validateRecipients('ch-1', recipientsValidationRequest)

Parameters
- channelId: string
  
  ID of the digital channel
- recipientsValidationRequest: CXoneDigitalRecipientsValidationRequest
Returns Promise<HttpResponse>
HttpResponse containing per-recipient validation results

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DigitalContactService

Properties

Private APPROVE_DRAFT_MESSAGE

Private CREATE_DRAFT_MESSAGE

Private DELETE_DRAFT_MESSAGE

Private DELETE_MESSAGE_BY_ID

Private DIGITAL_DRAFT_CONTACT

Private DIGITAL_QR_REPLACE_VARIABLES

Private DIGITAL_QUICK_REPLIES_OUTBOUND

Private DIGITAL_RECIPIENTS_VALIDATION

Private FOCUS_DEFOCUS_CONTACT

Private HIDE_MESSAGE_BY_ID

Private LOAD_RELATED_CASES

Private QUICK_RESPONSE_REPLACE_VARIABLES

Private REJECT_DRAFT_MESSAGE

Private RELATED_MESSAGES

Private UPDATE_DRAFT_MESSAGE

Private adminService

Private auth

Private isAbortDelayDigitalApiEnabled

logger

Private Readonly requestManager

Private urlUtilsService

Protected utilService

Methods

approveDraftMessage

Parameters

contactId: string

messageDraftId: string

Returns Promise<HttpResponse>

changeAssignedUser

Parameters

contactId: string

cxoneUserId: string

Returns Promise<HttpResponse | CXoneSdkError>

changeCustomerContactStatus

Parameters

caseId: string

status: string

Returns Promise<HttpResponse>

changeRoutingQueue

Parameters

contactId: string

skillId: string

Returns Promise<HttpResponse | CXoneSdkError>

createDraftMessage

Parameters

draftMessage: CXoneDigitalCreateDraftRequest

contactId: string

Returns Promise<HttpResponse>

createOutboundDraftContact

Parameters

draftContactRequest: CXoneDigitalDraftContactRequest

Returns Promise<HttpResponse>

deFocusContact

Parameters

contactIdToDefocus: string

Returns Promise<HttpResponse>

deleteDraftMessage

Parameters

contactId: string

messageDraftId: string

Returns Promise<HttpResponse>

deleteMessage

Parameters

messageId: string

Returns Promise<HttpResponse>

fetchQuickResponseReplaceVariable

Parameters

quickResponseId: string

digitalContactVariableDetails: CXoneQuickReplyReplaceVariableRequest

Returns Promise<HttpResponse>

focusContact