Options
All
  • Public
  • Public/Protected
  • All
Menu

Class containing properties and methods related to a digital contact

Hierarchy

Index

Constructors

Properties

acwTypeId?: number
remarks
  • represent model for ACW Type Id value
attachments?: { attachments: AttachmentType[] }
remarks
  • represents metadata stored in local storage for attachments uploaded by user

Type declaration

case: 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>; 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> }>
remarks
  • represents model for case.
caseId: string
remarks
  • The identifier of case in digital platform of a digital contact. This is id field in case object (case->id) in Digital and DFOContactId in ACD getNextEvent.
channel: AssertsShape<{ externalPlatformIcon: RequiredStringSchema<string, AnyObject>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: RequiredStringSchema<string, AnyObject>; isPrivate: RequiredBooleanSchema<boolean, AnyObject>; isTrackingMessageDeliveryStatus: default<boolean, AnyObject, boolean>; name: RequiredStringSchema<string, AnyObject>; realExternalPlatformId: RequiredStringSchema<string, AnyObject>; wysiwygEnabled: default<boolean, AnyObject, boolean> } & {} & { hasAbilityToChangeFrom: default<boolean, AnyObject, boolean>; hasAbilityToChangeRecipient: default<boolean, AnyObject, boolean>; hasAbilityToDelete: default<boolean, AnyObject, boolean>; hasAbilityToForwardMessage: default<boolean, AnyObject, boolean>; hasAbilityToHide: default<boolean, AnyObject, boolean>; hasAbilityToLike: default<boolean, AnyObject, boolean>; hasAbilityToQuoteMessage: default<boolean, AnyObject, boolean>; hasAbilityToSendFiles: default<boolean, AnyObject, boolean>; hasAbilityToShare: default<boolean, AnyObject, boolean>; hasAbilityToTag: default<boolean, AnyObject, boolean>; hasCcAndBcc: default<boolean, AnyObject, boolean>; hasCustomerOnThirdParty: default<boolean, AnyObject, boolean>; hasEditableTitle: default<boolean, AnyObject, boolean>; hasMultipleRecipient: default<boolean, AnyObject, boolean>; hasMultipleThreadsPerEndUser: default<boolean, AnyObject, boolean>; hasOutboundFlow: default<boolean, AnyObject, boolean>; hasOutboundTemplates: default<boolean, AnyObject, boolean>; hasPostAsPlaceholder: default<boolean, AnyObject, boolean>; hasPublishing: default<boolean, AnyObject, boolean>; hasReply: default<boolean, AnyObject, boolean>; hasTreeStructure: default<boolean, AnyObject, boolean>; hasVisibleRecipients: default<boolean, AnyObject, boolean>; hasVisibleTitle: default<boolean, AnyObject, boolean>; replyPrefixMentionTemplate: default<string, AnyObject, string> }>
remarks
  • model properties for channel.
channelType: string
coBrowseLink?: string
remarks
  • stores coBrowse surfly link
contactCustomFieldDefs?: AssertsShape<{ ident: RequiredStringSchema<string, AnyObject>; isEditable: RequiredBooleanSchema<boolean, AnyObject>; isRequired: RequiredBooleanSchema<boolean, AnyObject>; isVisibleInAgentConsole: RequiredBooleanSchema<boolean, AnyObject>; isVisibleInChatPreSurvey: RequiredBooleanSchema<boolean, AnyObject>; label: RequiredStringSchema<string, AnyObject>; type: RequiredStringSchema<string, AnyObject>; value: default<string, AnyObject, string>; values: any }>[]
remarks
  • list of contact custom fields assigned to case
contactID: string
remarks
  • 'contactID' is identifier for the ACD contacts only. For DFO Contact please refer 'caseID' property in CXoneDigitalContact
customerMessageUpdatedAt: Date
remarks
  • used to check if message is updated at
customerName: string
digitalContactService: DigitalContactService
eventDetails: AssertsShape<{ eventId: default<string, AnyObject, string>; eventObject: default<string, AnyObject, string>; eventType: RequiredStringSchema<string, AnyObject> }>
remarks
  • represents model for websocket events received
fromProvider?: string
remarks
  • represent model for denoting type of parent interaction while elevating
hasUnreadMessage: boolean
remarks
  • used to check if message is updated at
inboxAssignee: AssertsShape<{ emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: RequiredNumberSchema<number, AnyObject>; incontactId: RequiredStringSchema<string, AnyObject>; loginUsername: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>
remarks
  • represents model for inboxAssignee.
interactionId: string
remarks
  • represent model for interaction id
isAssignedToAgentInbox?: boolean
remarks
  • flag that determines whether case is assigned to agent inbox or not(false for view only cases)
isCaseAssigned: boolean
remarks
  • flag to differential case assignment or transfer
isCoBrowseEnabled?: boolean = false
remarks
  • stores coBrowse status
logger: Logger = ...
maxSecondsACW?: number
remarks
  • represent model for max seconds ACW
messageDrafts: AssertsShape<Assign<ObjectShape, { attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; channel: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; id: RequiredStringSchema<string, AnyObject>; isRefused: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: 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> }>>[]>; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; title: default<string, AnyObject, string>; user: any }>>[] = []
remarks
  • this will use to store list of all draft messages related to current case from MessageAddedIntoCase WS event
messageNote: ContactMessageNote
remarks
  • conversationNote of case in digital platform of a digital contact. This is note details which store content of note specific to in case object (case->id) in Digital status: true if message note is opened or false if closed content: holds the note message
messages: AssertsShape<Assign<ObjectShape, { _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>>[] = []
remarks
  • this will use to store list of all messages related to current case from MessageAddedIntoCase WS event
originURL?: string = ''
remarks
  • URL to jump to origin of message and case
previousCaseId?: string
remarks
  • caseId of the previous case
previousConversationMessages?: any[]
remarks
  • stores details about the previous case
publicMessagesParentChildMap: any
remarks
  • used to maintain the parent child map for public channel
publicMessagesTree: CXonePublicMessage
remarks
  • used to maintain the parent child message tree for public channel
refusalTimeOut: number
replyChannels?: AssertsShape<Assign<ObjectShape, { canAgentInviteCustomersToContact: default<boolean, AnyObject, boolean>; canReplyToAnyMessage: default<boolean, AnyObject, boolean>; canSaveResponse: default<boolean, AnyObject, boolean>; channelId: default<string, AnyObject, string>; channelIntegrationId: default<string, AnyObject, string>; contentFormat: default<string, AnyObject, string>; externalPlatformAvatar: default<string, AnyObject, string>; externalPlatformIcon: default<string, AnyObject, string>; externalPlatformId: default<string, AnyObject, string>; hasAbilityToChangeFrom: default<boolean, AnyObject, boolean>; hasAbilityToChangeRecipient: default<boolean, AnyObject, boolean>; hasAbilityToDelete: default<boolean, AnyObject, boolean>; hasAbilityToForwardMessage: default<boolean, AnyObject, boolean>; hasAbilityToHide: default<boolean, AnyObject, boolean>; hasAbilityToLike: default<boolean, AnyObject, boolean>; hasAbilityToQuoteMessage: default<boolean, AnyObject, boolean>; hasAbilityToSendFiles: default<boolean, AnyObject, boolean>; hasAbilityToShare: default<boolean, AnyObject, boolean>; hasAbilityToTag: default<boolean, AnyObject, boolean>; hasCcAndBcc: default<boolean, AnyObject, boolean>; hasCustomerOnThirdParty: default<boolean, AnyObject, boolean>; hasEditableTitle: default<boolean, AnyObject, boolean>; hasManualOutboundFlow: default<boolean, AnyObject, boolean>; hasMultipleRecipient: default<boolean, AnyObject, boolean>; hasMultipleThreadsPerEndUser: default<boolean, AnyObject, boolean>; hasOutboundFlow: default<boolean, AnyObject, boolean>; hasOutboundTemplates: default<boolean, AnyObject, boolean>; hasPostAsPlaceholder: default<boolean, AnyObject, boolean>; hasPublishing: default<boolean, AnyObject, boolean>; hasReply: RequiredBooleanSchema<boolean, AnyObject>; hasTreeStructure: default<boolean, AnyObject, boolean>; hasVisibleRecipients: default<boolean, AnyObject, boolean>; hasVisibleTitle: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isAutomaticSignatureAttached: default<boolean, AnyObject, boolean>; isCaseBasedStorage: default<boolean, AnyObject, boolean>; isDeleted: default<boolean, AnyObject, boolean>; isHidden: default<boolean, AnyObject, boolean>; isLiveChat: default<boolean, AnyObject, boolean>; isPostWritable: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; isTrackingMessageDeliveryStatus: default<boolean, AnyObject, boolean>; isVisibleInSettingsChannels: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string>; nicknameOnExternalPlatform: default<string, AnyObject, string>; originId: default<string, AnyObject, string>; ownerUserId: default<number, AnyObject, number>; realExternalPlatformId: default<string, AnyObject, string>; replyPrefixMentionTemplate: default<string, AnyObject, string>; shouldBeNotifiedAboutReassign: default<boolean, AnyObject, boolean>; studioScript: default<string, AnyObject, string>; translationGroup: default<string, AnyObject, string>; type: default<string, AnyObject, string>; wysiwygEnabled: default<boolean, AnyObject, boolean> }>>[]
remarks
  • stores details about reply channels
requireDisposition?: boolean
remarks
  • represent model for require disposition value
routingQueue: 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> }>
remarks
  • represents model properties for routingQueue.
skill: string
remarks
  • represent model for contact skill
skillName: string
remarks
  • represent model for skill name
startTime: Date
remarks
  • represent model for start time
status: string
remarks
  • represent model for contact status
type: string
remarks
  • represent model for contact type
updatedMessageNote: CxoneDigitalMessageNote
remarks
  • updatedMessageNote of case in digital platform of a digital contact. This holds the message note details which has been created/deleted/updated published after capturing the web socket event
userRolePermissions: AssertsShape<{ canApproveDraft: RequiredBooleanSchema<boolean, AnyObject>; canAssign: RequiredBooleanSchema<boolean, AnyObject>; canCreateDraft: RequiredBooleanSchema<boolean, AnyObject>; canReply: RequiredBooleanSchema<boolean, AnyObject>; canUnassign: RequiredBooleanSchema<boolean, AnyObject> }>
remarks
  • represents user role permissions

Methods

  • approveDraftMessage(draftMessageId: string): Promise<HttpResponse>
  • Method to approveDraftMessage

    Parameters

    • draftMessageId: string

    Returns Promise<HttpResponse>

    • promise HttpResponce/error
    @example
    approveDraftMessage( id)
  • Method to change routing queue

    Parameters

    • skillId: string

    Returns Promise<HttpResponse | CXoneSdkError>

    • returns customer contact assignment to routing queue response
    @example
    changeRoutingQueue()
  • Method to change Digital Contact Status

    Parameters

    • status: string

    Returns Promise<HttpResponse | CXoneSdkError>

    @example
    changeStatus()
  • Method to change User

    Parameters

    • cxoneUserId: string

    Returns Promise<HttpResponse | CXoneSdkError>

    • returns customer contact assignment to user response
    @example
    changeUser()
  • checkForAdditionalMessageContent(inputMessages: AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>[]): Promise<AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>[]>
  • Method to check if messages has additional content

    Parameters

    • inputMessages: AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>[]

    Returns Promise<AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>[]>

    • complete message content with html tags
    @example
    checkForAdditionalMessageContent()
  • deleteDraftMessage(draftMessageId: string): Promise<HttpResponse>
  • Method to deleteDraftMessage

    Parameters

    • draftMessageId: string

    Returns Promise<HttpResponse>

    • promise HttpResponce/error
    @example
    deleteDraftMessage( id)
  • deleteMessage(messageId: string): Promise<unknown>
  • Method to delete message

    example
    deleteMessage(messageId)
    

    Parameters

    • messageId: string

      MessageID

    Returns Promise<unknown>

  • getAdditionalMessageContent(messageId: string): Promise<HttpResponse>
  • Method to getAdditionalMessageContent

    Parameters

    • messageId: string

    Returns Promise<HttpResponse>

    • complete message content with html tags
    @example
    getAdditionalMessageContent()
  • getSingleMessageAdditionalContent(inputMessage: AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>): Promise<AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>>
  • Method to get additional message content for single message in case of websocket response

    Parameters

    • inputMessage: AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>

    Returns Promise<AssertsShape<{ _changes: default<default<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { currentValue: MixedSchema<any, AnyObject, any>; fieldName: default<string, AnyObject, string> }>>[]>; attachments: default<default<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; isInline: RequiredBooleanSchema<boolean, AnyObject>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; url: default<string, AnyObject, string> }>>[]>; authorEndUserIdentity: any; authorNameRemoved: any; authorUser: any; channel: any; channelName: default<string, AnyObject, string>; channelType: default<string, AnyObject, string>; contactNumber: default<string, AnyObject, string>; contentRemoved: any; createdAt: RequiredStringSchema<string, AnyObject>; customerStatistics: any; delivered: default<default<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>, AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[], AssertsShape<Assign<ObjectShape, { deliveredAt: default<string, AnyObject, string>; isSuccess: default<boolean, AnyObject, boolean>; reason: default<string, AnyObject, string> }>>[]>; deviceFingerprint: any; direction: RequiredStringSchema<string, AnyObject>; forward: any; hasAdditionalMessageContent: default<boolean, AnyObject, boolean>; id: RequiredStringSchema<string, AnyObject>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isHiddenOnExternalPlatform: RequiredBooleanSchema<boolean, AnyObject>; isRead: default<boolean, AnyObject, boolean>; isRelatedMessage: default<boolean, AnyObject, boolean>; isReplyAllowed: default<boolean, AnyObject, boolean>; isReplyToSpecificMessage: default<boolean, AnyObject, boolean>; messageContent: any; messageNotes: default<default<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>, AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[], AssertsShape<Assign<ObjectShape, { content: RequiredStringSchema<string, AnyObject>; createdAt: RequiredStringSchema<string, AnyObject>; currentAssignee: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; message: default<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { id: RequiredStringSchema<string, AnyObject> }>>>; status: default<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { type: RequiredStringSchema<string, AnyObject> }>>>; updatedAt: RequiredStringSchema<string, AnyObject>; user: any }>>[]>; postId: RequiredStringSchema<string, AnyObject>; reactionStatistics: any; readAt: default<string, AnyObject, string>; 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> }>>[]>; replyChannel: any; replyToMessage: any; sentStatus: default<string, AnyObject, string>; tags: default<default<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>, AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>>, AnyObject, TypeOfShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[], AssertsShape<Assign<ObjectShape, { color: RequiredStringSchema<string, AnyObject>; id: RequiredNumberSchema<number, AnyObject>; title: RequiredStringSchema<string, AnyObject> }>>[]>; threadId: RequiredStringSchema<string, AnyObject>; threadIdOnExternalPlatform: default<string, AnyObject, string>; title: default<string, AnyObject, string>; url: default<string, AnyObject, string>; xTraceId: default<string, AnyObject, string> }>>

    • complete message content with html tags
    @example
    getSingleMessageAdditionalContent()
  • Method to hideMessage

    Parameters

    • messageData: { isHidden: boolean; msgId: string }
      • isHidden: boolean
      • msgId: string

    Returns Promise<HttpResponse | CXoneSdkError>

    • response
    @example
    hideUnhideMessage()
  • loadConversationHistory(contactId: string): Promise<any>
  • Method to get conversation history of previous/next contact of current digital contact

    Parameters

    • contactId: string

      Contact Id of the digital contact

      @example
      loadConversationHistory('2345678')

    Returns Promise<any>

  • loadRelatedDigitalContacts(contactId: string): Promise<AssertsShape<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string> }>>
  • Method to get previous & next case ids of current digital contact

    Parameters

    • contactId: string

      Contact Id of the digital contact

      @example
      loadRelatedDigitalContacts('2345678')

    Returns Promise<AssertsShape<{ next: default<string, AnyObject, string>; previous: default<string, AnyObject, string> }>>

  • parse(validatedResponse: {}): Promise<void>
  • Method to parse web socket event response

    example

    Parameters

    • validatedResponse: {}
      • [key: string]: any

    Returns Promise<void>

    • parsed response based on predefined schema
  • rejectDraftMessage(draftMessageId: string): Promise<HttpResponse>
  • Method to rejectDraftMessage

    Parameters

    • draftMessageId: string

    Returns Promise<HttpResponse>

    • promise HttpResponce/error
    @example
    rejectDraftMessage( id)
  • Method to replace quick reply variables

    example
    replaceQuickReplyVariables()
    

    Parameters

    • quickReplyId: string

      Unique identification for quick reply

    Returns Promise<CXoneDigitalReplaceVariables>

  • Method to send reply

    example

    TODO: This method signature should receive object from map need to update this method after websocket implementation

    Parameters

    Returns Promise<HttpResponse | CXoneSdkError>

    • returns the send reply response
  • subscribeToEventHub(): void
  • Method to subscribeToEventHub

    Returns void

    • returns promise to event hub subscription call
    @example
    subscribeToEventHub()
  • Method to unassign customer contact

    Returns Promise<HttpResponse | CXoneSdkError>

    • returns customer contact unassigned response
    @example
    unassign()
  • upload(uploadDetails: CXoneFileUploadRequest, uId: string): Promise<AssertsShape<{ expireAt: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; uId: RequiredStringSchema<string, AnyObject>; url: RequiredStringSchema<string, AnyObject> }>>
  • Method to upload digital channel attachment

    Parameters

    Returns Promise<AssertsShape<{ expireAt: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; uId: RequiredStringSchema<string, AnyObject>; url: RequiredStringSchema<string, AnyObject> }>>

    • returns s3 bucket URL in Response
    @example
    upload() takes CXoneFileUploadRequest as parameter for uploading file to s3 bucket

Generated using TypeDoc