action circuitsandbox_get_flag_item { label: "Gets a list of the flagged messages of a conversation" description: "Gets a list of all the flagged messages in the given conversation.\nOauthScopes: READ_CONVERSATIONS, ORGANIZE_CONVERSATIONS" provider: circuitsandbox method: GET path: "/conversations/{convId}/messages/flag" encoding: json input: { type: "object" properties: { convId: { type: "string" } } required: ["convId"] additionalProperties: false } output: { 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" } } } } }