Gets a list of conversation items. OauthScopes: READ_CONVERSATIONS
643 matches
100 actions
REST API Version 2
100 actions
- Add a user labelPOSTv1.0.0
- Add moderatorsPOSTv1.0.0
- Add Participant to SpacePOSTv1.0.0
- Adds a "like" to a messagePOSTv1.0.0
- Adds a conversation to the favoritesPOSTv1.0.0
- Adds a flag to a message in a conversationPOSTv1.0.0
- Adds a label to a conversationPOSTv1.0.0
- Adds a message to a conversationPOSTv1.0.0
- Adds a message to an itemPOSTv1.0.0
- Adds participants to a communityPOSTv1.0.0
- Adds participants to a group conversationPOSTv1.0.0
- Adds the authenticated user to a communityPOSTv1.0.0
- Archives conversationPOSTv1.0.0
- Assign labelsPOSTv1.0.0
- Checks for a 1-to-1 conversationGETv1.0.0
- Create a spacePOSTv1.0.0
- Creates a 1-to-1 conversationPOSTv1.0.0
- Creates a community conversationPOSTv1.0.0
- Creates a group conversationPOSTv1.0.0
- creates a new space topicPOSTv1.0.0
- creates a reply to a topicPOSTv1.0.0
- Delete a spaceDELETEv1.0.0
- Deletes a message from a conversationDELETEv1.0.0
- deletes a space itemDELETEv1.0.0
- Deny access for a spacePOSTv1.0.0
- Finds participants to add to add to a space GETv1.0.0
- Get devices infosGETv1.0.0
- Get flagged itemsGETv1.0.0
- Get journalGETv1.0.0
- Get telephony conversation idGETv1.0.0
- Get the directoryGETv1.0.0
- Get the likes of an itemGETv1.0.0
- Get the participants of a spaceGETv1.0.0
- Get the participants of a spaceGETv1.0.0
- Get the pending participants of a spaceGETv1.0.0
- Get the spacesGETv1.0.0
- Get the spaces by their idsGETv1.0.0
- Get user by emailGETv1.0.0
- Gets a conversationGETv1.0.0
- Gets a list of active sessionsGETv1.0.0
- Gets a list of communitiesGETv1.0.0
- Gets a list of conversation itemsGETv1.0.0
- Gets a list of conversationsGETv1.0.0
- Gets a list of the flagged messagesGETv1.0.0
- Gets a list of the flagged messages of a conversationGETv1.0.0
- Gets conversationsGETv1.0.0
- Gets favorite conversationsGETv1.0.0
- Gets space repliesGETv1.0.0
- Gets space replies and a topicGETv1.0.0
- Gets space topicsGETv1.0.0
- Gets the authenticated user's profile informationGETv1.0.0
- Gets the conference details for multiple conversationsGETv1.0.0
- Gets the conference details of a conversationGETv1.0.0
- Gets the presence statusGETv1.0.0
- Gets the presence statusGETv1.0.0
- Gets the support informationGETv1.0.0
- Gets the user's profile informationGETv1.0.0
- grant access for a spacePOSTv1.0.0
- Join a spacePOSTv1.0.0
- Leave a spacePOSTv1.0.0
- Performs a conversation searchGETv1.0.0
- Performs a list of participantsGETv1.0.0
- Pins a topic of a conversationPOSTv1.0.0
- Remove a user labelDELETEv1.0.0
- Remove moderatorsDELETEv1.0.0
- Removes a "like" from a messageDELETEv1.0.0
- Removes a conversation from favoritesDELETEv1.0.0
- Removes a label from a conversationDELETEv1.0.0
- Removes participants from a communityDELETEv1.0.0
- Removes participants from a group conversationDELETEv1.0.0
- Removes the flag from a messageDELETEv1.0.0
- request access for a spacePOSTv1.0.0
- Retrieve pinned topicsGETv1.0.0
- Retrieve recent space searchesGETv1.0.0
- Returns a text itemGETv1.0.0
- Returns all user labelsGETv1.0.0
- Returns conversations with a certain labelGETv1.0.0
- Returns pinned topics of a conversationGETv1.0.0
- Search for usersGETv1.0.0
- Search multiple users.GETv1.0.0
- Set conversation moderatedPOSTv1.0.0
- Set conversation unmoderatedPOSTv1.0.0
- Space name existsGETv1.0.0
- starts a basic search in spacesGETv1.0.0
- starts a detailed search in a spaceGETv1.0.0
- Unassign labelsDELETEv1.0.0
- Unmute conversationDELETEv1.0.0
- Unpins a topic of a conversationDELETEv1.0.0
- Update a spacePUTv1.0.0
- Update content of welcome boxPUTv1.0.0
- Update participantPUTv1.0.0
- Update read timestampPUTv1.0.0
- Update tagsPUTv1.0.0
- Updates a messagePUTv1.0.0
- Updates a space replyPUTv1.0.0
- Updates a topicPUTv1.0.0
- Updates the information of a communityPUTv1.0.0
- Updates the information of a group conversationPUTv1.0.0
- Updates the presence statusPUTv1.0.0
- Updates the user profilePUTv1.0.0
Communication/REST API Version 2
Gets a list of conversation items
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
{
"type": "object",
"properties": {
"convId": {
"type": "string"
},
"direction": {
"type": "string",
"enum": [
"BEFORE",
"AFTER"
]
},
"modTime": {
"type": "string",
"format": "date-time"
},
"results": {
"type": "number",
"format": "int32"
}
},
"required": [
"convId"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
{
"type": "array",
"items": {
"properties": {
"attachments": {
"type": "array",
"description": "Array of files attached to the item",
"items": {
"properties": {
"creationTime": {
"type": "number",
"format": "int64",
"description": "The creation time of the attachment."
},
"creatorId": {
"type": "string",
"description": "The id of the creator of the attachment."
},
"deleteUrl": {
"type": "string",
"description": "The delete URL of the attachment."
},
"fileId": {
"type": "string",
"description": "The id of the attachment file."
},
"fileName": {
"type": "string",
"description": "The name of the attachment file."
},
"itemId": {
"type": "string",
"description": "The item id to which the attachment is attached."
},
"mimeType": {
"type": "string",
"description": "The mime type of the attachment file."
},
"modificationTime": {
"type": "number",
"format": "int64",
"description": "The modification time of the attachment."
},
"size": {
"type": "number",
"format": "int64",
"description": "The size of the attachment file."
},
"url": {
"type": "string",
"description": "The URL of the attachment."
}
}
}
},
"convId": {
"type": "string",
"description": "The ID of the conversation the item belongs to"
},
"creationTime": {
"type": "number",
"format": "int64",
"description": "UTC timestamp when the item was created"
},
"creatorId": {
"type": "string",
"description": "The ID of the user who created the conversation item"
},
"includeInUnreadCount": {
"type": "boolean",
"description": "Indicates whether the item is included in the unread message count"
},
"itemId": {
"type": "string",
"description": "The ID of the item"
},
"modificationTime": {
"type": "number",
"format": "int64",
"description": "UTC timestamp when the conversation was modified"
},
"rtc": {
"properties": {
"ended": {
"properties": {
"duration": {
"type": "number",
"format": "int64",
"description": "The duration of the call."
},
"maxNumberOfAttendees": {
"type": "number",
"format": "int32",
"description": "The maximum number of attendees during a call."
},
"pickFromParticipant": {
"type": "string",
"description": "UserID of the pick from participant."
}
}
},
"missed": {
"type": "string",
"description": "Indicates a missed call."
},
"moved": {
"properties": {
"conversationId": {
"type": "string",
"description": "ID of the conversation moved from or to."
},
"direction": {
"type": "string",
"description": "Moved from or to conversation."
}
}
},
"rtcParticipants": {
"type": "array",
"description": "Participants of the call.",
"items": {
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the participant."
},
"fullyQualifiedNumber": {
"type": "string",
"description": "missing documentation"
},
"phoneNumber": {
"type": "string",
"description": "missing documentation"
},
"resolvedUser": {
"description": "missing documentation",
"type": "object"
},
"type": {
"type": "string",
"description": "The RTC type of the participant."
},
"userId": {
"type": "string",
"description": "The ID of the participant."
}
}
}
},
"type": {
"type": "string",
"description": "The type of the RTC item."
}
}
},
"system": {
"properties": {
"affectedParticipants": {
"type": "array",
"description": "List off affected participants (user ID of the Circuit user) in case the item type PARTICIPANT_ADDED or PARTICIPANT_REMOVED",
"items": {
"type": "string"
}
},
"newTopic": {
"type": "string",
"description": "Filled with the new topic of a conversation if the type of the item is CONVERSATION_RENAMED."
},
"oldTopic": {
"type": "string",
"description": "Filled with the previous topic of a conversation if the type of the item is CONVERSATION_RENAMED."
},
"type": {
"type": "string",
"description": "The type of the system item"
}
}
},
"text": {
"properties": {
"content": {
"type": "string",
"description": "The content of the text item"
},
"contentType": {
"type": "string",
"description": "The type of the text item. It can be one of the following: RICH (with HTML content) or PLAIN (only text)"
},
"formMetaData": {
"type": "string",
"description": "The meta data form"
},
"isWebhookMessage": {
"type": "boolean",
"description": "Is this a webhook message?"
},
"likedUserIds": {
"type": "array",
"description": "Array of IDs of the users who liked the item",
"items": {
"type": "string"
}
},
"parentId": {
"type": "string",
"description": "The ID of the parent item of the text item. This field is optional and can be used for thread views"
},
"preview": {
"properties": {
"imageURI": {
"type": "string",
"description": "n/a"
},
"srcURL": {
"type": "string",
"description": "n/a"
},
"title": {
"type": "string",
"description": "n/a"
},
"type": {
"type": "string",
"description": "n/a"
}
}
},
"state": {
"type": "string",
"description": "The state of the text item. It can be one of the following: CREATED (which denotes that it was not modified since its creation), EDITED (which denotes that the creator of this item modified the item) or DELETED (which denotes that the item itself exists but its content was removed)"
},
"subject": {
"type": "string",
"description": "TThe subject of the text item. This field is optional and maybe filled when creating the text item"
}
}
},
"type": {
"type": "string",
"description": "The type of the conversation item. It can be one of the following TEXT, SYSTEM or RTC"
}
}
}
}