markdown

Autogenerated from source code. Do not edit.

Structures

CallDevice

Call participant device.

• muted (bool) — Device muted.

• useragent (string) — Device description.

CallEvent

Audio call information.

• start (string, nullable) — Call start, iso date.

• finish (string, nullable) — Call finish, iso date.

• audiorecord (bool) — Call record enabled.

• onliners (CallOnliner, list) — Call members.

CallOnliner

Call participant.

• jid (JID) — Contact id.

• display_name (string) — Contact name.

• role (string) — Contact role.

• icon (string) — Contact icon.

• muted (bool) — Microphone muted. Computed from devices muted states.

• devices (CallDevice, list) — Member devices, strictly one for now.

Chat

Chat (direct, group, task) representation.

• jid (JID) — Group/Task/Contact id.

• chat_type (ChatType) — Chat type.

• base_gentime (int64, omitempty) — Base fields (not related to concrete participant) version.

• gentime (int64) — Chat fields related to concrete participant) version.

• created (ISODateTimeString) — Creation date, iso datetime.

• display_name (string) — Title.

• icons (IconData, nullable) — Icons info.

• counters_enabled (bool, omitempty) — Include unread messages to counters.

• can_call (bool, omitempty) — Can I call to this chat.

• can_send_message (bool, omitempty) — Can I send message to this chat.

• cant_send_message_reason (string, omitempty) — Why I can't send message to this chat (if can't).

• collapsed (bool, omitempty) — Description collapsed. Used for tasks only.

• draft (string, omitempty) — Last message draft, if any.

• draft_num (int64, omitempty) — Last message draft version , if any.

• hidden (bool, omitempty) — Hidden chat.

• notifications_enabled (bool, omitempty) — Push notifications enabled.

• num_importants (int, omitempty) — Number of important messages.

• num_unread (uint, omitempty) — Unread counter.

• num_unread_notices (uint, omitempty) — Mentions (@) counter.

• last_message (Message, nullable, omitempty) — Last message object.

• last_read_message_id (string, omitempty) — Last read message id, if any.

• section (string, omitempty) — Project / section id, if any.

• changeable_fields (string, list, omitempty) — List of editable fields.

• pinned (bool, omitempty) — Is chat pinned on top.

• pinned_sort_ordering (int, omitempty) — Sort ordering for pinned chat.

• num_members (uint, nullable, omitempty) — Non-archive participants number.

• can_delete (bool, omitempty) — Can I delete this chat.

• description (string, omitempty) — Group or task description.

• markup (MarkupEntity, readonly for clients, list, omitempty) — Markup entities for description field. Experimental.

• feed (bool, omitempty) — Present in feed (main screen).

• pinned_message (Message, nullable, omitempty) — Pinned message for this chat.

• color_index (uint16, nullable, omitempty) — Custom color index from table of colors. Tasks only.

• num_items (uint, nullable, omitempty) — Items in checklist. Tasks only.

• num_checked_items (uint, nullable, omitempty) — Checked items in checklist. Tasks only.

• assignee (JID, nullable, omitempty) — Assignee contact id. Tasks only.

• num (uint, omitempty) — Task number in this team.

• observers (JID, nullable, list, omitempty) — Task followers id's. TODO: rename to "followers".

• owner (JID, nullable, omitempty) — Task creator.

• task_status (string, omitempty) — Task status. May be custom.

• title (string, omitempty) — Task title. Generated from number and description.

• done (string, omitempty) — Task done date in iso format, if any.

• done_reason (string, omitempty) — Task done reason, if any.

• deadline (string, omitempty) — Task deadline in iso format, if any.

• deadline_expired (bool, omitempty) — Is task deadline expired.

• links (MessageLinks, omitempty) — Links in description.

• tags (string, list, omitempty) — Task tags list, if any.

• importance (int, nullable, omitempty) — Task importance, if available in team.

• urgency (int, nullable, omitempty) — Task urgency, if available in team.

• spent_time (int, nullable, omitempty) — Task spent time, number.

• complexity (int, nullable, omitempty) — Task complexity, number.

• linked_messages (interface{}, list, omitempty) — Used for "Create task from messages...".

• uploads (Upload, list, omitempty) — Upload uids for request, upload objects for response.

• items (TaskItem, list, omitempty) — Checklist items. Task only.

• parents (Subtask, list, omitempty) — Parent tasks.

• tabs (TaskTabKey, nullable, list, omitempty) — Tab names.

• status (GroupStatus, nullable, omitempty) — My status in group chat.

• members (GroupMembership, list, omitempty) — Group chat members.

• can_add_member (bool, omitempty) — Can I add member to this group chat.

• can_remove_member (bool, omitempty) — Can I remove member from this group chat.

• can_change_member_status (bool, omitempty) — Can I change member status in this group chat.

• can_change_settings (bool, omitempty) — deprecated: use changeable fields.

• default_for_all (bool, omitempty) — Any new team member will be added to this group chat.

• readonly_for_members (bool, omitempty) — Readonly for non-admins group chat (Like Channels in Telegram bug switchable).

• autocleanup_age (int, nullable, omitempty) — Delete messages in this chat in seconds. Experimental function.

• public (bool, omitempty) — Can other team member see this task/group chat.

• can_join (bool, omitempty) — Can I join to this public group/task.

• can_delete_any_message (bool, omitempty) — Can I delete any message in this chat.

• can_set_important_any_message (bool, omitempty) — Can I change Important flag in any message in this chat.

• last_activity (ISODateTimeString, omitempty) — Date of the last message sent even if it was deleted.

ChatShort

Minimal chat representation.

• jid (JID) — Group/Task/Contact id.

• chat_type (ChatType) — Chat type.

• display_name (string) — Title.

• icons (IconData, nullable) — Icon data.

ChatType

Chat type.

• "direct" Direct chat
• "group" Group chat
• "task" Task

ColorRule

Set of rules to apply to tasks for coloring.

• uid (string) — Uid.

• priority (int) — Priority.

• color_index (uint16) — ColorIndex.

• section (string, omitempty) — Section.

• tags (string, list, omitempty) — Tags.

• description (string, omitempty) — Description.

• task_status (string, omitempty) — TaskStatus.

• task_importance (int, nullable, omitempty) — TaskImportance.

• task_urgency (int, nullable, omitempty) — TaskUrgency.

• section_enabled (bool, nullable, omitempty) — SectionEnabled.

• task_importance_enabled (bool, nullable, omitempty) — TaskImportanceEnabled.

• task_urgency_enabled (bool, nullable, omitempty) — TaskUrgencyEnabled.

• tags_enabled (bool, nullable, omitempty) — TagsEnabled.

Contact

Contact.

• jid (JID) — Contact Id.

• display_name (string) — Full name in chats.

• short_name (string) — Short name in chats.

• contact_email (string) — Contact email in this team.

• contact_phone (string) — Contact phone in this team.

• icons (IconData, nullable) — Icons data.

• role (string) — Role in this team.

• mood (string, omitempty) — Mood in this team.

• status (TeamStatus) — Status in this team.

• last_activity (string, nullable) — Last activity in this team (iso datetime).

• add_to_team_rights (bool, omitempty) — Can contact add users to this team.

• is_archive (bool, omitempty) — Contact deleted.

• botname (string, omitempty) — Bot name. Empty for users.

• sections (string, list) — Section ids.

• can_send_message (bool, omitempty) — Can I send message to this contact.

• cant_send_message_reason (string, omitempty) — Why I can't send message to this chat (if can't).

• can_call (bool, omitempty) — Can I call to this contact.

• can_create_task (bool, omitempty) — Can I call create task for this contact.

• can_add_to_group (bool, omitempty) — Can I add this contact to group chats.

• can_delete (bool, omitempty) — Can I remove this contact from team.

• changeable_fields (string, nullable, list, omitempty) — Changeable fields.

• family_name (string, nullable, omitempty) — Family name.

• given_name (string, nullable, omitempty) — Given name.

• patronymic (string, nullable, omitempty) — Patronymic, if any.

• default_lang (string, nullable, omitempty) — Default language code.

• debug_show_activity (bool, nullable, omitempty) — Enable debug messages in UI.

• dropall_enabled (bool, nullable, omitempty) — Enable remove all messages experimental features.

• alt_send (bool, nullable, omitempty) — Use Ctrl/Cmd + Enter instead Enter.

• asterisk_mention (bool, nullable, omitempty) — Use * as @ for mentions.

• always_send_pushes (bool, nullable, omitempty) — Send push notifications even contact is online.

• timezone (string, nullable, omitempty) — Timezone, if any.

• quiet_time_start (string, nullable, omitempty) — Quiet time start.

• quiet_time_finish (string, nullable, omitempty) — Quiet time finish.

• group_notifications_enabled (bool, nullable, omitempty) — Push notifications for group chats.

• task_notifications_enabled (bool, nullable, omitempty) — Push notifications for task chats.

• contact_short_view (bool, nullable, omitempty) — Short view in contact list.

• group_short_view (bool, nullable, omitempty) — Short view in group list.

• task_short_view (bool, nullable, omitempty) — Short view in task list.

• contact_mshort_view (bool, nullable, omitempty) — Short view in contact list in mobile app.

• group_mshort_view (bool, nullable, omitempty) — Short view in group list in mobile app.

• task_mshort_view (bool, nullable, omitempty) — Short view in task list in mobile app.

• contact_show_archived (bool, nullable, omitempty) — Show archived contacts in contact list.

• unread_first (bool, nullable, omitempty) — Show unread chats first in feed.

• munread_first (bool, nullable, omitempty) — Show unread chats first in feed in mobile app.

• can_add_to_team (bool, omitempty) — Can I add new members to this team.

• can_manage_sections (bool, omitempty) — Can I manage sections in this team.

• can_manage_tags (bool, omitempty) — Can I manage tags in this team.

• can_manage_integrations (bool, omitempty) — Can I manage integrations in this team.

• can_manage_color_rules (bool, omitempty) — Can I manage color rules in this team.

• can_create_group (bool, omitempty) — Can I create group chats in this team.

• can_join_public_groups (bool, omitempty) — Can I view/join public group in this team.

• can_join_public_tasks (bool, omitempty) — Can I view/join public tasks in this team.

• can_delete_any_message (bool, omitempty) — Deprecated: use CanDeleteAnyMessage in chat object.

• custom_fields (ContactCustomFields, nullable, omitempty) — Extra contact fields.

ContactCustomFields

Extra contact fields.

• company (string, omitempty) — Company.

• department (string, omitempty) — Department.

• title (string, omitempty) — Title.

• mobile_phone (string, omitempty) — MobilePhone.

• source (string, omitempty) — Source.

ContactShort

Short contact representation.

• jid (JID) — Contact Id.

• display_name (string) — Full name in chats.

• short_name (string) — Short name in chats.

• icons (IconData, nullable) — Icons data.

Country

Country for phone numbers selection on login screen.

• code (string) — Country code.

• name (string) — Country name.

• default (bool, omitempty) — Selected by default.

• popular (bool, omitempty) — Is popular, need to cache.

DeletedChat

Minimal chat representation for deletion.

• jid (JID) — Group/Task/Contact id.

• chat_type (ChatType) — Chat type.

• gentime (int64) — Chat fields (related to concrete participant) version.

• is_archive (bool) — Archive flag. Always true for this structure.

DeletedRemind

Remind deleted message.

• uid (string) — Remind id.

DeletedTag

Delete tag message.

• uid (string) — Tag id.

DeletedTeam

Team deletion message. Readonly.

• uid (string) — Team id.

• is_archive (bool) — Team deleted.

• gentime (int64) — Object version.

Features

Server information. Readonly.

• host (string) — Current host.

• build (string) — Build/revision of server side.

• desktop_version (string) — Desktop application version.

• front_version (string) — Webclient version.

• app_title (string) — Application title.

• app_schemes (string, list) — Local applications urls.

• userver (string) — Static files server address.

• ios_app (string) — Link to AppStore.

• android_app (string) — Link to Google Play.

• theme (string) — Default UI theme.

• min_app_version (string) — Minimal application version required for this server. Used for breaking changes.

• free_registration (bool) — Free registration allowed.

• max_upload_mb (int) — Maximum size of user's upload.

• max_linked_messages (int) — Maximum number of forwarded messages.

• max_message_uploads (int) — Maximum number of message uploads.

• max_username_part_length (int) — Maximum chars for: family_name, given_name, patronymic if any.

• max_group_title_length (int) — Maximum chars for group chat name.

• max_role_length (int) — Maximum chars for role in team.

• max_mood_length (int) — Maximum chars for mood in team.

• max_message_length (int) — Maximum chars for text message.

• max_section_length (int) — Maximum length for project and contact's sections names.

• max_tag_length (int) — Maximum length for tags.

• max_task_title_length (int) — Maximum length for task title.

• max_color_rule_description_length (int) — Maximum length for ColorRule description.

• max_url_length (int) — Maximum length for urls.

• max_integration_comment_length (int) — Maximum length for Integration comment.

• max_teams (int) — Maximum teams for one account.

• max_message_search_limit (int) — Maximum search result.

• afk_age (int) — Max inactivity seconds.

• auth_by_password (bool, omitempty) — Password authentication enabled.

• auth_by_qr_code (bool, omitempty) — QR-code / link authentication enabled.

• auth_by_sms (bool, omitempty) — SMS authentication enabled.

• auth_2fa (bool, omitempty) — Two-factor authentication (2FA) enabled.

• oauth_services (OAuthService, list, omitempty) — External services.

• ice_servers (ICEServer, list) — ICE servers for WebRTC.

• custom_server (bool) — True for premise installation.

• installation_type (string) — Name of installation.

• is_testing (bool) — Testing installation.

• metrika (string) — Yandex metrika counter id.

• min_search_length (int) — Minimal chars number for starting global search.

• resend_timeout (int) — Resend message in n seconds if no confirmation from server given.

• sentry_dsn_js (string) — Frontend sentry.io settings.

• server_drafts (bool) — Message drafts saved on server.

• firebase_app_id (string) — Firebase settings for web-push notifications.

• firebase_sender_id (string) — Firebase settings for web-push notifications.

• firebase_api_key (string) — Firebase settings for web-push notifications.

• firebase_auth_domain (string) — Firebase settings for web-push notifications.

• firebase_database_url (string) — Firebase settings for web-push notifications.

• firebase_project_id (string) — Firebase settings for web-push notifications.

• firebase_storage_bucket (string) — Firebase settings for web-push notifications.

• calls (bool) — Calls functions enabled.

• mobile_calls (bool) — Calls functions enabled for mobile applications.

• calls_record (bool) — Calls record enabled.

• only_one_device_per_call (bool, omitempty) — Disallow call from multiply devices. Experimental.

• max_participants_per_call (int, omitempty) — Maximum number of participants per call.

• safari_push_id (string) — Safari push id for web-push notifications.

• message_uploads (bool) — Multiple message uploads.

• terms (Terms) — Team entity naming. Experimental.

• single_group_teams (bool) — Cross team communication. Experimental.

• wiki_pages (bool) — Wiki pages in chats. Experimental.

• allow_admin_mute (bool, omitempty) — Wiki pages in chats. Experimental.

• default_wallpaper (Wallpaper, nullable, omitempty) — Default wallpaper url for mobile apps, if any.

• task_checklist (bool) — Deprecated.

• readonly_groups (bool) — Deprecated.

• task_dashboard (bool) — Deprecated.

• task_messages (bool) — Deprecated.

• task_public (bool) — Deprecated.

• task_tags (bool) — Deprecated.

GroupMembership

Group chat membership status.

• jid (JID) — Contact id.

• status (GroupStatus) — Status in group.

• can_remove (bool, omitempty) — Can I remove this member.

GroupStatus

Status in team.

• "admin" Group administrator
• "member" Group member

ICEServer

Interactive Connectivity Establishment Server for WEB Rtc connection. Readonly.

• urls (string) — URls.

IconData

Icon data. Contains sm+lg (for uploaded image) OR stub+letters+color (for icon generated from display name).

• sm (SingleIcon, nullable, omitempty) — Small icon.

• lg (SingleIcon, nullable, omitempty) — Large image.

• stub (string, omitempty) — Generated image with 1-2 letters.

• letters (string, omitempty) — Letters from stub icon.

• color (string, omitempty) — Stub icon background color.

Integration

Integration for concrete chat.

• uid (string, omitempty) — Id.

• comment (string) — Comment, if any.

• created (ISODateTimeString, omitempty) — Creation datetime, iso.

• enabled (bool) — Integration enabled.

• form (IntegrationForm) — Integration form.

• group (JID) — Chat id.

• help (string, omitempty) — Full description.

• kind (string) — Unique integration name.

IntegrationField

Integration form field.

• label (string) — Label.

• readonly (bool) — Is field readonly.

• value (string) — Current value.

IntegrationForm

Integration form.

• api_key (IntegrationField, nullable, omitempty) — Api key field, if any.

• webhook_url (IntegrationField, nullable, omitempty) — Webhook url, if any.

• url (IntegrationField, nullable, omitempty) — Url, if any.

IntegrationKind

Integration kind.

• kind (string) — Integration unique name.

• title (string) — Plugin title.

• template (Integration) — Integration template.

• icon (string) — Path to icon.

• description (string) — Plugin description.

Integrations

Complete integrations data, as received from server.

• integrations (Integration, list) — Currently existing integrations.

• kinds (IntegrationKind, list) — Types of integrations available for setup.

MarkupEntity

Markup entity. Experimental.

• op (int) — Open marker offset.

• oplen (int, omitempty) — Open marker length.

• cl (int) — Close marker offset.

• cllen (int, omitempty) — Close marker length.

• typ (MarkupType) — Marker type.

• url (string, omitempty) — Url, for Link type.

• repl (string, omitempty) — Text replacement.

• time (string, omitempty) — Time, for Time type.

• childs (MarkupEntity, list, omitempty) — List of internal markup entities.

MarkupType

Markup type.

• "bold" Bold text
• "italic" Italic text
• "underscore" Underscore text
• "strike" Striked text
• "code" Inlined code
• "codeblock" Code block
• "quote" Quote
• "link" Link
• "time" Datetime
• "unsafe" Unsafe html element

Message

Chat message.

• content (MessageContent) — Message content struct.

• push_text (string, readonly for clients, omitempty) — Simple plaintext message representation.

• from (JID, readonly for clients) — Sender contact id.

• to (JID) — Recipient id (group, task or contact).

• message_id (string) — Message uid.

• created (ISODateTimeString, readonly for clients) — Message creation datetime (set by server side) or sending datetime in future for draft messages.

• drafted (ISODateTimeString, readonly for clients, omitempty) — Creation datetime for draft messages.

• gentime (int64, readonly for clients) — Object version.

• chat_type (ChatType, readonly for clients) — Chat type.

• chat (JID, readonly for clients) — Chat id.

• links (MessageLinks, readonly for clients, omitempty) — External/internals links.

• markup (MarkupEntity, readonly for clients, list, omitempty) — Markup entities. Experimental.

• important (bool, omitempty) — Importance flag.

• edited (ISODateTimeString, readonly for clients, omitempty) — ISODateTimeString of message modification or deletion.

• received (bool, readonly for clients, omitempty) — Message was seen by anybody in chat. True or null.

• num_received (int, readonly for clients, omitempty) — Unused yet.

• nopreview (bool, omitempty) — Disable link previews. True or null.

• has_previews (bool, readonly for clients, omitempty) — Has link previews. True or null.

• prev (string, readonly for clients, omitempty) — Previous message id in this chat. Uid or null.

• is_first (bool, readonly for clients, omitempty) — This message is first in this chat. True or null.

• is_last (bool, readonly for clients, omitempty) — This message is first in this chat. True or null.

• uploads (Upload, list, omitempty) — Message uploads.

• reactions (MessageReaction, readonly for clients, list, omitempty) — Message reactions struct. Can be null.

• reply_to (Message, nullable, omitempty) — Message that was replied to, if any.

• linked_messages (Message, list, omitempty) — Forwarded messages. Can be null. Also contains double of ReplyTo for backward compatibility.

• notice (bool, readonly for clients, omitempty) — Has mention (@). True or null.

• silently (bool, readonly for clients, omitempty) — Message has no pushes and did not affect any counters.

• editable_until (ISODateTimeString, readonly for clients, omitempty) — Author can change this message until date. Can be null.

• num (int, readonly for clients, nullable, omitempty) — Index number of this message. Starts from 0. Null for deleted messages. Changes when any previous message wad deleted.

• is_archive (bool, readonly for clients, omitempty) — This message is archive. True or null.

• _debug (string, readonly for clients, omitempty) — Debug information, if any.

MessageContent

Chat message content.

• text (string) — Text representation of message.

• type (Mediatype) — Message type.

• subtype (Mediasubtype, omitempty) — Message subtype, if any.

• upload (string, omitempty) — Upload id, if any. Deprecated: use Uploads instead.

• mediaURL (string, omitempty) — Upload url, if any. Deprecated: use Uploads instead.

• size (int, omitempty) — Upload size, if any. Deprecated: use Uploads instead.

• duration (uint, nullable, omitempty) — Upload duration, if any. Deprecated: use Uploads instead.

• processing (bool, omitempty) — Upload still processing, if any. Deprecated: use Uploads instead.

• previewHeight (int, omitempty) — Upload preview height, in pixels, if any. Deprecated: use Uploads instead.

• previewWidth (int, omitempty) — Upload width, in pixels, if any. Deprecated: use Uploads instead.

• previewURL (string, omitempty) — Upload preview absolute url, if any. Deprecated: use Uploads instead.

• preview2xURL (string, omitempty) — Upload high resolution preview absolute url, if any. Deprecated: use Uploads instead.

• name (string, omitempty) — Upload name, if any. Deprecated: use Uploads instead.

• animated (bool, omitempty) — Upload is animated image, if any. Deprecated: use Uploads instead.

• title (string, omitempty) — Change title (for "change" mediatype).

• old (string, nullable, omitempty) — Change old value (for "change" mediatype).

• new (string, nullable, omitempty) — Change new value (for "change" mediatype).

• actor (JID, nullable, omitempty) — Change actor contact id (for "change" mediatype).

• comment (string, omitempty) — Comment. For audio message.

• given_name (string, nullable, omitempty) — Given name (for "contact" mediatype).

• family_name (string, nullable, omitempty) — Family name (for "contact" mediatype).

• patronymic (string, nullable, omitempty) — Patronymic name (for "contact" mediatype).

• phones (string, nullable, list, omitempty) — Contact phones list (for "contact" mediatype).

• emails (string, nullable, list, omitempty) — Emails list (for "contact" mediatype).

• stickerpack (string, omitempty) — Stickerpack name (for "sticker" subtype).

• pdf_version (PdfVersion, nullable, omitempty) — Pdf version, if any.

MessageLink

Checked message links. In short: "Click here: {link.Pattern}" => "Click here: {link.Text}".

• pattern (string) — Text fragment that should be replaced by link.

• url (string) — Internal or external link.

• text (string) — Text replacement.

• preview (MessageLinkPreview, nullable, omitempty) — Optional preview info, for websites.

• uploads (Upload, list, omitempty) — Optional upload info.

• nopreview (bool, omitempty) — Website previews disabled.

• youtube_id (string, omitempty) — Optional youtube movie id.

MessageLinkPreview

Website title and description.

• title (string) — Website title or og:title content.

• description (string, omitempty) — Website description.

MessagePush

Push message over websockets. Readonly.

• title (string) — Push title.

• subtitle (string) — Push subtitle.

• message (string) — Push body.

• icon_url (string) — Absolute url to push icon.

• click_action (string) — Url opened on click.

• tag (string) — Push tag (for join pushes).

• team (string) — Team uid.

• sender (JID) — Sender contact id.

• chat (JID) — Chat id.

• message_id (string) — Message id.

• created (ISODateTimeString) — Message creation iso datetime.

MessageReaction

Message emoji reaction.

• name (string) — Emoji.

• counter (int) — Number of reactions.

• details (MessageReactionDetail, list) — Details.

MessageReactionDetail

Message reaction detail.

• created (ISODateTimeString) — When reaction added, iso datetime.

• sender (JID) — Reaction author.

• name (string) — Reaction emoji.

OAuthService

OAuth service.

• name (string) — Integration title.

• url (string) — Redirect url.

PdfVersion

PDF preview of mediafile. Experimental.

• url (string) — Absolute url.

• text_preview (string, omitempty) — First string of text content.

Remind

Remind.

• uid (string) — Remind id.

• chat (JID) — Chat id.

• fire_at (string) — Activation time, iso.

• comment (string, omitempty) — Comment, if any.

Session

Websocket session.

• uid (string) — Session id.

• created (ISODateTimeString) — Creation datetime.

• lang (string, omitempty) — Language code.

• team (string, omitempty) — Team id.

• is_mobile (bool, omitempty) — Mobile.

• afk (bool, omitempty) — Away from keyboard.

• useragent (string, omitempty) — User agent.

• addr (string, omitempty) — IP address.

ShortMessage

Short message based on chat message.

• from (JID, readonly for clients) — Sender contact id.

• to (JID) — Recipient id (group, task or contact).

• message_id (string) — Message uid.

• created (ISODateTimeString, readonly for clients) — Message creation datetime (set by server side) or sending datetime in future for draft messages.

• gentime (int64, readonly for clients) — Object version.

• chat_type (ChatType, readonly for clients) — Chat type.

• chat (JID, readonly for clients) — Chat id.

• is_archive (bool, readonly for clients, omitempty) — This message is archive. True or null.

SingleIcon

Small or large icon.

• url (string) — absolute url to icon.

• width (int) — Icon width, in pixels.

• height (int) — Icon height, in pixels.

Subtask

Link to sub/sup task.

• jid (JID) — Task id.

• assignee (JID) — Assignee contact id. Tasks only.

• title (string) — Task title. Generated from number and description.

• num (uint) — Task number in this team.

• display_name (string) — Title.

• public (bool, omitempty) — Can other team member see this task/group chat.

Tag

Task tag.

• uid (string) — Tag id.

• name (string) — Tag name.

TaskColor

Task color rules color.

• regular (string) — Regular.

• dark (string) — Dark.

• light (string) — Light.

TaskCounters

Tasks counters.

• jid (JID) — Task jid.

• num_unread (uint, omitempty) — Unreads counter.

• num_unread_notices (uint, omitempty) — Mentions (@) counter.

TaskFilter

Task filter.

• field (TaskFilterKey) — Task filter field.

• title (string) — Filter title.

TaskItem

Task checklist item.

• uid (string, omitempty) — Id.

• sort_ordering (uint, omitempty) — Sort ordering.

• text (string) — Text or "#{OtherTaskNumber}".

• checked (bool, omitempty) — Item checked.

• can_toggle (bool, omitempty) — Can I toggle this item.

• subtask (Subtask, nullable, omitempty) — Link to subtask. Optional.

TaskSort

Task sort type.

• key (TaskSortKey) — Field.

• title (string) — Sort title.

TaskStatus

Custom task status.

• uid (string, omitempty) — Status id.

• sort_ordering (uint) — Status sort ordering.

• name (string) — Status internal name.

• title (string) — Status localized name.

• is_archive (bool, omitempty) — Status not used anymore.

TaskTab

Task tab.

• key (TaskTabKey) — Tab name.

• title (string) — Tab title.

• hide_empty (bool) — Disable this tab when it has no contents.

• show_counter (bool) — Show unread badge.

• pagination (bool) — Enable pagination.

• filters (TaskFilter, list) — Filters inside tab.

• sort (TaskSort, list) — Sort available in tab.

• unread_tasks (TaskCounters, list) — Unread tasks with jid and counters.

Team

Team.

• uid (string, readonly for clients) — Team id.

• is_archive (bool, readonly for clients, omitempty) — Team deleted.

• gentime (int64, readonly for clients) — Object version.

• name (string) — Team name.

• default_task_deadline (string, omitempty) — Default task deadline.

• max_message_update_age (int) — Max message update/deletion age, in seconds.

• icons (IconData, readonly for clients) — Team icons.

• last_active (bool, readonly for clients) — User last activity was in this team.

• changeable_statuses (TeamStatus, readonly for clients, list, omitempty) — What status I can set to other team members.

• bad_profile (bool, readonly for clients, omitempty) — My profile in this team isn't full.

• need_confirmation (bool, readonly for clients) — Need confirmation after invite to this team.

• use_patronymic (bool, omitempty) — Patronymic in usernames for this team.

• user_fields (string, readonly for clients, list) — Username fields ordering.

• display_family_name_first (bool, omitempty) — Family name should be first in display name.

• use_task_importance (bool, omitempty) — Use importance field in task.

• task_importance_min (int, omitempty) — Minimal value of task importance. Default is 1.

• task_importance_max (int, omitempty) — Maximum value of task importance. Default is 5.

• task_importance_rev (bool, omitempty) — Bigger number = bigger importance. Default: lower number = bigger importance.

• use_task_urgency (bool, omitempty) — Use urgency field in task.

• use_task_complexity (bool, omitempty) — Use complexity field in task.

• use_task_spent_time (bool, omitempty) — Use spent time field in task.

• uploads_size (int64, readonly for clients, omitempty) — Total uploads size, bytes.

• uploads_size_limit (int64, readonly for clients, omitempty) — Maximum uploads size, bytes, if any.

• unread (TeamUnread, readonly for clients, nullable) — Unread message counters.

• me (Contact, readonly for clients) — My profile in this team.

• contacts (Contact, readonly for clients, list, omitempty) — Team contacts. Used only for team creation.

• single_group (JID, readonly for clients, nullable, omitempty) — For single group teams, jid of chat.

• theme (Theme, readonly for clients, nullable, omitempty) — Color theme, if any.

• hide_archived_users (bool, omitempty) — Don't show archived users by default.

TeamCounter

Unread message counters.

• uid (string) — Team id.

• unread (TeamUnread) — Unread message counters.

TeamShort

Short team representation. For invites, push notifications, etc. Readonly.

• uid (string) — Team id.

• name (string) — Team name.

• icons (IconData) — Team icons.

TeamStatus

Team status.

• "owner" Team owner. Can do anything
• "admin" Team administrator
• "member" Team member
• "guest" Team guest. Restricted account

Terms

Experimental translation fields for "team" entity renaming. Readonly.

• EnInTeam (string) — EnInTeam.

• EnTeam (string) — EnTeam.

• EnTeamAccess (string) — EnTeamAccess.

• EnTeamAdmin (string) — EnTeamAdmin.

• EnTeamAdmins (string) — EnTeamAdmins.

• EnTeamGuest (string) — EnTeamGuest.

• EnTeamMember (string) — EnTeamMember.

• EnTeamMembers (string) — EnTeamMembers.

• EnTeamOwner (string) — EnTeamOwner.

• EnTeamSettings (string) — EnTeamSettings.

• RuTeamSettings (string) — RuTeamSettings.

• EnTeams (string) — EnTeams.

• EnToTeam (string) — EnToTeam.

• RuInTeam (string) — RuInTeam.

• RuTeam (string) — RuTeam.

• RuTeamAccess (string) — RuTeamAccess.

• RuTeamAdmin (string) — RuTeamAdmin.

• RuTeamAdmins (string) — RuTeamAdmins.

• RuTeamD (string) — RuTeamD.

• RuTeamGuest (string) — RuTeamGuest.

• RuTeamMember (string) — RuTeamMember.

• RuTeamMembers (string) — RuTeamMembers.

• RuTeamOwner (string) — RuTeamOwner.

• RuTeamP (string) — RuTeamP.

• RuTeamR (string) — RuTeamR.

• RuTeams (string) — RuTeams.

• RuTeamsD (string) — RuTeamsD.

• RuTeamsP (string) — RuTeamsP.

• RuTeamsR (string) — RuTeamsR.

• RuTeamsT (string) — RuTeamsT.

• RuTeamsV (string) — RuTeamsV.

• RuTeamT (string) — RuTeamT.

• RuTeamV (string) — RuTeamV.

• RuToTeam (string) — RuToTeam.

Theme

Color theme.

• BgColor (string) — Web colors.

• BgHoverColor (string) — BgHoverColor.

• TextColor (string) — TextColor.

• MutedTextColor (string) — MutedTextColor.

• AccentColor (string) — AccentColor.

• AccentHoverColor (string) — AccentHoverColor.

• TextOnAccentHoverColor (string) — TextOnAccentHoverColor.

• MainAccent (string) — MainAccent.

• MainAccentHover (string) — MainAccentHover.

• MainLightAccent (string) — MainLightAccent.

• MainLink (string) — MainLink.

• AppAccentColor (string) — Deprecated.

• AppPrimaryColor (string) — Deprecated.

• brand (string) — App colors.

• brand_dark (string) — BrandDark.

• brand_light (string) — BrandLight.

• back (string) — Back.

• back_light (string) — BackLight.

• back_dark (string) — BackDark.

• success (string) — Success.

• success_light (string) — SuccessLight.

• error (string) — Error.

• error_light (string) — ErrorLight.

• background (string) — Background.

• tab_background (string) — TabBackground.

• chat_input_background (string) — ChatInputBackground.

• attention (string) — Attention.

• attention_light (string) — AttentionLight.

• font (FontColors, nullable) — Font.

• message (MessageColors, nullable) — Message.

• switcher (SwitcherColors, nullable) — Switcher.

• button (ButtonColors, nullable) — Button.

• input (InputColors, nullable) — Input.

• ic (IconColors, nullable) — Icon.

Unread

Unread message counters.

• messages (uint) — Total unread messages.

• notice_messages (uint) — Total unread messages with mentions.

• chats (uint) — Total chats with unread messages.

Upload

Uploaded media.

• uid (string) — Upload id.

• created (ISODateTimeString) — Uploaded at.

• size (int) — Upload size in bytes.

• duration (uint, omitempty) — Mediafile duration (for audio/video only).

• name (string) — Filename.

• url (string) — Absolute url.

• preview (UploadPreview, nullable, omitempty) — Preview details.

• content_type (string) — Content type.

• animated (bool, omitempty) — Is animated (images only).

• processing (bool, omitempty) — File still processing (video only).

• pdf_version (PdfVersion, nullable, omitempty) — PDF version of file. Experimental.

• type (UploadMediaType) — ?type=file,image,audio,video.

UploadPreview

Upload preview.

• url (string) — Absolute url to image.

• url_2x (string) — Absolute url to high resolution image (retina).

• width (int) — Width in pixels.

• height (int) — Height in pixels.

UploadShortMessage

Upload + ShortMessage.

• upload (Upload) — Upload.

• message (ShortMessage) — Message.

User

Account data.

• phone (string, omitempty) — Phone for login.

• email (string, omitempty) — Email for login.

• family_name (string, omitempty) — Family name.

• given_name (string, omitempty) — Given name.

• patronymic (string, omitempty) — Patronymic, if any.

• default_lang (string, omitempty) — Default language code.

• alt_send (bool) — Use Ctrl/Cmd + Enter instead Enter.

• asterisk_mention (bool) — Use * as @ for mentions.

• always_send_pushes (bool) — Send pushes even user is online.

• unread_first (bool) — Show unread chats in chat list first.

• munread_first (bool) — Show unread chats in chat list first on mobiles.

• timezone (string) — Timezone.

• quiet_time_start (string, nullable) — Start silently time (no pushes, no sounds).

• quiet_time_finish (string, nullable) — Finish silently time (no pushes, no sounds).

Wallpaper

Chat wallpaper.

• key (string) — Unique identifier.

• name (string) — Localized description.

• url (string) — Url to jpg or png.

WikiPage

Wiki page. Experimental.

• gentime (int64) — Object version.

• updated (string) — Update time, iso.

• editor (JID) — Last editor contact id.

• text (string) — Page text.

clientCallBuzzParams

Call buzzing.

• jid (JID) — Jid.

• members (JID, list) — Members.

Events

client.activity

Change AFG (away from keyboard) status.

client.call.buzz.cancel

Call buzzing cancelled.

client.call.leave

Leave call.

client.call.mute.all

Mute all other call participants.

client.call.offer

Start a call.

client.call.reject

Reject the call.

client.call.sound

Change mute state in call.

client.call.trickle

Send trickle candidate for webrtc connection.

client.chat.composing

Typing or recording audiomessage.

client.chat.lastread

Last read message in chat changed.

client.confirm

Client confirmed server message.

client.message.deleted

Message deleted.

client.message.updated

Message created or changed.

client.ping

Empty message for checking server connection.

server.call.answer

Call parameters.

server.call.buzz

Call buzzing.

server.call.buzzcancel

Call cancelled on buzzing.

server.call.check.fingerprint

Experimental function.

server.call.leave

Participant leave a call.

server.call.muteall

All participants in call muted.

server.call.reject

Call rejected.

server.call.restart

Call restarted.

server.call.sound

Mute/unmute call participant.

server.call.state

Call participant number or parameters changed.

server.call.talking

Someone talks in call.

server.chat.composing

Someone typing or recording audiomessage in chat.

server.chat.deleted

Chat deleted.

server.chat.draft

Changed draft message in chan.

server.chat.lastread

Changed last read message in chat.

server.chat.updated

Chat created or updated.

server.confirm

Server confirmed client message.

server.contact.updated

Contact created or updated.

server.debug

Debug message.

server.login

Login from other device.

server.message.push

Push replacement for desktop application.

server.message.received

Message received by someone in chat.

server.message.updated

Chat message created, updated or deleted.

server.online

Online team members and current active calls.

server.panic

Critical server error.

server.processing

Status of background operation.

server.remind.deleted

Task or group remind deleted.

server.remind.fired

Task or group remind fired.

server.remind.updated

Task/group remind created or changed.

server.section.deleted

Contact section or task project deleted.

server.section.updated

Contact section or task project created or changed.

server.tag.deleted

Tag deleted.

server.tag.updated

Tag created or changed.

server.team.counters

Counters form other teams.

server.team.deleted

Team archived.

server.team.updated

Team created or changed.

server.time

Current server time.

server.ui.settings

Part of UI settings changed.

server.upload.updated

Upload object created or changed.

server.warning

Something went wrong with client message.