ConversationMessage
usernamestring
is_unreadboolean
If accessing as a user, true if this conversation message is unread
message_parsedstring
HTML parsed version of the message contents.
can_editboolean
can_reactboolean
view_urlstring
Conversation object
If requested by context, the conversation this message is part of.
usernamestring
Name of the user that started the conversation
recipientsobject
Key-value pair of recipient user IDs and names
is_starredboolean
True if the viewing user starred the conversation
is_unreadboolean
If accessing as a user, true if this conversation is unread
can_editboolean
can_replyboolean
can_inviteboolean
can_upload_attachmentboolean
view_urlstring
conversation_idinteger
titlestring
user_idinteger
start_dateinteger
open_inviteboolean
conversation_openboolean
reply_countinteger
recipient_countinteger
first_message_idinteger
last_message_dateinteger
last_message_idinteger
last_message_user_idinteger
Starter object
Information about the user. Different information will be included based on permissions and verbosity.
aboutstring
activity_visibleboolean
ageinteger
The user's current age. Only included if available.
alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject
Maps from size types to URL.
profile_banner_urlsobject
Maps from size types to URL.
can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject
Map of custom field keys and values.
custom_titlestring
Will have a value if a custom title has been specifically set; prefer user_title instead.
dobobject
Date of birth with year, month and day keys.
emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean
True if the visitor is following this user. Only included if visitor is not a guest.
is_ignoredboolean
True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderatorboolean
is_super_adminboolean
last_activityinteger
Unix timestamp of user's last activity, if available.
locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger
Current warning points.
websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
Attachments object[]
If there are attachments to this message, a list of attachments.
Array [
filenamestring
file_sizeinteger
heightinteger
widthinteger
thumbnail_urlstring
retina_thumbnail_urlstring
direct_urlstring
is_videoboolean
is_audioboolean
attachment_idinteger
content_typestring
content_idinteger
attach_dateinteger
view_countinteger
]
is_reacted_toboolean
True if the viewing user has reacted to this content
visitor_reaction_idinteger
If the viewer reacted, the ID of the reaction they used
message_idinteger
conversation_idinteger
message_dateinteger
user_idinteger
messagestring
attach_countinteger
reaction_scoreinteger
User object
Information about the user. Different information will be included based on permissions and verbosity.
aboutstring
activity_visibleboolean
ageinteger
The user's current age. Only included if available.
alert_optoutundefined[]
allow_post_profilestring
allow_receive_news_feedstring
allow_send_personal_conversationstring
allow_view_identitiesstring
allow_view_profilestring
avatar_urlsobject
Maps from size types to URL.
profile_banner_urlsobject
Maps from size types to URL.
can_banboolean
can_converseboolean
can_editboolean
can_followboolean
can_ignoreboolean
can_post_profileboolean
can_view_profileboolean
can_view_profile_postsboolean
can_warnboolean
content_show_signatureboolean
creation_watch_statestring
custom_fieldsobject
Map of custom field keys and values.
custom_titlestring
Will have a value if a custom title has been specifically set; prefer user_title instead.
dobobject
Date of birth with year, month and day keys.
emailstring
email_on_conversationboolean
gravatarstring
interaction_watch_stateboolean
is_adminboolean
is_bannedboolean
is_discouragedboolean
is_followedboolean
True if the visitor is following this user. Only included if visitor is not a guest.
is_ignoredboolean
True if the visitor is ignoring this user. Only included if visitor is not a guest.
is_moderatorboolean
is_super_adminboolean
last_activityinteger
Unix timestamp of user's last activity, if available.
locationstring
push_on_conversationboolean
push_optoutundefined[]
receive_admin_emailboolean
secondary_group_idsundefined[]
show_dob_dateboolean
show_dob_yearboolean
signaturestring
timezonestring
use_tfaboolean
user_group_idinteger
user_statestring
user_titlestring
visibleboolean
warning_pointsinteger
Current warning points.
websitestring
view_urlstring
user_idinteger
usernamestring
message_countinteger
question_solution_countinteger
register_dateinteger
trophy_pointsinteger
is_staffboolean
reaction_scoreinteger
vote_scoreinteger
ConversationMessage
{
"username": "string",
"is_unread": true,
"message_parsed": "string",
"can_edit": true,
"can_react": true,
"view_url": "string",
"Conversation": {
"username": "string",
"recipients": {},
"is_starred": true,
"is_unread": true,
"can_edit": true,
"can_reply": true,
"can_invite": true,
"can_upload_attachment": true,
"view_url": "string",
"conversation_id": 0,
"title": "string",
"user_id": 0,
"start_date": 0,
"open_invite": true,
"conversation_open": true,
"reply_count": 0,
"recipient_count": 0,
"first_message_id": 0,
"last_message_date": 0,
"last_message_id": 0,
"last_message_user_id": 0,
"Starter": {
"about": "string",
"activity_visible": true,
"age": 0,
"alert_optout": [
null
],
"allow_post_profile": "string",
"allow_receive_news_feed": "string",
"allow_send_personal_conversation": "string",
"allow_view_identities": "string",
"allow_view_profile": "string",
"avatar_urls": {},
"profile_banner_urls": {},
"can_ban": true,
"can_converse": true,
"can_edit": true,
"can_follow": true,
"can_ignore": true,
"can_post_profile": true,
"can_view_profile": true,
"can_view_profile_posts": true,
"can_warn": true,
"content_show_signature": true,
"creation_watch_state": "string",
"custom_fields": {},
"custom_title": "string",
"dob": {},
"email": "string",
"email_on_conversation": true,
"gravatar": "string",
"interaction_watch_state": true,
"is_admin": true,
"is_banned": true,
"is_discouraged": true,
"is_followed": true,
"is_ignored": true,
"is_moderator": true,
"is_super_admin": true,
"last_activity": 0,
"location": "string",
"push_on_conversation": true,
"push_optout": [
null
],
"receive_admin_email": true,
"secondary_group_ids": [
null
],
"show_dob_date": true,
"show_dob_year": true,
"signature": "string",
"timezone": "string",
"use_tfa": true,
"user_group_id": 0,
"user_state": "string",
"user_title": "string",
"visible": true,
"warning_points": 0,
"website": "string",
"view_url": "string",
"user_id": 0,
"username": "string",
"message_count": 0,
"question_solution_count": 0,
"register_date": 0,
"trophy_points": 0,
"is_staff": true,
"reaction_score": 0,
"vote_score": 0
}
},
"Attachments": [
{
"filename": "string",
"file_size": 0,
"height": 0,
"width": 0,
"thumbnail_url": "string",
"retina_thumbnail_url": "string",
"direct_url": "string",
"is_video": true,
"is_audio": true,
"attachment_id": 0,
"content_type": "string",
"content_id": 0,
"attach_date": 0,
"view_count": 0
}
],
"is_reacted_to": true,
"visitor_reaction_id": 0,
"message_id": 0,
"conversation_id": 0,
"message_date": 0,
"user_id": 0,
"message": "string",
"attach_count": 0,
"reaction_score": 0,
"User": {
"about": "string",
"activity_visible": true,
"age": 0,
"alert_optout": [
null
],
"allow_post_profile": "string",
"allow_receive_news_feed": "string",
"allow_send_personal_conversation": "string",
"allow_view_identities": "string",
"allow_view_profile": "string",
"avatar_urls": {},
"profile_banner_urls": {},
"can_ban": true,
"can_converse": true,
"can_edit": true,
"can_follow": true,
"can_ignore": true,
"can_post_profile": true,
"can_view_profile": true,
"can_view_profile_posts": true,
"can_warn": true,
"content_show_signature": true,
"creation_watch_state": "string",
"custom_fields": {},
"custom_title": "string",
"dob": {},
"email": "string",
"email_on_conversation": true,
"gravatar": "string",
"interaction_watch_state": true,
"is_admin": true,
"is_banned": true,
"is_discouraged": true,
"is_followed": true,
"is_ignored": true,
"is_moderator": true,
"is_super_admin": true,
"last_activity": 0,
"location": "string",
"push_on_conversation": true,
"push_optout": [
null
],
"receive_admin_email": true,
"secondary_group_ids": [
null
],
"show_dob_date": true,
"show_dob_year": true,
"signature": "string",
"timezone": "string",
"use_tfa": true,
"user_group_id": 0,
"user_state": "string",
"user_title": "string",
"visible": true,
"warning_points": 0,
"website": "string",
"view_url": "string",
"user_id": 0,
"username": "string",
"message_count": 0,
"question_solution_count": 0,
"register_date": 0,
"trophy_points": 0,
"is_staff": true,
"reaction_score": 0,
"vote_score": 0
}
}