v1

latestOpenAPI 3.0.02026-07-1412360190.8 KB

Conversations

Gets a list of conversation items

Gets a list of conversation items. OauthScopes: READ_CONVERSATIONS

get/conversations/{convId}/items

Path parameters

convIdstring required

The ID of the conversation to which the items belong

Query parameters

modTimestring date-time

The modification time of the item in UTC format. During the query the items before (default) or after this timestamps are returned. In case no timestamp is specified the current server time in UTC is used, i.e. the last 25 modified items are returned

direction'BEFORE' | 'AFTER'

The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER

resultsnumber

The maximum number of returned results (default 25). The maximum allowed value is 100.

Response

The matching conversation items

convIdstring

The ID of the conversation the item belongs to

creationTimenumber

UTC timestamp when the item was created

creatorIdstring

The ID of the user who created the conversation item

includeInUnreadCountboolean

Indicates whether the item is included in the unread message count

itemIdstring

The ID of the item

modificationTimenumber

UTC timestamp when the conversation was modified

typestring

The type of the conversation item. It can be one of the following TEXT, SYSTEM or RTC