markdown

Structures

Autogenerated from source code. Do not edit.

Upload

Uploaded media.

• uid (string) — Upload id.

• 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.

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.

SingleIcon

Small or large icon.

• url (string) — absolute url to icon.

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

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

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.

CallEvent

Audiocall 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.

• icon (string) — Contact icon.

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

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

CallDevice

Call participant device.

• muted (bool) — Device muted.

• useragent (string) — Device description.

PdfVersion

PDF preview of mediafile. Experimental.

• url (string) — Absolute url.

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

MessageContent

Chat message content.

• text (string) — Text repesentation of message.

• type (Mediatype) — Message type.

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

• upload (string, omitempty) — Upload id, if any.

• mediaURL (string, omitempty) — Upload url, if any.

• size (int, omitempty) — Upload size, if any.

• duration (uint, nullable, omitempty) — Upload duration, if any.

• processing (bool, omitempty) — Upload stil processing, if any.

• previewHeight (int, omitempty) — Upload preview height, in pixels, if any.

• previewWidth (int, omitempty) — Upload width, in pixels, if any.

• previewURL (string, omitempty) — Upload preview absolute url, if any.

• preview2xURL (string, omitempty) — Upload high resolution preview absolute url, if any.

• name (string, omitempty) — Upload name, if any.

• animated (bool, omitempty) — Upload is animated image, if any.

• 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 audimessage.

• 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.

Message

Chat message.

• content (MessageContent) — Message content struct.

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

• from (JID) — Sender contact id.

• to (JID) — Recipient jid.

• message_id (string) — Message uid.

• created (string) — Message creation datetime (set by server side).

• gentime (int64) — Object version.

• chat_type (ChatType) — Chat type.

• chat (JID, omitempty) — chat jid.

• links (MessageLinks, omitempty) — external/internals links.

• important (bool, omitempty) — importance flag.

• edited (string, omitempty) — datetime of message modification or deletion.

• received (bool, omitempty) — message was seen by anybody in chat. True or null.

• num_received (int, omitempty) — unused yet.

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

• has_previews (bool, omitempty) — has link previews. True or null.

• prev (string, omitempty) — previous message id in this chat. Uid or null.

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

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

• reactions (MessageReaction, 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, omitempty) — has mention (@). True or null.

• silently (bool, omitempty) — message has no pushes and did not affect any counters.

• editable_until (string, omitempty) — author can change this message until date. Can be null.

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

• _debug (string, omitempty) — debug information if any.

MessageLinkPreview

Website title and description.

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

• description (string, omitempty) — Website description.

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 (tadateam://) 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.

MessageReaction

Message emoji reaction.

• name (string) — Emoji.

• counter (int) — Number of reactions.

• details (MessageReactionDetail, list) — Details.

MessageReactionDetail

Message reaction detail.

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

• sender (JID) — Reaction author.

• name (string) — Reaction emoji.

Features

{hostname}/features.js / {hostname}/features.json structure.

• 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.

• 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_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_teams (int) — Maximum teams for one account.

• 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.

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

• custom_server (bool) — True for onpremise installation.

• installation_type (string) — Name of instalation.

• 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) — Frontent sentry.io settings.

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

• firebase_app_id (string) — Firebase application id for web-push notifacations.

• firebase_sender_id (string) — Firebase sender id for web-push notifacations.

• 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 notifacations.

• 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.

• task_checklist (bool) — Deprecated.

• readonly_groups (bool) — Deprecated.

• task_dashboard (bool) — Deprecated.

• task_messages (bool) — Deprecated.

• task_public (bool) — Deprecated.

• task_tags (bool) — Deprecated.

ICEServer

Interactive Connectivity Establishment Server for WEB Rtc connection.

• urls (string) — URls.

Terms

Exprtimental translation fields for "team" entity renaming.

ChatShort

Mimimal chat representaion.

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

• chat_type (ChatType) — Chat type.

• display_name (string) — Title.

• icons (IconData, nullable) — Icon data.

DeletedChat

Mimimal chat representaion for deletion.

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

• chat_type (ChatType) — Chat type.

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

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

Chat

Chat (direct, group, task) representaion.

• 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 participan) version.

• created (string) — 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 importants messages.

• num_unread (uint, omitempty) — Unreads conuter.

• 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 oreding 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.

• 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 observers id's.

• 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...".

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

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

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

• status (GroupStatus, 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. Experemental 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, nullable, omitempty) — Can I delete any message in this chat.

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

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.

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.

GroupMembership

Group chat membership status.

• jid (JID) — Contact id.

• status (GroupStatus) — Status in group.

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