Get messages

Description

This endpoint returns all unread messages in a dialog. After calling this endpoint, all messages in the dialog will be marked as read.

Endpoint

[GET] /api/v2/dialog/{dialogRef}/message

The dialogRef parameter is the reference number to the dialog (Dxxxx).

Query parameters

This endpoint has two query parameters:

• includeReadMessages
  Returns all messages, not only the unread ones
• markAsRead
  If true, the dialog messages will be marked as read when this endpoint is called. If false, the client must explicitly call the Mark as read endpoint after processing the messages. For backward compatibility, the default value is true

Scope

Required scope:
nhn:melde/dialog/melding