Magidoc

messagesEasySearch
Query

Searches through messages in a workspace

Very useful for searching through existing private conversations or chat groups. Supports search by the group type or id. Could return total count of messages.

Access: Requires user access to the workspace, groups if used.

Arguments

#

text

String !
Non-null

Text to search within messages, required. Use a plain string to search for an exact match. e.g. "Hello, World!" If you don't know the exact phrase, you can use the AND and OR Lucene query syntax e.g "Hello AND World" or "Hello OR World" If you want to inject the exact phrase, use quotes around the phrase. e.g. ""Hello, World!" query"

workspaceId

ID !
Non-null

ID of the workspace

users

[ID !]

Array of user IDs that sent the messages

groups

[ID !]

Array of group IDs to search within

limit

Int !
Non-null

Limit the number of messages to return

includeTotalCount

Boolean

Whether to include the total count of messages

Response

#

Returns MessageConnection !.

Example

#