AgentHiveOutboundMessageService | nice-cxone-acd-agent-apps

Service to handle Outbound messages API calls on Agent Hive

Hierarchy

AgentHiveOutboundMessageService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AgentHiveOutboundMessageService(): AgentHiveOutboundMessageService

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:39
example
```
const agentHiveSvc = new AgentHiveOutboundMessageService();
```
Returns AgentHiveOutboundMessageService

Properties

Private abortController

abortController: AbortController = null

Private auth

auth: CXoneAuth

Private baseUrl

baseUrl: string = ''

logger

logger: CcfLogger = ...

Private requestId

requestId: number = 0

Protected utilService

utilService: HttpUtilService = ...

Methods

clearUnreadMessages

clearUnreadMessages(receiverId: string, threadId: string): Promise<void>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:147
Method to clear unread messages for a specific thread and user
example
- clearUnreadMessages('user123', 'thread456')
Parameters
- receiverId: string
- threadId: string
  
  The unique identifier of the thread
Returns Promise<void>
A promise that resolves when the unread messages are cleared

fetchRecentChatThreads

fetchRecentChatThreads(userId: string): Promise<AgentHiveRecentChatThreads[]>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:319
Method to get all recent chat threads
example
- fetchRecentChatThreads()
Parameters
- userId: string
Returns Promise<AgentHiveRecentChatThreads[]>

fetchUserMessages

fetchUserMessages(userMessageRequest?: string[], skip?: number, top?: number, contentContains?: string): Promise<AssertsShape<{ data: default<OptionalObjectSchema<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>>, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[], AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[]>; hits: RequiredNumberSchema<number, AnyObject>; scrollToken: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:177
Method to fetch User Messages
example
- fetchUserMessages(userMessageRequest,skip,top)
Parameters
- userMessageRequest: string[] = []
- skip: number = 0
- top: number = 15
- Optional contentContains: string
Returns Promise<AssertsShape<{ data: default<OptionalObjectSchema<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>>, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[], AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[]>; hits: RequiredNumberSchema<number, AnyObject>; scrollToken: default<string, AnyObject, string> }>>

getChannelId

getChannelId(): Promise<AssertsShape<{ channelId: RequiredStringSchema<string, AnyObject>; errorCode: default<string, AnyObject, string>; tenantId: RequiredStringSchema<string, AnyObject> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:239
Method to get channel id for a user
example
```
getChannelId();
```
Returns Promise<AssertsShape<{ channelId: RequiredStringSchema<string, AnyObject>; errorCode: default<string, AnyObject, string>; tenantId: RequiredStringSchema<string, AnyObject> }>>

getThreadMessages

getThreadMessages(threadId?: string, skip?: number, top?: number, contentContains?: string): Promise<AssertsShape<{ data: default<OptionalObjectSchema<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>>, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[], AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[]>; hits: RequiredNumberSchema<number, AnyObject>; scrollToken: default<string, AnyObject, string> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:57
Method to get all thread details
example
- getThreadMessages('1234567890', 0, 15)
```
getThreadMessages('1234567890', 0, 15);
```
Parameters
- Optional threadId: string
  
  The unique identifier of the thread to fetch messages for. If not provided, an empty string is used.
- skip: number = 0
  
  The number of messages to skip for pagination. Defaults to 0.
- top: number = 15
  
  The maximum number of messages to retrieve. Defaults to 15.
- Optional contentContains: string
Returns Promise<AssertsShape<{ data: default<OptionalObjectSchema<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>>, AnyObject, TypeOfShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[], AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: RequiredStringSchema<string, AnyObject>; inline: default<boolean, AnyObject, boolean>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: RequiredStringSchema<string, AnyObject>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; createdAtWithMilliseconds: default<string, AnyObject, string>; deletedOnExternalPlatform: default<boolean, AnyObject, boolean>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isDeletedOnExternalPlatform: default<boolean, AnyObject, boolean>; messageContent: OptionalObjectSchema<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ createdAtWithMilliseconds: default<string, AnyObject, string>; fallbackText: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isAutoTranslated: default<boolean, AnyObject, boolean>; parameters: OptionalObjectSchema<{ value: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ value: default<string, AnyObject, string> }>>; payload: OptionalObjectSchema<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ elements: default<OptionalObjectSchema<ObjectShape, AnyObject, TypeOfShape<ObjectShape>>, AnyObject, TypeOfShape<ObjectShape>[], AssertsShape<ObjectShape>[]>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string> }>>; postback: default<string, AnyObject, string>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; postId: default<string, AnyObject, string>; recipients: default<OptionalObjectSchema<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[], AssertsShape<{ anonymizedAt: default<string, AnyObject, string>; anonymizedReason: default<string, AnyObject, string>; idOnExternalPlatform: default<string, AnyObject, string>; isPrimary: default<boolean, AnyObject, boolean>; isPrivate: default<boolean, AnyObject, boolean>; name: default<string, AnyObject, string> }>[]>; sentiment: default<string, AnyObject, string>; threadId: default<string, AnyObject, string>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<string, AnyObject, string>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; isBotUser: default<boolean, AnyObject, boolean>; isSurveyUser: default<boolean, AnyObject, boolean>; loginUsername: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string>; userType: default<string, AnyObject, string> }>> }>[]>; hits: RequiredNumberSchema<number, AnyObject>; scrollToken: default<string, AnyObject, string> }>>
A promise that resolves to the validated thread messages details (AgentHiveThreadsDetails).

getUnreadMessages

getUnreadMessages(userId: string): Promise<AssertsShape<{ count: RequiredNumberSchema<number, AnyObject>; group: RequiredBooleanSchema<boolean, AnyObject>; receiverId: RequiredStringSchema<string, AnyObject>; senderId: RequiredStringSchema<string, AnyObject>; threadId: RequiredStringSchema<string, AnyObject> }>[]>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:111
Method to get unread messages
example
- getUnreadMessages('1234567890')
Parameters
- userId: string
  
  The unique identifier of the user to fetch unread messages for.
Returns Promise<AssertsShape<{ count: RequiredNumberSchema<number, AnyObject>; group: RequiredBooleanSchema<boolean, AnyObject>; receiverId: RequiredStringSchema<string, AnyObject>; senderId: RequiredStringSchema<string, AnyObject>; threadId: RequiredStringSchema<string, AnyObject> }>[]>
A promise that resolves to the validated unread messages details (AgentHiveThreadsDetails).

outboundMessages

outboundMessages(outboundMessageRequest: OutboundMessage): Promise<AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; messageContent: OptionalObjectSchema<{ idOnExternalPlatform: default<string, AnyObject, string>; payload: OptionalObjectSchema<{ text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ text: default<string, AnyObject, string> }>>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; payload: OptionalObjectSchema<{ text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ text: default<string, AnyObject, string> }>>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; recipients: default<OptionalObjectSchema<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>[], AssertsShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>[]>; replyToMessage: default<string, AnyObject, string>; tags: default<default<string, AnyObject, string>, AnyObject, string[], string[]>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>> }>>

- Defined in user-chat-sdk/src/lib/agent-hive/service/agent-hive-outbound-messages-service.ts:280
Method for outbound messages
example
```
outboundMessages(outboundMessageRequest);
```
Parameters
- outboundMessageRequest: OutboundMessage
  
  it contains details of message
Returns Promise<AssertsShape<{ attachments: default<OptionalObjectSchema<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[], AssertsShape<{ antivirusScanStatus: default<string, AnyObject, string>; blobUrl: default<string, AnyObject, string>; canBeStored: default<boolean, AnyObject, boolean>; fileName: default<string, AnyObject, string>; friendlyName: default<string, AnyObject, string>; id: default<string, AnyObject, string>; isInline: default<boolean, AnyObject, boolean>; mimeType: default<string, AnyObject, string>; previewUrl: default<string, AnyObject, string>; securedPermanentUrl: default<string, AnyObject, string>; sizeInBytes: default<number, AnyObject, number>; url: default<string, AnyObject, string> }>[]>; authorUser: OptionalObjectSchema<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>>; createdAt: default<string, AnyObject, string>; direction: default<string, AnyObject, string>; id: default<string, AnyObject, string>; messageContent: OptionalObjectSchema<{ idOnExternalPlatform: default<string, AnyObject, string>; payload: OptionalObjectSchema<{ text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ text: default<string, AnyObject, string> }>>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; payload: OptionalObjectSchema<{ text: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ text: default<string, AnyObject, string> }>>; text: default<string, AnyObject, string>; type: default<string, AnyObject, string> }>>; recipients: default<OptionalObjectSchema<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>>, AnyObject, TypeOfShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>[], AssertsShape<{ idOnExternalPlatform: default<string, AnyObject, string>; name: default<string, AnyObject, string> }>[]>; replyToMessage: default<string, AnyObject, string>; tags: default<default<string, AnyObject, string>, AnyObject, string[], string[]>; threadIdOnExternalPlatform: default<string, AnyObject, string>; user: OptionalObjectSchema<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }, AnyObject, TypeOfShape<{ agentId: default<number, AnyObject, number>; emailAddress: default<string, AnyObject, string>; firstName: default<string, AnyObject, string>; id: default<number, AnyObject, number>; imageUrl: default<string, AnyObject, string>; incontactId: default<string, AnyObject, string>; nickname: default<string, AnyObject, string>; publicImageUrl: default<string, AnyObject, string>; surname: default<string, AnyObject, string> }>> }>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentHiveOutboundMessageService

Properties

Private abortController

Private auth

Private baseUrl

logger

Private requestId

Protected utilService

Methods

clearUnreadMessages

Parameters

receiverId: string

threadId: string

Returns Promise<void>

fetchRecentChatThreads

Parameters

userId: string

Returns Promise<AgentHiveRecentChatThreads[]>

fetchUserMessages

Parameters

userMessageRequest: string[] = []

skip: number = 0

top: number = 15

Optional contentContains: string

getChannelId

Returns Promise<AssertsShape<{ channelId: RequiredStringSchema<string, AnyObject>; errorCode: default<string, AnyObject, string>; tenantId: RequiredStringSchema<string, AnyObject> }>>

getThreadMessages

Parameters

Optional threadId: string

skip: number = 0

top: number = 15

Optional contentContains: string

getUnreadMessages

Parameters

userId: string

Returns Promise<AssertsShape<{ count: RequiredNumberSchema<number, AnyObject>; group: RequiredBooleanSchema<boolean, AnyObject>; receiverId: RequiredStringSchema<string, AnyObject>; senderId: RequiredStringSchema<string, AnyObject>; threadId: RequiredStringSchema<string, AnyObject> }>[]>

outboundMessages

Parameters

outboundMessageRequest: OutboundMessage