Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 2.18 KB

Conversation.md

File metadata and controls

20 lines (16 loc) · 2.18 KB

SunshineConversationsClient.Conversation

Properties

Name Type Description Notes
id String The unique ID of the conversation. [optional]
type ConversationType [optional]
metadata Object Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. [optional]
activeSwitchboardIntegration SwitchboardIntegrationWebhook The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation. [optional]
pendingSwitchboardIntegration SwitchboardIntegrationWebhook The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control. [optional]
isDefault Boolean Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases. [optional]
displayName String A friendly name for the conversation, may be displayed to the business or the user. [optional]
description String A short text describing the conversation. [optional]
iconUrl String A custom conversation icon url. The image must be in either JPG, PNG, or GIF format [optional]
businessLastRead String A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business. [optional]
lastUpdatedAt String A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet. [optional]
createdAt String A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the creation time of the conversation. [optional]