A private message.

id
string

Unique (server-wide) identifier of this message.

ap_id
string

Globally-unique ActivityPub identifier for this message.

from
integer (positive)

Identifier of the user who sent this message.

to
array of integers

Identifiers of primary recipients of this message.

cc
array of integers

Identifiers of secondary recipients of this message.

date
integer

Timestamp (unixtime) when this message was sent.

read_by
array of integers

Identifiers of recipients who have read (opened) this message.

Read receipts are currently only supported by Smithereen, so users from servers running different software won’t show up here.

subject
string

The subject line.

body
string

The main text of the message as HTML.

attachments
array of attachments

Media attachments added to this message.

reply_to
object

If this message is in reply to something, information about that object.

Mastodon and most other similar microblogging-style software represents private messages as posts with limited visibility, thus allowing its users to reply to public content in private.

type
enum

The type of the object this is in reply to.

  • wall_post – A wall post
  • wall_comment – A comment on a wall post
  • message – Another message
wall_post_id
integer

If type is wall_post, the identifier of that post.

wall_comment_id
integer

If type is wall_comment, the identifier of that comment.

message_id
string

If type is message, the identifier of that message.