SideConversations
Create, update and query Side Conversations in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the 本製品.At least TicketId is required in order to retrieve the SideConversations.
SELECT * FROM SideConversations WHERE TicketId = 1 SELECT * FROM SideConversations WHERE TicketId = 1 AND Id = '5d133b65-576c-11ee-bcb2-bdce8f618e59'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The Columns TicketId, Subject, PreviewText and Participants are required to insert. Allowed for Agents.
INSERT INTO SideConversationParticipants#temp(Email,Name) VALUES('[email protected]', 'someone') INSERT INTO SideConversations(TicketId, Subject, PreviewText, Participants) VALUES(1, 'Test Subject', 'Test Body', 'SideConversationParticipants#temp')
You can also reply to a side conversation. The Columns Id, TicketId, Subject, PreviewText and Participants are required for Reply on a particular SideConversation. Allowed for Agents.
INSERT INTO SideConversationParticipants#temp(Email,Name) VALUES('[email protected]', 'someone') INSERT INTO SideConversations(Id, TicketId, Subject, PreviewText, Participants) VALUES('5d133b65-576c-11ee-bcb2-bdce8f618e59', 2, 'Test Reply', 'Body for Reply message', 'SideConversationParticipants#temp')
Update
You must specify the TicketId and Id of the SideConversation to update. It only update the State and Subject columns. All fields that are not readonly (readonly="false" in the table) are optional. Allowed for Agents.
UPDATE SideConversations SET State='open' WHERE Id='5d133b65-576c-11ee-bcb2-bdce8f618e59' AND TicketId=1
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | String | False |
Automatically assigned when the side conversation is created. | |
TicketId | Integer | False |
Tickets.Id |
The parent ticket id of the side conversation. |
ExternalIds | String | False |
A key-value store of metadata. All values must be strings. | |
Subject | String | False |
The subject of the side conversation. | |
CreatedAt | Datetime | True |
The time the side conversation was created. | |
UpdatedAt | Datetime | True |
The time the side conversation was created. | |
MessageAddedAt | Datetime | True |
The time of the last message on the side conversation. | |
Participants | String | False |
An array of participants in the side conversation. | |
PreviewText | String | False |
A plain text text describing the side conversation. | |
State | String | False |
The state of the side conversation. | |
StateUpdatedAt | Datetime | True |
The time of the update of the state of the side conversation. | |
Url | String | True |
The API url of the side conversation. |