Returns the current user’s incoming or outgoing private messages.

This method requires the following permissions: messages:read.

Parameters

out
boolean

Whether to return outgoing or incoming messages.

By default false.

offset
integer (non-negative)

Offset into the list of messages for pagination.

count
integer (1..200)

How many messages to return.

By default 20.

extended
boolean

Whether to return users related to these messages.

By default false.

fields
string

Comma-separated list of user profile fields to be returned.

Result

Returns a paginated list of messages.

If extended is true, an extra profiles field will be returned with relevant user objects.

Errors

Global errors may occur when calling this method.