General Ticket Chat
The API provides endpoints to:
- Create a new chat — see the Gateway API reference
- Get existing chats — see the Gateway API reference
- Create a chat message — see the Gateway API reference
- Get chat messages — see the Gateway API reference
Chat file endpoints are covered in Ticket Chat Files.
Chat participant model
Section titled “Chat participant model”When working with chats, the commonly used model is TicketChatParticipantModel (or TicketChatCreateParticipantModel when creating a new chat).
The following properties identify chat participants:
watcherEmail— the participant is an external email and cannot be placed in any of the following categoriesuserId— either a management or tenant usercrmCompanyId— a CRM contractorcrmCompanyContactId— a CRM contractor contact; every contact can see all contractor chatsbuildingId— used for building-based ticketing links generated for non-users. ThebuildingIdserves as the participant key for chats to and from that viewhausingCompanyId— used to synchronize chats between contractors that are also Hausing client companies. In normal cases, this should not be used by external integrators
participantGroupType
Section titled “participantGroupType”Only available on TicketChatCreateParticipantModel. Used to create a chat where the management user receiver participant is still unknown (ticket supervisor is not yet assigned).