Skip to content

Query Conversation Messages

Request

Returns messages from a specific conversation. The conversationId must be obtained from query_conversations or query_user_conversations. Use the user-scoped variant (query_user_conversation_messages) for chats that only exist in a user's mailbox. Where the provider supports create_direct_message, the conversation UID it returns is accepted here. Where the provider declares a chat_message.parent_uid filter, filtering on it with the uid of a thread's top-level message returns that thread's replies instead.

Operation ID: chat_query_conversation_messages

Security
BearerAuth
Path
conversationIdstringrequired
Query
metaArray of strings

Add metadata to the response by invoking meta functions.

limitinteger or null

Number of messages to return. Defaults to 100 with a maximum of 1000. If a provider has a maximum limit lower than 1000, the provider's maximum limit will be used instead. A page may hold fewer results than limit, or none, even when more remain; keep paging until the returned cursor is empty.

filterArray of strings

Filter results by this query. Supported filter fields vary by provider. Defaults to no filter. If used more than once, the queries are ANDed together.

cursorstring or null

Start search from cursor position.

include_raw_databoolean or null

Include the raw data from the chat provider in the response. Defaults to false.

curl
curl -i -X GET \
  'https://api.synqly.com/v1/chat/conversations/{conversationId}/messages' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
cursorstringrequired

Cursor to use to retrieve the next page of results

resultArray of objects(ocsfv1.8.0chatmessageactivityChatMessageActivity)required

List of messages, each wrapped in an OCSF Chat Message Activity event.

messagesobject or null(MessagesResponse)

Additional messages from the service response that may be helpful to the client.

metaobject or null(MetaResponse)

Various metadata about the results organized by group, then type, then field.

Response
{ "result": [ { … } ], "cursor": "string", "messages": { "problems": [ … ] }, "meta": { "stats": { … }, "api": { … }, "mapping": { … } } }